Clarify repo contents in readme

This commit is contained in:
s3lph 2022-07-11 22:22:30 +02:00
parent 1d57c60875
commit e2e85eb291
Signed by: s3lph
GPG key ID: 8AC98A811E5BEFF5

View file

@ -2,8 +2,8 @@
Remote control the CCC Basel video projector via MQTT ( -> ESP8266 -> RS232 -> projector ).
This repo contains
* An ESP8266 firmware which connects to an MQTT server and subscribes to certain command topics
* An adapter and power supply PCB which connects an ESP-01 to a MAX3232 board and provides power to both from a USB Micro-B socket.
* A [PlatformIO][pio] project for an ESP8266 firmware which connects to an MQTT server and subscribes to certain command topics
* A [KiCad][kicad] project for an adapter and power supply PCB which connects an ESP-01 to a MAX3232 board and provides power to both from a USB Micro-B socket.
## ESP8266 Firmware
@ -49,4 +49,6 @@ pio run -e benqx3000i -t upload --upload-port /dev/tty<X>
1. The 2x2 in header can face either direction (if facing down, check beforehand whether there's enough space to the MAX3232 board
1. The jumpers go next to each other on the 2x2 pin header. Depending on their orientation, Rx and Tx can be swapped if necessary.
[pio]: https://platformio.org/
[kicad]: https://www.kicad.org/
[max3232]: https://de.aliexpress.com/item/1005001548466845.html?spm=a2g0o.productlist.0.0.29142932HtTivS&algo_pvid=37640f61-ffd9-40fb-b468-f261709c162b&algo_exp_id=37640f61-ffd9-40fb-b468-f261709c162b-1&pdp_ext_f=%7B%22sku_id%22%3A%2212000016543520800%22%7D&pdp_npi=2%40dis%21CHF%21%210.41%21%21%21%21%21%402101d8b516564877891056410e1251%2112000016543520800%21sea