Skip to content

Latest commit

 

History

History
701 lines (439 loc) · 29.2 KB

fgkf601_0_0.md

File metadata and controls

701 lines (439 loc) · 29.2 KB
layout title
documentation
FGKF601 - ZWave

{% include base.html %}

FGKF601 Keyfob

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

The device is in the category of Remote Control, defining Any portable or hand-held device that controls the status of something, e.g. remote control, keyfob etc..

FGKF601 product image

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

Overview

FIBARO KeyFob is a Z-Wave Plus compatible, battery-powered, compact remote control. Six buttons allow you to control other devices through the Z-Wave network and run various scenes defined in FIBARO System. Configure actions for one, two, three clicks, holding the button and button sequences to suit all your needs.

Built-in locking system will ensure that unauthorized person will not take control of your home.

Main features of FIBARO KeyFob:

  • Compatible with any Z-Wave or Z-Wave+ Controller,
  • Supports Z-Wave network Security Mode with AES-128 encryption,
  • Battery powered,
  • Completely wireless,
  • Pocket size,
  • Equipped with 6 easily recognizable buttons,
  • 30 different actions, single/double/triple click, hold for each button and sequences,
  • Easy to operate menu,
  • Actions are confirmed by the built-in LED diode.

Basic activation

  1. Using included keyring or a coin, open the battery cover by turning it counter-clockwise
  2. Remove the sticker protecting the battery.
  3. Using included keyring or a coin, close the battery cover by turning it clockwise.
  4. Locate the device nearby the main Z-Wave controller.
  5. Set the main Z-Wave controller in (Security/non-Security Mode) add mode (see the controller’s manual).
  6. Click any button three times.
  7. LED will pulse white during the adding process.
  8. Wait for the device to be added into the system.
  9. Successful adding will be confirmed by the Z-Wave controller’s message and green LED colour.

Inclusion Information

  1. Set the main Z-Wave controller in (Security/non-Security Mode) add mode (see the controller’s manual).
  2. Power the device (insert the battery).
  3. Click any button three times.
  4. LED will pulse white during the adding process.
  5. Wait for the adding process to end.
  6. Successful adding will be confirmed by the Z-Wave controller’s message and green LED colour.

Exclusion Information

  1. Set the main Z-Wave controller in remove mode (see the controller’s manual).
  2. Click o and - simultaneously.
  3. Click Δ or x until LED glows green.
  4. Click +.
  5. Wait for the removing process to end.
  6. Successful removing will be confirmed by the Z-Wave controller’s message.

Wakeup Information

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

The KeyFob needs to be woken up to receive information about the new configuration from the Z-Wave controller, like parameters and associations. Use 1st menu position (white) or click o and + simultaneously to wake up the device.

General Usage Information

Menu allows to perform Z-Wave network actions. In order to use the menu:

  1. Click o and - simultaneously.
  2. Click Δ or x until LED indicates desired menu position with colour:
    • White - wake up the device
    • Green - learning mode (adding/removing)
    • Cyan - check battery level
    • Yellow - reset the device*
  3. Click + to confirm selection, Click - to exit the menu.
  4. LED will pulse twice with same colour as selected menu position to confirm completing action.

Resetting the device to factory defaults:

Reset procedure allows to restore the device back to its factory settings, which means all information about the Z-Wave controller and
user configuration will be deleted. There are two ways of resetting the device:

Resetting the device using the menu:

  1. Click o and - simultaneously.
  2. Click Δ or x until LED glows yellow.
  3. Click +.

Emergency resetting the device on start-up:

  1. Remove the battery.
  2. Hold □ and + , while inserting the battery.

Successful resetting will be confirmed by smoothly brightening and dimming of the yellow LED colour.

Channels

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

Channel Channel Id Category Item Type
Scene Number scene_number Number
Battery Level battery-level Battery Number

Scene Number

Triggers when a scene button is pressed.

The scene_number channel supports the Number item. This channel provides the scene, and the event as a decimal value in the form <scene>.<event>. The scene number is set by the device, and the event is as follows -:

Event ID Event Description
0 Single key press
1 Key released
2 Key held down
3 Double keypress
4 Tripple keypress
5 4 x keypress
6 5 x keypress

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.

Device Configuration

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

