Skip to content

ESP 5+ and RMT fix #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
harmon25 merged 5 commits into from
Dec 4, 2025
Merged

ESP 5+ and RMT fix #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
64b4c60
Refactor RMT handling for ESP-IDF version compatibility and update LE…
harmon25 Dec 2, 2025
0d5bfc6
Update header includes to use esp_idf_version.h for SDK version compa…
harmon25 Dec 4, 2025
db1582c
Ensure esp_idf_version.h is included first in relevant source files f…
harmon25 Dec 4, 2025
6c11613
Refactor LED strip driver for ESP-IDF 5.x compatibility by removing l…
harmon25 Dec 4, 2025
bb796a5
Fix memory allocation for WS2812 LED strip by ensuring proper variabl…
harmon25 Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 41 additions & 104 deletions nifs/atomvm_neopixel.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@

#include <atomvm_neopixel.h>
#include <context.h>
#include <driver/rmt.h>
#include <defaultatoms.h>
#include <esp_log.h>
#include <esp32_sys.h>
Expand All @@ -31,18 +30,8 @@
#include "trace.h"

#define TAG "atomvm_neopixel"
#define NO_ALLOC_FLAGS 0

// References
// https://docs.espressif.com/projects/esp-idf/en/v3.3.4/api-reference/peripherals/rmt.html
//

static const char *const led_strip_atom = "\x9" "led_strip";
static const char *const channel_0_atom = "\x9" "channel_0";
static const char *const channel_1_atom = "\x9" "channel_1";
static const char *const channel_2_atom = "\x9" "channel_2";
static const char *const channel_3_atom = "\x9" "channel_3";
// 123456789ABCDEF01
static const char *const led_strip_atom = "\x9" "led_strip";


static inline term ptr_to_binary(void *ptr, Context* ctx)
Expand All @@ -61,25 +50,6 @@ static inline void *binary_to_ptr(term binary)
}


static rmt_channel_t get_rmt_channel(Context *ctx, term channel)
{
if (channel == globalcontext_make_atom(ctx->global, channel_0_atom)) {
return RMT_CHANNEL_1;
} else if (channel == globalcontext_make_atom(ctx->global, channel_1_atom)) {
return RMT_CHANNEL_2;
} else if (channel == globalcontext_make_atom(ctx->global, channel_2_atom)) {
return RMT_CHANNEL_2;
} else if (channel == globalcontext_make_atom(ctx->global, channel_3_atom)) {
return RMT_CHANNEL_3;
#if SOC_RMT_CHANNELS_PER_GROUP > 4
// TODO
#endif
} else {
return RMT_CHANNEL_MAX;
}
}


static term nif_init(Context *ctx, int argc, term argv[])
{
UNUSED(argc);
Expand All @@ -90,44 +60,28 @@ static term nif_init(Context *ctx, int argc, term argv[])
VALIDATE_VALUE(num_pixels, term_is_integer);
term channel = argv[2];
VALIDATE_VALUE(channel, term_is_atom);

rmt_channel_t rmt_channel = get_rmt_channel(ctx, channel);
// Note: channel argument is kept for API compatibility but ignored in ESP-IDF 5.x

if (UNLIKELY(memory_ensure_free(ctx, 3) != MEMORY_GC_OK)) {
RAISE_ERROR(OUT_OF_MEMORY_ATOM);
} else {
rmt_config_t config = RMT_DEFAULT_CONFIG_TX(term_to_int(pin), rmt_channel);
// set counter clock to 40MHz
config.clk_div = 2;

esp_err_t err = rmt_config(&config);
if (err != ESP_OK) {
TRACE("Failed to initialize rmt config. err=%i\n", err);
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, term_from_int(err));
return error_tuple;
}
err = rmt_driver_install(config.channel, 0, NO_ALLOC_FLAGS);
if (err != ESP_OK) {
TRACE("Failed to install rmt driver. err=%i\n", err);
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, term_from_int(err));
return error_tuple;
}
led_strip_config_t strip_config = LED_STRIP_DEFAULT_CONFIG(term_to_int(num_pixels), (led_strip_dev_t) config.channel);
led_strip_t *strip = led_strip_new_rmt_ws2812(&strip_config);
if (!strip) {
TRACE("Failed to install WS2812 driver.\n");
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, globalcontext_make_atom(ctx->global, led_strip_atom));
return error_tuple;
}
ESP_LOGI(TAG, "Installed WS2812 driver.");
return ptr_to_binary(strip, ctx);
}

led_strip_config_t strip_config = {
.max_leds = term_to_int(num_pixels),
.gpio_num = term_to_int(pin)
};

led_strip_t *strip = led_strip_new_rmt_ws2812(&strip_config);
if (!strip) {
TRACE("Failed to install WS2812 driver.\n");
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, globalcontext_make_atom(ctx->global, led_strip_atom));
return error_tuple;
}

ESP_LOGI(TAG, "Installed WS2812 driver.");
return ptr_to_binary(strip, ctx);
}


