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/Window Sensor

This describes the Z-Wave device FGK101, manufactured by Fibargroup with the thing type UID of fibaro_fgk101_02_005. This version of the device is limited to firmware version 2.5

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

The Fibaro Door / Window Sensor is a wireless, battery powered, Z-Wave compatible reed sensor. Each time its two parts, i.e. the sensor’s body and a magnet separate, a radio signal is sent. In addition the Fibaro Door / Window Sensor supports one DS18B20 temperature sensor and has one potential free input. The Fibaro Door / Window Sensor is designed for use with scenes in home automation systems and everywhere else where information related to opening / closing of doors, windows, garage gates, etc. is needed.

Inclusion Information

To add the device to the Z-Wave network:

  1. Place the device within direct range of the Z-Wave controller.
  2. Make sure that Sensor’s cover is closed.
  3. Find the TMP button located on the underside of the device, which allows for proper inclusion.
  4. Set the main Z-Wave controller into the learning mode (see main controller’s operating manual).
  5. Quickly, triple click the TMP button.
  6. Wait for the adding process to end.
  7. Successful adding will be confirmed by the Z-Wave controller’s message.

Adding/removing will be confirmed by LED blinking. Fast blinking means that the inclusion process has not been successful.

Exclusion Information

To exclude the device from the Z-Wave network:

  1. Place the device within direct range of the Z-Wave controller.
  2. Make sure that Sensor’s cover is closed.
  3. Find the TMP button located on the underside of the device, which allows for proper inclusion.
  4. Set the main Z-Wave controller into exclusion mode (see main controller’s operating manual).
  5. Quickly, triple click the TMP button.
  6. Wait for the exclusion process to end.
  7. Successful removing will be confirmed by the Z-Wave controller’s message.

Wakeup Information

Waking up the Door/Window Sensor:

FIBARO Door/Window Sensor needs to be woken up to receive information about the new configuration from the controller, like parameters and associations.

To wake up the sensor manually triple click the TMP button located underside the casing.

Channels

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

Channel Channel Id Category Item Type
Binary Sensor sensor_binary Door Switch
Battery Level battery-level Battery Number
Alarm (smoke) alarm_smoke Door Switch

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

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 (smoke)

Indicates if a smoke is triggered.

The alarm_smoke 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 11 configuration parameters available in the FGK101. Detailed information on each parameter can be found in the sections below.

Param Name Description
1 Input IN alarm cancellation delay Additional delay after an alarm from input IN1 has ceased.
2 Status change signalled by LED  
3 Type of IN input Type of IN input
5 Type of control frame transmitted for group 1 Type of transmitted control frame for association group 1
7 Forced Level of Dimming group 1 Parameter for dimming/opening blinds
9 Enable/Disable transmission of frame cancelling alarm Enable/Disable transmission of frame cancelling alarm
10 Tamper alarm Enable/disable tamper alarm
12 Sensitivity to temperature changes Sensitivity to temperature changes
13 Transmitting the alarm or control frame broadcast Enabling/Disabling broadcast alarm for IN and TMP
14 Scene activation Enable/Disable scene functionality
15 DS18B20 Status of DS18B20 sensor
  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: Input IN alarm cancellation delay

Additional delay after an alarm from input IN1 has ceased. The parameter allows you to specify additional time, after which the input no. 1 alarm is cancelled once its violation has ceased. Values in the range 0 to 65535 may be set.

The manufacturer defined default value is 0.

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

Parameter 2: Status change signalled by LED

The following option values may be configured -:

Value Description
0 LED turned Off
1 LED turned On
255 No DS18B20 temperature sensor

The manufacturer defined default value is 1 (LED turned On).

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

Parameter 3: Type of IN input

Type of IN input Type of IN input The following option values may be configured -:

Value Description
0 INPUT_NC (Normal Close)
1 INPUT_NO (Normal Open)
2 INPUT_MONOSTABLE
3 INPUT_BISTABLE

The manufacturer defined default value is 0 (INPUT_NC (Normal Close)).

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

Parameter 5: Type of control frame transmitted for group 1

Type of transmitted control frame for association group 1 The parameter allows you to specify the type of an alarm frame or to force control frames transmission (BASIC_SET)

Available settings:
1 – ALARM SMOKE frame
2 – ALARM CO frame
3 – ALARM CO2 frame
4 – ALARM HEAT frame
5 – ALARM WATER frame
255 – Control frame BASIC_SET
Default setting: 255 The following option values may be configured -:

Value Description
1 ALARM SMOKE frame
2 ALARM CO frame
3 ALARM CO2 frame
4 ALARM HEAT frame
5 ALARM WATER frame
255 Control frame BASIC_SET

The manufacturer defined default value is 255 (Control frame BASIC_SET).

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

Parameter 7: Forced Level of Dimming group 1

Parameter for dimming/opening blinds Value of the parameter specifying the forced level of dimming/opening roller blinds when “switch on”/”open” commands are sent to devices from association group no.1. In case of alarm frames an alarm priority is specified.

Default value: 255

Possible parameter settings: (1 – 99) and 255

Value of 255 makes it possible to activate a device. In case of the Dimmer module it means activating the device and setting it to the previously stored condition, e.g. when Dimmer is set to 30%, deactivated and then reactivated using 255 commend, it will be automatically set to the previous condition i.e. 30% Values in the range 1 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 9: Enable/Disable transmission of frame cancelling alarm

