Skip to content

Commit 96fe2de

Browse files
author
QuickSander
committed
doc: Remove color status object.
1 parent e92cd02 commit 96fe2de

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Following configuration is a real world example for a accessory that combines a
175175
"url":"http://192.168.0.120/api/<apikey>/lights/6/state",
176176
"body": "{\"bri\": %s}"
177177
},
178-
"http_method": "put",
178+
"http_method": "`PUT`",
179179
"max": 254
180180
},
181181
"color": {
@@ -188,7 +188,7 @@ Following configuration is a real world example for a accessory that combines a
188188
"body": "{\"xy\": [%xy-x,%xy-y]}"
189189
},
190190
"brightness": false,
191-
"http_method": "put"
191+
"http_method": "PUT"
192192
}
193193
}
194194
]
@@ -226,7 +226,7 @@ Following configuration is a real world example for a accessory that combines a
226226
| `username` _(optional)_ | Username if http authentication is enabled on the RGB device. | |
227227
| `password` _(optional)_ | Password if http authentication is enabled on the RGB device. | |
228228
| `notificationID` _(optional)_ | Identifier to use when device sends push notifications. See [Push notifications](#push-responses-device-pushes-updates) | |
229-
| `notificationPasword` _(optional)_ | Password to use when device sends push notifications. | |
229+
| `notificationPassword` _(optional)_ | Password to use when device sends push notifications. | |
230230
| `switch` | A [switch object](#switch-object) | - |
231231
| `brightness` | A [brightness object](#brightness-object) | - |
232232
| `color` | A [color object](#color-object) | - |
@@ -264,7 +264,7 @@ Following configuration is a real world example for a accessory that combines a
264264
| Key | Description |
265265
| --- | --- |
266266
| `url` | URL to set brightness status |
267-
| `body` | relevant, if the http_method is put/post. this body is sent to the url. you can use a placeholder (`%s`) within the body. example: `{"bri": %s}` |
267+
| `body` | relevant, if the http_method is PUT/POST. this body is sent to the url. you can use a placeholder (`%s`) within the body. example: `{"bri": %s}` |
268268

269269

270270
### Color object
@@ -275,17 +275,11 @@ Following configuration is a real world example for a accessory that combines a
275275
| `brightness` | Whether or not the plugin should include brightness data in `color` HEX data (`true` or `false`). When `true` brightness will be controllable in HomeKit but will be changed through changing RGB values. |
276276
| `http_method` _(optional)_ | The brightness specific HTTP method for set requests. If omitted defaults to `http_method` as specified in the root structure |
277277

278-
#### Color status object
279-
| Key | Description |
280-
| --- | --- |
281-
| `url` | URL to retrieve brightness status |
282-
| `bodyRegEx` _(optional)_ | Regular expression to extract the brightness out of a response body. Example: `"bri":([0-9]+)` |
283-
284278
#### Color url object
285279
| Key | Description |
286280
| --- | --- |
287281
| `url` | URL to set color status |
288-
| `body` | relevant, if the http_method is put/post. this body will be sent to the url. you can use following placeholders: `%s` (hex-rgb), `%xy-x`, `%xy-y`. Example: `{"xy": [%xy-x,%xy-y]}` |
282+
| `body` | relevant, if the http_method is PUT/POST. this body will be sent to the url. you can use following placeholders: `%s` (hex-rgb), `%xy-x`, `%xy-y`. Example: `{"xy": [%xy-x,%xy-y]}` or `{"rgb": "%s"}` |
289283

290284

291285
# Device responses

0 commit comments

Comments
 (0)