8.6 KiB
| layout | title |
|---|---|
| documentation | HSP02 - ZWave |
{% include base.html %}
HSP02 Motion Detector
This describes the Z-Wave device HSP02, manufactured by Everspring with the thing type UID of everspring_hsp02_00_000.
The device is in the category of Motion Detector, defining Motion sensors/detectors.
The HSP02 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 HSP02 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
Battery powered Motion Sensor
Inclusion Information
Pressing link key 3 times within 1.5 second will enter inclusion mode.
Exclusion Information
Pressing link key 3 times within 1.5 second will enter exclusion mode.
Wakeup Information
The HSP02 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.
Press link key 3 times within 1.5 second
Channels
The following table summarises the channels available for the HSP02 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|---|---|---|---|---|
| Binary Sensor | sensor_binary | sensor_binary | Switch | |
| Alarm | alarm_general | alarm_general | Alarm | Switch |
| Battery Level | battery-level | system.battery_level | Battery | Number |
Binary Sensor
Indicates if a sensor has triggered.
The sensor_binary 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
Indicates if an alarm is triggered.
The alarm_general 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 |
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 6 configuration parameters available in the HSP02. Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|---|---|---|
| 1 | Basic Set Level | Value to be sent with a BASIC SET command |
| 2 | Sensor Detecting Function | |
| 3 | Sensitivity Level | |
| 4 | Re-trigger Interval Setting | |
| 5 | LUX Level | Value for what LUX level will arm the detection sensor |
| 6 | On-Off Duration | |
| 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: Basic Set Level
Value to be sent with a BASIC SET command
Values in the range 0 to 99 may be set.
The manufacturer defined default value is 99.
This parameter has the configuration ID config_1_1 and is of type INTEGER.
Parameter 2: Sensor Detecting Function
The following option values may be configured -:
| Value | Description |
|---|---|
| 1 | Group 1 Enabled / Group 2 Enabled |
| 2 | Group 1 Enabled / Group 2 Disabled |
| 3 | Group 1 Disabled / Group 2 Disabled |
The manufacturer defined default value is 1 (Group 1 Enabled / Group 2 Enabled).
This parameter has the configuration ID config_2_1 and is of type INTEGER.
Parameter 3: Sensitivity Level
Values in the range 1 to 10 may be set.
The manufacturer defined default value is 6.
This parameter has the configuration ID config_3_1 and is of type INTEGER.
Parameter 4: Re-trigger Interval Setting
Values in the range 5 to 255 may be set.
The manufacturer defined default value is 180.
This parameter has the configuration ID config_4_1 and is of type INTEGER.
Parameter 5: LUX Level
Value for what LUX level will arm the detection sensor
Values in the range 1 to 100 may be set.
The manufacturer defined default value is 10.
This parameter has the configuration ID config_5_1 and is of type INTEGER.
Parameter 6: On-Off Duration
Values in the range 5 to 255 may be set.
The manufacturer defined default value is 15.
This parameter has the configuration ID config_6_1 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 HSP02 supports 2 association groups.
Group 1: Target for reports
Association group 1 supports 1 node.
Group 2: Target nodes who receive BASIC_SET command
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_SENSOR_BINARY_V1 | |
| COMMAND_CLASS_CONFIGURATION_V1 | |
| COMMAND_CLASS_ALARM_V1 | |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1 | |
| COMMAND_CLASS_BATTERY_V1 | |
| COMMAND_CLASS_WAKE_UP_V2 | |
| COMMAND_CLASS_ASSOCIATION_V2 | |
| COMMAND_CLASS_VERSION_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.