Best Practices for Plugins doing an action?

[hoeken]

I've been using SignalK for a while and love it. Mostly I have just been gathering data and displaying it nicely.

I'd like to step things up to the next level and have SignalK start automating some things for me. My plan for the first project is to extend the signalk-spectra-plugin to allow it to start and stop the watermaker. Right now the plugin just reads the data from the watermaker.

Ideally, I'd like to be able to use node-red to stop the watermaker when the tank hits a certain % threshold.

Is there a standard way of going about this? Maybe another plugin that has done it well in the past? Seems like from the docs it should be a PUT request with the path and new state. I can set it up in node red to send a PUT request when the water tank gets to a certain level. Then in the plugin, maybe watch a path like watermaker.spectra.run_state and turn it on/off depending on the value?

[sbender9]

Yes. PUT is the correct way to do it.

See https://github.com/SignalK/signalk-server/blob/master/SERVERPLUGINS.md#appregisterputhandlercontext-path-callback-source