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.

FGK101 Door Opening Sensor

This describes the Z-Wave device FGK101, manufactured by Fibargroup with the thing type UID of fibaro_fgk101_03_002. This version of the device is limited to firmware versions above 3.2

The device is in the category of Door, defining Door sensors.

FGK101 product image

The FGK101 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 FGK101 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 FGK101 -:

Channel Channel Id Category Item Type
Scene Number scene_number   Number
Binary Sensor sensor_binary Door Switch
Sensor (Temperature) sensor_temperature Temperature Number
Door Sensor sensor_door Door Contact
Tamper Alarm alarm_tamper   Switch
Battery Level battery-level Battery Number
Alarm (general) alarm_general Door Switch

Scene Number

Triggers when a scene button is pressed.

The scene_number channel supports the Number item.

Binary Sensor

Indicates if a sensor has triggered.

The sensor_binary 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
ON Triggered
OFF Untriggered

Sensor (Temperature)

Indicates the current temperature.

The sensor_temperature channel supports the Number item and is in the Temperature category. This is a read only channel so will only be updated following state changes from the device.

Door Sensor

Indicates if the door/window is open or closed.

The sensor_door channel supports the Contact 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 Contact item type -:

Value Label
OPEN Open
CLOSED Closed

Tamper Alarm

Indicates if the tamper alarm is triggered.

The alarm_tamper channel supports the Switch item. 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.

Alarm (general)

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

Device Configuration

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

Param Name Description
1 Operations mode Parameter defines device operation mode
2 Door/Window or alarm status Parameter defines state of the sensor when the magnet …
3 Visual LED indications This parameter defines events indicated by the visual …
4 Range test after double click Allows to enable activation of Z-Wave range test with …
10 2nd association group triggers Parameter defines events which result in sending on/off …
11 Commands sent to 2nd association group Command frames sent to devices added to the 2nd association group.
12 Value of ON command frame sent to 2nd association group Value of ON command frame sent to 2nd association group
13 Value of OFF command frame sent to 2nd association group The value of 0 turns OFF the device, 255 turns it ON.
14 Time delay of ON command frame Time period after which ON command frame will be sent.
15 Time delay of OFF command frame Time period after which OFF command frame will be sent.
20 Type of sent alarm frames Type of control frames transmitted to the main controller …
30 Delay of tamper alarm cancellation Time period after which a tamper alarm will be cancelled.
31 Reporting tamper alarm cancellation Reporting cancellation of tamper alarm to the controller …
50 Interval of temperature measurements This parameter defines how often the temperature will …
51 Temperature reports threshold This parameter defines the change of temperature in …
52 Interval of temperature reports This parameter determines how often the temperature …
53 Temperature offset The value to be added to the actual temperature, measured …
54 Temperature alarm reports Temperature alarms reported to the Z-Wave controller.
55 High temperature alarm threshold If temperature is higher than set value, overheat …
56 Low temperature alarm threshold If temperature is lower than the set value, underheat …
70 Scene activation functionality The device can trigger scenes using scene IDs assigned …
71 Alarm broadcast Settings for broadcasting ON/OFF commands, sensor …
72 Associations in Z-Wave network Security Mode This parameter defines how commands are sent in …
  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: Operations mode

Parameter defines device operation mode Available settings:

0 - Door/Window Sensor or external alarm sensor
1 - external button Values in the range 0 to 1 may be set.

The manufacturer defined default value is 0.

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

Parameter 2: Door/Window or alarm status

Parameter defines state of the sensor when the magnet … … is close. If the alarm sensor is connected, it determines the output type. Parameter inactive in external button mode (parameter 1 set to 1).

Available settings:

0 - Door/Window Sensor or external alarm sensor
1 - external button Values in the range 0 to 1 may be set.

The manufacturer defined default value is 0.

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

Parameter 3: Visual LED indications

This parameter defines events indicated by the visual … … LED indicator. Disabling events might extend battery life.

Available settings:

0 - no indications
1 - indication of opening/closing status change
(input IN)
2 - indication of wake up (1 x click or periodical)
4 - indication of device tampering Values in the range 0 to 6 may be set.

