diff --git a/README.md b/README.md index bbd4b64..f592f04 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,40 @@ # DMX-Interface -Art-Net-Interface +> _Art-Net interface for controlling DMX devices via WiFi or Ethernet._ -## Case +--- -All print files (STL, STEP, X_T) can be found in [assets/case](/assets/case/). Alternatively you can view the project on [OnShape](https://cad.onshape.com/documents/7363818fd18bf0cbf094790e/w/52455282b39e47fbde5d0e53/e/9bec98aa83a813dc9a4d6ab2) where you can export the files in a format you like. +## ๐Ÿ›’ Parts -![Prusa Slicer with case loaded](/assets/case/Screenshot.png) +| Count | Part | +| ----- | ------------- | +| 1x | ESP32 | +| 2x | RS485 | +| 1x | W5500-ETH | +| 1x | LED-Button | +| 1x | โ™‚๏ธ-DMX-socket | +| 1x | โ™€๏ธ-DMX-socket | -## Wiring +> Additionally you need: `some wires`, `soldering equipment`, `3D-printer`, `small screws`, `shrink tubing`, `hot glue gun` + +--- + +## ๐Ÿ“ฑ Implemented microcontrollers + +- [x] Lolin S2 mini +- [ ] ESP 32 WROOM +- [ ] ESP 32 C3 + +> For other microcontrollers you may need to adjust the `platformio.ini` + +--- + +## ๐Ÿ”Œ Wiring + +You have to short-circuit `R0` on the RS485 boards to enable the termination resistor required for DMX before the first and after the last device in line. ![Circuit diagram](/assets/circuit/diagram.svg) -You have to short-circuit R0 on the RS485 boards to enable the termination resistor required for DMX before the first and after the last device in line. - -## Pin usage - | GPIO | Usage | | ---- | -------------- | | GND | GND to others | @@ -33,3 +52,66 @@ You have to short-circuit R0 on the RS485 boards to enable the termination resis | 35 | SPI MOS | | 36 | SPI SCK | | 37 | SPI MISO | + +--- + +## ๐Ÿš€ Installation + +1. make sure you have [PlatformIO](https://platformio.org/) installed +2. open the project folder in PlatformIO +3. click `Upload Filesystem Image` +4. click `Upload and Monitor` +5. ๐Ÿ you are done ๐ŸŽ‰ + +--- + +## ๐Ÿ“ฆ Case + +All print files (STL, STEP, X_T) can be found in [assets/case](/assets/case/). Alternatively you can view the project on [OnShape](https://cad.onshape.com/documents/7363818fd18bf0cbf094790e/w/52455282b39e47fbde5d0e53/e/9bec98aa83a813dc9a4d6ab2) where you can export the files in a format you like. + +![Prusa Slicer with case loaded](/assets/case/Screenshot.png) + +--- + +## ๐Ÿ’ก Status LED + +| LED | Description | +| --------------------------------- | ------------------------- | +| ![off](/assets/led/off.gif) | no power; LED deactivated | +| ![static](/assets/led/static.gif) | powered on; normal | +| ![slow](/assets/led/slow.gif) | startup; warning | +| ![fast](/assets/led/fast.gif) | resetting; error | + +--- + +## โš™๏ธ Default config + +To reset the settings, hold down the button and connect the ESP to the power supply. As soon as the LED flashes quickly, the settings are reset. + +| Setting | Value | +| -------------- | ------------------ | +| TYPE | WiFi AP | +| SSID | ChaosDMX-โ–กโ–กโ–กโ–ก | +| PASSWORD | mbgmbgmbg | +| IP-Address | 192.168.4.1 | +| DMX1 (Left) | OUTPUT; Universe 1 | +| DMX2 (Right) | INPUT; Universe 2 | +| LED Brightness | 10 % | + +--- + +## ๐Ÿค Contributing + +Contributions, issues and feature requests are welcome!
Feel free to check the [issues page](https://github.com/HendrikRauh/dmx-interface/issues). + +--- + +## ๐Ÿ‘ฅ Authors + +### [@HendrikRauh](https://github.com/HendrikRauh) + +### [@RaffaelW](https://github.com/RaffaelW) + +### [@psxde](https://github.com/psxde) + +[Chaostreff Backnang](https://chaostreff-backnang.de/) diff --git a/assets/led/fast.gif b/assets/led/fast.gif new file mode 100644 index 0000000..d4e6c58 Binary files /dev/null and b/assets/led/fast.gif differ diff --git a/assets/led/off.gif b/assets/led/off.gif new file mode 100644 index 0000000..c60e0b3 Binary files /dev/null and b/assets/led/off.gif differ diff --git a/assets/led/slow.gif b/assets/led/slow.gif new file mode 100644 index 0000000..23536c6 Binary files /dev/null and b/assets/led/slow.gif differ diff --git a/assets/led/static.gif b/assets/led/static.gif new file mode 100644 index 0000000..fd2bb77 Binary files /dev/null and b/assets/led/static.gif differ