Skip to content

Commit 455b432

Browse files
committed
chore: added help text
1 parent 87daaed commit 455b432

6 files changed

+40
-6
lines changed

signalk-flatten-delta.html

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,16 @@
2222
</script>
2323

2424
<script type="text/x-red" data-help-name="signalk-flatten-delta">
25-
<p>A simple node that converts the message payloads into all lower-case characters</p>
25+
<p>Function that flatten deltas from signalk-on-delta.</p>
26+
27+
<p>The output payload with be have path, value, source and context:</p>
28+
29+
<pre><code class="javascript">
30+
{
31+
"path":"navigation.speedOverGround",
32+
"value":2.45,
33+
"source":{"label":"actisense","type":"NMEA2000","pgn":129026,"src":"3",
34+
"context": "vessels.self"
35+
}
36+
</code></pre>
2637
</script>

signalk-notification.html

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,20 @@
3939
</script>
4040

4141
<script type="text/x-red" data-help-name="signalk-notification">
42-
<p>A simple node that converts the message payloads into all lower-case characters</p>
42+
<p>Input that sends a message when a notification is received. Configuration allows messages for a specific notification or any notification. The notification state can also be specified. Payload will be the notification path and value.</p>
43+
44+
<pre><code class="javascript">
45+
{
46+
"path: "notifications.anchorAlarm",
47+
"value" : {
48+
"state" : "emergency",
49+
"method" : [
50+
"visual",
51+
"sound"
52+
],
53+
"timestamp" : "2018-06-15T15:01:55.007Z",
54+
"message" : "Anchor Alarm - Emergency"
55+
}
56+
}
57+
</code></pre>
4358
</script>

signalk-on-delta.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@
2222
</script>
2323

2424
<script type="text/x-red" data-help-name="signalk-on-delta">
25-
<p>A simple node that converts the message payloads into all lower-case characters</p>
25+
<p>Input that sends messages for every delta the server receives</p>
2626
</script>

signalk-send-delta.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@
2323
</script>
2424

2525
<script type="text/x-red" data-help-name="signalk-send-delta">
26-
<p>A simple node that converts the message payloads into all lower-case characters</p>
26+
<p>Output that sends a delta to the server. Input should be a fully formed SignalK delta</p>
2727
</script>

signalk-send-pathvalue.html

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,13 @@
2323
</script>
2424

2525
<script type="text/x-red" data-help-name="signalk-send-pathvalue">
26-
<p>A simple node that converts the message payloads into all lower-case characters</p>
26+
27+
<p>Output that sends a delta through the server. Input should be path and value</p>
28+
29+
<pre><code class="javascript">
30+
{
31+
"path":"navigation.speedOverGround",
32+
"value":20.45
33+
}
34+
</code></pre>
2735
</script>

signalk-send-put.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@
2828
</script>
2929

3030
<script type="text/x-red" data-help-name="signalk-send-put">
31-
<p>A simple node that converts the message payloads into all lower-case characters</p>
31+
<p>Output that send a SignalK put request via `app.putSelfPath`. Input should be the value to put.</p>
3232
</script>

0 commit comments

Comments
 (0)