Skip to content

Latest commit

 

History

History
executable file
·
354 lines (222 loc) · 15.4 KB

zw187_0_0.md

File metadata and controls

executable file
·
354 lines (222 loc) · 15.4 KB
layout title
documentation
ZW187 - ZWave

{% include base.html %}

ZW187 Recessed Door Sensor 7

This describes the Z-Wave device ZW187, manufactured by Aeotec Limited with the thing type UID of aeotec_zw187_00_000.

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

ZW187 product image

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

Aeotec Recessed Door Sensor (Gen 7) installs within a door's frame detecting the status of a door.

Inclusion Information

Add Recessed Door Sensor to your Z-Wave network.

Getting your Recessed Door Sensor Gen7 up and running is as simple as powering it up, and adding it to your Z-Wave network. There are 2 methods to pairing your sensor depending on the capabilities of your Z-Wave gateway/controller/hub.

SmartStart Inclusion.

You can use this method of inclusion only if your Z-Wave gateway/controller/hub supports SmartStart.

  1. Open up your Z-Wave gateway/controller/hub app over your Smartphone.
  2. Select SmartStart inclusion.
  3. Scan the QR code located on Recessed Door Sensor Gen7.
  4. Once scanned, Recessed Door Sensor 7 will join your Z-Wave network automatically within 10 minutes from when it is powered up.

Classic Inclusion.

  1. Decide on where you want your Recessed Door Sensor 7 to be placed.
  2. Set your Z-Wave Controller into pairing mode.
  3. Press the Z-Wave Button on your Recessed Door Sensor 7 and quickly release the button (should only be a quick tap action on the button).

Recessed Door Sensor 7 will quickly flash its red LED up to 30 seconds or until it is paired successfully. If successfully paired, the red LED will become solid for 10 seconds.

If your Recessed Door Sensor failed to pair, the LED will return to slow breathing LED. If it is this case, please return to step 2.

  1. If you pairing with S2 encryption/security, enter the first 5 digits of the DSK into your controller/gateway/hub interface when requested.

When Recessed Door Sensor 7 successfully joins your Z-Wave network its LED will turn solid red for 10 seconds. If LED

becomes slow fade-in fade-out Red color before turning off, it means the device is still unable to join your Z-Wave

network; repeat the above steps and please contact us for further support if needed.

Manual: https://aeotec.com/hidden-z-wave-door-sensor/

Exclusion Information

Remove your sensor from your Z-Wave network (Software reset).

Your Recessed Door Sensor can be removed from your Z-Wave network at any time. You'll need to use your Z-Wave network's main controller to do this. 

  1. Set your Z-Wave Controller into its ‘Remove Device‘ mode in order to remove the product from your Z-Wave system Refer to the Controller's manual if you are unsure of how to perform this step.
  2. Make sure the product is powered.
  3. Click Action Button once; LED will become flash Red color for 5 seconds.
  4. If Removing fails, it will extinguish, without slow fade-in fade-out Red color.
  5. If Removing succeeds, it will become slow fade-in fade-out Red color for 10 seconds, and then extinguish. Now, it is Roved from Z-Wave network successfully.

Manually Factory Reset your sensor.

If the primary controller is missing or inoperable, you may need to reset the device to factory settings. Make sure the product is powered. To complete the reset process manually, 

  • Press and hold the Action Button for at least 20 seconds.
    • @2 seconds, LED will shows a slow pulsing LED
    • @5 seconds, LED will pulse faster
    • @10 seconds, LED will flash even faster.
    • @20 seconds, LED will become solid for 2 seconds to indicate it factory reset.
      • You can release the action button here.
    • @22 seconds. LED will breathe slowly to indicate it is factory reset.
  • Release the Action Button when LED becomes slow fade-in fade-out red color.

Note:

    1. This procedure should only be used when the primary controller is missing or inoperable.
  1. Factory Reset will:
  • Remove the product from Z-Wave network;
  • Delete the Association setting;
  • Restore the configuration settings to the default.

Manual: https://aeotec.com/hidden-z-wave-door-sensor/

Wakeup Information

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

Wakeup your Recessed Door Sensor for configuration.

