https://github.com/getlarge/arduino-device
Arduino library to interact with Aloes MQTT backend
https://github.com/getlarge/arduino-device
aloes arduino iot-application mqtt-client
Last synced: about 1 year ago
JSON representation
Arduino library to interact with Aloes MQTT backend
- Host: GitHub
- URL: https://github.com/getlarge/arduino-device
- Owner: getlarge
- Created: 2019-05-17T11:20:41.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-04-28T18:05:52.000Z (about 6 years ago)
- Last Synced: 2025-02-14T06:51:21.628Z (over 1 year ago)
- Topics: aloes, arduino, iot-application, mqtt-client
- Language: C++
- Homepage:
- Size: 107 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Aloes Device - Arduino
ESP8266 | ESP32 Arduino library to interact with [Aloes backend](https://framagit.org/aloes/device-manager) MQTT and HTTP API.
## Requirements
### Arduino tools
Arduino IDE - download the latest from arduino
- https://www.arduino.cc/en/Main/Software
Or Arduino CLI - download the latest from arduino
- https://github.com/arduino/arduino-cli
### For ESP8266
Packages for ESP8266 on Arduino
- Enter `http://arduino.esp8266.com/stable/package_esp8266com_index.json` into Additional Board Manager URLs field.
Packages to upload data on ESP8266 FileSystem
- Follow instructions on `https://github.com/esp8266/arduino-esp8266fs-plugin` to install the plugin in your Arduino IDE.
### For ESP32
Packages for ESP32 on Arduino
- Enter `https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json` into Additional Board Manager URLs field.
Packages to upload data on ESP32 FileSystem
- Follow instructions on `https://github.com/me-no-dev/arduino-esp32fs-plugin` to install the plugin in your Arduino IDE.
### Dependencies
Requires the next libraries :
-
-
-
-
-
-
- on ESP8266 :
-
-
-
- on ESP32 :
-
-
-
-
Starting from Arduino IDE 1.8.10, dependencies can be automatically installed.
Starting from arduino-cli 0.7.0, dependencies can be automatically installed with `arduino-cli lib install`
## Installation
- Via git, clone into your `~/Arduino/Libraries` folder
```bash
git clone https://framagit.org/aloes/arduino-device.git
```
- Via Arduino Library Manager, look for AloesDevice
## Library usage
- Create the directory `data` at the root of your Arduino project
- Create the file `./data/sensors.json` following [Open Mobile Alliance LwM2M Registry](http://openmobilealliance.org/wp/OMNA/LwM2M/LwM2MRegistry.html) and [Aloes](https://aloes.io/about?tab=docs) ( see examples )
- Open any .ino file of the project folder with Arduino IDE
- Upload `sensors.json` on your ESP** board
- Edit your preferences in `config.h`, at the root of your Arduino project
- Enter wifi and device credentials or configure the board via the Access Point ( 192.168.244.1 )
- Upload the code on your ESP** board
- If the device is not registerd on your Aloes account, copy the `DevEUI` ( generated at setup on the serial interface ) to create one on Aloes backend
- Configure Aloes credentials and servers configuration in `config.h` to connect to Aloes backend
- You can use examples as a base for your project