Skip to content

Latest commit

 

History

History
639 lines (416 loc) · 26.3 KB

fgwp102_3_2.md

File metadata and controls

639 lines (416 loc) · 26.3 KB
layout title
documentation
FGWP102 - ZWave

{% include base.html %}

FGWP102 Metered Wall Plug Switch

This describes the Z-Wave device FGWP102, manufactured by Fibargroup with the thing type UID of fibaro_fgwp102_03_002. This version of the device is limited to firmware versions above 3.2

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.

FGWP102 product image

The FGWP102 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 universal, Z-Wave Plus compatible, remotely controlled outlet adapter. This device may be applied wherever you want to control electrical devices with up to 2500W load.

The Wall Plug is equipped with a power and energy metering function. It uses a LED ring to visualize the current load with colour changing illumination and operating mode. This is the smallest and most attractive device of this type available in the world.

The Wall Plug may be operated using the B-button located on its casing or via any Z-Wave compatible controller.

Inclusion Information

To add the device to the Z-Wave network:

  1. Plug the device into a socket nearby the main Z-Wave controller.
  2. The LED ring will glow red signalling not being added (reset or remove the device otherwise).
  3. Set the main controller in (security/non-security) add mode (see the controller’s manual).
  4. Quickly, triple click the B-button located on the casing.
  5. Wait for the adding process to end.
  6. Successful adding will be confirmed by the Z-Wave controller’s message.

Exclusion Information

To remove the device from the Z-Wave network:

  1. Plug the device into a socket nearby the main Z-Wave controller.
  2. The LED ring will glow green signalling being added (removing is not necessary otherwise).
  3. Set the main controller into remove mode (see the controller’s manual).
  4. Quickly, triple click the B-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 FGWP102 -:

Channel Name Channel ID Channel Type Category Item Type
Switch switch_binary switch_binary Switch Switch
Sensor (power) sensor_power sensor_power Energy Number
Electric meter (watts) meter_watts meter_watts Energy Number
Electric meter (kWh) meter_kwh meter_kwh Energy Number
Reset the total power consumption meter_reset meter_reset Energy Switch
LED ring colour when device is on config_decimal config_decimal Number
LED ring colour when device is off config_decimal config_decimal Number
Alarm (power) alarm_power alarm_power Energy Switch

Switch

Switch the power on and off.

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

Sensor (power)

Indicates the energy consumption (kWh).

The sensor_power channel and is of type sensor_power 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 (watts)

Indicates the instantaneous power consumption.

The meter_watts channel and 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 and 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.

Reset the total power consumption

Reset the meter.

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

LED ring colour when device is on

Generic class for configuration parameter.

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

LED ring colour when device is off

Generic class for configuration parameter.

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

Alarm (power)

Indicates if a power alarm is triggered.

The alarm_power channel and 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

Device Configuration

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

Param Name Description
1 “Always On” mode Will turn on connected device permanently
2 Remember device status before the power failure determines how the Wall Plug will react in the event of power supply failure
3 Overload safety switch allows to turn off the controlled device in case of exceeding the defined power.
10 High priority power report minimum percentage change in active power
11 Standard power report minimum percentage change in active power
12 Power reporting interval defines the time interval of sending at most 5 standard power reports
13 Energy reporting threshold specifies the minimum change in energy consumption
14 Power and energy periodic reports defines time period between independent reports sent
15 Measuring energy consumed by the Wall Plug itself determines whether power metering should include the amount of power
20 „On/Off (Button)” association group (2) Control of „On/Off (Button)” association group (2) devices
21 DOWN value - association group (3) DOWN value - „On/Off (Power)” for association group (3)
22 UP value - association group (3) UP value - „On/Off (Power)” for association group (3)
23 The response after exceeding defined power values defines the way that 3rd association group devices are controlled.
24 SWITCH ON value - „On/Off” association groups SWITCH ON value - „On/Off” association groups
30 Active alarms Define Z-Wave network alarms to which the Wall Plug will respond
31 Response to alarm frames defines how the Wall Plug will respond to alarms
32 Alarm state duration specifies the duration of alarm state
40 Power load for violet colour determines maximum active power value
41 LED ring colour (device is ON) LED ring colour when controlled device is on
42 LED ring colour (device is OFF) LED ring colour when controlled device is off
43 LED ring colour (alarm detection) LED ring colour at the Z-Wave network alarm detection
50 Associations in Z-Wave network security mode defines how commands are sent in specified association groups

Parameter 1: “Always On” mode

Will turn on connected device permanently In this mode Wall Plug will turn on connected device permanently and will stop reacting to attempts of turning it off (through Z-Wave network or pushing the B-button).

“Always On” function turns the Wall Plug into a power and energy meter. Connected device will not be turned off upon receiving an alarm frame from another Z-Wave device (parameter 31 will be ignored).