You can wakeup Recessed Door Sensor 7 to communicate with your Z-Wave gateway or push configuration settings to your sensor.

To wake up your sensor, follow these steps:

  • Press and hold the Action Button for at least 2 seconds, but before 5 seconds.
    • @2 seconds, LED will shows a slow pulsing LED
      • Release action button here to toggle 10 minute wakeup.
      • If successful, LED will remain solid until sensor goes back to sleep.

General Usage Information

Channels

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

Channel Name Channel ID Channel Type Category Item Type
Door State sensor_door sensor_door Door Contact
Battery Level battery-level system.battery_level Battery Number

Door State

Indicates if the door/window is open or closed.

The sensor_door channel is of type sensor_door and supports the Contact item and is in the Door 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 Contact item type -:

Value Label
OPEN Open
CLOSED Closed

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 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%.

Device Configuration

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

Param Name Description
1 Binary Sensor Report Enable/Disable Binary Sensor Report
2 Sensor Reports Reverse Sensor Reports
3 Association Group Settings Configure the Basic Set value
4 Application Layer Retry Configure retry number and wait time
5 Supervision Report Wait Time Configure Supervision Report Wait Time
81 LED Indicator Control LED Indicator
90 Low Battery threshold Configure the Low Battery threshold
101 Timed barrery report Enable/Disable timed battery report
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: Binary Sensor Report

Enable/Disable Binary Sensor Report Allow for backward compatibility to report Binary if Notification Report cannot be used for status changes. The following option values may be configured -:

Value Description
0 Disable
1 Enable

The manufacturer defined default value is 0 (Disable).

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

Parameter 2: Sensor Reports

Reverse Sensor Reports

The following option values may be configured -:

Value Description
0 Open when open
1 Closed when open

The manufacturer defined default value is 0 (Open when open).

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

Parameter 3: Association Group Settings

Configure the Basic Set value Determine the Basic Set value to control other z-wave devices directly when Magnet is away or near The following option values may be configured -:

Value Description
0 Disable
1 Option 1
2 Option 2
3 Option 3
4 Option 4
5 Option 5
6 Option 6

The manufacturer defined default value is 1 (Option 1).

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

Parameter 4: Application Layer Retry

Configure retry number and wait time The device supports an application retry mechanism when the application of the device has detected a transmission error when Basic Set, Sensor Binary Report or Notification Report (Access Control) message is sent out but fails to result in an ACK or a Supervision Report.

High Byte: Configure the number of retries. The valid value is 0-5. 0 means disable retry.

Low Byte: Configure the wait time between retries. The valid value is 0-255. Unit is 100ms.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range 0 to 1535 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: Supervision Report Wait Time

Configure Supervision Report Wait Time This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range 0 to 50 may be set.

The manufacturer defined default value is 15.

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

Parameter 81: LED Indicator

Control LED Indicator Determine whether the LED flash or not when sending Basic Set, Sensor Binary Report or Notification Report (access Control). The following option values may be configured -:

Value Description
0 Disable LED
1 LED Option 1
2 LED Option 2
3 LED Option 3

The manufacturer defined default value is 3 (LED Option 3).

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

Parameter 90: Low Battery threshold

Configure the Low Battery threshold Induce a battery report when the battery level is less than or equal to the threshold. Forward battery report. Valid 10%-50% remaining. Values in the range 10 to 50 may be set.

The manufacturer defined default value is 30.

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

Parameter 101: Timed barrery report

Enable/Disable timed battery report Enable timed battery report and sets how often battery is reported in minutes. Values in the range 1 to 14400 may be set.

The manufacturer defined default value is 70.

This parameter has the configuration ID config_101_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 ZW187 supports 2 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.

Association group 1 supports 5 nodes.

Group 2: On/Off Control

Association group 2 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_SENSOR_BINARY_V2
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_FIRMWARE_UPDATE_MD_V1
COMMAND_CLASS_BATTERY_V1
COMMAND_CLASS_WAKE_UP_V2
COMMAND_CLASS_ASSOCIATION_V2
COMMAND_CLASS_VERSION_V2
COMMAND_CLASS_INDICATOR_V3
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.