Browse Source

Update README.md and add docs folder with Hydrawise REST API manuals found

Miroslav Abrahám 5 months ago
parent
commit
1b5053d11a

+ 14 - 16
README.md

@@ -1,8 +1,6 @@
 # Hydrawise API
 # Hydrawise API
 
 
-[![Build Status](https://travis-ci.org/paulmolluzzo/hydrawise-api.svg?branch=master)](https://travis-ci.org/paulmolluzzo/hydrawise-api)
-
-This is a client for the [Hydrawise API](https://support.hydrawise.com/hc/en-us/articles/360008965753-Hydrawise-API-Information). [Hydrawise](https://hydrawise.com) is an internet-controlled home irrigation system.
+This is a client for the [Hydrawise API](docs/Hydrawise REST API). [Hydrawise](https://hydrawise.com) is an internet-controlled home irrigation system.
 
 
 On a very basic level, it allows you to do:
 On a very basic level, it allows you to do:
 * [Get controllers](#get-controllers)
 * [Get controllers](#get-controllers)
@@ -20,7 +18,7 @@ Local connections are only possible on firmware versions below v3.0.0 however.
 ### Setup for a cloud connection
 ### Setup for a cloud connection
 
 
 ```js
 ```js
-const Hydrawise = require('hydrawise-api').Hydrawise;
+const Hydrawise   = require('hydrawise-api').Hydrawise;
 const myHydrawise = new Hydrawise({ type:'CLOUD', key:'YOUR_API_KEY' });
 const myHydrawise = new Hydrawise({ type:'CLOUD', key:'YOUR_API_KEY' });
 ```
 ```
 
 
@@ -29,7 +27,7 @@ You can obtain your API key from the "Account Details" screen on the [Hydrawise
 ### Setup for a local connection
 ### Setup for a local connection
 
 
 ```js
 ```js
-const Hydrawise = require('hydrawise-api').Hydrawise;
+const Hydrawise   = require('hydrawise-api').Hydrawise;
 const myHydrawise = new Hydrawise({ type:'LOCAL', host:'HOSTNAME_OR_IP_ADDRESS', password:'YOUR_CONTROLLER_PASSWORD' });
 const myHydrawise = new Hydrawise({ type:'LOCAL', host:'HOSTNAME_OR_IP_ADDRESS', password:'YOUR_CONTROLLER_PASSWORD' });
 ```
 ```
 
 
@@ -75,14 +73,14 @@ myHydrawise.getControllers()
 This will return an array of HydrawiseZone objects containing the following info:
 This will return an array of HydrawiseZone objects containing the following info:
 
 
 ```js
 ```js
-{number} relayID - The unique relay number known to the Hydrawise cloud
-{number} zone - The local zone/relay number
-{string} name - The name of the zone
-{Date} nextRunAt - The date & time of the next scheduled run 
-{number} nextRunDuration - Run time in seconds of the next run defined by nextRunAt
-{boolean} isSuspended - Returns true when the zoneis currently suspended
-{boolean} isRunning - Returns true when the zone is actively running
-{number} remainingRunningTime - Remaining run time in seconds when isRunning = true
+{number}  relayID              - The unique relay number known to the Hydrawise cloud
+{number}  zone                 - The local zone/relay number
+{string}  name                 - The name of the zone
+{Date}    nextRunAt            - The date & time of the next scheduled run 
+{number}  nextRunDuration      - Run time in seconds of the next run defined by nextRunAt
+{boolean} isSuspended          - Returns true when the zoneis currently suspended
+{boolean} isRunning            - Returns true when the zone is actively running
+{number}  remainingRunningTime - Remaining run time in seconds when isRunning = true
 ```
 ```
 
 
 ### Run a command on a zone
 ### Run a command on a zone
@@ -168,10 +166,10 @@ npm run build
 
 
 ## Contributors
 ## Contributors
 
 
-* Miroslav Abrahám (kunago) - Further modifications and fixes of the code
-* Martijn Dierckx - Complete rewrite to service both the cloud & local API binding in TypeScript
+* Miroslav Abrahám - Further modifications and fixes of the code
+* [Martijn Dierckx](https://github.com/martijndierckx/hydrawise-api) - Complete rewrite to service both the cloud & local API binding in TypeScript
 * [Paul Molluzzo](https://paul.molluzzo.com) - Initial 0.1.0 version containing the cloud binding
 * [Paul Molluzzo](https://paul.molluzzo.com) - Initial 0.1.0 version containing the cloud binding
 
 
-Tested on a configuration with a single HC6 controller. If you have multiple controllers in your configuration and you run into problems, you're free to create an issue or contribute yourself :-)
+Tested on a configuration with a single HC6 controller. If you have multiple controllers in your configuration and you run into problems, you're free to create an issue or contribute yourself.
 
 
 MIT license
 MIT license

BIN
docs/Hydrawise REST API/Hydrawise REST API 1.3.pdf


BIN
docs/Hydrawise REST API/Hydrawise REST API 1.4.pdf


BIN
docs/Hydrawise REST API/Hydrawise REST API 1.5.pdf


BIN
docs/Hydrawise REST API/Hydrawise REST API 1.6.pdf