DatavenueLiveObjects/Start-here-nodeJS

Live Objects Client code samples for the MQTT protocol, written in JavaScript for node.js

Live Objects MQTT Client

This project includes Live Objects Client code samples for the MQTT protocol.

• LiveObjects official help includes a dev. guide mqtt section
• Samples are written in JavaScript for node.js.
• Samples require minimal common environment described in "Quick start" below.

Quick start

Download

Clone this repository from GitHub:

$ git clone https://github.com/DatavenueLiveObjects/Start-here-nodeJS

Prerequisites

1. Install NodeJs (https://nodejs.org/en/download/)
2. Install samples dependencies (from package.json, example, https://github.com/mqttjs/MQTT.js)

   npm install

Setup your own private environment

• copy the template in a private file

cp initEnv.template.sh initEnv.dontpush.sh

• edit initEnv.dontpush.sh
• source it

. ./initEnv.dontpush.sh

Start using samples

Go to sample dedicated documentation.

The samples are:

• lo-device - a mqtt client using device mode, this sample is able to connect, receive command, receive firmware updates and config. This device can send data messages too.
• lo-application - a mqtt client using application mode, this sample is able to listen a given fifo.

Example:

source ./initEnvLO.dontpush.sh
node samples/lo-device/lo-device.js

License

Copyright (c) 2015 — 2023 Orange

This code is released under the BSD3 license. See the LICENSE file for more information.

Contact

• Homepage: liveobjects.orange-business.com

Contribute

• cf CONTRIBUTING