esp8266-mqtt-projector-serial/README.md


Remote control the CCC Basel video projector via MQTT ( -> ESP8266 -> RS232 -> projector ).

This repo contains
* 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

### Building

Edit esp/src/main.cpp and set the configuration (WiFi credentials, MQTT broker & topic)!

For Sanyo Z4:

```
cd esp
pio run -e sanyoz4 -t upload --upload-port /dev/tty<X>
```

For Benq X3000i

```
cd esp
pio run -e benqx3000i -t upload --upload-port /dev/tty<X>
```

## PCB

![Screenshot of the PCB in PCBNew](screenshot.png)

### BOM

* ESP-01
* A MAX3232 + D-Sub 9 connector board
  * The adapter PCB is designed for [this specific MAX3232-Board from AliExpress][max3232]
* 1x 10k 0805 SMD Resistor
* 1x 2x2 2.54mm pin header
* 1x 2x4 2.54mm socket header
* 1x 1x4 2.54mm socket header
* 2x 2.54mm jumpers
* USB Micro-B socket
* SOT-223 3v3 voltage regulator


The USB socket footprint in this PCB is modified to use circular holes, because our PCB mill can't mill oval holes that small.  If your chosen USB socket has thru-hole legs wider than 1mm, you may want to replace the footprint with another one from KiCad's library.

### Assembly

1. The copper side (bottom) faces the MAX3232 board, with the 1x4 socket header plugged into the matching in header on the MAX3232 board.
1. The 2x4 socket header faces the other direction, this is where the ESP-01 is plugged into
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
Initial commit 2022-07-10 04:27:32 +02:00
Readme, screenshot, add missing footprint 2022-07-11 22:18:45 +02:00			`Remote control the CCC Basel video projector via MQTT ( -> ESP8266 -> RS232 -> projector ).`

			`This repo contains`
Clarify repo contents in readme 2022-07-11 22:22:30 +02:00			`* 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.`
Readme, screenshot, add missing footprint 2022-07-11 22:18:45 +02:00
Initial commit 2022-07-10 04:27:32 +02:00			`## ESP8266 Firmware`

			`### Building`

			`Edit esp/src/main.cpp and set the configuration (WiFi credentials, MQTT broker & topic)!`

			`For Sanyo Z4:`

			```
			`cd esp`
Readme, screenshot, add missing footprint 2022-07-11 22:18:45 +02:00			`pio run -e sanyoz4 -t upload --upload-port /dev/tty<X>`
Initial commit 2022-07-10 04:27:32 +02:00			```

			`For Benq X3000i`

			```
			`cd esp`
Readme, screenshot, add missing footprint 2022-07-11 22:18:45 +02:00			`pio run -e benqx3000i -t upload --upload-port /dev/tty<X>`
Initial commit 2022-07-10 04:27:32 +02:00			```

			`## PCB`

Readme, screenshot, add missing footprint 2022-07-11 22:18:45 +02:00			`![Screenshot of the PCB in PCBNew](screenshot.png)`

			`### BOM`

Initial commit 2022-07-10 04:27:32 +02:00			`* ESP-01`
Readme, screenshot, add missing footprint 2022-07-11 22:18:45 +02:00			`* A MAX3232 + D-Sub 9 connector board`
			`* The adapter PCB is designed for [this specific MAX3232-Board from AliExpress][max3232]`
Initial commit 2022-07-10 04:27:32 +02:00			`* 1x 10k 0805 SMD Resistor`
			`* 1x 2x2 2.54mm pin header`
			`* 1x 2x4 2.54mm socket header`
			`* 1x 1x4 2.54mm socket header`
Readme, screenshot, add missing footprint 2022-07-11 22:18:45 +02:00			`* 2x 2.54mm jumpers`
Initial commit 2022-07-10 04:27:32 +02:00			`* USB Micro-B socket`
			`* SOT-223 3v3 voltage regulator`

Add footprint note 2022-07-11 22:26:29 +02:00

			`The USB socket footprint in this PCB is modified to use circular holes, because our PCB mill can't mill oval holes that small. If your chosen USB socket has thru-hole legs wider than 1mm, you may want to replace the footprint with another one from KiCad's library.`

Readme, screenshot, add missing footprint 2022-07-11 22:18:45 +02:00			`### Assembly`

			`1. The copper side (bottom) faces the MAX3232 board, with the 1x4 socket header plugged into the matching in header on the MAX3232 board.`
			`1. The 2x4 socket header faces the other direction, this is where the ESP-01 is plugged into`
			`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.`

Clarify repo contents in readme 2022-07-11 22:22:30 +02:00			`[pio]: https://platformio.org/`
			`[kicad]: https://www.kicad.org/`
Initial commit 2022-07-10 04:27:32 +02:00			`[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`