Expand All @@ -147,12 +101,11 @@ static term nif_clear(Context *ctx, int argc, term argv[])
TRACE("Failed to clear led strip. err=%i\n", err);
if (UNLIKELY(memory_ensure_free(ctx, 3) != MEMORY_GC_OK)) {
RAISE_ERROR(OUT_OF_MEMORY_ATOM);
} else {
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, term_from_int(err));
return error_tuple;
}
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, term_from_int(err));
return error_tuple;
}
TRACE("Cleared led strip.\n");
return OK_ATOM;
Expand All @@ -175,12 +128,11 @@ static term nif_refresh(Context *ctx, int argc, term argv[])
TRACE("Failed to refresh led strip. err=%i\n", err);
if (UNLIKELY(memory_ensure_free(ctx, 3) != MEMORY_GC_OK)) {
RAISE_ERROR(OUT_OF_MEMORY_ATOM);
} else {
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, term_from_int(err));
return error_tuple;
}
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, term_from_int(err));
return error_tuple;
}
TRACE("Refreshed led strip.\n");
return OK_ATOM;
Expand Down Expand Up @@ -210,12 +162,11 @@ static term nif_set_pixel_rgb(Context *ctx, int argc, term argv[])
TRACE("Failed to set pixel value on index %i (r=%i g=%i b=%i). err=%i\n", i, red, green, blue, err);
if (UNLIKELY(memory_ensure_free(ctx, 3) != MEMORY_GC_OK)) {
RAISE_ERROR(OUT_OF_MEMORY_ATOM);
} else {
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, term_from_int(err));
return error_tuple;
}
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, term_from_int(err));
return error_tuple;
}
TRACE("Set pixel %i to r=%i g=%i b=%i\n", i, term_to_int(red), term_to_int(green), term_to_int(blue));
return OK_ATOM;
Expand Down Expand Up @@ -250,12 +201,11 @@ static term nif_set_pixel_hsv(Context *ctx, int argc, term argv[])
TRACE("Failed to set pixel value on index %i (r=%i g=%i b=%i). err=%i\n", i, red, green, blue, err);
if (UNLIKELY(memory_ensure_free(ctx, 3) != MEMORY_GC_OK)) {
RAISE_ERROR(OUT_OF_MEMORY_ATOM);
} else {
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, term_from_int(err));
return error_tuple;
}
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, term_from_int(err));
return error_tuple;
}
TRACE("Set pixel %i to r=%i g=%i b=%i\n", i, red, green, blue);
return OK_ATOM;
Expand All @@ -270,6 +220,7 @@ static term nif_tini(Context *ctx, int argc, term argv[])
VALIDATE_VALUE(handle, term_is_binary);
term channel = argv[1];
VALIDATE_VALUE(channel, term_is_atom);
// Note: channel argument is kept for API compatibility but ignored in ESP-IDF 5.x

led_strip_t *strip = (led_strip_t *) binary_to_ptr(handle);

Expand All @@ -278,28 +229,14 @@ static term nif_tini(Context *ctx, int argc, term argv[])
TRACE("Failed to delete led strip. err=%i\n", err);
if (UNLIKELY(memory_ensure_free(ctx, 3) != MEMORY_GC_OK)) {
RAISE_ERROR(OUT_OF_MEMORY_ATOM);
} else {
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, term_from_int(err));
return error_tuple;
}
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, term_from_int(err));
return error_tuple;
}

rmt_channel_t rmt_channel = get_rmt_channel(ctx, channel);
err = rmt_driver_uninstall(term_to_int(rmt_channel));
if (err != ESP_OK) {
TRACE("Failed to uninstall rmt driver. err=%i\n", err);
if (UNLIKELY(memory_ensure_free(ctx, 3) != MEMORY_GC_OK)) {
RAISE_ERROR(OUT_OF_MEMORY_ATOM);
} else {
term error_tuple = term_alloc_tuple(2, &ctx->heap);
term_put_tuple_element(error_tuple, 0, ERROR_ATOM);
term_put_tuple_element(error_tuple, 1, term_from_int(err));
return error_tuple;
}
}
TRACE("LED strip niti'd\n");
TRACE("LED strip tini'd\n");
return OK_ATOM;
}

Expand Down
18 changes: 1 addition & 17 deletions nifs/include/led_strip.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,6 @@ extern "C" {
*/
typedef struct led_strip_s led_strip_t;

/**
* @brief LED Strip Device Type
*
*/
typedef void *led_strip_dev_t;

/**
* @brief Declare of LED Strip Type
*
Expand Down Expand Up @@ -99,19 +93,9 @@ struct led_strip_s {
*/
typedef struct {
uint32_t max_leds; /*!< Maximum LEDs in a single strip */
led_strip_dev_t dev; /*!< LED strip device (e.g. RMT channel, PWM channel, etc) */
int gpio_num; /*!< GPIO number */
} led_strip_config_t;

/**
* @brief Default configuration for LED strip
*
*/
#define LED_STRIP_DEFAULT_CONFIG(number, dev_hdl) \
{ \
.max_leds = number, \
.dev = dev_hdl, \
}

/**
* @brief Install a new ws2812 driver (based on RMT peripheral)
*
Expand Down
Loading