Skip to content

Commit 3ae0203

Browse files
authored
Update documentation (openhab#17808)
Signed-off-by: Leo Siepel <[email protected]>
1 parent 546bb56 commit 3ae0203

File tree

1 file changed

+40
-31
lines changed
  • bundles/org.openhab.binding.hydrawise

1 file changed

+40
-31
lines changed

bundles/org.openhab.binding.hydrawise/README.md

+40-31
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,19 @@ The Hydrawise binding allows monitoring and control of [Hunter Industries's](htt
66

77
## Supported Things
88

9-
### Account Bridge Thing
10-
11-
The Account Bridge Thing type represents the user's account on the Hydrawise cloud service. The bridge can have one or more child [Controllers](#controller-thing) linked.
12-
9+
- `account`: Bridge type represents the user's account on the Hydrawise cloud service. The bridge can have one or more child [Controllers](#controller-thing) linked.
1310
An account must be manually added and configured.
11+
- `controller` Things are automatically discovered once an account Bridge is properly configured.[more details](#local-thing)
12+
- `local` Things uses an undocumented API that allows direct HTTP access to an irrigation controller on the user's network. [more details](#local-thing)
1413

15-
### Controller Thing
16-
17-
Controller Things are automatically discovered once an [Account Bridge](#account-bridge-thing) has be properly configured.
14+
### `controller` Thing
1815

1916
The Controller Thing type is the primary way most users will control and monitor their irrigation system.
2017
This allows full control over zones, sensors and weather forecasts.<br>
2118
Changes made through this Thing type will be reflected in the Hydrawise mobile and web applications as well as in their reporting modules.
19+
Controller Things require a parent `account` Bridge
2220

23-
Controller Things require a parent [Account Bridge](#account-bridge-thing)
24-
25-
#### Controller Thing Supported Channel Groups
26-
27-
| channel group ID |
28-
|-----------------------------------------------|
29-
| [Controller](#controller-thing-1) |
30-
| [Zones](#zone-channel-group) |
31-
| [All Zones](#all-zones-channel-group) |
32-
| [Sensor](#sensor-channel-group) |
33-
| [Forecast](#forecast-channel-group) |
34-
35-
### Local Thing
21+
### `local` Thing
3622

3723
The Local Thing type uses an undocumented API that allows direct HTTP access to an irrigation controller on the user's network.
3824
This provides a subset of features compared to the Cloud Thing type limited to basic zone control.
@@ -45,16 +31,9 @@ Use Cases
4531
- The Local thing can be useful when testing zones, as there is no delay when starting/stopping zones as compared to the cloud API which can take anywhere between 5-15 seconds.
4632
- This is also useful if you wish to not use the cloud scheduling at all and use openHAB as the irrigation scheduling system.
4733

48-
#### Local Thing Supported Channel Groups
49-
50-
| channel group ID |
51-
|---------------------------------------|
52-
| [Zones](#zone-channel-group) |
53-
| [All Zones](#all-zones-channel-group) |
54-
5534
## Thing Configuration
5635

57-
### Account Thing
36+
### `account` Bridge Configuration
5837

5938
| Configuration Name | type | required | Comments |
6039
|--------------------|---------|----------|---------------------------------------------------------------------------------------------------------------------------|
@@ -64,13 +43,13 @@ Use Cases
6443
| refresh | Integer | False | Defaults to a 60 second polling rate, more frequent polling may cause the service to deny requests |
6544
| refreshToken | Boolean | False | An oAuth refresh token, this will be automatically configured after the first login and updated as the token is refreshed |
6645

67-
### Controller Thing
46+
### `controller` Thing Configuration
6847

6948
| Configuration Name | type | required | Comments |
7049
|--------------------|---------|----------|----------------------|
7150
| controllerId | Integer | True | ID of the controller |
7251

73-
### Local Thing
52+
### `local` Thing Configuration
7453

7554
| Configuration Name | type | required | Comments |
7655
|--------------------|---------|----------|-----------------------------------------------------------------------------------------------------------------|
@@ -79,10 +58,27 @@ Use Cases
7958
| password | String | True | Password set on the touch panel of the controller. This can be found under the setting menu on the controller. |
8059
| refresh | Integer | True | Defaults to a 30 seconds polling rate |
8160

82-
## Channels
61+
## Channels and Groups
8362

8463
### Channel Groups
8564

65+
### Controller Thing Supported Channel Groups
66+
67+
| channel group ID |
68+
|---------------------------------------|
69+
| [Controller](#controller-thing-1) |
70+
| [Zones](#zone-channel-group) |
71+
| [All Zones](#all-zones-channel-group) |
72+
| [Sensor](#sensor-channel-group) |
73+
| [Forecast](#forecast-channel-group) |
74+
75+
#### Local Thing Supported Channel Groups
76+
77+
| channel group ID |
78+
|---------------------------------------|
79+
| [Zones](#zone-channel-group) |
80+
| [All Zones](#all-zones-channel-group) |
81+
8682
#### System Channel Group
8783

8884
| channel group ID | Description |
@@ -161,6 +157,19 @@ Channels uses across zones, sensors and forecasts
161157

162158
## Full Example
163159

160+
## `demo.things` Example
161+
162+
```java
163+
Bridge hydrawise:account:myaccount "Hydrawise Cloud" [ userName="my-username", password="my-password", savePassword=true, refresh=120 ] {
164+
Thing controller irrigation1 "Frontyard Controller" [ controllerId="12345" ]
165+
Thing controller irrigation2 "Backyard Controller" [ controllerId="67890" ]
166+
}
167+
168+
Thing local directIrrigation "Garden Controller" [ host="host-ip", username="my-username", password="my-password", refresh="30" ]
169+
```
170+
171+
## `demo.items` Example
172+
164173
```java
165174
Group Sprinkler "Sprinkler"
166175
Group SprinklerController "Controller" (Sprinkler)

0 commit comments

Comments
 (0)