Skip to content

Commit

Permalink
merge from dev
Browse files Browse the repository at this point in the history
  • Loading branch information
someweisguy committed Sep 20, 2021
2 parents daec1fc + 6b86dc7 commit b0b9162
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Clone this repository into your project's `components` folder. The library can b

## Quick-Start Guide

This library was written to look similar to the ESP-IDF UART implementation. To get started, call the following code in `app_main()` in your `main.c` file.
This library was written to look similar to the ESP-IDF UART implementation. To get started, call the following code in your `setup()` function if using Arduino, or `app_main()` in your `main.c` file if using ESP-IDF.

```cpp
const dmx_port_t dmx_num = DMX_NUM_2;
Expand Down Expand Up @@ -223,7 +223,7 @@ The timing tool installs an edge-triggered interrupt on the specified GPIO pin.

A quirk of the default ESP-IDF GPIO ISR is that lower GPIO numbers are processed earlier than higher GPIO numbers. It is recommended that the DMX RX pin be shorted to a lower GPIO number in order to ensure that the DMX timing tool can run with low latency.

It is important to note that the timing tool requires a fast clock speed in order to maintain low latency. In order to guarantee accuracy of the timing tool, the ESP32 must be set to a CPU clock speed of at least 160MHz. This setting can be configured in `sdkconfig`.
It is important to note that the timing tool requires a fast clock speed in order to maintain low latency. In order to guarantee accuracy of the timing tool, the ESP32 must be set to a CPU clock speed of at least 160MHz. This setting can be configured in `sdkconfig` if the ESP-IDF is used.

Before enabling the timing analysis tool `gpio_install_isr_service()` must be called.

Expand Down
2 changes: 1 addition & 1 deletion examples/DMXWrite/DMXWrite.ino
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
DMX Wr9te
DMX Write
This sketch allows you to write DMX to a DMX listener using a standard DMX
shield, such SparkFun ESP32 Thing Plus DMX to LED Shield.
Expand Down
24 changes: 24 additions & 0 deletions library.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"name": "esp_dmx",
"version": "1.1.1",
"description": "Transmit and receive DMX using an ESP32.",
"keywords": "esp32, espressif32, DMX, DMX512, DMX512-A, lighting, theater, theatre, esp_dmx",
"repository":
{
"type": "git",
"url": "https://github.com/someweisguy/esp_dmx"
},
"authors":
[
{
"name": "Mitch Weisbrod",
"email": "mitch@theweisbrods.com",
"url": "https://github.com/someweisguy/esp_dmx",
"maintainer": true
}
],
"license": "MIT",
"homepage": "https://github.com/someweisguy/esp_dmx",
"frameworks": "arduino, espidf",
"platforms": "espressif32"
}
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=esp_dmx
version=1.1.0
version=1.1.1
author=Mitch Weisbrod <mitch@theweisbrods.com>
maintainer=Mitch Weisbrod <mitch@theweisbrods.com>
sentence=Transmit and receive DMX using an ESP32.
Expand Down

0 comments on commit b0b9162

Please sign in to comment.