Enable/Disable transmission of frame cancelling alarm Deactivating transmission of the alarm cancelling frame or the control frame deactivating the device (Basic).

It allows for disabling the function of deactivating the device and cancelling alarms for devices associated with IN input.

Available parameter settings:

0 – for association group no. 1 information is sent

1 – for association group no. 1 information is not sent.

Default value: 0

The parameter cancels alarms only. Information on alarm violation or activation commands for devices from association groups are always sent. The following option values may be configured -:

Value Description
0 for association group no. 1 information is sent
1 for association group no. 1 information is not sent

The manufacturer defined default value is 0 (for association group no. 1 information is sent).

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

Parameter 10: Tamper alarm

Enable/disable tamper alarm Enable/disable tamper alarm.

Available settings:
0 – Tamper alarm cancellation inactive
1 – Tamper alarm cancellation active
Default setting: 1 The following option values may be configured -:

Value Description
0 Tamper alarm cancellation inactive
1 Tamper alarm cancellation active

The manufacturer defined default value is 1 (Tamper alarm cancellation active).

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

Parameter 12: Sensitivity to temperature changes

Sensitivity to temperature changes The maximum acceptable difference between the last reported temperature and the current temperature read from the sensor. If the temperatures differ by the set value or more, a report with the current temperature value is sent to the device assigned to association group no. 3.

Default value: 8 [0.5 °C]

Available parameter settings: 0 – 255 [0 °C to 16 °C] [32 °F – 60.8 °F]

To set an appropriate parameter value use the following formula:

x = delta T x 16 - for Celsius

x = delta T x 80 / 9 - for Fahrenheit

x = parameter value

delta T – maximum acceptable temperature gradient in Celsius or Fahrenheit

If the value is set to 0: - if the wake-up interval is set to 255 seconds, temperature report will be sent according to the interval, - if the wake-up interval is set to over 255, temperature report will be sent each ca. 4 minutes. Values in the range 0 to 255 may be set.

The manufacturer defined default value is 8.

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

Parameter 13: Transmitting the alarm or control frame broadcast

Enabling/Disabling broadcast alarm for IN and TMP Sending an alarm or control frame (for IN input, depending on parameter no.5 value), and TMP button alarm frame. The frame is sent in “broadcast” mode, i.e. to all devices within range - information sent in this mode is not repeated by the mesh network.

Default value: 0

Available parameter settings:

0 – IN and TMP Broadcast mode inactive,

1 – IN broadcast mode active, TMP broadcast mode inactive

2 – IN broadcast mode inactive, TMP broadcast mode active

3 – IN and TMP broadcast mode active The following option values may be configured -:

Value Description
0 IN and TMP Broadcast mode inactive
1 IN broadcast mode active, TMP broadcast mode inactive
2 IN broadcast mode inactive, TMP broadcast mode active
3 IN and TMP broadcast mode active

The manufacturer defined default value is 0 (IN and TMP Broadcast mode inactive).

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

Parameter 14: Scene activation

Enable/Disable scene functionality The device offers the possibility of sending commands compatible with Command class scene activation. Information is sent to devices assigned to association group no. 3

Available settings:
0 – functionality deactivated
1 – functionality activated
Default setting: 0

Controllers such as the Home Center 2 are able to interpret such commands and based on these commands activate scenes, to which specific scene IDs have been assigned. The user may expand the functionality of a button connected to IN input by distinguishing the sequence of it being pushed. For example: double click would trigger the “goodnight” scene and triple click would trigger the “morning” scene. To fully use the possibilities offered by the parameter no.14 it is recommended to use a momentary or a toggle switch (parameter no.3).

Scene ID is determined in the following manner:
IN input:
Switch from “off” to “on” ID10
Switch from “on” to “off” ID11
Remaining IDs are recognized correctly if the value of parameter no.3 was set to 2
Holding down ID12
Releasing ID13
Double click ID14
Triple click ID15 The following option values may be configured -:

Value Description
0 Disabled
1 Enabled

The manufacturer defined default value is 0 (Disabled).

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

Parameter 15: DS18B20

Status of DS18B20 sensor The parameter value is automatically sent to the association group III if the connected sensor DS18B20 four times mistakenly read the temperature. In case of Wake Up Interval set for 4000 seconds temperature sensor will be checked every 5 minutes. The following option values may be configured -:

Value Description
0 DS18B20 is working properly
1 DS18B20 is not working properly
255 No DS18B20 temperature sensor

The manufacturer defined default value is 0 (DS18B20 is working properly).

This parameter has the configuration ID config_15_1 and is of type INTEGER. This is a read only parameter.

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 3 association groups.

Group 1: Input IN1

This group supports 5 nodes.

Group 2: TMP Button

This group supports 5 nodes.

Group 3: Condition

This group supports 1 nodes.

Technical Information

Endpoints

Endpoint 0

Command Class Comment
COMMAND_CLASS_NO_OPERATION_V1  
COMMAND_CLASS_BASIC_V1  
COMMAND_CLASS_SENSOR_BINARY_V1  
COMMAND_CLASS_CRC_16_ENCAP_V1  
COMMAND_CLASS_CONFIGURATION_V1  
COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1  
COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1  
COMMAND_CLASS_BATTERY_V1  
COMMAND_CLASS_WAKE_UP_V1  
COMMAND_CLASS_ASSOCIATION_V2  
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.