Skip to content

Latest commit

 

History

History
executable file
·
670 lines (454 loc) · 16.5 KB

ft098_0_0.md

File metadata and controls

executable file
·
670 lines (454 loc) · 16.5 KB
layout title
documentation
FT098 - ZWave

{% include base.html %}

FT098 9W Color Light Bulb

This describes the Z-Wave device FT098, manufactured by Fantem with the thing type UID of oomi_ft098_00_000.

The device is in the category of Light Bulb, defining Devices that illuminate something, such as bulbs, etc..

FT098 product image

The FT098 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.

Overview

Oomi Bulb is a Z-Wave LED module which allows control (on/off/dim) with the use of Z-Wave. It's a bulb which has a Smart RGB LED, which can be used to add colour to your home. The bulb has 5 main colour channels available for you to adjust: Red, Green, Blue, Warm White and Cold White. You can configure its colour according to your favour. The Bulb is also a security Z-wave device and supports the Over The Air (OTA) feature for the product's firmware upgrade.  

Inclusion Information

  1. Toggle off the wall switch before you screw in Bulb and firmly screw in Bulb.
  2. Set your Z-Wave hub into pairing mode.
  3. Toggle off the wall switch controlling your Bulb to turn it off (keep it in the "OFF" state for 2 seconds) and then toggle on the wall switch to turn your Bulb on, the green will blink to indicate the Bulb is entering into pairing mode.
  4. If Bulb has been successfully added to your Z-Wave network, its RGB LED will be solid when you turn Bulb on.

Note:

  1. If your Bulb has already been added into another Z-Wave network, you'll need to remove it from the existing network first. Refer to the Exclusion instructions.
  2. To check if LED Bulb is already paired to an existing network, toggle the wall switch off and on 3 times fast (the final ending position of the wall switch must be on). If LED Bulb blinks orange for 3 seconds, it is already paired into a Z-Wave network.

Exclusion Information

Your Bulb can be removed from your Z-Wave network at any time. You'll need to use your Z-Wave network's main controller. To set your Z-Wave hub into removal mode, please refer to the respective section within your hubs instruction manual.

  1. Set your Z-Wave hub into device removal mode.
  2. Toggle the wall switch off and on 3 times fast (the final ending position of the wall switch must be on). If successful, the Bulb will change to orange colour for 2 seconds before changing to white. If removal was unsuccessful, then Bulb will blink orange for 3 seconds before changing to red colour for 2 seconds.

Channels

The following table summarises the channels available for the FT098 -:

Channel Name Channel ID Channel Type Category Item Type
Dimmer switch_dimmer switch_dimmer DimmableLight Dimmer
Color Control color_color color_color ColorLight Color
Color Temperature color_temperature color_temperature ColorLight Dimmer

Dimmer

The brightness channel allows to control the brightness of a light. It is also possible to switch the light on and off.

The switch_dimmer channel is of type switch_dimmer and supports the Dimmer item and is in the DimmableLight category.

Color Control

The color channel allows to control the color of a light. It is also possible to dim values and switch the light on and off.

The color_color channel is of type color_color and supports the Color item and is in the ColorLight category.

Color Temperature

The color temperature channel allows to set the color temperature of a light from 0 (cold) to 100 (warm).

The color_temperature channel is of type color_temperature and supports the Dimmer item and is in the ColorLight category.

Device Configuration

The following table provides a summary of the 14 configuration parameters available in the FT098. Detailed information on each parameter can be found in the sections below.

Param Name Description
20 Power-on state The bulb's state after power is applied
32 Send report when color is changed
33 Get the bulb's color value Byte 1: reserved, Bytes 2, 3, 4: Red, Green, Blue
34 Allow external switch to turn the bulb on/off
35 Allow external switch to change the color
36 Reboot / Save / Exit colorful mode
37 Colorful mode configuration Configure the colour cycling modes. See overview for details.
38 Change speed Change the speed when going from OFF to ON, ON to OFF. See overview for details.
39 Multi-colour configuration Set up to 8 colours to cycle between when the LED is in Multi Colour Mode
80 Send notifications to associated devices (Group 1)
112 Dimer mode
200 Partner ID
252 Enable/disable Lock Configuration
255 Reset to factory defaults Reset the bulb, optionally also removing it from the z-wave network