In “Always on” mode, connected device may be turned off after exceeding the power defined in parameter 3 or in case of detecting current greater than 110% of rated current. In such cases, connected device can be turned on again by pushing the B-button or sending a control frame. By default, overload protection is inactive. The following option values may be configured -:

Value Description
0 function inactive
1 function activated

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

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

Parameter 2: Remember device status before the power failure

determines how the Wall Plug will react in the event of power supply failure This parameter determines how the Wall Plug will react in the event of power supply failure (e.g. power outage or taking out from the electrical outlet).

After the power supply is back on, the Wall Plug can be restored to previous state or remain switched off.

This parameter is ignored in „Always On” mode - the device automatically turns ON after plugging it into the socket. The following option values may be configured -:

Value Description
0 device remains switched off
1 Remember state before power failure

The manufacturer defined default value is 1 (Remember state before power failure).

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

Parameter 3: Overload safety switch

allows to turn off the controlled device in case of exceeding the defined power. This function allows to turn off the controlled device in case of exceeding the defined power. Controlled device will be turned off even if “Always On” function is active (parameter 1).

Controlled device can be turned back on via B-button or sending a control frame. By default this function is inactive.

10-30000 (1.0-3000.0W, step 0.1W) - power threshold The following option values may be configured, in addition to values in the range 10 to 30000 -:

Value Description
0 function inactive

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

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

Parameter 10: High priority power report

minimum percentage change in active power This parameter determines the minimum percentage change in active power that will result in sending power report to the main controller with the highest priority in the Z-Wave network.

By default, the Wall Plug immediately sends the power report if the power load changes by 80%.

1-99 - power change in percent

100 - reports are disabled Values in the range 1 to 100 may be set.

The manufacturer defined default value is 80.

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

Parameter 11: Standard power report

minimum percentage change in active power This parameter determines the minimum percentage change in active power that will result in sending power report to the main controller

Compared to parameter 10, the maximum number of reports sent is reduced (parameter 12) to 5 in a specified time interval. In addition, the reports are not sent in mode, which may result in overloading the Z-Wave network.

By default changes in power load may be reported up to 5 times per 30 seconds, when power load changes by 15%. Values in the range 1 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: Power reporting interval

defines the time interval of sending at most 5 standard power reports This parameter defines the time interval of sending at most 5 standard power reports when the power changes by the value set in parameter 11. The higher the value of parameter 12, the fewer reports the device will send.

Settings in second

Default: 30s Values in the range 5 to 600 may be set.

The manufacturer defined default value is 30.

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

Parameter 13: Energy reporting threshold

specifies the minimum change in energy consumption This parameter specifies the minimum change in energy consumption (in relation to the previously reported), that will result in sending a new report.

0 - energy reports inactive
1-500 (0.01-5kWh, step 0.01kWh) - threshold

Default: 10 (0.1kWh) The following option values may be configured, in addition to values in the range 0 to 500 -:

Value Description
0 energy reports inactive

The manufacturer defined default value is 10.

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

Parameter 14: Power and energy periodic reports

defines time period between independent reports sent 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.

Default: 3600 second (1h) The following option values may be configured, in addition to values in the range 5 to 32400 -:

Value Description
0 periodic reports inactive

The manufacturer defined default value is 3600.

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

Parameter 15: Measuring energy consumed by the Wall Plug itself

determines whether power metering should include the amount of power 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 activated

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

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

Parameter 20: „On/Off (Button)” association group (2)

Control of „On/Off (Button)” association group (2) devices Controlling devices with the B-Button. This parameter is inactive in “Always On” mode (parameter 1).
Control as the Wall Plug:

  • switching the Wall Plug on – switch the devices on (parameter 24)
    switching the Wall Plug off – switch the devices off (parameter 24)

Control opposite to the Wall Plug:

  • switching the Wall Plug on – switch the devices off
  • switching the Wall Plug off – switch the devices on The following option values may be configured -:
Value Description
0 control as the Wall Plug
1 control opposite to the Wall Plug

The manufacturer defined default value is 0 (control as the Wall Plug).

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

Parameter 21: DOWN value - association group (3)

DOWN value - „On/Off (Power)” for association group (3) Lower power threshold, used in parameter 23. DOWN value cannot be higher than a value specified in parameter 22.

Setting: 0-24900 (0.0-2490.0W, step 0.1W)

Default: 300 (30W) Values in the range 0 to 24900 may be set.

The manufacturer defined default value is 300.

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

Parameter 22: UP value - association group (3)

UP value - „On/Off (Power)” for association group (3) Upper power threshold, used in parameter 23. UP value cannot belower than a value specified in parameter 21.

Available settings: 100-25000 (10.0-2500.0W, step 0.1W)
Default setting: 500 (50W) Values in the range 100 to 25000 may be set.

