Skip to content

Latest commit

 

History

History
500 lines (313 loc) · 20.6 KB

pst02b_0_0.md

File metadata and controls

500 lines (313 loc) · 20.6 KB
layout title
documentation
PST02B - ZWave

{% include base.html %}

PST02B Slim Multi-Sensor (PIR/Temperature/Illumination)

This describes the Z-Wave device PST02B, manufactured by Philio Technology Corp with the thing type UID of philio_pst02b_00_000.

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

PST02B product image

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

Wakeup Information

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

Channels

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

Channel Channel Id Category Item Type
Binary Sensor [Deprecated] sensor_binary Door Switch
Sensor (temperature) sensor_temperature Temperature Number:Temperature
Sensor (luminance) sensor_luminance Number
Motion Alarm alarm_motion Door Switch
Tamper Alarm [Deprecated] alarm_tamper Switch
Battery Level battery-level Battery Number

Binary Sensor [Deprecated]

Indicates if a sensor has triggered.

The sensor_binary channel supports the Switch 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 Switch item type -:

Value Label
ON Triggered
OFF Untriggered

Note: This channel is marked as deprecated so should not be used.

Sensor (temperature)

Indicates the current temperature.

The sensor_temperature channel supports the Number:Temperature item and is in the Temperature category.

Sensor (luminance)

Indicates the current light reading.

The sensor_luminance channel supports the Number item. This is a read only channel so will only be updated following state changes from the device.

Motion Alarm

Indicates if a motion alarm is triggered.

The alarm_motion channel supports the Switch 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 Switch item type -:

Value Label
OFF OK
ON Alarm

Tamper Alarm [Deprecated]

Indicates if the tamper alarm is triggered.

The alarm_tamper channel 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

Note: This channel is marked as deprecated so should not be used.

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 14 configuration parameters available in the PST02B. Detailed information on each parameter can be found in the sections below.

Param Name Description
2 Basic Set Level BASIC command value sent when turning on lights
3 PIR Sensitivity PIR Sensitivity setting.
4 Light Threshold Illumination threshold for turning on associated lights.
5 Operation Mode Mode of operation and enabled multisensor functions
6 Multisensor Function Switch Enable or disable functions of the multisensor.
7 Customer Function Enable or disable functions of the multisensor. Not applicable for TSP01.
8 PIR Re-Detect Interval Time Time period to wait until reporting motion detected again.
9 Turn Off Light Time Time to wait before sending command to turn off lights
10 Auto Report Battery Time The interval time for auto reporting the battery level.
12 Auto Report Illumination Time The interval time for auto reporting the illumination state
13 Auto Report Temperature Time The interval time for auto reporting the temperature.
20 Auto Report Tick interval The interval time for auto report each tick.
21 Temperature differential report. The temperature differential to report. Not applicable to TSP01.
22 Illumination differential report. The illumination differential to report. Not applicable to TSP01.
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 2: Basic Set Level

BASIC command value sent when turning on lights BASIC command value to send when turning on the light.

  • -1 (0xFF): turn on the light
  • 0: turn off the light
  • 1–100: send this dimmer value Values in the range -1 to 100 may be set.

The manufacturer defined default value is -1.

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

Parameter 3: PIR Sensitivity

PIR Sensitivity setting. Sensitivity for the PIR (Passive Infrared) sensor

  • 0: Disable PIR motion detection.
  • 1–99: Motion detection sensitivity, where 1 is the lowest and 99 is the highest. Values in the range 0 to 99 may be set.

The manufacturer defined default value is 70.

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

Parameter 4: Light Threshold

Illumination threshold for turning on associated lights. When the event is triggered and the environment illumination is lower than the threshold, the device will turn on the associated lights.

  • 0: turn off the illumination detection function and never turn on the lights
  • 1: darkest threshold level
  • 99 brightest threshold level
  • 100: turn off the illumination detection function and always turn on the lights.

Note: when not in test mode, only values in the range 1–99 will enable the illumination detection function and update the illumination value. Values in the range 0 to 100 may be set.

The manufacturer defined default value is 100.

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

Parameter 5: Operation Mode

Mode of operation and enabled multisensor functions Bitfield for setting the device in certain modes and enabling or disabling specific functions of the multisensor device.