The manufacturer defined default value is 6.

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

Parameter 4: Range test after double click

Allows to enable activation of Z-Wave range test with … … double click of a TMP button.

Available settings:

0 - disabled
1 - enabled Values in the range 0 to 1 may be set.

The manufacturer defined default value is 0.

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

Parameter 10: 2nd association group triggers

Parameter defines events which result in sending on/off … … commands to devices added to the 2nd association group. These commands are sent alternately to switch the devices on and off. Commands represent the values of BASIC SET command frames. Parameter is inactive in external button mode (parameter 1 set to 1).

Available settings:

0 - switch after opening and closing
1 - switch after opening
2 - switch after closing Values in the range 0 to 2 may be set.

The manufacturer defined default value is 0.

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

Parameter 11: Commands sent to 2nd association group

Command frames sent to devices added to the 2nd association group. Available settings:

0 - ON
1 - OFF
2 - ON & OFF Values in the range 0 to 2 may be set.

The manufacturer defined default value is 2.

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

Parameter 12: Value of ON command frame sent to 2nd association group

Value of ON command frame sent to 2nd association group The value of 0 turns OFF the device, 255 turns it On. In case of associating the Dimmer or Roller Shutter module, values 1-99 allow to set
an associated device to a specifed level. Values in the range 0 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 13: Value of OFF command frame sent to 2nd association group

The value of 0 turns OFF the device, 255 turns it ON. In case of associating the Dimmer or Roller Shutter module, values 1-99 allow to set an associated device to a specified level

The value of 0 turns OFF the device, 255 turns it On. In case of associating the Dimmer or Roller Shutter module, values 1-99 allow to set
an associated device to a specifed level. Values in the range 0 to 255 may be set.

The manufacturer defined default value is 0.

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

Parameter 14: Time delay of ON command frame

Time period after which ON command frame will be sent.

Values in the range 0 to 32400 may be set.

The manufacturer defined default value is 0.

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

Parameter 15: Time delay of OFF command frame

Time period after which OFF command frame will be sent.

Values in the range 0 to 32400 may be set.

The manufacturer defined default value is 0.

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

Parameter 20: Type of sent alarm frames

Type of control frames transmitted to the main controller … … and 3rd association group “Alarm”. If an external sensor is connected to IN input, it is possible to choose its functionality. Otherwise it is recommended to set this parameter to default value.

Available settings:

0 - Door/Window Sensor (General Purpose Alarm)
1 - smoke sensor (Smoke Alarm)
2 - CO detector (CO Alarm)
3 - CO2 detector (CO2 Alarm)
4 - high temperature sensor (Heat Alarm)
5 - flood sensor (Water Alarm) Values in the range 0 to 5 may be set.

The manufacturer defined default value is 0.

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

Parameter 30: Delay of tamper alarm cancellation

Time period after which a tamper alarm will be cancelled.

Values in the range 0 to 32400 may be set.

The manufacturer defined default value is 5.

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

Parameter 31: Reporting tamper alarm cancellation

Reporting cancellation of tamper alarm to the controller … … and 5th association group.

Available settings:

0 - do not send tamper cancellation report
1 - send tamper cancellation report Values in the range 0 to 1 may be set.

The manufacturer defined default value is 1.

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

Parameter 50: Interval of temperature measurements

This parameter defines how often the temperature will … … be measured. The shorter the time, the more frequently the temperature will be measured, but the battery life will shorten.

Available settings:

0 - temperature measurements disabled
5-32400 - time in seconds Values in the range 0 to 32400 may be set.

The manufacturer defined default value is 300.

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

Parameter 51: Temperature reports threshold

This parameter defines the change of temperature in … …comparison with last reported, resulting in temperature report being sent to the main controller.

Available settings:

0 - temperature reports based on threshold disabled
1-300 - temperature threshold (0.1-30°C, 0.1°C step) Values in the range 0 to 300 may be set.

The manufacturer defined default value is 10.

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

Parameter 52: Interval of temperature reports

This parameter determines how often the temperature … … reports will be sent to the main controller.

