From e7b039dee3fec147d93ae476f1a883571d390628 Mon Sep 17 00:00:00 2001 From: Mitch Weisbrod Date: Mon, 13 Sep 2021 21:48:28 -0700 Subject: [PATCH 1/5] add platformIO manifest --- library.json | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 library.json diff --git a/library.json b/library.json new file mode 100644 index 000000000..829b6f99d --- /dev/null +++ b/library.json @@ -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" + } \ No newline at end of file From 7c66b00dd6fd9dd962dbcd7365dd2eae024000c2 Mon Sep 17 00:00:00 2001 From: Mitch Weisbrod Date: Mon, 13 Sep 2021 21:54:29 -0700 Subject: [PATCH 2/5] typos --- examples/DMXWrite/DMXWrite.ino | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/DMXWrite/DMXWrite.ino b/examples/DMXWrite/DMXWrite.ino index ae92bcd7e..adf699796 100644 --- a/examples/DMXWrite/DMXWrite.ino +++ b/examples/DMXWrite/DMXWrite.ino @@ -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. From 52e52a81638703ce0e8505a25a130ee446846de7 Mon Sep 17 00:00:00 2001 From: Mitch Weisbrod Date: Mon, 13 Sep 2021 22:03:24 -0700 Subject: [PATCH 3/5] indentation --- library.json | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/library.json b/library.json index 829b6f99d..a5c996fef 100644 --- a/library.json +++ b/library.json @@ -1,24 +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": + "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": + [ { - "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" - } \ No newline at end of file + "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" +} \ No newline at end of file From d5fa7ad8690d9f3d9773346165188306be9ee693 Mon Sep 17 00:00:00 2001 From: Mitch Weisbrod Date: Sun, 19 Sep 2021 17:46:25 -0700 Subject: [PATCH 4/5] clarify Arduino instructions --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5279c46bb..301b8d87f 100644 --- a/README.md +++ b/README.md @@ -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; @@ -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. From 6b86dc786718e5b0318c48f0436a3c0e10c5bc6c Mon Sep 17 00:00:00 2001 From: Mitch Weisbrod Date: Sun, 19 Sep 2021 17:46:40 -0700 Subject: [PATCH 5/5] update version --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index fd5dfa5ad..939d370ea 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=esp_dmx -version=1.0.2 +version=1.1.1 author=Mitch Weisbrod maintainer=Mitch Weisbrod sentence=Transmit and receive DMX using an ESP32.