The manufacturer defined default value is 500.

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

Parameter 23: The response after exceeding defined power values

defines 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 (as parameters 21 and 22 settings). The following option values may be configured -:

Value Description
1 turn the associated devices ON (DOWN)
2 turn the associated devices OFF (DOWN)
3 turn the associated devices ON (UP)
4 turn the associated devices OFF (UP)
5 combination of 1 and 4
6 combination of 2 and 3

The manufacturer defined default value is 6 (combination of 2 and 3).

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

Parameter 24: SWITCH ON value - „On/Off” association groups

SWITCH ON value - „On/Off” association groups The value of BASIC SET command frame sent to the devices associated in „On/Off” association groups (2, 3).

„On/Off (Button)” association group - in accordance with parameter 20.
„On/Off (Power)” association group - in accordance with parameter 23.

Available settings: 0-99 or255

Default setting: 255 The following option values may be configured, in addition to values in the range 0 to 255 -:

Value Description
255 Default

The manufacturer defined default value is 255 (Default).

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

Parameter 30: Active alarms

Define Z-Wave network alarms to which the Wall Plug will respond Available settings:

  • 1 - general alarm
  • 2 - smoke alarm
  • 4 - CO alarm
  • 8 - CO2 alarm
  • 16 - high temperature alarm
  • 32 - flood alarm
  • 63 - All The following option values may be configured -:
Value Description
1 general alarm
2 smoke alarm
4 CO alarm
8 CO2 alarm
16 high temperature 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: Response to alarm frames

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

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

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.

Available settings: 0 - no reaction,

  • 1 - turn connected device on
  • 2 - turn connected device off
  • 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 5 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: Alarm state duration

specifies the duration of alarm state This parameter specifies the duration of alarm state. If a device sending an alarm frame through the Z-Wave network sets alarm duration as well, this settings are ignored.

Available settings: 1-32400 (in seconds)
Default setting: 600 (10min) 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: Power load for violet colour

determines maximum active power value This parameter determines maximum active power value, which when exceeded, causes the LED ring flash violet. Function is active only when parameter 41 is set to 1 or 2.

Available settings: 1000-30000 (100.0-3000.0W, step 0.1W)
Default setting: 25000 (2500W) Values in the range 1000 to 30000 may be set.

The manufacturer defined default value is 25000.

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

Parameter 41: LED ring colour (device is ON)

LED ring colour when controlled device is on When set to 1 or 2, LED ring colour will change depending on active power and parameter 40. Other colours 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 colour changes depending on active power
2 colour 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 (colour changes depending on active power).

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

Parameter 42: LED ring colour (device is OFF)

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

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

The manufacturer defined default value is 0 (illumination turned off completely).

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

Parameter 43: LED ring colour (alarm detection)

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

Value Description
0 illumination turned off completely
1 no change in colour
2 LED ring 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 ring flashes red/blue/white).

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

Parameter 50: Associations in Z-Wave network security mode

defines how commands are sent in specified association groups This parameter defines how commands are sent in specified association groups: as secure or non-secure. Parameter is active only in Z-Wave network security mode. This parameter does not apply to 1st „Lifeline” group The following option values may be configured -:

Value Description
0 none of the groups sent as secure
1 2nd group sent as secure
2 3rd group sent as secure
3 2nd and 3rd group sent as secure

The manufacturer defined default value is 3 (2nd and 3rd group sent as secure).

This parameter has the configuration ID config_50_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 FGWP102 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. 1st Association Group – “Lifeline” reports the device status and allows for assigning single device only (main controller by default).

Association group 1 supports 1 node.

Group 2: On/Off (Button)

2nd Association Group – “On/Off (Button)” devices in this group will be switched on or off when relay status is changed using the B-button (uses Basic command class).

The Wall Plug in 2nd and 3rd group allows to control up to 10 regular or multichannel devices per an association group. “LifeLine” group is reserved solely for the controller and hence only 1 node can be assigned.

It is not recommended to associate more than 10 devices in general, as the response time to control commands depends on the number of associated devices. In extreme cases, system response may be delayed.

Association group 2 supports 10 nodes.

Group 3: On/Off (Power)

3rd Association Group – “On/Off (Power)” devices in this group will be switched on or off depending on the current load (uses Basic command class).

The Wall Plug in 2nd and 3rd group allows to control up to 10 regular or multichannel devices per an association group. “LifeLine” group is reserved solely for the controller and hence only 1 node can be assigned.

It is not recommended to associate more than 10 devices in general, as the response time to control commands depends on the number of associated devices. In extreme cases, system response may be delayed.

Association group 3 supports 10 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_SENSOR_MULTILEVEL_V5
COMMAND_CLASS_METER_V2
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_V5
COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1
COMMAND_CLASS_POWERLEVEL_V1
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.