The openHAB Documentation Has Moved

The documentation has moved to openhab.org/docs and openhab.org/addons.

Please use the link below to be redirected to the new version of this article, and update your bookmarks.

FGPB101 A real push button (switch) available in several colors.

This describes the Z-Wave device FGPB101, manufactured by Fibargroup with the thing type UID of fibaro_fgpb101_00_000.

FGPB101 product image

The FGPB101 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is unable to participate in the routing of data from other devices.

The FGPB101 does not permanently listen for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour. The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.

Overview

No device information is provided in the database. Consider updating the database to improve the documentation.

Channels

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

Channel Channel Id Category Item Type
Scene Number scene_number   Number
Alarm alarm_general Door Switch
Battery Level battery-level Battery Number

Scene Number

Triggers when a scene button is pressed.

The scene_number channel supports the Number item.

Alarm

Indicates if an alarm is triggered.

The alarm_general channel supports the Switch item and is in the Door category. This is a read only channel so will only be updated following state changes from the device.

The following state translation is provided for this channel to the Switch item type -:

Value Label
OFF Ok
ON Alarm

Battery Level

Represents the battery level as a percentage (0-100%). Bindings for things supporting battery level in a different format (e.g. 4 levels) should convert to a percentage to provide a consistent battery level reading.

The battery-level channel supports the Number item and is in the Battery category.

Device Configuration

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

Param Name Description
1 Scenes sent to the controller This parameter determines which actions result in sending scene IDs to them.
3 Associations in Z-Wave network Security Mode This parameter defines how commands are sent in specified association groups
10 Key Pressed 1 time – command sent to 2nd group Associated in 2nd association group after a single click.
11 Key Pressed 1 time – value of SWITCH ON sent to 2nd group Value of SWITCH ON command sent to devices in 2nd association group
12 Key Pressed 2 times – command sent to 2nd group Commands sent to devices associated in 2nd association group
13 Key Pressed 2 times – value of SWITCH ON sent to 2nd group SWITCH ON command in 2nd association group after double click
14 Key Pressed 3 times – command sent to 2nd group Commands associated in 2nd association group after a triple click.
15 Key Pressed 3 times – value of SWITCH ON sent to 2nd group Value of SWITCH ON command sent in 2nd association group after a triple click
20 Key Pressed 1 time – command sent to 3rd group Ssent to devices associated in 3rd association group after a single click.
21 Key Pressed 1 time – value of SWITCH ON sent to 3rd group Value of SWITCH ON command sent in 3rd association group after a single click.
22 Key Pressed 2 times – command sent to 3rd group Sent to associated in 3rd association group after a double click.
23 Key Pressed 2 times – value of SWITCH ON sent to 3rd group Value of SWITCH ON command sent in 3rd association group after a double click.
24 Key Pressed 3 times – command sent to 3rd group Sent to devices associated in 3rd association group after a triple click.
25 Key Pressed 3 times – value of SWITCH ON sent to 3rd group Value SWITCH ON command sent in 3rd association group after a triple click.
29 Key Held Down – command sent to 3rd group Sent associated in 3rd association group after holding the button down.
30 Alarm frame triggers Which actions result in sending alarm frames to 4th association group.
  Wakeup Interval Sets the interval at which the device will accept commands from the controller
  Wakeup Node Sets the node ID of the device to receive the wakeup notifications

Parameter 1: Scenes sent to the controller

This parameter determines which actions result in sending scene IDs to them. This parameter determines which actions result in sending scene IDs and attributes assigned to them.

Available settings:

1 - Key Pressed 1 time
2 - Key Pressed 2 times
4 - Key Pressed 3 times
8 - Key Pressed 4 times
16 - Key Pressed 5 times
32 - Key Held Down
64 - Key Released

Values of parameter 1 may be combined, e.g. 1+2=3 means that scenes will be sent after pressing the button once or twice. Values in the range 1 to 127 may be set.

The manufacturer defined default value is 127.

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

Parameter 3: Associations in Z-Wave network Security Mode