Param Name Description
1 Lock Mode - unlocking sequence 0 - Lock Mode disabled, 9-28086 - unlocking sequence
2 Lock Mode - time to lock and locking button 0 - Lock Mode disabled, 5-1791 - calculated value
3 First scene sequence 0 - 1st sequence disabled, 9-28086 - value of sequence
4 Second scene sequence 0 - 2nd sequence disabled, 9-28086 - value of sequence
5 Third scene sequence 0 - 3rd sequence disabled, 9-28086 - value of sequence
6 Fourth scene sequence 0 - 4th sequence disabled, 9-28086 - value of sequence
7 Fifth scene sequence 0 - 5th sequence disabled, 9-28086 - value of sequence
8 Sixth scene sequence 0 - 6th sequence disabled, 9-28086 - value of sequence
9 Sequences - timeout 5-30 (0.5-3s, 0.1s step) - time to lock
10 Single button associations - operating mode This parameter allows to choose operating mode for single button associations.
11 Value sent to □ association group 1-99 or 255 (last state)
12 Value sent to ○ association group 1-99 or 255 (last state)
13 Value sent to x association group 1-99 or 255 (last state)
14 Value sent to Δ association group 1-99 or 255 (last state)
15 Value sent to - association group 1-99 or 255 (last state)
16 Value sent to + association group 1-99 or 255 (last state)
17 Paired buttons association for □ and ○ activate paired buttons association mode for □ and ○ buttons
18 Paired buttons association for x and Δ allows to activate paired buttons association mode for x and Δ buttons
19 Paired buttons association for - and + allows to activate paired buttons association mode for - and + buttons
21 Scene activation for □ button 1 = 1 time, 2 = 2 times, 4 = 3 times, 8 = held down and released
22 Scene activation for ○ button 1 = 1 time, 2 = 2 times, 4 = 3 times, 8 = held down and released
23 Scene activation for x button 1 = 1 time, 2 = 2 times, 4 = 3 times, 8 = held down and released
24 Scene activation for Δ button 1 = 1 time, 2 = 2 times, 4 = 3 times, 8 = held down and released
25 Scene activation for - button 1 = 1 time, 2 = 2 times, 4 = 3 times, 8 = held down and released
26 Scene activation for + button 1 = 1 time, 2 = 2 times, 4 = 3 times, 8 = held down and released
29 Associations in Z-Wave network security mode defines how commands are sent in specified association groups
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

Parameter 1: Lock Mode - unlocking sequence

0 - Lock Mode disabled, 9-28086 - unlocking sequence This parameter allows to activate Lock Mode and set up unlocking sequence. Device will lock after time set in parameter 2 or after pressing and holding selected button.  Values in the range 0 to 28086 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: Lock Mode - time to lock and locking button

0 - Lock Mode disabled, 5-1791 - calculated value

  • This parameter allows to set time that must elapse from the last press of the button to lock the device and locking button.
  • Setting locking button will deactivate associations and scenes for pressing and holding the selected button.
  • This parameter is irrelevant if parameter 1 is set to 0 (Lock Mode disable). Values in the range 0 to 1791 may be set.

The manufacturer defined default value is 60.

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

Parameter 3: First scene sequence

0 - 1st sequence disabled, 9-28086 - value of sequence This parameter allows to set up sequence that activates scene with ID 7. See "Sequences" on page 10 for more information. Values in the range 0 to 28086 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 4: Second scene sequence

0 - 2nd sequence disabled, 9-28086 - value of sequence This parameter allows to set up sequence that activates scene with ID 8. Values in the range 0 to 28086 may be set.

The manufacturer defined default value is 0.

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

Parameter 5: Third scene sequence

0 - 3rd sequence disabled, 9-28086 - value of sequence This parameter allows to set up sequence that activates scene with ID 9. Values in the range 0 to 28086 may be set.

The manufacturer defined default value is 0.

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

Parameter 6: Fourth scene sequence

0 - 4th sequence disabled, 9-28086 - value of sequence This parameter allows to set up sequence that activates scene with ID 10.  Values in the range 0 to 28086 may be set.

The manufacturer defined default value is 0.

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

Parameter 7: Fifth scene sequence

0 - 5th sequence disabled, 9-28086 - value of sequence This parameter allows to set up sequence that activates scene with ID 11.  Values in the range 0 to 28086 may be set.

The manufacturer defined default value is 0.

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

Parameter 8: Sixth scene sequence

0 - 6th sequence disabled, 9-28086 - value of sequence This parameter allows to set up sequence that activates scene with ID 12. Values in the range 0 to 28086 may be set.

The manufacturer defined default value is 0.

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

Parameter 9: Sequences - timeout

5-30 (0.5-3s, 0.1s step) - time to lock This parameter allows to set time that must elapse from the last click of the button to check if the sequence is valid. Values in the range 5 to 30 may be set.

The manufacturer defined default value is 10.

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

Parameter 10: Single button associations - operating mode

This parameter allows to choose operating mode for single button associations. This parameter allows to choose operating mode for single button associations. The following option values may be configured -:

Value Description
0 single click switches state to opposite
1 single click => opposite, double click => max
2 single click turns on, double click turns off

The manufacturer defined default value is 0 (single click switches state to opposite).

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

Parameter 11: Value sent to □ association group

1-99 or 255 (last state) This parameter allows to set value sent to devices in association group. It will result in turning multilevel devices on with set or last level. Value is irrelevant for simple on/off devices.

