| layout | title |
|---|---|
documentation |
HS-MS100+ - ZWave |
{% include base.html %}
This describes the Z-Wave device HS-MS100+, manufactured by HomeSeer Technologies with the thing type UID of homeseer_hsms100_00_000.
The device is in the category of Motion Detector, defining Motion sensors/detectors.
The HS-MS100+ 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 HS-MS100+ 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.
Motion sensor can be included and operated in any Z-Wave network with other Z-Wave certified devices.
The features list:
- Z-Wave Plus certified for wide compatibility (500 serials product)
- Supports security 0 and security 2 protected mode with AES-128 encryption.
- Motion sensor.
- Tamper alarm by shock sensor.
- The battery life is up to 1 year.
- Low battery alarm.
- Support firmware OTA.
- Open the cover
- Place the device withing the direct range of your Z-Wave controller
- Set the main controller into inclusion mode
- "Secure Inclusion". Hold Z-button for 5 sec and then release. The LED indicator should blink fast.
- "Non-secure Inclusion". Press Z-button once. The LED indicator should blink fast.
- Wait for the adding process to end
- Open the cover
- Place the device withing the direct range of your Z-Wave controller
- Set the main controller into exclusion mode
- Triple click Z-button quickly. The LED indicator should blink fast.
- Wait for the removing process to end
The HS-MS100+ 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 and hold Z button for more than 5 seconds and release
The following table summarises the channels available for the HS-MS100+ -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|---|---|---|---|---|
| Motion Alarm | alarm_motion | alarm_motion | Motion | Switch |
| Tamper Alarm | alarm_tamper | alarm_tamper | Switch | |
| Battery Level | battery-level | system.battery_level | Battery | Number |
Indicates if a motion alarm is triggered.
The alarm_motion channel is of type alarm_motion and supports the Switch item and is in the Motion 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 |
Indicates if the tamper alarm is triggered.
The alarm_tamper channel is of type alarm_tamper 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 |
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%.
The following table provides a summary of the 6 configuration parameters available in the HS-MS100+. Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|---|---|---|
| 12 | Motion sensor sensitivity | Motion sensor sensitivity |
| 14 | Enable/Disable BASIC SET command | Enable/Disable BASIC SET command |
| 15 | Value of the BASIC SET | Value of the BASIC SET |
| 17 | Enable/ Disable shock alarm | Enable/ Disable shock alarm |
| 18 | Motion timeout interval | Motion timeout interval |
| 32 | Level of low battery | Level of low battery |
| 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 |
Motion sensor sensitivity The higher the value, the more sensitive the PIR sensor. Values in the range 1 to 8 may be set.
The manufacturer defined default value is 8.
This parameter has the configuration ID config_12_1 and is of type INTEGER.
Enable/Disable BASIC SET command
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_14_1 and is of type INTEGER.
Value of the BASIC SET
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Triggered value 255 |
| 1 | Triggered value 0 |
The manufacturer defined default value is 0 (Triggered value 255).
This parameter has the configuration ID config_15_1 and is of type INTEGER.
Enable/ Disable shock alarm
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Do not send a vibration alarm |
| 1 | Send a vibration alarm |
The manufacturer defined default value is 1 (Send a vibration alarm).
This parameter has the configuration ID config_17_1 and is of type INTEGER.
Motion timeout interval Set 0 to disable report.
Value 1 to 65535 set timeout of transmitting command when motion has not been sensed for a period of time Values in the range 0 to 65535 may be set.
The manufacturer defined default value is 600.
This parameter has the configuration ID config_18_2 and is of type INTEGER.
Level of low battery The low level from 10% to 50% Values in the range 10 to 50 may be set.
The manufacturer defined default value is 20.
This parameter has the configuration ID config_32_1 and is of type INTEGER.
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.
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 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 HS-MS100+ supports 2 association groups.
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. Z-Wave Plus Lifeline:
- Notification Report. Sensor will send Notification Report to the associated nodes when Motion Sensor is removed or/and PIR is triggered.
- Battery Report. Motion Sensor will send Battery Report when the battery level is low and the battery report’s value is 0xFF.
- Device Reset Locally Notification.
Association group 1 supports 5 nodes.
- Basic Set. Motion Sensor will send Basic Set to associated nodes when the PIR is triggered.
Association group 2 supports 5 nodes.
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_NO_OPERATION_V1 | |
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_SENSOR_BINARY_V2 | |
| COMMAND_CLASS_TRANSPORT_SERVICE_V1 | |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1 | |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1 | |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1 | |
| COMMAND_CLASS_SUPERVISION_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_BATTERY_V1 | |
| COMMAND_CLASS_WAKE_UP_V2 | |
| COMMAND_CLASS_ASSOCIATION_V2 | |
| COMMAND_CLASS_VERSION_V2 | |
| COMMAND_CLASS_SECURITY_V1 | |
| COMMAND_CLASS_SECURITY_2_V1 |
Did you spot an error in the above definition or want to improve the content? You can contribute to the database here.