Available settings:

0 - periodic temperature reports disabled
5-32400 - time in seconds Values in the range 0 to 32400 may be set.

The manufacturer defined default value is 0.

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

Parameter 53: Temperature offset

The value to be added to the actual temperature, measured … … by the sensor (temperature compensation).

Available settings:

-1000-1000 (-100-100°C, 0.1°C step) Values in the range -1000 to 1000 may be set.

The manufacturer defined default value is 0.

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

Parameter 54: Temperature alarm reports

Temperature alarms reported to the Z-Wave controller. Thresholds are set in parameters 55 and 56.

Available settings:

0 - temperature alarms disabled
1 - high temperature alarm
2 - low temperature alarm
3 - high and low temperature alarms enabled Values in the range 0 to 3 may be set.

The manufacturer defined default value is 0.

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

Parameter 55: High temperature alarm threshold

If temperature is higher than set value, overheat … … notification will be sent and high temperature scene will be triggered (if activated).

Available settings:

0-1000 (0-100°C, 0.1°C step) Values in the range 0 to 1000 may be set.

The manufacturer defined default value is 540.

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

Parameter 56: Low temperature alarm threshold

If temperature is lower than the set value, underheat … … notification will be sent and low temperature scene will be triggered (if activated).

Available settings:

-300-700 (-30-70°C, 0.1°C step) Values in the range -300 to 700 may be set.

The manufacturer defined default value is 40.

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

Parameter 70: Scene activation functionality

The device can trigger scenes using scene IDs assigned … … to different events. To deactivate all scenes set the value to 0. To activate all scenes set the value to 3903.

Available settings:

1 - [ID 10] opening door/window (single click)
2 - [ID 11] closing door/window (single click)
4 - [ID 12] holding
8 - [ID 13] releasing
16 - [ID 14] double click
32 - [ID 15] triple click
256 - [ID 50] high temperature - door/window
opened
512 - [ID 50] high temperature - door/window
closed
1024 - [ID 51] low temperature - door/window
opened
2048 - [ID 51] low temperature - door/window
closed Values in the range 0 to 2048 may be set.

The manufacturer defined default value is 0.

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

Parameter 71: Alarm broadcast

Settings for broadcasting ON/OFF commands, sensor … … alarm and tamper alarm. Value other than 0 means alarms are sent in Broadcast Mode, to all devices only within the range of the device. They are not repeated by the mesh network.

Available settings:

0 - broadcasts inactive
1 - ON/OFF commands broadcast active
2 - sensor alarm broadcast active
4 - tamper alarm broadcast active Values in the range 0 to 4 may be set.

The manufacturer defined default value is 0.

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

Parameter 72: Associations in Z-Wave network Security Mode

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 group “Lifeline”.

Available settings:

0 - none of the groups sent as secure
1 - 2nd group ”Control” sent as secure
2 - 3rd group ”Alarm” sent as secure
4 - 4th group “Sensor ZW3” sent as secure
8 - 5th group “Tamper ZW3” sent as secure

15 - (all) Values in the range 0 to 15 may be set.

The manufacturer defined default value is 15.

This parameter has the configuration ID config_72_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 FGK101 supports 5 association groups.

Group 1: Lifeline

This group supports 1 nodes.

Group 2: Control

This group supports 5 nodes.

Group 3: Alarm

This group supports 5 nodes.

Group 4: Sensor ZW3

This group supports 5 nodes.

Group 5: Tamper ZW3

This group supports 5 nodes.

Technical Information

Endpoints

Endpoint 0

Command Class Comment
COMMAND_CLASS_NO_OPERATION_V1  
COMMAND_CLASS_BASIC_V1  
COMMAND_CLASS_APPLICATION_STATUS_V1  
COMMAND_CLASS_SCENE_ACTIVATION_V1  
COMMAND_CLASS_SENSOR_BINARY_V1  
COMMAND_CLASS_SENSOR_MULTILEVEL_V5  
COMMAND_CLASS_CRC_16_ENCAP_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  
COMMAND_CLASS_SENSOR_ALARM_V1  

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