Skip to content

Latest commit

 

History

History
502 lines (330 loc) · 19 KB

fgwpb111_0_0.md

File metadata and controls

502 lines (330 loc) · 19 KB
layout title
documentation
FGWPB-111 - ZWave

{% include base.html %}

FGWPB-111 FIBARO Wall Plug

This describes the Z-Wave device FGWPB-111, manufactured by Fibargroup with the thing type UID of fibaro_fgwpb111_00_000.

The device is in the category of Power Outlet, defining Small devices to be plugged into a power socket in a wall which stick there.

FGWPB-111 product image

The FGWPB-111 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

FIBARO Wall Plug is a remotely controlled plug-in switch with the ability to measure power and energy consumption.

  • Compatible with type B sockets and plugs.
  • Compatible with any Z-Wave or Z-Wave+ Controller.
  • Supports Z-Wave network Security Modes: S0 with AES-128 encryption and S2 with PRNG-based encryption.
  • Extremely easy installation – simply plug the device into the mains socket.
  • Active power and energy consumption metering.
  • Equipped with USB charging port with power metering (only FGWPB-121).
  • Works as a Z-Wave signal repeater.
  • Current value of the load and operating mode are indicated by the multi-color LED frame.

Inclusion Information

  1. Plug the device into a socket nearby the main Z-Wave controller.
  2. The LED frame will glow red signaling not being added (reset or remove the device otherwise)
  3. Set the main controller into the adding mode (see the controller’s manual).
  4. Quickly, triple click the button located on the casing.
  5. If you are adding in S2 authenticated mode, type in the device pin code (underlined part of the public key available on the device or in the manual).
  6. Wait for the adding process to end.
  7. Successful adding will be confirmed by the Z-Wave controller’s message.

