Code Monkey home page Code Monkey logo

signalkinterface's Introduction

signalkinterface

Basic support for Node-Red to read/send data to/from signalK servers.

These nodes do not need to be run in an embedded Node-Red in SignalK. They can connect to both remove and local SignalK servers like a normal SignalK client. This was made in mind for Victron systems having separate SignalK and Node-Red servers and you only need to read SignalK data and update via PUT.

The nodes uses a basic web-socket (which the user needs to deploy), but provides support to subscribe to SignalK paths as well as to autenticate to the SignalK server. Authentication is needed if the user wants to change data in SignalK via PUT-messages. Do note that these modules can't update any SignalK value, only values with a PUT handler associated with them (such as electrical switches).

The modules also provides a "flattening" node which takes SignalK JSON data and make it into Java Script objects to be used in other nodes. The node also separates deltas containing many values into multiple messages. Flattened messages will have the SignalK path as msg.topic and the SignalK value as msg.payload. Other SignalK data will also be present in the message like timestamp.

Installation/Use

  1. Add a websocket in to your flow
    • For properties use
      • URL ws://[hostname]:[port]/signalk/v1/stream?subscribe=none (ws://localhost:3000/signalk/v1/stream?subscribe=none)
      • Subprotocol:
      • Send/Receive: payload
  2. Add a websocket out using the same configuration as above
  3. Create a signalkhelper and connect the websocket in to the in-port and the 'control'-out port to the websocket out node. This will pass controll messages back to the web-socket.
  4. Create a signalkflattener and connect it after the signalkhelper on the delta port

If you want to PUT values to Signal K, use the signalkputhelper and connect the output to the websocket out node.
[Picture of example - TBD]

signalkinterface's People

Contributors

crankydad avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.