From 0929a8db3781b74452dc82fd1ceb433d9597f5dd Mon Sep 17 00:00:00 2001 From: TOKITA Hiroshi Date: Sat, 9 Mar 2024 16:06:25 +0900 Subject: [PATCH] samples: drivers: Rename `led_ws2812` to `led_strip` Rename it so that it can be used as a sample of various LED strips. Signed-off-by: TOKITA Hiroshi --- .../shields/adafruit_neopixel_grid_bff/doc/index.rst | 2 +- boards/vcc-gnd/yd_esp32/doc/index.rst | 4 ++-- .../drivers/{led_ws2812 => led_strip}/CMakeLists.txt | 2 +- samples/drivers/{led_ws2812 => led_strip}/Kconfig | 0 samples/drivers/{led_ws2812 => led_strip}/README.rst | 12 ++++++------ .../boards/adafruit_qt_py_rp2040.conf | 0 .../boards/bbc_microbit.overlay | 0 .../boards/esp32c3_devkitm.overlay | 0 .../boards/esp32s2_saola.overlay | 0 .../boards/esp32s3_devkitm_esp32s3_procpu.overlay | 0 .../boards/mimxrt1050_evk.overlay | 0 .../boards/mimxrt1050_evk_qspi.overlay | 0 .../boards/nrf51dk_nrf51822.overlay | 0 .../boards/nrf52dk_nrf52832.conf | 0 .../boards/nrf52dk_nrf52832.overlay | 0 .../boards/nrf5340dk_nrf5340_cpuapp.overlay | 0 .../boards/nucleo_f070rb.conf | 0 .../boards/nucleo_f070rb.overlay | 0 .../boards/nucleo_g071rb.overlay | 0 .../boards/nucleo_h743zi.overlay | 0 .../boards/nucleo_l476rg.overlay | 0 .../boards/thingy52_nrf52832.overlay | 0 .../{led_ws2812 => led_strip}/f070rb-bindings.h | 0 .../{led_ws2812 => led_strip}/nrf52-bindings.h | 0 samples/drivers/{led_ws2812 => led_strip}/prj.conf | 0 samples/drivers/led_strip/sample.yaml | 11 +++++++++++ samples/drivers/{led_ws2812 => led_strip}/src/main.c | 0 samples/drivers/led_ws2812/sample.yaml | 11 ----------- 28 files changed, 21 insertions(+), 21 deletions(-) rename samples/drivers/{led_ws2812 => led_strip}/CMakeLists.txt (91%) rename samples/drivers/{led_ws2812 => led_strip}/Kconfig (100%) rename samples/drivers/{led_ws2812 => led_strip}/README.rst (94%) rename samples/drivers/{led_ws2812 => led_strip}/boards/adafruit_qt_py_rp2040.conf (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/bbc_microbit.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/esp32c3_devkitm.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/esp32s2_saola.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/esp32s3_devkitm_esp32s3_procpu.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/mimxrt1050_evk.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/mimxrt1050_evk_qspi.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/nrf51dk_nrf51822.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/nrf52dk_nrf52832.conf (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/nrf52dk_nrf52832.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/nrf5340dk_nrf5340_cpuapp.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/nucleo_f070rb.conf (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/nucleo_f070rb.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/nucleo_g071rb.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/nucleo_h743zi.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/nucleo_l476rg.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/boards/thingy52_nrf52832.overlay (100%) rename samples/drivers/{led_ws2812 => led_strip}/f070rb-bindings.h (100%) rename samples/drivers/{led_ws2812 => led_strip}/nrf52-bindings.h (100%) rename samples/drivers/{led_ws2812 => led_strip}/prj.conf (100%) create mode 100644 samples/drivers/led_strip/sample.yaml rename samples/drivers/{led_ws2812 => led_strip}/src/main.c (100%) delete mode 100644 samples/drivers/led_ws2812/sample.yaml diff --git a/boards/shields/adafruit_neopixel_grid_bff/doc/index.rst b/boards/shields/adafruit_neopixel_grid_bff/doc/index.rst index f4648e9b02f..24e6762e1d6 100644 --- a/boards/shields/adafruit_neopixel_grid_bff/doc/index.rst +++ b/boards/shields/adafruit_neopixel_grid_bff/doc/index.rst @@ -39,7 +39,7 @@ LED Strip Example Set ``-DSHIELD=adafruit_neopixel_grid_bff`` when you invoke ``west build``. For example: .. zephyr-app-commands:: - :zephyr-app: samples/drivers/led_ws2812 + :zephyr-app: samples/drivers/led_strip :board: adafruit_qt_py_rp2040 :shield: adafruit_neopixel_grid_bff :goals: build diff --git a/boards/vcc-gnd/yd_esp32/doc/index.rst b/boards/vcc-gnd/yd_esp32/doc/index.rst index e69f7d07704..890c3de6855 100644 --- a/boards/vcc-gnd/yd_esp32/doc/index.rst +++ b/boards/vcc-gnd/yd_esp32/doc/index.rst @@ -233,10 +233,10 @@ RGB LED ======= The board contains an addressable RGB LED (`XL-5050RGBC-WS2812B`_), driven by GPIO16. -Here is an example of how to test it using the :zephyr:code-sample:`led-ws2812` application. +Here is an example of how to test it using the :zephyr:code-sample:`led-strip` application. .. zephyr-app-commands:: - :zephyr-app: samples/drivers/led_ws2812 + :zephyr-app: samples/drivers/led_strip :board: yd_esp32/esp32/procpu :goals: flash diff --git a/samples/drivers/led_ws2812/CMakeLists.txt b/samples/drivers/led_strip/CMakeLists.txt similarity index 91% rename from samples/drivers/led_ws2812/CMakeLists.txt rename to samples/drivers/led_strip/CMakeLists.txt index 6a2883198d3..ad3393e0c2a 100644 --- a/samples/drivers/led_ws2812/CMakeLists.txt +++ b/samples/drivers/led_strip/CMakeLists.txt @@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.20.0) find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE}) -project(led_ws2812) +project(led_strip) FILE(GLOB app_sources src/*.c) target_sources(app PRIVATE ${app_sources}) diff --git a/samples/drivers/led_ws2812/Kconfig b/samples/drivers/led_strip/Kconfig similarity index 100% rename from samples/drivers/led_ws2812/Kconfig rename to samples/drivers/led_strip/Kconfig diff --git a/samples/drivers/led_ws2812/README.rst b/samples/drivers/led_strip/README.rst similarity index 94% rename from samples/drivers/led_ws2812/README.rst rename to samples/drivers/led_strip/README.rst index d41bad1e207..c99cf0ee383 100644 --- a/samples/drivers/led_ws2812/README.rst +++ b/samples/drivers/led_strip/README.rst @@ -1,5 +1,5 @@ -.. zephyr:code-sample:: led-ws2812 - :name: WS2812 LED strip +.. zephyr:code-sample:: led-strip + :name: LED strip sample :relevant-api: led_strip_interface Control an LED strip using a WS2812 (or compatible) driver chip. @@ -41,14 +41,14 @@ Wiring on a thingy52 The thingy52 has integrated NMOS transistors, that can be used instead of a level shifter. The I2S driver supports inverting the output to suit this scheme, using the ``out-active-low`` dts property. See the overlay file -:zephyr_file:`samples/drivers/led_ws2812/boards/thingy52_nrf52832.overlay` for more detail. +:zephyr_file:`samples/drivers/led_strip/boards/thingy52_nrf52832.overlay` for more detail. Building and Running -********************* +******************** .. _blog post on WS2812 timing: https://wp.josh.com/2014/05/13/ws2812-neopixels-are-not-so-finicky-once-you-get-to-know-them/ -This sample's source directory is :zephyr_file:`samples/drivers/led_ws2812/`. +This sample's source directory is :zephyr_file:`samples/drivers/led_strip/`. To make sure the sample is set up properly for building, you must: @@ -80,7 +80,7 @@ modified by changing the :kconfig:option:`CONFIG_SAMPLE_LED_UPDATE_DELAY`. Then build and flash the application: .. zephyr-app-commands:: - :zephyr-app: samples/drivers/led_ws2812 + :zephyr-app: samples/drivers/led_strip :board: :goals: flash :compact: diff --git a/samples/drivers/led_ws2812/boards/adafruit_qt_py_rp2040.conf b/samples/drivers/led_strip/boards/adafruit_qt_py_rp2040.conf similarity index 100% rename from samples/drivers/led_ws2812/boards/adafruit_qt_py_rp2040.conf rename to samples/drivers/led_strip/boards/adafruit_qt_py_rp2040.conf diff --git a/samples/drivers/led_ws2812/boards/bbc_microbit.overlay b/samples/drivers/led_strip/boards/bbc_microbit.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/bbc_microbit.overlay rename to samples/drivers/led_strip/boards/bbc_microbit.overlay diff --git a/samples/drivers/led_ws2812/boards/esp32c3_devkitm.overlay b/samples/drivers/led_strip/boards/esp32c3_devkitm.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/esp32c3_devkitm.overlay rename to samples/drivers/led_strip/boards/esp32c3_devkitm.overlay diff --git a/samples/drivers/led_ws2812/boards/esp32s2_saola.overlay b/samples/drivers/led_strip/boards/esp32s2_saola.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/esp32s2_saola.overlay rename to samples/drivers/led_strip/boards/esp32s2_saola.overlay diff --git a/samples/drivers/led_ws2812/boards/esp32s3_devkitm_esp32s3_procpu.overlay b/samples/drivers/led_strip/boards/esp32s3_devkitm_esp32s3_procpu.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/esp32s3_devkitm_esp32s3_procpu.overlay rename to samples/drivers/led_strip/boards/esp32s3_devkitm_esp32s3_procpu.overlay diff --git a/samples/drivers/led_ws2812/boards/mimxrt1050_evk.overlay b/samples/drivers/led_strip/boards/mimxrt1050_evk.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/mimxrt1050_evk.overlay rename to samples/drivers/led_strip/boards/mimxrt1050_evk.overlay diff --git a/samples/drivers/led_ws2812/boards/mimxrt1050_evk_qspi.overlay b/samples/drivers/led_strip/boards/mimxrt1050_evk_qspi.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/mimxrt1050_evk_qspi.overlay rename to samples/drivers/led_strip/boards/mimxrt1050_evk_qspi.overlay diff --git a/samples/drivers/led_ws2812/boards/nrf51dk_nrf51822.overlay b/samples/drivers/led_strip/boards/nrf51dk_nrf51822.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/nrf51dk_nrf51822.overlay rename to samples/drivers/led_strip/boards/nrf51dk_nrf51822.overlay diff --git a/samples/drivers/led_ws2812/boards/nrf52dk_nrf52832.conf b/samples/drivers/led_strip/boards/nrf52dk_nrf52832.conf similarity index 100% rename from samples/drivers/led_ws2812/boards/nrf52dk_nrf52832.conf rename to samples/drivers/led_strip/boards/nrf52dk_nrf52832.conf diff --git a/samples/drivers/led_ws2812/boards/nrf52dk_nrf52832.overlay b/samples/drivers/led_strip/boards/nrf52dk_nrf52832.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/nrf52dk_nrf52832.overlay rename to samples/drivers/led_strip/boards/nrf52dk_nrf52832.overlay diff --git a/samples/drivers/led_ws2812/boards/nrf5340dk_nrf5340_cpuapp.overlay b/samples/drivers/led_strip/boards/nrf5340dk_nrf5340_cpuapp.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/nrf5340dk_nrf5340_cpuapp.overlay rename to samples/drivers/led_strip/boards/nrf5340dk_nrf5340_cpuapp.overlay diff --git a/samples/drivers/led_ws2812/boards/nucleo_f070rb.conf b/samples/drivers/led_strip/boards/nucleo_f070rb.conf similarity index 100% rename from samples/drivers/led_ws2812/boards/nucleo_f070rb.conf rename to samples/drivers/led_strip/boards/nucleo_f070rb.conf diff --git a/samples/drivers/led_ws2812/boards/nucleo_f070rb.overlay b/samples/drivers/led_strip/boards/nucleo_f070rb.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/nucleo_f070rb.overlay rename to samples/drivers/led_strip/boards/nucleo_f070rb.overlay diff --git a/samples/drivers/led_ws2812/boards/nucleo_g071rb.overlay b/samples/drivers/led_strip/boards/nucleo_g071rb.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/nucleo_g071rb.overlay rename to samples/drivers/led_strip/boards/nucleo_g071rb.overlay diff --git a/samples/drivers/led_ws2812/boards/nucleo_h743zi.overlay b/samples/drivers/led_strip/boards/nucleo_h743zi.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/nucleo_h743zi.overlay rename to samples/drivers/led_strip/boards/nucleo_h743zi.overlay diff --git a/samples/drivers/led_ws2812/boards/nucleo_l476rg.overlay b/samples/drivers/led_strip/boards/nucleo_l476rg.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/nucleo_l476rg.overlay rename to samples/drivers/led_strip/boards/nucleo_l476rg.overlay diff --git a/samples/drivers/led_ws2812/boards/thingy52_nrf52832.overlay b/samples/drivers/led_strip/boards/thingy52_nrf52832.overlay similarity index 100% rename from samples/drivers/led_ws2812/boards/thingy52_nrf52832.overlay rename to samples/drivers/led_strip/boards/thingy52_nrf52832.overlay diff --git a/samples/drivers/led_ws2812/f070rb-bindings.h b/samples/drivers/led_strip/f070rb-bindings.h similarity index 100% rename from samples/drivers/led_ws2812/f070rb-bindings.h rename to samples/drivers/led_strip/f070rb-bindings.h diff --git a/samples/drivers/led_ws2812/nrf52-bindings.h b/samples/drivers/led_strip/nrf52-bindings.h similarity index 100% rename from samples/drivers/led_ws2812/nrf52-bindings.h rename to samples/drivers/led_strip/nrf52-bindings.h diff --git a/samples/drivers/led_ws2812/prj.conf b/samples/drivers/led_strip/prj.conf similarity index 100% rename from samples/drivers/led_ws2812/prj.conf rename to samples/drivers/led_strip/prj.conf diff --git a/samples/drivers/led_strip/sample.yaml b/samples/drivers/led_strip/sample.yaml new file mode 100644 index 00000000000..4bc7135af81 --- /dev/null +++ b/samples/drivers/led_strip/sample.yaml @@ -0,0 +1,11 @@ +sample: + description: Demonstration of the LED strip driver + name: LED strip sample +tests: + sample.drivers.led_strip: + tags: LED + filter: dt_alias_exists("led-strip") + harness_config: + fixture: fixture_led_strip + integration_platforms: + - mimxrt1050_evk diff --git a/samples/drivers/led_ws2812/src/main.c b/samples/drivers/led_strip/src/main.c similarity index 100% rename from samples/drivers/led_ws2812/src/main.c rename to samples/drivers/led_strip/src/main.c diff --git a/samples/drivers/led_ws2812/sample.yaml b/samples/drivers/led_ws2812/sample.yaml deleted file mode 100644 index 3add7297b33..00000000000 --- a/samples/drivers/led_ws2812/sample.yaml +++ /dev/null @@ -1,11 +0,0 @@ -sample: - description: Demonstration of the WS2812 LED driver - name: WS2812 sample -tests: - sample.drivers.led.ws2812: - tags: LED - filter: dt_compat_enabled("worldsemi,ws2812-spi") - harness_config: - fixture: fixture_led_ws2812 - integration_platforms: - - mimxrt1050_evk