PST02B only:

  • Bit 0: reserved.
  • Bit 1: device mode. 0 = normal mode; 1 = test mode.
  • Bit 2: disable the door/window function. 0 = enabled; 1 = disabled.
  • Bit 3: temperature unit. 0 = Fahrenheit; 1 = Celcius.
  • Bit 4: disable the illumination report after event triggered. 0 = enabled; 1 = disabled.
  • Bit 5: disable the temperature report after event triggered. 0 = enabled; 1 = disabled.
  • Bit 6: reserved.
  • Bit 7: disable the back key release into test mode. 0 = enabled; 1 = disabled.

TSP01 only:

  • Bit 0: operation mode. 0 = home automation mode; 1 = security mode
  • Bit 1: device mode. 0 = normal mode; 1 = test mode.
  • Bit 2: Reserved, always 1.
  • Bit 3: temperature unit. 0 = Fahrenheit; 1 = Celcius.
  • Bit 4: disable the illumination report after event triggered. 0 = enabled; 1 = disabled.
  • Bit 5: disable the temperature report after event triggered. 0 = enabled; 1 = disabled.
  • Bit 6: reserved.
  • Bit 7: reserved. Values in the range 0 to 127 may be set.

The manufacturer defined default value is 0.

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

Parameter 6: Multisensor Function Switch

Enable or disable functions of the multisensor. Bitfield for enabling or disabling functions of the multisensor.

PST02B only:

  • Bit 0: Disable magnetic integrate illumination.
  • Bit 1: Disable PIR integrate Illumination.
  • Bit 2: Disable magnetic integrate PIR (Default is 1 = disabled).
  • Bit 3: When bit 2 is 0 (enabled), is the device is installed in the same room as the light? 0 = In the same room; 1 = In another room.
    • Note: If this bit is 1, it is recommended to also set bit 1 to 1, because when the PIR triggered, it doesn't mean that a person is in the room where the lights are.
  • Bit 4: Disable the 5 seconds delay to turn off the light, when door/window is closed.
  • Bit 5: Disable auto turn off the light, after door/window opened to turn on the light.
    • Note: If bit 2 is 0, this setting has no effect.
    • _Note: If configuration parameter is 0, _this setting has no effect.
  • Bit 6: Reserved.
  • Bit 7: Reserved

TSP01 only:

  • Bit 0: Reserved, always 1.
  • Bit 1: Disable PIR integrate Illumination.
  • Bit 2: Reserved, always 1.
  • Bit 3: Reserved.
  • Bit 4: Reserved.
  • Bit 5: Reserved.
  • Bit 6: Enable temperature monitoring.
    • When this bit is enabled, a temperature change of 3 degrees Fahrenheit will be reported immediately. Additionally, if the temperature is greater than 140 degrees Fahrenheit the temperature will be reported every 64 seconds. 
  • Bit 7: Reserved Values in the range 0 to 127 may be set.

The manufacturer defined default value is 4.

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

Parameter 7: Customer Function

Enable or disable functions of the multisensor. Not applicable for TSP01. Bitfield for enabling or disabling certain customer functions of the multisensor device.

PST02B only:

  • Bit 0: Reserved.
  • Bit 1: Enable sending motion OFF report. 0=Disable; 1=Enable. Note: Depends on the value of bit 4, see below:
    • Bit 4 is 0: Report Notification CC, Type: 0x07, Event: 0xFE.
    • Bit 4 is 1: Sensor Binary Report, Type: 0x0C, Value: 0x00.
  • Bit 2: Enable PIR super sensitivity mode. 0=Disable; 1=Enable.
  • Bit 3: Disable sending BASIC OFF after door/window is closed. 1=Disable, 0=Enable.
  • Bit 4: Notification type. 0=Using Notification Report; 1=Using Sensor Binary Report.
  • Bit 5: Disable Multi CC in auto report. 1=Disable; 0=Enable.
  • Bit 6: Disable reporting battery state when the device is triggered. 1=Disable; 0=Enable.
  • Bit 7: Reserved.

TSP01 only:

  • All bits reserved. The following option values may be configured, in addition to values in the range 0 to 127 -:
Value Description
0 Preset option for TSP01.
22 Preset for PST02B motion detection settings.

The manufacturer defined default value is 0 (Preset option for TSP01.).

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

Parameter 8: PIR Re-Detect Interval Time

Time period to wait until reporting motion detected again. After sending a "motion detected" report, wait at least the configured number of seconds before sending a new "motion detected" report.

The timeout is the configured value multiplied with 8 seconds, i.e. value 3 (the default) means 24 seconds timeout.

Note: For PST02B this setting applies to normal mode only.

