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.

FGFS101 Flood Sensor

This describes the Z-Wave device FGFS101, manufactured by Fibargroup with the thing type UID of fibaro_fgfs101_00_000. This version of the device is limited to firmware versions below 3.0

The device is in the category of Sensor, defining Device used to measure something.

FGFS101 product image

The FGFS101 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 from other devices.

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 FGFS101 -:

Channel Channel Id Category Item Type
Binary Sensor sensor_binary Door Switch
Battery Level battery-level Battery Number
Alarm (general) alarm_general Door Switch
Alarm (water) sensor_flood   Switch
Binary Sensor 1 sensor_binary1 Door Switch
Sensor (temperature) 2 sensor_temperature2 Temperature Number

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

Alarm (water)

Indicates a flood sensor is activated.

The sensor_flood 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
ON Flood
OFF Ok

Binary Sensor 1

Indicates if a sensor has triggered.

The sensor_binary1 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) 2

Indicates the current temperature.

The sensor_temperature2 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.

Device Configuration

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

Param Name Description
1 Alarm Cancellation Delay Time period (in seconds) that an alarm will still be indicated after the alarm condition has ceased.
2 Acoustic and visual signals On / Off in case of flooding Parameter allows for LED indicator and acoustic alarm deactivation in case of flooding detection
5 Type of alarm frame sent to 1-st association group (FLOOD) Parameter determines a type of command frame sent by the Sensor in case flooding has been detected or cancelled
7 Forced Level of Dimming group 1 Value of the parameter specifying the forced level of dimming / opening sun blinds when comes ‘switch on’ / ‘open’ command to devices from association group 1.
9 Alarm cancelling or turning a device off (Basic) command frame deactivation Set to 0 to disable all-clear basic set & alarm frame generation. After flooding, device will keep reporting flooding even if flooding ceased.
10 Interval between successive readings of temperature sensors Interval between successive readings of temperature in seconds.
12 Insensitiveness to temperature changes. Determines a minimum temperature change value (insensitivity level; def: 0,5C), resulting in a temperature report being sent to the main controller, according to the Parameter 10 settings
13 Alarm BROADCAST Transmit the alarm or control frame in ‘broadcast’ mode. Information sent in this mode is not repeated by the mesh network.
50 Low temperature alarm threshold The parameter stores a temperature value (def. 15C), below which LED indicator blinks with a colour determined by a Parameter 61 settings. By default the LED indicator blinks blue.
51 High temperature alarm threshold The parameter stores a temperature value (def. 35C), above which LED indicator blinks with a colour determined by the Parameter 62 settings. By default the LED indicator blinks red
61 Low temperature alarm indicator colour Default is blue (0x000000FF).
62 High temperature alarm indicator colour Default is red (0x00FF0000). 65535 * Red + 256 * Green + Blue
63 Managing a LED indicator under standard operation Parameter determines LED indicator’s operation. Set to 0 turns the indicator off, saving a battery life
73 Temperature measurement compensation Parameter stores a temperature value to be added to or deducted from the current temperature measured by internal temperature sensor in order to compensate the difference between air temperature and temperature at the floor level
74 Alarm frame sent to 2-nd Association Group activation (MOVEMENT_TAMPER / BUTTON_TAMPER) The device is able to turn on alarms resulting from sensor’s vibrations e.g. when the sensor is moved, or the TMP button released. 2-nd Association Group alarms are not cancelled.
75 Visual and audible alarms duration Visual and audible alarm duration
76 Alarm frame / basic set frame retransmission time when flooding Parameter determines time period after which an alarm frame will be retransmitted. Value of 0 disables alarm frame retransmission.
77 Flood sensor functionality turned off Allows for turning of the internal flood sensor. Tamper and built in temperature sensor will remain active

Parameter 1: Alarm Cancellation Delay

Time period (in seconds) that an alarm will still be indicated after the alarm condition has ceased.

Values in the range 0 to 3600 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: Acoustic and visual signals On / Off in case of flooding

Parameter allows for LED indicator and acoustic alarm deactivation in case of flooding detection

The following option values may be configured -:

Value Description
0 Acoustic and visual alarms inactive
1 Acoustic alarm inactive, visual alarm active
2 Acoustic alarm active, visual alarm inactive
3 Acoustic and visual alarms active

The manufacturer defined default value is 3 (Acoustic and visual alarms active).

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

Parameter 5: Type of alarm frame sent to 1-st association group (FLOOD)

Parameter determines a type of command frame sent by the Sensor in case flooding has been detected or cancelled

The following option values may be configured -:

Value Description
0 ALARM WATER
255 BASIC_SET

The manufacturer defined default value is 255 (BASIC_SET).

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

Parameter 7: Forced Level of Dimming group 1

Value of the parameter specifying the forced level of dimming / opening sun blinds when comes ‘switch on’ / ‘open’ command to devices from association group 1.

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: Alarm cancelling or turning a device off (Basic) command frame deactivation

Set to 0 to disable all-clear basic set & alarm frame generation. After flooding, device will keep reporting flooding even if flooding ceased.

The following option values may be configured -:

Value Description
0 Alarm (flooding) cancellation inactive
1 Alarm (flooding) cancellation active

The manufacturer defined default value is 1 (Alarm (flooding) cancellation active).

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

Parameter 10: Interval between successive readings of temperature sensors

Interval between successive readings of temperature in seconds.

Values in the range 1 to 32767 may be set.

The manufacturer defined default value is 300.

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

Parameter 12: Insensitiveness to temperature changes.

Determines a minimum temperature change value (insensitivity level; def: 0,5C), resulting in a temperature report being sent to the main controller, according to the Parameter 10 settings

Values in the range 0 to 1000 may be set.

The manufacturer defined default value is 50.

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