This parameter defines how commands are sent in specified association groups This parameter defines how commands are sent in specified association groups: as secure or non-secure. Parameter is active only in Z-Wave network Security Mode. It does not apply to 1st „Lifeline” group.

1 - 2nd group sent as secure
2 - 3rd group sent as secure
4 - 4th group sent as secure

Values of parameter 3 may be combined, e.g. 1+2=3 means that 2nd & 3rd group are sent as secure Values in the range 1 to 7 may be set.

The manufacturer defined default value is 7.

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

Parameter 10: Key Pressed 1 time – command sent to 2nd group

Associated in 2nd association group after a single click. This parameter defines commands sent to devices associated in 2nd association group after a single click.

Available settings:

0 - no action
1 - SWITCH ON
2 - SWITCH OFF
3 - SWITCH ON/OFF – alternately Values in the range 0 to 3 may be set.

The manufacturer defined default value is 3.

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

Parameter 11: Key Pressed 1 time – value of SWITCH ON sent to 2nd group

Value of SWITCH ON command sent to devices in 2nd association group This parameter defines value of SWITCH ON command sent to devices in 2nd association group after a single click.

Available settings:

1-255 - sent value Values in the range 1 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 12: Key Pressed 2 times – command sent to 2nd group

Commands sent to devices associated in 2nd association group This parameter defines commands sent to devices associated in 2nd association group after a double click.

Available settings:

0 - no action
1 - SWITCH ON
2 - SWITCH OFF
3 - SWITCH ON/OFF – alternately Values in the range 0 to 3 may be set.

The manufacturer defined default value is 1.

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

Parameter 13: Key Pressed 2 times – value of SWITCH ON sent to 2nd group

SWITCH ON command in 2nd association group after double click This parameter defines value of SWITCH ON command sent to devices in 2nd association group after a double click.

Available settings:

1-255 - sent value Values in the range 1 to 255 may be set.

The manufacturer defined default value is 99.

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

Parameter 14: Key Pressed 3 times – command sent to 2nd group

Commands associated in 2nd association group after a triple click. This parameter defines commands sent to devices associated in 2nd association group after a triple click.

Available settings:

0 - no action
1 - SWITCH ON
2 - SWITCH OFF
3 - SWITCH ON/OFF – alternately Values in the range 0 to 3 may be set.

The manufacturer defined default value is 0.

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

Parameter 15: Key Pressed 3 times – value of SWITCH ON sent to 2nd group

Value of SWITCH ON command sent in 2nd association group after a triple click This parameter defines value of SWITCH ON command sent to devices in 2nd association group after a triple click.

Available settings:

1-255 - sent value Values in the range 1 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 20: Key Pressed 1 time – command sent to 3rd group

Ssent to devices associated in 3rd association group after a single click. This parameter defines commands sent to devices associated in 3rd association group after a single click.

Available settings:

0 - no action
1 - SWITCH ON
2 - SWITCH OFF
3 - SWITCH ON/OFF – alternately Values in the range 0 to 3 may be set.

The manufacturer defined default value is 3.

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

Parameter 21: Key Pressed 1 time – value of SWITCH ON sent to 3rd group

Value of SWITCH ON command sent in 3rd association group after a single click. This parameter defines value of SWITCH ON command sent to devices in 3rd association group after a single click.

Available settings:

1-255 - sent value Values in the range 1 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 22: Key Pressed 2 times – command sent to 3rd group

Sent to associated in 3rd association group after a double click. This parameter defines commands sent to devices associated in 3rd association group after a double click.

Available settings:

0 - no action
1 - SWITCH ON
2 - SWITCH OFF
3 - SWITCH ON/OFF – alternately Values in the range 0 to 3 may be set.

The manufacturer defined default value is 1.

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

Parameter 23: Key Pressed 2 times – value of SWITCH ON sent to 3rd group

Value of SWITCH ON command sent in 3rd association group after a double click. This parameter defines value of SWITCH ON command sent to devices in 3rd association group after a double click.

Available settings:

