Skip to content

Automatic state setting for Signal K vessels

Notifications You must be signed in to change notification settings

meri-imperiumi/signalk-autostate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Signal K auto-state plugin

This plugin attempts to determine the vessel's state based on sensor values, and updates the navigation.state value accordingly.

Currently inputs used are:

  • navigation.anchor.position: if an anchor is set, the vessed is set as "anchored"
  • navigation.position: if the vessel moves less than 100 meters in 10 minutes, it is set as "moored", otherwise it is set as "sailing"
  • propulsion.*.revolutions is used to determine whether the vessel is "sailing" or "motoring" when considered to be moving
  • propulsion.*.state (value started or stopped) is used to determine whether the vessel is "sailing" or "motoring" when considered to be moving

The default means of propulsion ("sailing" or "motoring") when moving can be chosen in the plugin settings.

The vessel navigation state can be useful for AIS data, as well as for customizing boat dashboard for the current situation.

Changes

  • 0.4.0 (2024-02-16)
    • Speed threshold where stopping the engine will set state to "moored" immediately is now configurable
  • 0.3.1 (2023-07-27)
    • Fixed issue with persisted state "sticking"
  • 0.3.0 (2023-07-23)
    • Latest state is now persisted on disk to retain state between reboots (like when restarting Signal K while under way)
  • 0.2.0 (2023-02-16)
    • Switched "under way" heuristic to use a moving 10min window. This should eliminate some "false moored" situations
    • Made the switch between sailing and motoring when engine is started/stopped instant when under way
    • Added a special case for when motoring, motor is stopped and speed is zero. This goes directly to moored
  • 0.1.5 (2020-11-30)
    • Compatibility with the new setPluginStatus/setPluginError APIs in Signal K
  • 0.1.4 (2020-11-25)
    • Compatibility with the upcoming "meta deltas" feature in Signal K
  • 0.1.3 (2020-10-13)
    • Simplified dependency chain by only using the where library for location calculations at runtime
  • 0.1.2 (2020-04-17)
    • Switched status from not-under-way to moored
    • Switched status from under-engine to motoring
    • Added propulsion support
  • 0.1.1 (2020-01-31)
    • Fixed integration with Signal K
  • 0.1.0 (2020-01-31)
    • Initial release. Should work with anchor and position for a sailboat
    • No propulsion support implemented yet

About

Automatic state setting for Signal K vessels

Resources

Stars

Watchers

Forks

Packages

No packages published