1-99 - forcing level of associated devices
255 - setting associated devices to the last remembered state or turning them on Values in the range 1 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 12: Value sent to ○ association group

1-99 or 255 (last state) This parameter allows to set value sent to devices in association group. It will result in turning multilevel devices on with set or last level. Value is irrelevant for simple on/off devices.

1-99 - forcing level of associated devices
255 - setting associated devices to the last remembered state or turning them on Values in the range 1 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 13: Value sent to x association group

1-99 or 255 (last state) This parameter allows to set value sent to devices in association group. It will result in turning multilevel devices on with set or last level. Value is irrelevant for simple on/off devices.

1-99 - forcing level of associated devices
255 - setting associated devices to the last remembered state or turning them on Values in the range 1 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 14: Value sent to Δ association group

1-99 or 255 (last state) This parameter allows to set value sent to devices in association group. It will result in turning multilevel devices on with set or last level. Value is irrelevant for simple on/off devices.

1-99 - forcing level of associated devices
255 - setting associated devices to the last remembered state or turning them on Values in the range 1 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 15: Value sent to - association group

1-99 or 255 (last state) This parameter allows to set value sent to devices in association group. It will result in turning multilevel devices on with set or last level. Value is irrelevant for simple on/off devices.

1-99 - forcing level of associated devices
255 - setting associated devices to the last remembered state or turning them on Values in the range 1 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 16: Value sent to + association group

1-99 or 255 (last state) This parameter allows to set value sent to devices in association group. It will result in turning multilevel devices on with set or last level. Value is irrelevant for simple on/off devices.

1-99 - forcing level of associated devices
255 - setting associated devices to the last remembered state or turning them on Values in the range 1 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 17: Paired buttons association for □ and ○

activate paired buttons association mode for □ and ○ buttons This parameter allows to activate paired buttons association mode for □ and ○ buttons. Paired buttons are dependent and association are sent only to □ groups. ○ turns devices on and increases value, □ turns them off and decreases value. The following option values may be configured -:

Value Description
0 paired buttons association inactive
1 paired buttons association active

The manufacturer defined default value is 0 (paired buttons association inactive).

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

Parameter 18: Paired buttons association for x and Δ

allows to activate paired buttons association mode for x and Δ buttons This parameter allows to activate paired buttons association mode for x and Δ buttons. Paired buttons are dependent and association are sent only to x groups. Δ turns devices on and increases value, x turns them off and decreases value. The following option values may be configured -:

Value Description
0 paired buttons association inactive
1 paired buttons association active

The manufacturer defined default value is 0 (paired buttons association inactive).

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

Parameter 19: Paired buttons association for - and +

allows to activate paired buttons association mode for - and + buttons This parameter allows to activate paired buttons association mode for - and + buttons. Paired buttons are dependent and association are sent only to - groups. + turns devices on and increases value, - turns them off and decreases value.  The following option values may be configured -:

Value Description
0 paired buttons association inactive
1 paired buttons association active

The manufacturer defined default value is 0 (paired buttons association inactive).

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

Parameter 21: Scene activation for □ button

1 = 1 time, 2 = 2 times, 4 = 3 times, 8 = held down and released This parameter determines which actions result in sending assigned scene IDs and attributes to the controller.

1 - Key pressed 1 time
2 - Key pressed 2 times
4 - Key pressed 3 times
8 - Key held down & released

Combine multiple actions by combining the values. Values in the range 0 to 15 may be set.

The manufacturer defined default value is 9.

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

Parameter 22: Scene activation for ○ button

1 = 1 time, 2 = 2 times, 4 = 3 times, 8 = held down and released This parameter determines which actions result in sending assigned scene IDs and attributes to the controller.

1 - Key pressed 1 time
2 - Key pressed 2 times
4 - Key pressed 3 times
8 - Key held down & released

Combine multiple actions by combining the values. Values in the range 0 to 15 may be set.

The manufacturer defined default value is 9.

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

Parameter 23: Scene activation for x button

1 = 1 time, 2 = 2 times, 4 = 3 times, 8 = held down and released This parameter determines which actions result in sending assigned scene IDs and attributes to the controller.

1 - Key pressed 1 time
2 - Key pressed 2 times
4 - Key pressed 3 times
8 - Key held down & released

Combine multiple actions by combining the values. Values in the range 0 to 15 may be set.

The manufacturer defined default value is 9.

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

Parameter 24: Scene activation for Δ button

1 = 1 time, 2 = 2 times, 4 = 3 times, 8 = held down and released This parameter determines which actions result in sending assigned scene IDs and attributes to the controller.

1 - Key pressed 1 time
2 - Key pressed 2 times
4 - Key pressed 3 times
8 - Key held down & released

Combine multiple actions by combining the values. Values in the range 0 to 15 may be set.

