https://github.com/datavenueliveobjects/start-here-nodejs
Live Objects Client code samples for the MQTT protocol, written in JavaScript for node.js
https://github.com/datavenueliveobjects/start-here-nodejs
Last synced: 14 days ago
JSON representation
Live Objects Client code samples for the MQTT protocol, written in JavaScript for node.js
- Host: GitHub
- URL: https://github.com/datavenueliveobjects/start-here-nodejs
- Owner: DatavenueLiveObjects
- License: bsd-3-clause
- Created: 2020-03-03T09:47:07.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-11T00:04:38.000Z (over 1 year ago)
- Last Synced: 2025-05-07T14:23:08.671Z (14 days ago)
- Homepage: https://liveobjects.orange-business.com
- Size: 107 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Live Objects MQTT Client
[](https://github.com/DatavenueLiveObjects/Start-here-nodeJS/actions/workflows/audit.yml)
[](https://github-tools.github.io/github-release-notes/)
This project includes **Live Objects Client code samples for the MQTT protocol**.
- LiveObjects [official help](https://liveobjects.orange-business.com/#/cms/documentation-faq) includes [a dev. guide mqtt section](https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html#MQTT_API)
- 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](./samples/lo-device/README.md) - 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](./samples/lo-application/README.md) - a mqtt client using `application mode`, this sample is able to listen
a given fifo.
Example:
````bash
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](https://liveobjects.orange-business.com/)
## Contribute
* cf [CONTRIBUTING](CONTRIBUTING.md)