Skip to content

Commit 7071fe5

Browse files
authored
Update README.md
1 parent 240202c commit 7071fe5

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,26 @@ Output that sends a delta to the server. Input should be a fully formed SignalK
6060

6161
Output that send a SignalK put request via `app.putSelfPath`. Input should be the value to put.
6262

63+
## signalk-send-notification
64+
65+
Output that sends a SignalK notification
66+
67+
If the input payload is an object, then it will use the keys path, state, method, and message. Example below. Otherwise it will use the configured values.
68+
69+
To specify all the info, send:
70+
```
71+
{payload: {
72+
"path":"notifications.testNotification",
73+
"state":"alarm",
74+
"method":["visual","sound"],
75+
"message":"this is a notification message"
76+
}}
77+
```
78+
79+
Or to specify some of the info, send:
80+
```
81+
{payload: {
82+
"state":"normal",
83+
}}
84+
```
85+

0 commit comments

Comments
 (0)