The manufacturer defined default value is 9.

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

Parameter 25: Scene activation for - button

1 = 1 time, 2 = 2 times, 4 = 3 times, 8 = held down and released This parameter determines which actions result in sending assigned scene IDs and attributes to the controller.

1 - Key pressed 1 time
2 - Key pressed 2 times
4 - Key pressed 3 times
8 - Key held down & released

Combine multiple actions by combining the values. Values in the range 0 to 15 may be set.

The manufacturer defined default value is 9.

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

Parameter 26: Scene activation for + button

1 = 1 time, 2 = 2 times, 4 = 3 times, 8 = held down and released This parameter determines which actions result in sending assigned scene IDs and attributes to the controller.

1 - Key pressed 1 time
2 - Key pressed 2 times
4 - Key pressed 3 times
8 - Key held down & released

Combine multiple actions by combining the values. Values in the range 0 to 15 may be set.

The manufacturer defined default value is 9.

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

Parameter 29: Associations in Z-Wave network security mode

defines how commands are sent in specified association groups Parameter defines how commands are sent in specified association groups: using Security Mode or not. Parameter is active only in Z-Wave network Security Mode. It does not apply to 1st “Lifeline” association group.

Available settings:

1 - 2nd group sent using Security Mode
2 - 3rd group sent using Security Mode
4 - 4th group sent using Security Mode
8 - 5th group sent using Security Mode
16 - 6th group sent using Security Mode
32 - 7th group sent using Security Mode
64 - 8th group sent using Security Mode
128 - 9th group sent using Security Mode
256 - 10th group sent using Security Mode
512 - 11th group sent using Security Mode
1024 - 12th group sent using Security Mode
2048 - 13th group sent using Security Mode

Set multiple values by combining the values together. Values in the range 0 to 4095 may be set.

The manufacturer defined default value is 4095.

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

Wakeup Interval

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.

Wakeup Node

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

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 FGKF601 supports 13 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. “Lifeline” reports the device status and allows for assigning single device only (main controller by default).

Association group 1 supports 1 node.

Group 2: Square - On/Off

“Square - On/Off” is assigned to clicking the □ button and is used to turn on/off associated devices.

Association group 2 supports 5 nodes.

Group 3: Square - Multilevel

“Square - Multilevel” is assigned to clicking and holding the □ button and is used to turn on/off and change level of associated devices.

Association group 3 supports 5 nodes.

Group 4: Circle - On/Off

“Circle - On/Off” is assigned to clicking the ○ button and is used to turn on/off associated devices.

Association group 4 supports 5 nodes.

Group 5: Circle - Multilevel

“Circle - Multilevel” is assigned to clicking and holding the ○ button and is used to turn on/off and change level of associated devices.

Association group 5 supports 5 nodes.

Group 6: Cross - On/Off

“Cross - On/Off” is assigned to clicking the x button and is used to turn on/off associated devices.

Association group 6 supports 5 nodes.

Group 7: Cross - Multilevel

“Cross - Multilevel” is assigned to clicking and holding the x button and is used to turn on/off and change level of associated devices.

Association group 7 supports 5 nodes.

Group 8: Triangle - On/Off

“Triangle - On/Off” is assigned to clicking the Δ button and is used to turn on/off associated devices.

Association group 8 supports 5 nodes.

Group 9: Triangle - Multilevel

“Triangle - Multilevel” is assigned to clicking and holding the Δ button and is used to turn on/off and change level of associated devices.

Association group 9 supports 5 nodes.

Group 10: Minus - On/Off

“Minus - On/Off” is assigned to clicking the - button and is used to turn on/off associated devices.

Association group 10 supports 5 nodes.

Group 11: Minus - Multilevel

“Minus - Multilevel” is assigned to clicking and holding the - button and is used to turn on/off and change level of associated devices.

Association group 11 supports 5 nodes.

Group 12: Plus - On/Off

“Plus - On/Off” is assigned to clicking the + button and is used to turn on/off associated devices.

Association group 12 supports 5 nodes.

Group 13: Plus - Multilevel

“Plus - Multilevel” is assigned to clicking and holding the + button and is used to turn on/off and change level of associated devices.

Association group 13 supports 5 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_CRC_16_ENCAP_V1
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1
COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1
COMMAND_CLASS_CENTRAL_SCENE_V3 Linked to BASIC
COMMAND_CLASS_ZWAVEPLUS_INFO_V1
COMMAND_CLASS_CONFIGURATION_V1
COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1
COMMAND_CLASS_POWERLEVEL_V1
COMMAND_CLASS_PROTECTION_V2
COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1
COMMAND_CLASS_BATTERY_V1
COMMAND_CLASS_WAKE_UP_V2
COMMAND_CLASS_ASSOCIATION_V2
COMMAND_CLASS_VERSION_V2
COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3

Documentation Links


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