| layout | title |
|---|---|
documentation |
NQ-9021 - ZWave |
{% include base.html %}
This describes the Z-Wave device NQ-9021, manufactured by NorthQ with the thing type UID of northq_nq9021_00_000.
The NQ-9021 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 NQ-9021 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.
The NQ-9021 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 following table summarises the channels available for the NQ-9021 -:
| Channel | Channel Id | Category | Item Type |
|---|---|---|---|
| Electric meter (kWh) | meter_kwh | Energy | Number |
| Battery Level | battery-level | Battery | Number |
| Clock Time Offset | time_offset | Temperature | Number |
Indicates the energy consumption (kWh).
The meter_kwh channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
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.
Provides the current time difference for the devices time.
The time_offset channel supports the Number item and is in the Temperature category.
The following table provides a summary of the 14 configuration parameters available in the NQ-9021. Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|---|---|---|
| 1 | Pulse factor | Impulse or Rotation factor per KWh * 10 |
| 2 | Sensor type | |
| 3 | IR Listen period | Additional time for feedback measurement. Should always be 0. |
| 4 | IR Pulse Width | Adjusts transmit signal so received signal will in average be equal to this values. |
| 5 | Poll / Wake up frequency | Wake device up this many times per second. This value also controls number of measurements per second on mechanical meters |
| 6 | Pulse Threshold Low | Low detection threshold for wheel meters |
| 7 | Pulse Threshold High | High detection threshold for wheel meters |
| 8 | Wakeup Interval | like WAKEUP command class |
| 9 | Pulse count | Total pulse count (Meter reading / impulse factor) |
| 10 | Keep alive period | How many seconds before going back to sleep in normal wakeup mode. |
| 11 | Real-time mode | Set this to enter real-time mode from remote. Contains seconds * poll frequency before going back to sleep. If you press the button once this value will be set. |
| 12 | Serial number | Read-only serial number in decimal |
| 13 | Debug mode | |
| 15 | Calibration status | The calibration progress is calculated as (value[1] - 65 + value[2] / value[3]) * 25. The calibration is finished successfully when value[0] = 2 and value[2] = value[3]. The calibration has failed if value[0] != 1 OR (value[0] = 2 AND value[2] != value[ |
| 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 |
Impulse or Rotation factor per KWh * 10
Values in the range 0 to 65535 may be set.
The manufacturer defined default value is 1024.
This parameter has the configuration ID config_1_2 and is of type INTEGER.
The following option values may be configured -:
| Value | Description |
|---|---|
| 1 | Pulse meter |
| 2 | Mechanical meter |
The manufacturer defined default value is 2 (Mechanical meter).
This parameter has the configuration ID config_2_1 and is of type INTEGER.
Additional time for feedback measurement. Should always be 0.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_3_1 and is of type INTEGER.
Adjusts transmit signal so received signal will in average be equal to this values.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_4_1 and is of type INTEGER.
Wake device up this many times per second. This value also controls number of measurements per second on mechanical meters
Values in the range 1 to 50 may be set.
The manufacturer defined default value is 20.
This parameter has the configuration ID config_5_1 and is of type INTEGER.
Low detection threshold for wheel meters
Values in the range 0 to 143 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_6_1 and is of type INTEGER.
High detection threshold for wheel meters
Values in the range 0 to 143 may be set.
The manufacturer defined default value is 5.
This parameter has the configuration ID config_7_1 and is of type INTEGER.
like WAKEUP command class
Values in the range 0 to 65535 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_8_2 and is of type INTEGER.
Total pulse count (Meter reading / impulse factor)
Values in the range 0 to 2147483647 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_9_4 and is of type INTEGER.
How many seconds before going back to sleep in normal wakeup mode.
Values in the range 0 to 65535 may be set.
The manufacturer defined default value is 3.
This parameter has the configuration ID config_10_2 and is of type INTEGER.
Set this to enter real-time mode from remote. Contains seconds * poll frequency before going back to sleep. If you press the button once this value will be set.
Values in the range 0 to 65535 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_11_2 and is of type INTEGER.
Read-only serial number in decimal
Values in the range 0 to 65535 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_12_4 and is of type INTEGER.
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Off |
| 1 | LED blinks at pulse counting |
The manufacturer defined default value is 1 (LED blinks at pulse counting).
This parameter has the configuration ID config_13_1 and is of type INTEGER.
The calibration progress is calculated as (value[1] - 65 + value[2] / value[3]) * 25. The calibration is finished successfully when value[0] = 2 and value[2] = value[3]. The calibration has failed if value[0] != 1 OR (value[0] = 2 AND value[2] != value[
Values in the range 0 to 65535 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_15_4 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 device does not support associations.
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_NO_OPERATION_V1 | |
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_METER_V2 | |
| COMMAND_CLASS_METER_TBL_MONITOR_V1 | |
| COMMAND_CLASS_CRC_16_ENCAP_V1 | |
| COMMAND_CLASS_CONFIGURATION_V1 | |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1 | |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1 | |
| COMMAND_CLASS_BATTERY_V1 | |
| COMMAND_CLASS_WAKE_UP_V1 | |
| COMMAND_CLASS_VERSION_V1 | |
| COMMAND_CLASS_TIME_PARAMETERS_V1 |
Did you spot an error in the above definition or want to improve the content? You can contribute to the database here.