1-255 - sent value Values in the range 1 to 255 may be set.

The manufacturer defined default value is 99.

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

Parameter 24: Key Pressed 3 times – command sent to 3rd group

Sent to devices associated in 3rd association group after a triple click. This parameter defines commands sent to devices associated in 3rd association group after a triple click.

Available settings:

0 - no action
1 - SWITCH ON
2 - SWITCH OFF
3 - SWITCH ON/OFF – alternately Values in the range 0 to 3 may be set.

The manufacturer defined default value is 0.

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

Parameter 25: Key Pressed 3 times – value of SWITCH ON sent to 3rd group

Value SWITCH ON command sent in 3rd association group after a triple click. This parameter defines value of SWITCH ON command sent to devices in 3rd association group after a triple click.

Available settings:

1-255 - sent value Values in the range 1 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 29: Key Held Down – command sent to 3rd group

Sent associated in 3rd association group after holding the button down. This parameter defines commands sent to devices associated in 3rd association group after holding the button down.

Available settings:

0 - no action
1 - START LEVEL CHANGE UP (brightening)
2 - START LEVEL CHANGE DOWN (dimming)
3 - START LEVEL CHANGE UP/DOWN (brightening/dimming) – alternately Values in the range 0 to 3 may be set.

The manufacturer defined default value is 3.

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

Parameter 30: Alarm frame triggers

Which actions result in sending alarm frames to 4th association group. Parameter determines which actions result in sending alarm frames to 4th association group.

Available settings:

1 - Key Pressed 1 time
2 - Key Pressed 2 times
4 - Key Pressed 3 times
8 - Key Pressed 4 times
16 - Key Pressed 5 times
32 - Key Held Down
64 - Key Released

Values of parameter 30 may be combined, e.g. 1+2=3 means that alarm frames will be sent after pressing the button once or twice. Values in the range 1 to 127 may be set.

The manufacturer defined default value is 127.

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

Wakeup Interval

The wakeup interval sets the period at which the device will listen for messages from the controller. This is required for battery devices that sleep most of the time in order to conserve battery life. The device will wake up at this interval and send a message to the controller to tell it that it can accept messages - after a few seconds, it will go back to sleep if there is no further communications.

This setting is defined in seconds. It is advisable not to set this interval too short or it could impact battery life. A period of 1 hour (3600 seconds) is suitable in most instances.

Note that this setting does not affect the devices ability to send sensor data, or notification events.

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

Wakeup Node

When sleeping devices wake up, they send a notification to a listening device. Normally, this device is the network controller, and normally the controller will set this automatically to its own address. In the event that the network contains multiple controllers, it may be necessary to configure this to a node that is not the main controller. This is an advanced setting and should not be changed without a full understanding of the impact.

This parameter has the configuration ID wakeup_node 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 FGPB101 supports 4 association groups.

Group 1: Lifeline

reports the device status and allows for assigning single device only (main controller by default) This group supports 1 nodes.

Group 2: On/Off

assigned to clicking the button and is used to turn on/off associated devices This group supports 5 nodes.

Group 3: Dimmer

is assigned to holding the button and is used to change level of associated devices This group supports 5 nodes.

Group 4: Alarm

assigned to clicking and/or holding the button (triggers are defined in parameter 30) and is used to send alarm frames to associated devices This group supports 5 nodes.

Technical Information

Endpoints

Endpoint 0

Command Class Comment
COMMAND_CLASS_NO_OPERATION_V1  
COMMAND_CLASS_BASIC_V1 Linked to BASIC
COMMAND_CLASS_CRC_16_ENCAP_V1  
COMMAND_CLASS_CENTRAL_SCENE_V1  
COMMAND_CLASS_CONFIGURATION_V1  
COMMAND_CLASS_ALARM_V1  
COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1  
COMMAND_CLASS_BATTERY_V1  
COMMAND_CLASS_WAKE_UP_V2  
COMMAND_CLASS_ASSOCIATION_V1  
COMMAND_CLASS_VERSION_V1  

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