For a while, I wanted to create my own smart light. It's not a new concept, many similar repositories are already out there. But I couldn't find a firmware that also provides security and deployment.
I know, this is kind of free advertisement, but if you really want to know on what board I was developing: https://www.electrodragon.com/product/wifi-iot-relay-board-based-esp8266/
Clone this repo:
git clone --recurse-submodules https://github.com/ThomasDevoogdt/SmartHue.git
cd SmartHue
Have a look at the well-documentated page of platformio:
https://docs.platformio.org/en/latest/installation.html
The installation can be checked with pio --version.
$ pio --version
PlatformIO, version 3.6.3Probably, You'll also need to change the ota_ap_pass in the platformio.ini file.
{
"security": {
"soft_ap_pass": "4jBqXvQuEx7TBWfC",
"ota_ap_pass": "QLZWyG9Q9JNmth9t",
"www_user": "admin",
"www_pass": "a2XEnxmsq7zm2B9P"
}
}platformio run --target uploadOf course, its possible to manually upgrade every device with the platformio cli, but the preferred way is the usage of the deployment module.
How to manually upgrade: https://docs.platformio.org/en/latest/platforms/espressif8266.html#over-the-air-ota-update
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt{
"devices": {
"deploy": [
"SmartHue-12345a",
"SmartHue-12345c",
"SmartHue-12345d"
]
}
}python deployer.py -d devices.jsonSuper, you've now managed to upload the firmware to the esp8266. The esp8266 will boot and create a WiFi hotspot. The SSID is equal than the hostname of the device. Write it down, maybe you'll need it for an OTA update. Now you can test the device by calling https://10.0.1.1/api/systeminfo.
For security reasons, the AP/hotspot disables itself after 10 minutes. A power cycle is needed to re-enable the AP.
Note that everything goes over https. The certificates can be found under src/secure/ssl.h. Accept them in your browser, or add them to your system trusted certificates. It's also a good thing to replace them with your own certificates.
- base url:
- AP ip address (Only while serving AP): https://10.0.1.1/
- Over mDNS.local (Always up!): https://SmartHue-12345a.local/
- www_user:
admin - www_pass:
a2XEnxmsq7zm2B9P
no authentification needed
response: json body
response: plain text: ok
no authentification needed
response: json body
response/body: json body
{
"wifi": {
"ssid": "SSID",
"pass": "PASS"
},
"syslog": {
"ip": "SYSLOG-IP"
}
}The syslog key is optional.
Only needed to apply changes after /api/config
response: plain text: ok
Reset the current config to its default settings.
response: plain text: ok
no authentification needed
response: json body
{
"relay": 1,
"value": true
}body: json body
{
"relay": 1,
"value": true
}response: plain text: ok
no authentification needed
response: json body
{
"ota": "success/Auth Failed/Begin Failed/Connect Failed/Receive Failed/End Failed"
}I'm not a juridical expert but please, be compliant with the license. If you like the project or write about it, please mention it. A simple link to this repo is enough.