esp_dmx v4.1.0

What's Changed

• Fix ISO C++ cast by @someweisguy in #129
• Add RDM_PID_SENSOR_DEFINITION by @someweisguy in #130
• Add RDM_PID_DEVICE_MODEL_DESCRIPTION by @someweisguy in #132
• Add RDM_PID_RESET_DEVICE by @someweisguy in #133
• Add RDM_PID_LANGUAGE by @someweisguy in #134
• Add RDM_PID_DEVICE_HOURS by @someweisguy in #135
• Add RDM_PID_LAMP_HOURS by @someweisguy in #136
• allow disable SET device hours by @someweisguy in #137
• Unify advanced function names before release by @someweisguy in #138
• Fix sending RDM requests by @someweisguy in #141
• Fix personality description response by @someweisguy in #144
• Support for ESP-IDF v5.2 by @someweisguy in #148

Full Changelog: v4.0.1...v4.1.0

esp_dmx v4.0.1

This release is a patch for a few issues in the initial release of v4.0.0. It contains a breaking change for the rdm_send_request() function, which is an advanced, undocumented feature of the ABI. Documentation on these features will be coming soon.

What's Changed

• Fix Arduino Compilation Error by @someweisguy in #126
• Update rdm_send_request() by @someweisguy in #127

Full Changelog: v4.0.0...v4.0.1

esp_dmx v4.0.0

This release adds some more functionality to the RDM responder including RDM queues and RDM sensors as well as updated internal logic to better handle some edge cases of RDM. Because these edge cases (such as RDM queues and sub-devices) are so unusual, the ABI has been retooled to make the user experience easier. The goal is to remain on v4 for a while so that few, if any, breaking changes will need to be made for future updates.

Some future goals of v4 include:

• Unit tests to make sure that the code base is robust
• Parity between RDM responder and controller functions; right now there are far more RDM responder functions than controller functions
• Stronger documentation for advanced features, such as the custom RDM parameter ABI
• Support for sending and receiving RDM ACK overflow and timer messages
• Base support for more RDM parameters, both requests and responses
• Support for multiple sub-devices

Please reach out if there are any questions, comments, or concerns!

What's Changed

• Fix GPTimer error message spam by @someweisguy in #68
• Fix ESP32-C6 compatiblity by @someweisguy in #97
• add missing ISR_ATTR to methods called from isrs by @arneboe in #98
• Implemented personality and personality_description parameters by @arneboe in #92
• Add device label parameter by @arneboe in #93
• Add PARAMETER_DESCRIPTION and a way to define custom parameters by @arneboe in #100
• Update HAL files by @someweisguy in #106
• Add RDM queue by @someweisguy in #102
• Update File Structure by @someweisguy in #107
• Fix UART Logic by @someweisguy in #122
• Feature/rdm-response-function by @someweisguy in #123

Full Changelog: v3.1.0...v4.0.0

Basic RDM Responder Support is Here!

This version of esp_dmx bring basic support for RDM responders! The parameters which are supported include:

• Supported Parameters
• Discovery Unique Branch
• Discovery Mute
• Discovery Un-mute
• Device Info
• Software Version Label
• Identify Device
• DMX Start Address

Currently, the RDM responder does not support queuing messages, nor does it support ACK_OVERFLOW responses. Support for these features and more parameter support will be coming soon!

Because previous versions of esp_dmx were in beta, this release contains some breaking changes from previous versions. Moving forward, semantic versioning will be followed more closely (i.e., breaking changes will only occur between major versions).

What's Changed

• RDM Discovery Request and Request Updates by @someweisguy in #33
• split functions.h into .h. and .c by @arneboe in #35
• ESP-IDF v5 Support by @someweisguy in #36
• Fix UART Interrupts by @someweisguy in #41
• Fix DMX transmit by @someweisguy in #42
• Fix dmx_receive() block time and behavior by @someweisguy in #44
• PlatformIO v6.0 compatibility by @someweisguy in #46
• Add DMX Basics Documentation by @someweisguy in #48
• fix new size of expected dmx packet by @userbogd in #53
• allow gptimer to fail gracefully by @someweisguy in #54
• Allow enabling and disabling the driver by @someweisguy in #60
• Implement RDM responder by @someweisguy in #61
• Fix ESP32C3 driver error on Arduino and ESP-IDF v4 by @someweisguy in #69
• Update file structure for code readability. by @someweisguy in #70
• Add library version numbers. by @someweisguy in #71
• Add DMX/RDM device setting config by @someweisguy in #73
• Add NVS support by @someweisguy in #77
• HAL Optimization by @someweisguy in #80
• Do not increase parameter callback count when an existing callback is overwritten by @arneboe in #88
• fix: do not invoke user_cb for unknown rdm pids by @arneboe in #89
• Fix send/receive by @someweisguy in #91
• fix c6 build issues by @someweisguy in #94
• Implement RDM_PID_SUPPORTED_PARAMETERS by @arneboe in #90

New Contributors

• @arneboe made their first contribution in #35
• @userbogd made their first contribution in #53

Full Changelog: v1.1.4...v3.1.0

v3.0.3-beta

What's Changed

• Add DMX Basics Documentation by @someweisguy in #48
• fix new size of expected dmx packet by @userbogd in #53
• allow gptimer to fail gracefully by @someweisguy in #54
• Allow enabling and disabling the driver by @someweisguy in #60

New Contributors

• @userbogd made their first contribution in #53

Full Changelog: v3.0.2-beta...v3.0.3-beta

v3.0.2-beta

This release fixes compilations issues for those using ESP-IDF on PlatformIO.

v3.0.1-beta

What's Changed

• Split functions.h into .h. and .c by @arneboe in #35
• ESP-IDF v5 Support by @someweisguy in #36
• Fix UART Interrupts by @someweisguy in #41
• Fix DMX transmit by @someweisguy in #42
• Fix dmx_receive() block time and behavior by @someweisguy in #44
• PlatformIO v6 compatibility by @someweisguy in #46

New Contributors

• @arneboe made their first contribution in #35

Full Changelog: v3.0.0-beta...v3.0.1-beta

v3.0.0-beta

This is a pre-release of version 3.0!

This version brings several new changes to esp_dmx including:

• Remote Device Management support
• RDM Controller API
• FreeRTOS Task Notification support for much quicker context switching
• Improved DMX driver which allows for custom mark-before-break time
• Much more simplified DMX API
• Smaller driver memory footprint
• Updated documentation

Note that this is a PRE-release so some features may not work as intended. The DMX features in this library should remain relatively stable but RDM features are subject to change with future releases. Please assist in the development of this library by submitting bug reports to the issues page.

v2.0.2

This update fixes a bug that can cause the ESP32 to crash when CPU cache is disabled.

v2.0.1

This is a hotfix that addresses some compilation issues on Arduino.