Parameter 20: Power-on state

The bulb's state after power is applied

The following option values may be configured -:

Value Description
0 Use previous state
1 Always on
2 Always off

The manufacturer defined default value is 1 (Always on).

This parameter has the configuration ID config_20_1 and is of type INTEGER.

Parameter 32: Send report when color is changed

The following option values may be configured -:

Value Description
0 Disable
1 Hail CC

The manufacturer defined default value is 0 (Disable).

This parameter has the configuration ID config_32_1 and is of type INTEGER.

Parameter 33: Get the bulb's color value

Byte 1: reserved, Bytes 2, 3, 4: Red, Green, Blue Value 1 = Reserved

Value 2 = Red color value

Value 3 = Green color value

Value 4 = Blue color value Values in the range 0 to 0 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_33_4 and is of type INTEGER.

Parameter 34: Allow external switch to turn the bulb on/off

The following option values may be configured -:

Value Description
0 Disable
1 Enable

The manufacturer defined default value is 0 (Disable).

This parameter has the configuration ID config_34_1 and is of type INTEGER.

Parameter 35: Allow external switch to change the color

The following option values may be configured -:

Value Description
0 Disable
1 Enable

The manufacturer defined default value is 1 (Enable).

This parameter has the configuration ID config_35_1 and is of type INTEGER.

Parameter 36: Reboot / Save / Exit colorful mode

The following option values may be configured -:

Value Description
0 Un-reboot colorful mode
1 Reboot colorful mode
2 Exit colorful mode
3 Save current colorful mode value and then exit

The manufacturer defined default value is 0 (Un-reboot colorful mode).

This parameter has the configuration ID config_36_1 and is of type INTEGER.

Parameter 37: Colorful mode configuration

Configure the colour cycling modes. See overview for details.

Colour Display Cycle Configuration

Parameter 37 [4 bytes] will cycle the colour displayed by the LED bulb into different modes:

<td>
  Colour Change Speed Option
</td>

<td>
  Colour Display Cycle
</td>
<td>
  Colour Change Speed Level
</td>
Colour Transition Style
Brightness
Cycle Count
Time Base of Colour Change Speed

Colour Display Cycle (4 bits)

The Colour Display Cycle field can have the following values, corresponding to 4 different modes:

Inactive (keep the current configuration values)
Rainbow mode (red, orange, yellow, green, cyan, blue, violet)
Multi Colour Mode (cycle between selected colours)
Random mode
Single colour mode
Reserved

Colour Transition Style (2 bits)

The following values correspond to 2 different transition styles between colours:

Smooth Colour Transition
Fade Out Fade In Transition

Cycle Count (8 bits)

The Cycle Count is used to define the number of repetitions / cycles displayed by the LED bulb in Colour Display Cycle before stopping.

Unlimited
Total number of repetitions / cycles before stopping
Inactive (keep the current configuration values)

Brightness (8 bits)

1 = Min level. 99 = Max level.
Inactive (keep the current configuration values)

Time Base of Colour Change Speed (3 bits)

This function would be used when the Colour Transition Style is set to Fade Out/In.

1 = Min level. 99 = Max level.
Inactive (keep the current configuration values)

Colour Change Speed Level (5 bits)

This function would be used when the Colour Transition Style is set to Fade Out/In.

Constant speed
Accelerate / decelerate speed from the level 1 to 30
Inactive (keep the current configuration values)
Values in the range 0 to 0 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_37_4 and is of type INTEGER.

Parameter 38: Change speed

Change the speed when going from OFF to ON, ON to OFF. See overview for details. Change speed:

Value 1: the speed from OFF to ON

Value 2: the speed from ON to OFF

Value 3: pause time of ON

Value 4: pause time of OFF Values in the range 0 to 0 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_38_4 and is of type INTEGER.

Parameter 39: Multi-colour configuration

Set up to 8 colours to cycle between when the LED is in Multi Colour Mode