Exclusion Information

  1. Plug the device into a socket nearby the main Z-Wave controller.
  2. The LED frame will glow green signaling being added (removing is not necessary otherwise).
  3. Set the main controller in remove mode (see the controller's manual).
  4. Quickly, triple click the button located on the casing.
  5. Wait for the removing process to end.
  6. Successful removing will be confirmed by the Z-Wave controller’s message.

Channels

The following table summarises the channels available for the FGWPB-111 -:

Channel Name Channel ID Channel Type Category Item Type
Switch switch_binary switch_binary Switch Switch
Electric meter (watts) meter_watts meter_watts Energy Number
Electric meter (kWh) meter_kwh meter_kwh Energy Number
Alarm (power) alarm_power alarm_power Energy Switch
Alarm (system) alarm_system alarm_system Switch

Switch

Switch the power on and off.

The switch_binary channel is of type switch_binary and supports the Switch item and is in the Switch category.

Electric meter (watts)

Indicates the instantaneous power consumption.

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

Electric meter (kWh)

Indicates the energy consumption (kWh).

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

Alarm (power)

Indicates if a power alarm is triggered.

The alarm_power channel is of type alarm_power and supports the Switch item and is in the Energy 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 (system)

Indicates if a system alarm is triggered.

The alarm_system channel is of type alarm_system 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

Device Configuration

The following table provides a summary of the 21 configuration parameters available in the FGWPB-111. Detailed information on each parameter can be found in the sections below.

Param Name Description
2 PowerFailure How the Wall Plug will react in the event of power supply failure
3 Overload safety switch turn off the controlled device in case of exceeding the defined power.
11 PowerReporting Minimum change in active power consumption to trigger
12 EnergyReportingThreshold Energy reporting threshold
13 PeriodicPowerRpt Periodic power reporting
14 PeriodicEnergyRpt Periodic energy reporting
15 SelfConsumption Measuring energy consumed by the Wall Plug itself
21 UPValue UP value -On/Off (Power) association group (3)
22 DOWNvalue lower power threshold
23 ControlMode the way that 3rd association group devices are controlled
24 SwitchOn Command sent when physical button is pressed
25 SwitchOff Command sent when button turned off.
26 ThresholdUpCmd Command sent if power exceeds param 21
27 ThresholdDownCmd Command sent when power drops below threshold
30 ActiveAlarm Z-Wave network alarms to which the Wall Plug will respond
31 AlarmResponse how the Wall Plug will respond to alarms
32 AlarmDuration duration of alarm state
40 PwrLoadViolet maximum active power value causes the LED frame to flash violet
41 LEDwhenOn LED frame color when controlled device is on
42 LEDwhenOff LED frame color when controlled device is off
43 LEDwhenAlarm LED frame color at the Z-Wave network alarm detection

Parameter 2: PowerFailure

How the Wall Plug will react in the event of power supply failure After the power supply is back on, the Wall Plug can be restored to the previous state or remain switched off The following option values may be configured -:

Value Description
0 Off
1 Restore

The manufacturer defined default value is 1 (Restore).

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

Parameter 3: Overload safety switch

turn off the controlled device in case of exceeding the defined power. This function allows to turn off the controlled device in case of ex- ceeding the defined power.

Controlled device can be turned back on via button or sending a con- trol frame. By default this function is inactive. Values in the range 0 to 18000 may be set.

The manufacturer defined default value is 0.

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

Parameter 11: PowerReporting

Minimum change in active power consumption to trigger This parameter determines the minimum percentage change in active power consumption (in relation to the previously reported) that will result in sending new power report. Values in the range 0 to 100 may be set.

The manufacturer defined default value is 15.

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

Parameter 12: EnergyReportingThreshold

Energy reporting threshold This parameter determines the minimum change in energy consumption (in relation to the previously reported) that will result in sending a new report. Values in the range 0 to 500 may be set.

The manufacturer defined default value is 10.

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

Parameter 13: PeriodicPowerRpt

Periodic power reporting This parameter defines time period between independent reports sent when changes in power load have not been recorded or if changes are insignificant. By default reports are sent every hour. Values in the range 0 to 32400 may be set.

The manufacturer defined default value is 3600.

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

Parameter 14: PeriodicEnergyRpt

Periodic energy reporting This parameter defines time period between independent reports sent when changes in power load have not been recorded or if changes are insignificant. By default reports are sent every hour. Values in the range 0 to 32400 may be set.

The manufacturer defined default value is 3600.

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

Parameter 15: SelfConsumption

Measuring energy consumed by the Wall Plug itself This parameter determines whether power metering should include the amount of power consumed by the Wall Plug itself. Results are being added to the value of power consumed by controlled device. The following option values may be configured -:

Value Description
0 function inactive
1 function active

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

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

Parameter 21: UPValue

UP value -On/Off (Power) association group (3) upper power threshold, used in parameter 23. uP value cannot be lower than a value specified in parameter 22. Values in the range 100 to 18000 may be set.

The manufacturer defined default value is 500.

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

Parameter 22: DOWNvalue

lower power threshold Lower power threshold, used in parameter 23. DOWn value cannot be higher than a value specified in parameter 21. Values in the range 0 to 17900 may be set.

The manufacturer defined default value is 300.

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

Parameter 23: ControlMode

the way that 3rd association group devices are controlled This parameter defines the way that 3rd association group devices are controlled. Depends on the actual measured power (according to parameters 21 and 22 settings). The following option values may be configured -:

Value Description
1 Going Up
2 Going Down
3 Both Ways

The manufacturer defined default value is 3 (Both Ways).

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

Parameter 24: SwitchOn

Command sent when physical button is pressed The value of BASIC SET command frame sent to the devices associat- ed in 2nd group „On/Off (Button)” when turning the device On using the button. Values in the range 0 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 25: SwitchOff

Command sent when button turned off. The value of BASIC SET command frame sent to the devices associat- ed in 2nd group „On/Off (Button)” when turning the device OFF using the button. Values in the range 0 to 255 may be set.

The manufacturer defined default value is 0.

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

Parameter 26: ThresholdUpCmd

Command sent if power exceeds param 21 The value of BASIC SET command frame sent to the devices associat- ed in 3rd group „On/Off (Power)” if power exceeded value of param- eter 21. Values in the range 0 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 27: ThresholdDownCmd

Command sent when power drops below threshold The value of BASIC SET command frame sent to the devices associ- ated in 3rd group „On/Off (Power)” if power dropped below value of parameter 22. Values in the range 0 to 255 may be set.

The manufacturer defined default value is 0.

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

Parameter 30: ActiveAlarm

Z-Wave network alarms to which the Wall Plug will respond Define Z-Wave network alarms to which the Wall Plug will respond. The following option values may be configured -:

Value Description
1 general alarm
2 smoke alarm
4 CO Alarm
8 CO2 Alarm
16 High Temp Alarm
32 flood alarm
63 all

The manufacturer defined default value is 63 (all).

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

Parameter 31: AlarmResponse

how the Wall Plug will respond to alarms This parameter defines how the Wall Plug will respond to alarms (de- vice’s status change).

In case of values 1 or 2 the Wall Plug is operating normally and LED frame signals an alarm through time defined in parameter 32 or until the alarm is canceled.

In case of values 5 to 50 the Wall Plug does not report status change, power changes, ignores BASIC SET command frames. After time defined in parameter 32 or after the alarm cancellation, connected device is set to the previous state.

5-50 (0.5-5.0s, step 0.1s) - cyclically change device state with set period The following option values may be configured, in addition to values in the range 0 to 50 -:

Value Description
0 no reaction
1 turn connected device on
2 turn connected device off

The manufacturer defined default value is 0 (no reaction).

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

Parameter 32: AlarmDuration

duration of alarm state This parameter specifies the duration of alarm state. If a device send- ing an alarm frame through the Z-Wave network sets alarm duration as well, this settings are ignored. Values in the range 1 to 32400 may be set.

The manufacturer defined default value is 600.

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

Parameter 40: PwrLoadViolet

maximum active power value causes the LED frame to flash violet This parameter determines maximum active power value, which when exceeded, causes the LED frame to flash violet. Function is active only when parameter 41 is set to 1 or 2. Values in the range 1000 to 18000 may be set.

The manufacturer defined default value is 18000.

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

Parameter 41: LEDwhenOn

LED frame color when controlled device is on When set to 1 or 2, LED frame color will change depending on active power and parameter 40. Other colors are set permanently and do not depend on power consumption. The following option values may be configured -:

Value Description
0 illumination turned off completely
1 color changes smoothly depending on active power
2 color changes in steps depending on active power
3 white
4 red
5 green
6 blue
7 yellow
8 cyan
9 magenta

The manufacturer defined default value is 1 (color changes smoothly depending on active power).

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

Parameter 42: LEDwhenOff

LED frame color when controlled device is off This parameter defines the illumination color after turning off. The following option values may be configured -:

Value Description
0 illumination turned off completely
1 LED frame is illuminated with last color
3 white
4 red
5 green
6 blue
7 yellow
8 cyan
9 magenta

The manufacturer defined default value is 1 (LED frame is illuminated with last color).

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

Parameter 43: LEDwhenAlarm

LED frame color at the Z-Wave network alarm detection This parameter defines the illumination color in case of Z-Wave alarm. The following option values may be configured -:

Value Description
0 illumination turned off completely
1 no change in color
2 LED frame flashes red/blue/white
3 white
4 red
5 green
6 blue
7 yellow
8 cyan
9 magenta

The manufacturer defined default value is 2 (LED frame flashes red/blue/white).

This parameter has the configuration ID config_43_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 FGWPB-111 supports 3 association groups.

Group 1: Lifeline

The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. reports the device status and allows for assigning single device only

Association group 1 supports 1 node.

Group 2: OnOffButton

devices in this group will be switched on or off when relay status is changed using the but- ton

Association group 2 supports 50 nodes.

Group 3: OnOffPlugPower

devices in this group will be switched on or off depending on the current load of plugged device (uses Basic command class).

Association group 3 supports 50 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_SWITCH_BINARY_V1 Linked to BASIC
COMMAND_CLASS_METER_V3
COMMAND_CLASS_CRC_16_ENCAP_V1
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1
COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1
COMMAND_CLASS_ZWAVEPLUS_INFO_V1
COMMAND_CLASS_CONFIGURATION_V1
COMMAND_CLASS_ALARM_V8
COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1
COMMAND_CLASS_POWERLEVEL_V1
COMMAND_CLASS_PROTECTION_V2
COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1
COMMAND_CLASS_ASSOCIATION_V2
COMMAND_CLASS_VERSION_V2
COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3
COMMAND_CLASS_SECURITY_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.