Note: For TSP01 this setting applies to security mode only. If this value is bigger than the configuration setting No. 9 there is a period after the light is turned off when the PIR will not be detecting. Values in the range 1 to 127 may be set.

The manufacturer defined default value is 3.

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

Parameter 9: Turn Off Light Time

Time to wait before sending command to turn off lights When a BASIC SET command has been sent to turn on lights and motion is no longer detected by the PIR sensor, wait the configured time before sending a "turn off light" command.

The timeout is the configured value multiplied with 8 seconds, i.e. value 4 (the default) means 32 seconds timeout.

0 means "never turn off the lights". Values in the range 0 to 127 may be set.

The manufacturer defined default value is 4.

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

Parameter 10: Auto Report Battery Time

The interval time for auto reporting the battery level. PST02B only:

The interval time for auto reporting the battery level. The value is multiplied with the value of configuration parameter 20 and the unit is minutes. If the value is 0, auto reporting of battery level is turned off.

If this parameter has its default value (12) and parameter 20 has its default value (30), the interval time is 6 hours.

TSP01 only:

The interval time for auto report the battery level. 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours). Values in the range 0 to 127 may be set.

The manufacturer defined default value is 12.

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

Parameter 12: Auto Report Illumination Time

The interval time for auto reporting the illumination state PST02B only:

The interval time for auto reporting the battery level. The value is multiplied with the value of configuration parameter 20 and the unit is minutes. If the value is 0, auto reporting of illumination is turned off.

If this parameter has its default value (12) and parameter 20 has its default value (30), the interval time is 6 hours.

TSP01 only:

The interval time for auto report the illumination. 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours). Values in the range 0 to 127 may be set.

The manufacturer defined default value is 12.

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

Parameter 13: Auto Report Temperature Time

The interval time for auto reporting the temperature. PST02B only:

The interval time for auto reporting the temperature. The value is multiplied with the value of configuration parameter 20 and the unit is minutes. If the value is 0, auto reporting of temperature is turned off.

If this parameter has its default value (12) and parameter 20 has its default value (30), the interval time is 6 hours.

TSP01 only:

The tick interval time for auto report the temperature. 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours). Values in the range 0 to 127 may be set.

The manufacturer defined default value is 12.

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

Parameter 20: Auto Report Tick interval

The interval time for auto report each tick. PST02B only:

The interval time for auto report each tick. Setting this configuration will effect configuration No. 10, No. 11, No. 12 and No. 13

The unit is 1 minute

Caution1: Setting to 0 means turn off all auto report function.

Caution 2: Thing value is unsigned byte. the range is from 0x00 (0) to 0xff (255)

TSP01 only:

Despite TSP01 instructions, this parameter has same effect as PST02B (tick time). Values in the range 0 to 255 may be set.

The manufacturer defined default value is 30.

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

Parameter 21: Temperature differential report.

The temperature differential to report. Not applicable to TSP01. PST02B only:

The temperature differential to report.

0 means turn off.

The unit is fahrenheit.

Enable this function the device will detect every minute. And when the temperature is over 140 degree fahrenheit, it will continue report.

Enable this functionallity will cause some issue please see the detail in the "Temperature Report" section.

TSP01 only:

All bits reserved, set to 0. Values in the range 0 to 127 may be set.

The manufacturer defined default value is 1.

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

Parameter 22: Illumination differential report.

The illumination differential to report. Not applicable to TSP01. PST02B only:

The illumination differential to report.

0 means turn off this function. The unit is percentage.

Enable this function the device will detect every minute.

Enable this functionality will cause some issue please see the detail in the "Illumination Report" section.

TSP01 only:

All bits reserved, set to 0. Values in the range 0 to 127 may be set.

The manufacturer defined default value is 1.

This parameter has the configuration ID config_22_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 PST02B supports 2 association groups.

Group 1: Reports

Association group 1 supports 7 nodes.

Group 2: Light Control

Association group 2 supports 7 nodes.

Technical Information

Endpoints

Endpoint 0

Command Class Comment
COMMAND_CLASS_NO_OPERATION_V1
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SENSOR_BINARY_V2
COMMAND_CLASS_SENSOR_MULTILEVEL_V5
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1
COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1
COMMAND_CLASS_ZWAVEPLUS_INFO_V1
COMMAND_CLASS_CONFIGURATION_V1
COMMAND_CLASS_ALARM_V3
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_V1
COMMAND_CLASS_VERSION_V1
COMMAND_CLASS_MULTI_CMD_V1
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.