diff options
| author |   Romain Forlot <romain.forlot@iot.bzh> | 2017-09-19 11:26:07 +0200 |
|---|---|---|
| committer | Romain Forlot <romain.forlot@iot.bzh> | 2017-09-19 11:26:07 +0200 |
| commit | bc53fda3a047a23566d732df3aa06baa8a4f15b2 (patch) | |
| tree | 50d432b81688117eb1c8bc848d1d60b898418521 /docs/3-Usage.md | |
| parent | e08e9bc89e78b3937f84a8dbf47968159521a7ea (diff) | |
Update doc: Timestamp added to returned events.
Change-Id: I4021185bfee862ae701d7510debe31cf17dd97c9
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs/3-Usage.md')
| -rw-r--r-- | docs/3-Usage.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/3-Usage.md b/docs/3-Usage.md index 91b10671..fa2991c0 100644 --- a/docs/3-Usage.md +++ b/docs/3-Usage.md @@ -189,10 +189,10 @@ low-can subscribe { "event" : "doors*" } ON-REPLY 1:low-can/subscribe: {"jtype":"afb-reply","request":{"status":"success","uuid":"511c872e-d7f3-4f3b-89c2-aa9a3e9fbbdb"}} ``` -Then you will receive an event each time a CAN message is decoded for the event named _doors.driver.open_ +Then you will receive an event each time a CAN message is decoded for the event named _doors.driver.open_ with its received timestamp if available: ```json -ON-EVENT low-can/messages.doors.driver.open({"event":"low-can\/messages.doors.driver.open","data":{"name":"messages.doors.driver.open","value":true},"jtype":"afb-event"}) +ON-EVENT low-can/messages.doors.driver.open({"event":"low-can\/messages.doors.driver.open","data":{"name":"messages.doors.driver.open","value":true, "timestamp": 1505812906020023},"jtype":"afb-event"}) ``` Notice that event shows you that the CAN event is named _messages.doors.driver.open_ but you ask for event about _doors.driver.open_. @@ -223,7 +223,7 @@ ON-REPLY 3:low-can/unsubscribe: {"jtype":"afb-reply","request":{"status":"succes It is possible to limits received event notifications into minimum and maximum boundaries as well as doing frequency thinning. This is possible using the argument filter with one or more of the filters available : -* frequency: specify in Hertz the frequency which will be used to getting notified of new CAN events for the designated signal. If, during the blocked time, further changed CAN messages are received, the last valid one will be transferred after the lockout with a RX_CHANGED. +* frequency: specify in Hertz the frequency which will be used to getting notified of new CAN events for the designated signal. If, during the blocked time, further changed CAN messages are received, the last valid one will be transferred after the lockout with a RX_CHANGED. * min: Minimum value that the decoded value needs to be above to get pushed to the subscribed client(s). * max: Maximum value that the decoded value needs to be below to get pushed to the subscribed client(s) |