commit 9abad41614ac07781e800db5eec0ca67164d8087
parent 1eee37beb9e2f05b84d59c0a8bf93fe989e9e17f
Author: Martin Kloeckner <mjkloeckner@gmail.com>
Date: Sat, 11 Apr 2026 22:08:15 -0300
Update `README.md` and add `LICENSE` file
Diffstat:
4 files changed, 41 insertions(+), 16 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,7 @@
+Copyright 2026 Martin Klöckner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,18 +1,36 @@
+# ESP-01S Serial Remote Controller
+
+This repository contains custom firmware for the ESP-01S that runs a web server,
+which hosts a webpage. This webpage allows users to toggle values on a separate
+microcontroller that connects via UART.
+
+<div style="text-align: center;">
+ <img src="img/esp01s.jpg" style="padding: 10px;" width="35%">
+ <img src="img/esp01s-pinout.jpg" style="padding: 10px;" width="50%">
+ <p align="center"><em>ESP-01S Module </em></p>
+</div>
+
+## Flashing
+
+The firmware has been developed using PlatformIO and the Arduino framework. To
+flash the firmware, connect the ESP module to a computer using a UART to USB
+adapter. The ESP must be in programming mode, this is achived by holding
+GPIO0 low during MCU initilization. Once the ESP is ready, flash the firmware
+using PlatformIO console tools.
+
+First flash the main firmware.
+
```console
-$ esptool -p /dev/ttyACM0 flash-id
-Connected to ESP8266 on /dev/ttyACM0:
-Chip type: ESP8266EX
-Features: Wi-Fi, 160MHz
-Crystal frequency: 26MHz
-MAC: ec:64:c9:e7:bb:f8
-
-Stub flasher running.
-
-Flash Memory Information:
-=========================
-Manufacturer: 68
-Device: 4016
-Detected flash size: 4MB
-
-Hard resetting via RTS pin...
+$ pio run -t upload
```
+
+Finally upload the files to the LittleFS filesystem.
+
+```console
+$ pio run -t uploadfs
+```
+
+## LICENSE
+
+This software is licensed under the MIT License. See the [LICENSE](./LICENSE)
+file for details.
diff --git a/img/esp01s-pinout.jpg b/img/esp01s-pinout.jpg
Binary files differ.
diff --git a/img/esp01s.jpg b/img/esp01s.jpg
Binary files differ.
