Skip to content

Commit 404a921

Browse files
committed
docs: update node descriptions with better documentation
1 parent 564bfbb commit 404a921

File tree

3 files changed

+20
-24
lines changed

3 files changed

+20
-24
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,19 @@ Provides two palette nodes – one to send control commands to a Pioneer AVR, an
3030

3131
Sets the state of the receiver.
3232

33-
`msg.payload` must be an object containing the new state's properties of the selected Yeelight device.
33+
`msg.payload` must be an object containing the new state's properties of the Pioneer receiver.
3434

3535
| Property | Details |
3636
| :---| :---|
3737
| `on` | Sets the `on` state where the value is `true` or `false` |
3838
| `muted` | Sets the `muted` state where the value is `true` or `false` |
39-
| `volume` | Sets the volume from `0` to `153` |
39+
| `volume` | Sets the volume from `0` to `74`, or whatever your receiver's maximum is |
4040
| `channel` | Sets the active input channel, must be one of `CD`, `TUNER`, `DVD`, `TV`, `SAT/CBL`, `VIDEO`, `DVR/BDR`, `IPOD/USB`, `BD`, `ADAPTER`, `NETRADIO`, `MEDIA SERVER`, `FAVORITE`, `GAME` |
4141

4242
#### Example payloads
4343

4444
```JSON
45-
{
45+
{
4646
"on": true
4747
}
4848
```

pioneer-avr-config.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@
3939
<input type="text" id="node-config-input-port" placeholder="8102">
4040
</div>
4141
<div class="form-row">
42-
<label for="node-config-input-volume-multiplier"><i class="icon-bookmark"></i> Volume Multiplier</label>
43-
<input type="text" id="node-config-input-volume-multiplier" placeholder="0.4897959183673469">
42+
<label for="node-config-input-volume-multiplier" title="a factor to multiply volume values sent by the receiver by"><i class="icon-bookmark"></i> Volume Multiplier</label>
43+
<input type="text" id="node-config-input-volume-multiplier" placeholder="0.4897959183673469" title="a factor to multiply volume values sent by the receiver by">
4444
</div>
4545
<div class="form-row">
4646
<label for="node-config-input-name"><i class="icon-bookmark"></i> Name</label>

pioneer-avr-out.html

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<script type="text/x-red"
2828
data-template-name="pioneer-avr-out">
2929
<div class="form-row">
30-
<label for="node-input-server"><i class="icon-tag"></i> Yeelight</label>
30+
<label for="node-input-server"><i class="icon-tag"></i> Receiver</label>
3131
<input type="text" id="node-input-server" />
3232
</div>
3333
<div class="form-row">
@@ -40,37 +40,33 @@
4040

4141
<script type="text/x-red"
4242
data-help-name="pioneer-avr-out">
43-
<p>Sets the state of the selected Yeelight device, largely <a href="https://github.com/jdomeij/node-red-contrib-node-hue#readme">compatible with node-red-contrib-node-hue</a>.</p>
43+
<p>Sets the state of the selected Pioneer receiver.</p>
4444
<h3>Inputs</h3>
4545
<dl class="message-properties">
4646
<dt>payload <span class="property-type">object</span></dt>
47-
<dd>an object containing the next state of the selected Yeelight device.</dd>
47+
<dd>an object containing the next state of the Pioneer receiver.</dd>
48+
<dt>payload.on <span class="property-type">bool</span></dt>
49+
<dd></dd>
50+
<dt>payload.muted <span class="property-type">bool</span></dt>
51+
<dd></dd>
52+
<dt>payload.volume <span class="property-type">number</span></dt>
53+
<dd></dd>
54+
<dt>payload.channel <span class="property-type">enum</span></dt>
55+
<dd>One of <code>CD</code>, <code>TUNER</code>, <code>DVD</code>, <code>TV</code>, <code>SAT/CBL</code>, <code>VIDEO</code>, <code>DVR/BDR</code>, <code>IPOD/USB</code>, <code>BD</code>, <code>ADAPTER</code>, <code>NETRADIO</code>, <code>MEDIA SERVER</code>, <code>FAVORITE</code>, <code>GAME</code></dd>
4856
</dl>
4957

50-
<h3>Details</h3>
51-
<p>The node supports sending hex values, HSV values and color temperature values.</p>
52-
<p>The brightness value will always have to be provided separately and will not be deducted from e.g. a hex value's brightness component.</p>
53-
5458
<h4>Example inputs</h4>
5559
<p>
5660
<pre><code>{
57-
"on": true,
58-
"bri": 255,
59-
"hue": 913,
60-
"sat": 255,
61-
"duration": 5000
61+
"on": true
6262
}</code></pre>
6363
<pre><code>{
6464
"on": true,
65-
"bri": 120,
66-
"hex": "#AA00CC"
65+
"channel": "CD",
66+
"volume": 111
6767
}</code></pre>
6868
<pre><code>{
69-
"on": true,
70-
"ct": 2200
69+
"muted": true
7170
}</code></pre>
7271
</p>
73-
74-
<h3>References</h3>
75-
<p>This node's input is based on <a href="https://github.com/jdomeij/node-red-contrib-node-hue#readme">node-red-contrib-node-hue</a>, which is based on <a href="https://github.com/peter-murray/node-hue-api#lightstate-options">Node Hue API</a>.</p>
7672
</script>

0 commit comments

Comments
 (0)