jiang/esphome-dmx512
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify README regarding the uart_num parameter

Browse Source
This commit is contained in:
Andreas Böhler
2025-10-21 16:33:56 +02:00
parent 4f4cfb54aa
commit 9e0b48d31f
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -11,11 +11,12 @@ The implementation is based on other projects:
* https://github.com/cupertinomiranda/esphome
* https://github.com/jakosek/esphome/tree/dmx_no_uart
It differs in that it uses the internal UART component but generates the break signal by detaching and re-attaching the GPIO pin (on ESP32).
In contast to the other implementation, this uses the internal UART component and generates the break signal by detaching and re-attaching the GPIO pin (on ESP32).
## Important notes
DMX only works on hardware UARTs, therefore the number of the UART in use needs to be set. This defaults to 1, as the first UART is usually used for logging purposes.
DMX only works on hardware UARTs, therefore the internal number of the UART in use needs to be known. Currently, there is no way for a component to retrieve the internal UART number in use. This parameter `uart_num` defaults to 1, as the first UART is usually used for logging purposes.
The UART number is automatically assigned by ESPHome, based on the number of configured UARTs. It has no correspondence with the pins in use.
On the ESP8266, the only pin you can use is GPIO2. It's TX-only and can easily be used for DMX.
@@ -42,7 +43,7 @@ dmx512:
* `uart_id`: Set this to the ID of your UART component
* `enable_pin`: Set this to the pin number the MAX585 enable pins are connected to. Optional
* `tx_pin`: Set this to the same pin number as the UART component. This is required for the generation of the break signal. Defaults to GPIO5. If ESPHome >= 2023.12.0 is used, the option `allow_other_uses` has to be set to `true` (here and in the UART component).
* `uart_num`: Set this to the internal ESP32 UART number. If only logging is configured, this should be set to 1 (default). (Note some ESP32 boards don't have 3 UARTs, check the datasheet of your board if using a different one.)
* `uart_num`: Set this to the internal ESP32 UART number (see important notes above). If only logging is configured, this should be set to 1 (default).
* `periodic_update`: If set to false, only state changes are transmitted and the bus is silent in between - violates the specification and may cause some dimmers to turn off
* `force_full_frames`: If set to true, the full 513-byte frame is always sent. Otherwise, only the configured channels are transmitted.
* `custom_mab_len`: Set a custom mark-after-break length (in uS, default 12)