Skip to content

Latest commit

 

History

History
executable file
·
480 lines (327 loc) · 18.6 KB

fgbs001_0_0.md

File metadata and controls

executable file
·
480 lines (327 loc) · 18.6 KB
layout title
documentation
FGBS001 - ZWave

{% include base.html %}

FGBS001 Universal Binary Sensor

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

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

FGBS001 product image

The FGBS001 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 between other devices in the mesh network.

Overview

The Universal Binary Sensor is a wireless module that makes it possible to improve the functionality of any sensor with a binary output by allowing it to communicate with Z-WAVE.
The module allows for wireless communication between the system and the DS18B20 temperature sensors. The device can service up to two binary sensors and up to four DS18B20 temperature sensors.

Inclusion Information

The Fibaro Sensor is added to the network by quickly pressing the B button three times (the button is located in the center of the device).

Note: Every time when any changes are made to the configuration of TP and TD lines (1-wire), e.g. when DS18B20 sensor(s) is (are) included/excluded, it is necessary to execute the procedure of exclusion and repeated inclusion of the sensor module to the central hub. It should be remembered that the system shall enter into the programming mode only once all the connected sensors have been detected (about 10 s).

Exclusion Information

The Fibaro Sensor is removed from the network by quickly pressing the B button three times (the button is located in the center of the device).

Channels

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

Channel Name Channel ID Channel Type Category Item Type
Scene Number scene_number scene_number Number
Binary Sensor 1 sensor_binary1 sensor_binary Switch
Alarm 1 alarm_general1 alarm_general Alarm Switch
Binary Sensor 2 sensor_binary2 sensor_binary Switch
Alarm 2 alarm_general2 alarm_general Alarm Switch
Temperature 1 sensor_temperature3 sensor_temperature Temperature Number:Temperature
Temperature 2 sensor_temperature4 sensor_temperature Temperature Number:Temperature
Temperature 3 sensor_temperature5 sensor_temperature Temperature Number:Temperature
Temperature 4 sensor_temperature6 sensor_temperature Temperature Number:Temperature

Scene Number

Triggers when a scene button is pressed.

The scene_number channel is of type scene_number and supports the Number item.

Binary Sensor 1

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

Alarm 1

Indicates if an alarm is triggered.

The alarm_general1 channel is of type alarm_general and supports the Switch item and is in the Alarm 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

Binary Sensor 2

Indicates if a sensor has triggered.

The sensor_binary2 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

Alarm 2

Indicates if an alarm is triggered.

The alarm_general2 channel is of type alarm_general and supports the Switch item and is in the Alarm 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

Temperature 1

Indicates the current temperature.

The sensor_temperature3 channel is of type sensor_temperature and supports the Number:Temperature item and is in the Temperature category.

Temperature 2

Indicates the current temperature.

The sensor_temperature4 channel is of type sensor_temperature and supports the Number:Temperature item and is in the Temperature category.

Temperature 3

Indicates the current temperature.

The sensor_temperature5 channel is of type sensor_temperature and supports the Number:Temperature item and is in the Temperature category.

Temperature 4

Indicates the current temperature.

The sensor_temperature6 channel is of type sensor_temperature and supports the Number:Temperature item and is in the Temperature category.

Device Configuration

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

Param Name Description
1 IN1 Alarm Cancellation Delay Input I alarm cancellation delay.
2 IN2 Alarm Cancellation Delay Input 2 alarm cancellation delay.
3 Type of input no. 1 Type of input no. 1, what the input 1 will report if no contact is made
4 Type of input no. 2 Type of input no. 2, what the input 2 will report if no contact is made
5 Type of control frame for association group 1 Type of transmitted control frame for association group 1.
6 Type of control frame for association group 2 Type of transmitted control frame for association group 2
7 Forced Level of Dimming group 1 Value of the parameter specifying the forced levels.
8 Forced Level of Dimming group 2 Value of the parameter specifying forced levels.
9 Deactivate transmission of frame canceling alarm Deactivating transmission of the frame cancelling the alarm
10 Interval between readings of temperature sensors Interval between successive readings of temperature sensors
11 Interval betw. forcing to send report for temp. The forced report is sent immediately after ...
12 Insensitiveness to temperature changes. This is the maximum acceptable difference between
13 Transmitting alarm/control frame broadcast mode Transmitting the alarm or control frame in 'broadcast' mode
14 Scene activation Enable/Disable scene functionality.

Parameter 1: IN1 Alarm Cancellation Delay

Input I 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: IN2 Alarm Cancellation Delay

Input 2 alarm cancellation delay. Additional delay after an alarm from input IN2 has ceased. The parameter allows you to specify additional time, after which the input no. 2 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_2_2 and is of type INTEGER.

Parameter 3: Type of input no. 1

Type of input no. 1, what the input 1 will report if no contact is made

The following option values may be configured -:

Value Description
0 NO (Normal Open)
1 NC (Normal Close)
2 MONOSTABLE
3 BISTABLE

The manufacturer defined default value is 1 (NC (Normal Close)).

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

Parameter 4: Type of input no. 2

Type of input no. 2, what the input 2 will report if no contact is made

The following option values may be configured -:

Value Description
0 NO (Normal Open)
1 NC (Normal Close)
2 MONOSTABLE
3 BISTABLE

The manufacturer defined default value is 1 (NC (Normal Close)).

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

Parameter 5: Type of control frame for association group 1

Type of transmitted control frame for association group 1. Activated via input IN1. The parameter allows to specify the type of alarm frame or to force transmission of control commands (BASIC_SET) The following option values may be configured -:

Value Description
0 ALARM GENERIC
1 ALARM SMOKE
2 ALARM CO
3 ALARM CO2
4 ALARM HEAT
5 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 6: Type of control frame for association group 2

Type of transmitted control frame for association group 2 Activated via input IN2. The parameter allows to specify the type of alarm frame or to force transmission of control commands (BASIC_SET) The following option values may be configured -:

Value Description
0 ALARM GENERIC
1 ALARM SMOKE
2 ALARM CO
3 ALARM CO2
4 ALARM HEAT
5 ALARM WATER
255 BASIC_SET

The manufacturer defined default value is 255 (BASIC_SET).

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

Parameter 7: Forced Level of Dimming group 1

Value of the parameter specifying the forced levels. Value of the parameter specifying the forced levels 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: (1 – 99) and 255
Value of 255 makes it possible to activate the device when using
the Dimmer module it means activating the device and setting it to
the previous stored condition, e.g. when Dimmer is set to 30%, then
deactivated, and then reactivated using command 255, it will
automatically be 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 8: Forced Level of Dimming group 2

Value of the parameter specifying forced levels. 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. 2.
In the case of alarm frames the alarm priority is specified.
Default value: 255
Possible parameter settings:
(1 – 99) and 255
Value of 255 makes it possible to activate the device; when using of
the Dimmer module it means activating the device and setting it to
the previous stored condition, e.g. when Dimmer is set to 30%, then
deactivated, and then reactivated using command 255, it will
automatically be 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_8_1 and is of type INTEGER.

Parameter 9: Deactivate transmission of frame canceling alarm

Deactivating transmission of the frame cancelling the alarm or the
control frame deactivating the device (Basic). It allows for disabling
the deactivation function or the alarm cancellation function for
devices associated with the appropriate input of the Fibaro Sensor.
Default value: 0, in the case of association group no. 1 and 2 the
information is sent
Possible parameter settings:
0 – in the case of association group no. 1 and 2 the information is
sent
1 – in the case of association group no. 1 the information is sent. In
the case of association group no. 2 the information is not sent.
2 – in the case of association group no. 1 the information is not
sent. In the case of association group no. 2 the information is sent.
NOTE: Information concerning alarm violation or activation
commands for devices from association groups are always
sent. The following option values may be configured -:

Value Description
0 Groups 1 and 2 sent
1 Group 1 sent, Group 2 not sent.
2 Group 1 not sent, Group 2 sent.

The manufacturer defined default value is 0 (Groups 1 and 2 sent).

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

Parameter 10: Interval between readings of temperature sensors

Interval between successive readings of temperature sensors  from all sensors connected to the device in seconds. Note: taking temperature readings from the sensor does not result in sending a temperature condition report to the central hub. Values in the range 1 to 255 may be set.

The manufacturer defined default value is 20.

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

Parameter 11: Interval betw. forcing to send report for temp.

The forced report is sent immediately after ... ... the next reading of temperature from the sensor, irrespective of the settings
of parameter no. 12.
Default value: 200 s
Possible parameter settings:
0 – 255 s
0 – deactivating the function
Note: Frequent sending of temperature condition reports is
reasonable when the sensor is located somewhere where can
occure rapid changes of ambient temperature. In other cases
it is recommended to leave the parameter set to the default
value. Values in the range 1 to 255 may be set.

The manufacturer defined default value is 200.

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

Parameter 12: Insensitiveness to temperature changes.

This is the maximum acceptable difference between  the last reported temperature and the current temperature taken from the sensor. If the temperatures differ by the set value or more, then a report with the current temperature value is sent to the device 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 alarm/control frame 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 channel, then transmission of
information in “singlecast” mode to devices assigned to the
association group of this channel is deactivated. The following option values may be configured -:

Value Description
0 IN1 and IN2 Broadcast inactive
1 IN1 mode active, Sensor 2 mode inactive
2 IN1 mode inactive, Sensor 2 mode active
3 INI and IN2 broadcast mode active

The manufacturer defined default value is 0 (IN1 and IN2 Broadcast 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. The following option values may be configured -:

Value Description
0 Scenes disabled
1 Scenes enabled

The manufacturer defined default value is 0 (Scenes disabled).

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

Group 1: Input 1

Association group 1 supports 5 nodes.

Group 2: Input 2

Association group 2 supports 5 nodes.

Group 3: Controller Updates

Reports on the condition of the device

Association group 3 supports 1 node.

Technical Information

Endpoints

Endpoint 0

Command Class Comment
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SCENE_ACTIVATION_V1
COMMAND_CLASS_SENSOR_BINARY_V1 Linked to BASIC
COMMAND_CLASS_MULTI_CHANNEL_V2
COMMAND_CLASS_CONFIGURATION_V1
COMMAND_CLASS_ASSOCIATION_V1
COMMAND_CLASS_VERSION_V1

Endpoint 1

Command Class Comment
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SENSOR_BINARY_V1 Linked to BASIC
COMMAND_CLASS_SENSOR_ALARM_V1

Endpoint 2

Command Class Comment
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SENSOR_BINARY_V1 Linked to BASIC
COMMAND_CLASS_SENSOR_ALARM_V1

Endpoint 3

Command Class Comment
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SENSOR_MULTILEVEL_V1

Endpoint 4

Command Class Comment
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SENSOR_MULTILEVEL_V1

Endpoint 5

Command Class Comment
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SENSOR_MULTILEVEL_V1

Endpoint 6

Command Class Comment
COMMAND_CLASS_SENSOR_MULTILEVEL_V1

Documentation Links


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