Wordclock/Readme.md

46 lines
1.4 KiB
Markdown
Raw Normal View History

2016-04-12 18:24:21 +02:00
# ESP Wordclock
## Setup
2019-04-18 16:32:35 +02:00
### 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>
2019-07-26 21:33:48 +02:00
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()
2019-07-26 21:33:48 +02:00
node.restart()
</pre>
Then disconnect the serial terminal and copy the required files to the microcontroller:
<pre>
./tools/initialFlash.sh /dev/ttyUSB0
</pre>
2019-04-18 16:32:35 +02:00
### Upgrade
Determine the IP address of your clock and execute the following script:
<pre>
./tools/remoteFlash.sh IP-Address
</pre>
2021-01-15 18:39:23 +01:00
## Hardware Setup
* GPIO2 LEDs
2021-01-15 18:39:23 +01:00
* GPIO0 Bootloader (at start)
* GPIO0 factory reset (long during operation)
## MQTT Interface
* **basetopic**/command
** 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