HomieRoomSensor/host
Ollo b2db51d9a9 Spelling improved 2021-12-06 20:18:23 +01:00
..
Readme.md Spelling improved 2021-12-06 20:18:23 +01:00
ota_updater.py Initial version 2021-11-15 19:03:27 +01:00
spelling.sh Spelling improved 2021-12-06 20:18:23 +01:00
upload-via-mqtt.sh Initial version 2021-11-15 19:03:27 +01:00

Readme.md

Configuration

File

Generate a file as, described in http://homieiot.github.io/homie-esp8266/docs/develop-v3/configuration/json-configuration-file/

Upload

  • Start ESP
  • Login to Wifi, opened by the ESP
  • Use the script to upload the configuration file
  • restart the ESP

Remote Upload

This script will allow you to send an OTA update to your device: upload-via-mqtt.sh

Installation

Requirements are:

  • paho-mqtt

Usage of underlying tool

The python script can be used, manually, too:

usage: ota_updater.py [-h] -l BROKER_HOST -p BROKER_PORT [-u BROKER_USERNAME]
                      [-d BROKER_PASSWORD] [-t BASE_TOPIC] -i DEVICE_ID
                      firmware

ota firmware update script for ESP8226 implementation of the Homie mqtt IoT
convention.

positional arguments:
  firmware              path to the firmware to be sent to the device

arguments:
  -h, --help            show this help message and exit
  -l BROKER_HOST, --broker-host BROKER_HOST
                        host name or ip address of the mqtt broker
  -p BROKER_PORT, --broker-port BROKER_PORT
                        port of the mqtt broker
  -u BROKER_USERNAME, --broker-username BROKER_USERNAME
                        username used to authenticate with the mqtt broker
  -d BROKER_PASSWORD, --broker-password BROKER_PASSWORD
                        password used to authenticate with the mqtt broker
  -t BASE_TOPIC, --base-topic BASE_TOPIC
                        base topic of the homie devices on the broker
  -i DEVICE_ID, --device-id DEVICE_ID
                        homie device id
  • BROKER_HOST and BROKER_PORT defaults to 127.0.0.1 and 1883 respectively if not set.
  • BROKER_USERNAME and BROKER_PASSWORD are optional.
  • BASE_TOPIC has to end with a slash, defaults to homie/ if not set.

Example:

python ota_updater.py -l localhost -u admin -d secure -t "homie/" -i "device-id" /path/to/firmware.bin

Source

https://github.com/homieiot/homie-esp8266/blob/develop/scripts/ota_updater