Parameter 13: Alarm BROADCAST

Transmit the alarm or control frame in ‘broadcast’ mode. Information sent in this mode is not repeated by the mesh network. NOTE: If the broadcast mode of information transmission is activated for a given alarm, then the information is not relayed through the mesh network. It is only heard by directly reachable devices. The following option values may be configured -:

Value Description
0 Broadcast inactive
1 Flood broadcast mode active, Tamper broadcast mode inactive
2 Flood broadcast mode inactive, Tamper broadcast mode active
3 Flood and Tamper broadcast mode active

The manufacturer defined default value is 0 (Broadcast inactive).

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

Parameter 50: Low temperature alarm threshold

The parameter stores a temperature value (def. 15C), below which LED indicator blinks with a colour determined by a Parameter 61 settings. By default the LED indicator blinks blue. Negative numbers are encoded in U2 (two’s compliment) standard.

-1 actual temperature = 65535 reported

-10000 = 55536

-32768 = 32768

32767 = 32767 Values in the range -10000 to 10000 may be set.

The manufacturer defined default value is 1500.

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

Parameter 51: High temperature alarm threshold

The parameter stores a temperature value (def. 35C), above which LED indicator blinks with a colour determined by the Parameter 62 settings. By default the LED indicator blinks red

Values in the range -10000 to 10000 may be set.

The manufacturer defined default value is 3500.

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

Parameter 61: Low temperature alarm indicator colour

Default is blue (0x000000FF). NOTE: A main controller interprets colours as a sum of it component colours value. Each colours value is a number from 0 to 255. Eg: Indicated colour = 65536 * RED value + 256 * GREEN value + BLUE value Values in the range 0 to 16777215 may be set.

The manufacturer defined default value is 255.

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

Parameter 62: High temperature alarm indicator colour

Default is red (0x00FF0000). 65535 * Red + 256 * Green + Blue NOTE: A main controller interprets colours as a sum of it component colours value. Each colours value is a number from 0 to 255. Eg: Indicated colour = 65536 * RED value + 256 * GREEN value + BLUE value Values in the range 0 to 16777215 may be set.

The manufacturer defined default value is 16711680.

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

Parameter 63: Managing a LED indicator under standard operation

Parameter determines LED indicator’s operation. Set to 0 turns the indicator off, saving a battery life

The following option values may be configured -:

Value Description
0 LED indicator doesn’t indicate the temperature
1 LED indicator blinks temperature every measurement
2 LED indicator indicates the temperature continuously

The manufacturer defined default value is 2 (LED indicator indicates the temperature continuously).

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

Parameter 73: Temperature measurement compensation

Parameter stores a temperature value to be added to or deducted from the current temperature measured by internal temperature sensor in order to compensate the difference between air temperature and temperature at the floor level

Values in the range -10000 to 10000 may be set.

The manufacturer defined default value is 0.

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

Parameter 74: Alarm frame sent to 2-nd Association Group activation

(MOVEMENT_TAMPER / BUTTON_TAMPER) The device is able to turn on alarms resulting from sensor’s vibrations e.g. when the sensor is moved, or the TMP button released. 2-nd Association Group alarms are not cancelled.

The following option values may be configured -:

Value Description
0 Tamper alarms inactive
1 Button tamper alarm active
2 Movement tamper alarm active
3 Button and movement tampers alarm active

The manufacturer defined default value is 2 (Movement tamper alarm active).

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

Parameter 75: Visual and audible alarms duration

Visual and audible alarm duration User can silence the Flood Sensor. Because the Sensor’s alarm may last for a long time, it’s possible to turn off visual and audible alarm signaling to save battery. The parameter determines a time period after which alarm will become “quiet” - still active but the device will go into battery saving mode. Visual or acoustic alarm will be reactivated after time period specified in parameter 76. When alarm status ceases, alarm will be turned off immediately.

Value of 0 means visual and accoustic alarms are active indefinitely. In battery power mode sensor will never go to sleep which may shorten battery life significantly. Values in the range 0 to 65535 may be set.

The manufacturer defined default value is 0.

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

Parameter 76: Alarm frame / basic set frame retransmission time when flooding

Parameter determines time period after which an alarm frame will be retransmitted. Value of 0 disables alarm frame retransmission. NOTE: In case the time period set in this parameter is shorter than the one specified in parameter 75, the device will not quiet the alarm; it will remain active. Values in the range 0 to 65535 may be set.

The manufacturer defined default value is 0.

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

Parameter 77: Flood sensor functionality turned off

Allows for turning of the internal flood sensor. Tamper and built in temperature sensor will remain active

The following option values may be configured -:

Value Description
0 Default flood sensor operation (flood detection, reactions)
1 Built in flood sensor TURNED OFF

The manufacturer defined default value is 0 (Default flood sensor operation (flood detection, reactions)).

This parameter has the configuration ID config_77_1 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 FGFS101 supports 3 association groups.

Group 1: Flood Alarm

This group supports 5 nodes.

Group 2: Tilt & Tamper Sensors

This group supports 5 nodes.

Group 3: Device Status

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_MULTI_CHANNEL_V2| | | COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_BATTERY_V1| | | COMMAND_CLASS_ASSOCIATION_V1| | | COMMAND_CLASS_VERSION_V1| | | COMMAND_CLASS_SENSOR_ALARM_V1| Linked to BASIC|

Endpoint 1

| Command Class | Comment | |—————|———| | COMMAND_CLASS_BASIC_V0| | | COMMAND_CLASS_SENSOR_BINARY_V1| |

Endpoint 2

Command Class Comment
COMMAND_CLASS_BASIC_V0  
COMMAND_CLASS_SENSOR_MULTILEVEL_V0 Linked to BASIC

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