59 lines
1.9 KiB
Markdown
59 lines
1.9 KiB
Markdown
# ESP Wordclock
|
|
## Setup
|
|
|
|
### Initial Setup
|
|
Install the firmware on the ESP:
|
|
The ESP must be set into the bootloader mode, like [this](https://www.ccc-mannheim.de/wiki/ESP8266#Boot_Modi)
|
|
|
|
The firmware can be downloaded with the following script:
|
|
<pre>
|
|
cd os/
|
|
./flash.sh ttyUSB0
|
|
</pre>
|
|
|
|
Connect to the ESP via a terminal emulator like screen using a baud rate of 115200. Then format the filesystem and reboot the ESP with the following commands:
|
|
<pre>
|
|
file.format()
|
|
node.restart()
|
|
</pre>
|
|
|
|
Then disconnect the serial terminal and copy the required files to the microcontroller:
|
|
<pre>
|
|
./tools/initialFlash.sh /dev/ttyUSB0
|
|
</pre>
|
|
|
|
### Upgrade
|
|
|
|
Determine the IP address of your clock and execute the following script:
|
|
<pre>
|
|
./tools/remoteFlash.sh IP-Address
|
|
</pre>
|
|
|
|
## Hardware Setup
|
|
* GPIO2 LEDs
|
|
* GPIO0 Bootloader (at start)
|
|
* GPIO0 factory reset (long during operation)
|
|
|
|
## MQTT Interface
|
|
* **basetopic**/cmd/single
|
|
** ON Set brightness to 100%
|
|
** OFF Set brightness to 0%
|
|
** 0-100 Set brightness to given value
|
|
** #rrggbb Bacground color is set to hex representation of red, green and blue
|
|
** 0-255,0-255,0-255 Background color is set to decimal representation of red, green an blue
|
|
* **basetopic**/cmd/telnet
|
|
** ignored Stop MQTT server and start telnetserver at port 23
|
|
|
|
## OpenHAB2
|
|
Tested MQTT with binding-mqtt 2.5.x
|
|
### Configuration
|
|
```
|
|
Thing mqtt:topic:wordclock "Wordclock" (mqtt:broker) @ "MQTT" {
|
|
Channels:
|
|
Type dimmer : dim "Dimming" [ stateTopic="basetopic/brightness", commandTopic="basetopic/cmd/single" ]
|
|
Type string : cmd "Command" [ commandTopic="basetopic/cmd/single" ]
|
|
Type switch : active "Active" [ commandTopic="basetopic/cmd/single" ]
|
|
Type colorRGB : background "Background" [ stateTopic="basetopic/background", commandTopic="basetopic/cmd/single", on="28,0,0", off="0,0,0" ]
|
|
}
|
|
```
|