An open API service indexing awesome lists of open source software.

https://github.com/alcalzone/nc-zwave-repeater

Z-Wave Repeater firmware for OTW bootloader
https://github.com/alcalzone/nc-zwave-repeater

Last synced: about 1 year ago
JSON representation

Z-Wave Repeater firmware for OTW bootloader

Awesome Lists containing this project

README

          

# LED Bulb

The Z-Wave LED Bulb application shows an implementation of a remotely controlled color
switch. An example is a LED bulb or any other color capable device.

The LED Bulb application is based on:

| | |
| ----------------------- | -------------------------------------------- |
| Role Type | Always On End device (AOS) |
| Supporting Device Type | Actuator |
| Device Type | Color Switch |
| Generic Type | Switch Multilevel |
| Specific Type | Color Tunable Multilevel |
| Requested security keys | S0, S2_UNAUTHENTICATED, and S2_AUTHENTICATED |

## Supported Command Classes

The LED Bulb application implements mandatory and some optional command classes. The table below
lists the supported Command Classes, their version, and their required Security class

| Command Class | Version | Required Security Class |
| :------------------------ | :-----: | :----------------------------- |
| Association | 2 | Highest granted Security Class |
| Association Group Info | 3 | Highest granted Security Class |
| Basic | 2 | Highest granted Security Class |
| Color Switch | 3 | Highest granted Security Class |
| Device Reset Locally | 1 | Highest granted Security Class |
| Firmware Update Meta Data | 5 | Highest granted Security Class |
| Indicator | 3 | Highest granted Security Class |
| Manufacturer Specific | 2 | Highest Granted Security Class |
| Multi-Channel Association | 3 | Highest granted Security Class |
| Multilevel Switch | 4 | Highest granted Security Class |
| Powerlevel | 1 | Highest granted Security Class |
| Security 0 | 1 | None |
| Security 2 | 1 | None |
| Supervision | 1 | None |
| Transport Service | 2 | None |
| Version | 3 | Highest granted Security Class |
| Z-Wave Plus Info | 2 | None |

## Basic Command Class Mapping

The Basic Command Class is mapped according to the table below.

| Basic Command | Mapped Command |
| :------------------------------------- | :----------------------------------------- |
| Basic Set (Value) | Multilevel Switch Set (Value) |
| Basic Report (Current Value, Duration) | Multilevel Switch Report (Value, Duration) |

## Association Groups

The following association groups shown in the table below are available for Z-Wave and Z-Wave Long
Range respectively.

ID
Name
Node Count
Description

1
Lifeline
X

Supports the following command classes:



  • Device Reset Locally: triggered upon reset.

  • Color Switch Report: Triggered when the switch changes state.

  • Multilevel Switch Report: Triggered when the switch changes state.

  • Indicator Report: Triggered when LED0 changes state.


X: For Z-Wave node count is equal to 5 and for Z-Wave Long Range it is 1.

## Usage of Buttons and LED Status

We are differentiating four different types of button presses. The following types are the same for the BTN0 and BTN1 on the WSTK board. The duration values can be configured under the config directory in app_button_press_config.h file in each generated application/project.

Please note external wakeup is not supported on button 1 in case of brd2603a and brd2603b.

Press Type
Duration

Short Press
0 - 400 ms

Medium Press
401 - 1500 ms

Long Press
1501 - 5000 ms

Very Long Press
Every press longer than Long Press

Button
Action
Description

RST
Press
Resets the firmware of an application (like losing power). All volatile memory will be cleared.

BTN1
Short Press
Enter "learn mode" (sending node info frame) to add/remove the device.

Removing the device from a network will reset it.

Very Long Press
Perform a reset to factory default operation of the device, and a Device Reset Locally Notification Command is sent via Lifeline.

LED
Description

Boards with an RGB LED
Boards without an RGB LED

LED0

Blinks with 1 Hz when learn mode is active.

Used for Indicator Command Class.

LED1
-

Controlled by CC Color Switch and CC Multilevel Switch
(monochrome, brightness only)

RGB
Controlled by CC Color Switch (colors) and CC Multilevel Switch (brightness)
-

## Firmware Update

SDK 7.14.0 is the first SDK, including LED Bulb. When there are new versions of LED Bulb application, backward compatibility notes will be added in this section.

## CLI Support
Please note the zw_cli_common component will modify the power consumption in case of sleeping applications. Like door lock keypad, sensor pir or multilevel sensor. CLI cannot work with sleep mode, after a reset the application stays awake until the user issues the enable_sleeping command. From that point CLI won't work and sleep mode will be reached until the next reset.

Command
Arguments
Description

set_learn_mode

Toggling the learn mode functionality. In case the learn mode started, but inclusion does not happen,learn mode will automatically stop after about 30 seconds

factory_reset
-
Executing factory reset

get_dsk
-
Printing out the generated DSK of the device

get_region
-
Printing out the set region of the application

get_rgb_values
-
Shows the current Red Green and Blue values. The range is 0-65535 for each component. In case the target does not have RGB LED it shows the LED intensity on a scale 0-255.