Skip to content

Commit

Permalink
Extended the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
weiher committed May 23, 2017
1 parent 3464603 commit ef21868
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Prerequisits
2) In order to use the WSDL API you need to download and install the SUDS python package
Download suds-0.4.tar.gz here: https://pypi.python.org/pypi/suds
Install via command line: $ sudo pip install suds-0.4.tar.gz
3) If you don't want to execute the scripts from within an IDE (e.g. Pycharm) you could install pythoninstaller
to build the tools: $ sudo pip install pyinstaller
3) If you don't want to execute the scripts from within an IDE (e.g. Pycharm) you could install
pythoninstaller to build the tools: $ sudo pip install pyinstaller

Building the tools
------------------
Expand All @@ -22,7 +22,19 @@ Running the tools

e.g.: webctrl$ ./dist/wc_query/wc_query

When you run the tools without any arguments you will be prompted with how to use the commands and which
arguments to pass.
When you run the tools without any arguments you will be prompted with how to use the commands and
which arguments to pass.

Short explanation of each tool
------------------------------

wc_query : Query the paths and devices starting from /trees/geographic

wc_report : Retrieve a report for a directory or a specific device

wc_getValue : Retrieve the current value of a device

wc_getTrend : Retrieve data and date for a given time period and device
(ATTENTION: this command does not yet work because the path to the trend data is not correct)


0 comments on commit ef21868

Please sign in to comment.