-
Notifications
You must be signed in to change notification settings - Fork 638
Configuration
TODO
On normal boot (i.e. button not pressed) it will execute the firmware. It configures the hardware (button, LED, relay), the SPIFFS memory access, the WIFI, the WebServer and MQTT connection and whatever other enabled modules.
Obviously the default values for WIFI network and MQTT will probably not match your requirements. The device will start in Soft AP creating a WIFI SSID named "DEVICE_XXXXXX", where DEVICE will be an identifier of your device and XXXXXX are the last 3 bytes of the radio MAC.
Connect with phone, PC, laptop, whatever to that network, password is "fibonacci". Once connected browse to "http://192.168.4.1".
It will then present an authentication challenge. Default user and password are "admin" and "fibonacci" (again).
Then you will be presented a page to change this default password. The new password has to have a minimum of 8 characters (letters, numbers and _) including one number, one lower case and one uppercase. The same password is used for the WIFI Access Point, for the web interface and for the OTA firmware upload.
Once you change the password you will have to authenticate yourself again using now this new password and finally you will see the configuration page where you will be able to define different configuration parameters.
You can configure up to five WIFI networks. It will then try to connect to the configure WIFI networks in order of signal strength. If none of the defined networks succeed it will default to SoftAP mode again. You can also switch to SoftAP mode by double click the on-board button or reset the board long clicking it. It will stay in SoftAP mode for a minute before trying to reconnect.
Once connected to an access point the board will try to connect the MQTT server defined.
The device will publish the relay state to the given topic and it will subscribe to the same topic for remote switching. Don't worry, it avoids infinite loops.
You can also use "{identifier}" as place holder in the topic. It will be translated to your device ID (same as the soft AP network it creates).
If you're looking for support:
- Issues: this is the most dynamic channel at the moment, you might find an answer to your question by searching open or closed issues.
- Wiki pages: might not be as up-to-date as we all would like (hey, you can also contribute in the documentation!).
- Gitter channel: you have better chances to get fast answers from project contributors or other ESPurna users. (also available with any Matrix client!)
- Issue a question: as a last resort, you can open new question issue on GitHub. Just remember: the more info you provide the more chances you'll have to get an accurate answer.
- Backup the stock firmware
- Flash a pre-built binary image
- Flash a virgin Itead Sonoff device without opening
- Flash TUYA-based device without opening
- Flash Shelly device without opening
- Using PlatformIO
- from Visual Studio Code
- Using Arduino IDE
- Build the Web Interface
- Over-the-air updates
- Two-step updates
- ESPurna OTA Manager
- NoFUSS
- Troubleshooting
- MQTT
- REST API
- Domoticz
- Home Assistant
- InfluxDB
- Prometheus metrics
- Thingspeak
- Alexa
- Google Home
- Architecture
- 3rd Party Plugins
- Coding style
- Pull Requests