Colour Configuration

Parameter 39 [4 bytes] can be used to set up to 8 colours to cycle between when LED bulb is in Multi Colour Mode. Colours transition from Colour Index 1-8.

<td>
  Index 2
</td>
<td>
  Index 4
</td>
<td>
  Index 6
</td>
<td>
  Index 8
</td>
Index 1
Index 3
Index 5
Index 7

Colour Component Id

<td>
  Orange
</td>

<td>
  Yellow
</td>

<td>
  Green
</td>

<td>
  Cyan
</td>

<td>
  Blue
</td>

<td>
  Violet
</td>

<td>
  Pinkish
</td>
Red

Example

If you set the parameter 39 to 305135616 (0x12300000), the colour will be changed from Red to Orange and then Orange to Yellow circularly (Red-Orange-Yellow)

When the bulb is in Single Colour Mode and the Fade Out Fade In transition style, the parameter 39 would be used to set the RGB value:

Red value
Green value
Blue value
Reserved

When the bulb is in Random Mode, the parameter 39 would be used to set the random seed, then the bulb will automatically generate random colours to be displayed according to the random seed you set.

Random seed value
Values in the range 0 to 0 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_39_4 and is of type INTEGER.

Parameter 80: Send notifications to associated devices (Group 1)

The following option values may be configured -:

Value Description
0 Disabled
1 Hail CC
2 Basic CC Report

The manufacturer defined default value is 2 (Basic CC Report).

This parameter has the configuration ID config_80_1 and is of type INTEGER.

Parameter 112: Dimer mode

The following option values may be configured -:

Value Description
0 Parabolic curve
1 Index curve
2 (Parabolic + Index) / 2
3 Linear

The manufacturer defined default value is 0 (Parabolic curve).

This parameter has the configuration ID config_112_1 and is of type INTEGER.

Parameter 200: Partner ID

The following option values may be configured, in addition to values in the range 0 to 0 -:

Value Description
0 Aeon Labs Standard Product

The manufacturer defined default value is 0 (Aeon Labs Standard Product).

This parameter has the configuration ID config_200_1 and is of type INTEGER.

Parameter 252: Enable/disable Lock Configuration

The following option values may be configured -:

Value Description
0 Disable
1 Enable

The manufacturer defined default value is 0 (Disable).

This parameter has the configuration ID config_252_1 and is of type INTEGER.

Parameter 255: Reset to factory defaults

Reset the bulb, optionally also removing it from the z-wave network Value=0x55555555, Default=1, Size=4

Reset to factory default setting and removed from the z-wave network

Value=0, Default=1, Size=1 Reset to factory default setting Values in the range 0 to 0 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_255_4 and is of type INTEGER.

Association Groups

Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.

The FT098 supports 2 association groups.

Group 1: Group 1

Lifeline When the state of Smart Switch (turn on/off the load) is changed:

  1. Set Configuration parameter 80 to 0:Reserved (Default).
  2. Set Configuration parameter 80 to 1:Send Hail CC.
  3. Set Configuration parameter 80 to 2:Send the Basic Report.

Association group 1 supports 5 nodes.

Group 2: Group 2

Retransmit Forward the Basic Set, Switch Binary Set, Switch Multilevel Start Level Change, Switch Multilevel Stop Level Change, Switch Multilevel Set, Scene Activation Set to associated nodes in Group 2 when the Bulb receives the Basic Set, Switch Binary Set, Switch Multilevel Start Level Change, Switch Multilevel Stop Level Change, Switch Multilevel Set, Scene Activation Set commands from main controller.

Association group 2 supports 5 nodes.

Technical Information

Endpoints

Endpoint 0

Command Class Comment
COMMAND_CLASS_NO_OPERATION_V1
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SWITCH_MULTILEVEL_V1 Linked to BASIC
COMMAND_CLASS_SWITCH_COLOR_V1
COMMAND_CLASS_CONFIGURATION_V1
COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1
COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1
COMMAND_CLASS_ASSOCIATION_V1

Documentation Links


Did you spot an error in the above definition or want to improve the content? You can contribute to the database here.