| layout | title |
|---|---|
documentation |
FGFS101 - ZWave |
{% include base.html %}
This describes the Z-Wave device FGFS101, manufactured by Fibargroup with the thing type UID of fibaro_fgfs101_23_023.
This version of the device is limited to firmware versions above 23.23
The device is in the category of Sensor, defining Device used to measure something.
The FGFS101 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 FGFS101 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. Refer to the Wakeup Information section below for further information.
FIBARO Flood Sensor is a universal, Z-Wave Plus compatible, flood and temperature sensor. The device can be powered using battery, 12/24V DC power supply or both. Flood alarm is sent to the Z-Wave network devices or additionally to any external system through opening a NC contact using the external power supply.
The device has built in temperature sensor that allows to monitor ambient temperature. FIBARO Flood Sensor is designed to be placed on the floor or mounted on a wall (in this case Flood Sensor probes should be extended using addition wire). The device has a built-in visual LED indicator and an acoustic alarm.
In addition, the sensor is equipped with a tilt sensor reporting tilt or movement to the main controller e.g. when someone has taken the Sensor from its original location.
FIBARO Flood Sensor is sink-proof, which means it drifts on the water surface and keeps on sending alarm signal in case of substantial inundation of water.
- Open the cover.
- Place the Sensor within the direct range of your Z-Wave controller.
- Set the main controller in (security/non-security) add mode (see the controller’s manual).
- Quickly, three times press the TMP button.
Quickly, three times press the TMP button.
The FGFS101 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.
Quickly, three times press the TMP button.
The following table summarises the channels available for the FGFS101 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|---|---|---|---|---|
| Battery Level | battery-level | system.battery_level | Battery | Number |
| Alarm (flood) | alarm_flood | alarm_flood | Water | Switch |
| Binary Sensor (flood) | sensor_binary1 | sensor_binary | Switch | |
| Sensor (temperature) | sensor_temperature2 | sensor_temperature | Temperature | Number:Temperature |
| Alarm (tamper) | alarm_tamper2 | alarm_tamper | Switch |
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 system.battery-level channel is of type system.battery-level and supports the Number item and is in the Battery category.
This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%.
Internal pins (bottom of device).
Also trigger SENSOR_BINARY
Indicates if the flood alarm is triggered.
The alarm_flood channel is of type alarm_flood and supports the Switch item and is in the Water 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 |
This is for the "internal" 3 pins of the device.
IF using an extension wire a different channel might be triggered
Indicates if a sensor has triggered.
The sensor_binary1 channel is of type sensor_binary and 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 | Triggered |
| OFF | Untriggered |
Indicates the current temperature.
The sensor_temperature2 channel is of type sensor_temperature and supports the Number:Temperature item and is in the Temperature category.
Tilt device OR
Open Enclosure
triggers this alarm
Indicates if the tamper alarm is triggered.
The alarm_tamper2 channel is of type alarm_tamper and 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 |
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 | Additional delay after an alarm has ceased |
| 2 | Flooding Signals | LED indicator and acoustic alarm deactivation |
| 5 | Type of alarm frame for 1st group (FLOOD) | Command frame sent by the Sensor in case flooding |
| 7 | Forced Level of Dimming group 1 | Value of the parameter specifying linking to association group no. 1 |
| 9 | Alarm cancelling or turning a device off | Allows for deactivating device turn off and alarm cancellation functions |
| 10 | Temperature reading Interval | Interval between successive readings of temperature in seconds. |
| 12 | Insensitiveness to temperature changes. | Determines a minimum temperature change value (insensitivity level; def: 0,5C) |
| 13 | Alarm BROADCAST | Transmitting the alarm or control frame in 'broadcast' mode |
| 50 | Low temperature alarm threshold | The parameter stores a temperature value, below which LED indicator blinks. |
| 51 | High temperature alarm threshold | The parameter stores a temperature value, above which LED indicator blinks. |
| 61 | Low temperature alarm indicator colour | Default is blue (0x000000FF). |
| 62 | High temperature alarm indicator colour | Default is red (0x00FF0000). |
| 63 | Managing a LED indicator under standard operation | Parameter determines LED indicator’s operation |
| 73 | Temperature measurement compensation | Parameter stores a offset value from the current temperature |
| 74 | Alarm frame sent to 2nd Group activation | sensor’s vibrations alarm |
| 75 | Visual and audible alarms duration | Silence the Flood Sensor. |
| 76 | Visual and audible alarms retransmit | Period after which an alarm frame will be retransmitted |
| 77 | Flood sensor functionality turned off | Turning of the internal flood 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 |
Additional delay after an alarm has ceased Additional delay after an alarm has ceased. The parameter allows you to specify additional time, after which the alarm is cancelled once its violation 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.
LED indicator and acoustic alarm deactivation 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.
Command frame sent by the Sensor in case flooding 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.
Value of the parameter specifying linking to association group no. 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 no. 1. In the case of alarm frames the alarm priority is specified. Possible parameter settings. 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.
Allows for deactivating device turn off and alarm cancellation functions Allows for deactivating device turn off and alarm cancellation functions for the devices assigned to 1-st association group 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 0 (Alarm (flooding) cancellation inactive).
This parameter has the configuration ID config_9_1 and is of type INTEGER.
Interval between successive readings of temperature in seconds. Interval between successive readings of temperature from all sensors connected to the device 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.
Determines a minimum temperature change value (insensitivity level; def: 0,5C) 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.
Transmitting the alarm or control frame in 'broadcast' mode Transmitting the alarm or control frame in 'broadcast' mode (i.e. to all devices within range), 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 The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Broadcast inactive |
| 1 | Flood mode active, Tamper mode inactive |
| 2 | Tamper mode inactive, Tamper 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.
The parameter stores a temperature value, below which LED indicator blinks. 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. NOTE: The main controller does not interpret negative numbers 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.
The parameter stores a temperature value, above which LED indicator blinks.
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.
Default is blue (0x000000FF). 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.
Default is red (0x00FF0000). Default is red (0x00FF0000). 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 determines LED indicator’s 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 indicates the temperature (blink) |
| 2 | LED indicates temperature continuously |
The manufacturer defined default value is 2 (LED indicates temperature continuously).
This parameter has the configuration ID config_63_1 and is of type INTEGER.
Parameter stores a offset value from the current temperature 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.
sensor’s vibrations alarm (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.
Silence the Flood Sensor. The 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 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.
Period after which an alarm frame will be retransmitted Parameter determines a time period after which an alarm frame will be retransmitted. The value of 0 cancels an alarm frame retransmission. The value of 65535 means 'each 1 second'. NOTE: In case a time period set in this parameter is shorter th 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.
Turning of the internal flood sensor. 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 detection, reactions) |
| 1 | Built in flood sensor TURNED OFF |
The manufacturer defined default value is 0 (Default (flood detection, reactions)).
This parameter has the configuration ID config_77_1 and is of type INTEGER.
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.
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 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.
Association group 1 supports 5 nodes.
Association group 2 supports 5 nodes.
Association group 3 supports 1 node.
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_NO_OPERATION_V1 | |
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_SENSOR_BINARY_V1 | Linked to BASIC |
| COMMAND_CLASS_MULTI_CHANNEL_V2 | |
| COMMAND_CLASS_CONFIGURATION_V1 | |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1 | |
| COMMAND_CLASS_BATTERY_V1 | |
| COMMAND_CLASS_WAKE_UP_V1 | |
| COMMAND_CLASS_ASSOCIATION_V1 | |
| COMMAND_CLASS_VERSION_V1 | |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V1 | |
| COMMAND_CLASS_SENSOR_ALARM_V1 |
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_SENSOR_BINARY_V1 | Linked to BASIC |
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_SENSOR_MULTILEVEL_V1 | Linked to BASIC |
| 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.