search

SignalK / specification

Signal K is a JSON-based format for storing and sharing marine data from different sources (e.g. nmea 0183, 2000, seatalk, etc)
Other
91 stars 68 forks source link

corrected error in description of anchor alarm notification object de… #490

Closed RBerliner closed 5 years ago

RBerliner commented 6 years ago

The example in notificatons.md shows each of the zones as an array containing ints and strings.

vessels.self.navigation.anchor.currentRadius.meta.zones[[50,500, "alarm", "Dragging anchor!"]]

when what it should be is an array of js objects zones: [ {lower: "0", upper: maxRadius, state : "normal"}, {lower: maxRadius, upper: 999999, state: "alarm"}]

bkp7 commented 6 years ago

Thanks for spotting this.

I think the corrected zones should be [{"lower": 40, "state": "alarm", "message": "Dragging anchor!"}]. There is no need to specifiy a normal zone as that is the default, and you do not need to specify an upper limit.

Also, please see contributing.md for info on naming and describing changes.

fabdrol commented 5 years ago

@RBerliner could you look at @bkp7 feedback? Then we can move ahead with this.

RBerliner commented 5 years ago

I apologize for not responding to this comment earlier as I have been consumed by another large Java programming project and then the effectws of Hurrican Florence. My boat came through OK but others were not so lucky (See the photo below.) .

image

I looked into my code in AnchorControl.js and I paste below what is there.

path: 'navigation.anchor.currentRadius.meta', value: { "displayName": "Anchor Watch", "shortName": "Anchor Watch", "warnMethod": "visual", "warnMessage": "Check anchor, near watch limit", "alarmMethod": "sound", "alarmMessage": "Dragging anchor", "zones": [ {lower: "0", upper: maxRadius, state : "normal"}, {lower: maxRadius, upper: 999999, state: "alarm"} ]

I checked this code by recompiling and executing Freeboard-K. The anchor alarm works with this definition of the zones. I do not know if you can delete the "normal" state but it does no harm to have it there.

rob42 commented 5 years ago

I hate it when people moor their boats so they overhang and impeded the walkway.

fabdrol commented 5 years ago

@RBerliner can you let us know what the status is of this? Looks like it's ready to go or does it need more TLC?