diff --git a/README.md b/README.md index 19bfa9fdb9e34890ae4bb132b451ff7452998124..db1f3b4f3309c2a43e057545c57fa0885a772f77 100644 --- a/README.md +++ b/README.md @@ -30,14 +30,28 @@ A Json description of the messages is also available. ### Arduino -Load the LocaPack library and start with one of the examples: +LocaPack is available as an Arduino library, to produce or decode locapack messages. + +#### Installation + +1. Clone the LocaPack project, +1. Copy the `Arduino/LocaPack` directory into the libraries directory (typically `~/Arduino/libraries`) +1. Launch Arduino IDE and start with one of the examples. - tinygpsplus.ino: Make universal GNSS pakets with data from a hardware GPS receiver connected to the `Serial1` port ### Node-RED +LocaPack is available as a Node-RED Palette, ie a collection of nodes to produce or decode locapack messages. +  +#### Installation + +1. Clone the LocaPack project, +1. In your Node-RED user directory, typically ~/.node-red, run: `npm install <location of node module>` where location is the path to the `nodered` folder of the git cloned repository. +1. Restart Node-RED. + ### JSON messages LocaPack messages are also available in JSON. Example of a Universal GNSS localisation packet: