Skip to content

Commit 71e1800

Browse files
author
Matt
committed
docs: update docs with new color temp feature
1 parent 8e9d1ce commit 71e1800

File tree

3 files changed

+16
-3
lines changed

3 files changed

+16
-3
lines changed

CHANGELOG.md

Whitespace-only changes.

README.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
[Node-RED](http://nodered.org) nodes to control [MiHome/Xiaomi Yeelights](https://www.yeelight.com/) from your smart home, somewhat [API compatible with node-red-contrib-node-hue nodes](https://github.com/jdomeij/node-red-contrib-node-hue#input-node).
1212

13+
1314
## Install
1415

1516
Run the following command in your Node-RED user directory – typically `~/.node-red`:
@@ -24,6 +25,7 @@ Provides two palette nodes – one to send control commands to a Yeelight, and o
2425

2526
![](https://github.com/mattmattmatt/node-red-contrib-yeelight-compat-hue/blob/master/tooling/nodes.png?raw=true)
2627

28+
2729
### Output node
2830

2931
Sets the state of the selected Yeelight device.
@@ -34,6 +36,7 @@ Sets the state of the selected Yeelight device.
3436
| :---| :---|
3537
| `on` | Sets the `on` state where the value is `true` or `false`|
3638
| `bri` | Sets the brightness value from `0` to `255` |
39+
| `ct` | Sets the color temperature value in Kelvin from `1700` to `6500` |
3740
| `hue` | Sets the hue value from `0` to `65535` |
3841
| `sat` | Sets the saturation value from `0` to `255` |
3942
| `hex` | Sets the rgb value from `#00000` to `#FFFFFF` |
@@ -57,13 +60,18 @@ Sets the state of the selected Yeelight device.
5760
"hex": "#AA00CC",
5861
}
5962
```
60-
The node supports sending [hex values](http://htmlcolorcodes.com/) and [HSV values](https://alloyui.com/examples/color-picker/hsv).
63+
```JSON
64+
{
65+
"ct": 2200,
66+
}
67+
```
68+
The node supports sending [color temperature values](http://www.erco.com/service/rgbw/), [hex values](http://htmlcolorcodes.com/) and [HSV values](https://alloyui.com/examples/color-picker/hsv).
6169
The brightness value will always have to be provided separately and will not be deducted from e.g. a hex value's brightness component.
6270

63-
6471
##### References
6572
This node's input payload structure is based on [node-red-contrib-node-hue](https://github.com/jdomeij/node-red-contrib-node-hue#input-node), which is based on [Node Hue API](https://github.com/peter-murray/node-hue-api#lightstate-options).
6673

74+
6775
### Input node
6876

6977
Returns the current state of the selected Yeelight device.
@@ -106,6 +114,7 @@ Additionally, a fresh state can be requested from the connected Yeelight by send
106114
The `raw` property of `msg.payload` contains the raw state information retrieved from the Yeelight for advanced usage.
107115
Note that value scales are not compatible with _node-red-contrib-node-hue_, and that `hue` value and `rgb` value will not match since only the correct color per `color_mode` is returned by the lamp.
108116

117+
109118
### Configuration node
110119

111120
Configures a Yeelight connection to one light in the local network.

yeelight-compat-hue-out.html

+5-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,11 @@ <h4>Example inputs</h4>
6363
<pre><code>{
6464
"on": true,
6565
"bri": 120,
66-
"hex": "#AA00CC",
66+
"hex": "#AA00CC"
67+
}</code></pre>
68+
<pre><code>{
69+
"on": true,
70+
"ct": 2200
6771
}</code></pre>
6872
</p>
6973

0 commit comments

Comments
 (0)