Query Commands |
|||
In this Topic Hide
103 - Query Last Scene In Block (LSIB)
109 - Query Last Scene In Group (LSIG)
100 - Query Device Types and Addresses
106 - Query Description Device
107 - Query Workgroup Name - UDP Broadcast
108 - Query Workgroup Membership
Load Interface Maintenance Query Commands
71 - Query Ballast Running Hours
74 - Query Maximum Temperature
75 - Query Minimum Temperature
111 - Query Device Is Disabled
129 - Query Emergency Battery Failure
Measurement / Input / Level Query Commands
Power Consumption Query Commands
161 - Query Group Power Consumption
170 - Query Emergency Function Test Time
171 - Query Emergency Function Test State
172 - Query Emergency Duration Test Time
173 - Query Emergency Duration Test State
174 - Query Emergency Battery Charge
175 - Query Emergency Battery Time
176 - Query Emergency Total Lamp Time
When you send a query command, the message returned contains the query command data which was sent, followed by the reply; this data makes up the query reply. If you send a query command in raw format, for example, the query reply will comprise all ten Words of the command plus the Word(s) that makes up the reply. It is necessary for the reply to contain the command data as the system will not guarantee the order of replies.
Notes:
|
When you send a Query Clusters command, the reply provides you with all the Cluster IDs that exist in the system.
Send: Command (101)
Returns a bit field indicating the presence of all clusters:
Command (101), Cluster Count, 8x32 bit Words detailing the existence of the clusters 1-253 (bits 0, 254, 255 are always zero)
If you send the following Query Clusters command:
>V:1,C:101#
If there are clusters 1, 2 and 253, then the reply will be:
?V:1,C:101=1,2,253#
If you send the following Query Clusters command:
0x00010065 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If there are 1, 2 and 253 clusters, then the reply will be:
0x01010065 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00030006 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x20000000
When you send a Query Routers command, the reply provides you with all the Cluster Member (Router) IDs that exist in the specified cluster.
Send: Command (102), Cluster (1..253)
Returns a bit field indicating the presence of all routers within the specified cluster:
Command (102), Router Count / Cluster ID (1..253), 8x32 bit Words detailing the existence of the routers 1-254 (bits 0 and 255 are always zero)
If you send the following Query Routers in cluster 253 command:
>V:1,C:102,@253#
If there are routers 252, 253 and 254 in cluster 253, then the reply will be:
?V:1,C:102,@253=252,253,254#
If you send the following Query Routers in cluster 253 command:
0x00010066 0x000000FD 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If there are routers 252, 253 and 254 in cluster 253, then the reply will be:
0x01010066 0x000000FD 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00030000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x70000000
When you send a Query Last Scene In Block command, the reply provides
you with the last scene that was recalled in the specified scene block.
Note:
|
Send: Command (103), Group (1..16383), Block (1..8)
Returns the number of the last recalled scene in the scene block:
Command (103), Group (1..16383),
Block (1..8), Last Scene In Block (1..16)
If you send the following Query LSIB command (including the group and scene block parameters):
>V:1,C:103,G:5,B:2#
If the last scene called in the block is 4, then the reply will be:
?V:1,C:103,G:5,B:2=4#
If you send the following Query LSIB command (including the group and scene block parameters):
0x00010067 0x00000005 0x00000000 0x00020000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the last scene called in the block is 4, then the reply will be:
0x01010067 0x00000005 0x00000000 0x00020000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000004
When you send a Query Last Scene In Group command, the reply provides
you with the last scene that was recalled in the specified group.
Note:
|
Send: Command (109), Group (1..16383)
Returns the number of the last recalled scene in the group:
Command (109), Group (1..16383),
Last Scene In Group (1..128)
If you send the following Query LSIG command:
>V:2,C:109,G:5#
If the last scene called in the group is 78, then the reply will be:
?V:2,C:109,G:5=78#
DALI , DIGIDIM, Imagine (SDIM ) and DMX devices are all capable of returning a device type. Devices can return more than one piece of type information.
For an ASCII query the response will be four comma separated values, the last of which is the protocol; the penultimate is the device type; and the remaining two are extra device information.
For a raw query the response will be returned in a 32 bit Word. The least significant byte contains the protocol; the next least significant byte contains the main device type; the two most significant bytes contain extra device information.
The devices protocols are as follows:
Protocol |
Values |
DALI |
0x01 |
DIGIDIM |
0x02 |
Imagine / SDIM |
0x04 |
DMX |
0x08 |
Note:
|
Send: Command (104), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Returns the device type:
Command (104), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Device Type (see tables below)
If you send the following Query Device Type command (including the full address of the device):
>V:1,C:104,@2.2.1.1#
If the device is a 100 Rotary, then the reply will be:
?V:1,C:104,@2.2.1.1=00100802#
If you send the following Query Device Type command (including the full address of the device):
0x00010068 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the device is a 100 Rotary, then the reply will be:
0x01010068 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00100802
Device Type
|
Byte3-Byte1 (MSBytes) [Any combination of the following] |
Byte0 (LSByte) |
Fluorescent Lamps |
0x00 |
0x01 |
Self-contained emergency lighting |
0x01 |
0x01 |
Discharge lamps (excluding fluorescent lamps) |
0x02 |
0x01 |
Low voltage halogen lamps |
0x03 |
0x01 |
Incandescent lamps |
0x04 |
0x01 |
Conversion into D.C. voltage (IEC 60929) |
0x05 |
0x01 |
LED modules |
0x06 |
0x01 |
Switching function (i.e. Relay) |
0x07 |
0x01 |
Colour control |
0x08 |
0x01 |
Sequencer |
0x09 |
0x01 |
Undefined |
0x0B-0xFE |
0x01 |
Device Type
|
Byte3 (MSByte) |
Byte2 |
Byte1 |
Byte0 (LSByte)
|
100 – Rotary |
0x00 |
0x10 |
0x08 |
0x02 |
110 – Single Slider |
0x00 |
0x11 |
0x07 |
0x02 |
111 – Double Slider |
0x00 |
0x11 |
0x14 |
0x02 |
0x00 |
0x12 |
0x13 |
0x02 |
|
122 – 2 Button modifier + IR |
0x00 |
0x12 |
0x20 |
0x02 |
124 – 5 Button + IR |
0x00 |
0x12 |
0x44 |
0x02 |
125 – 5 Button + modifier + IR |
0x00 |
0x12 |
0x51 |
0x02 |
126 – 8 Button + IR |
0x00 |
0x12 |
0x68 |
0x02 |
170 – IR Receiver |
0x00 |
0x17 |
0x01 |
0x02 |
312 – Multisensor |
0x00 |
0x31 |
0x25 |
0x02 |
410 – Ballast Style 1-10V Converter |
0x00 |
0x41 |
0x08 |
0x02 |
416S – 16A Dimmer |
0x00 |
0x41 |
0x60 |
0x02 |
425S – 25A Dimmer |
0x00 |
0x42 |
0x52 |
0x02 |
444 – Mini Input Unit |
0x00 |
0x44 |
0x43 |
0x02 |
450 – 800W Dimmer |
0x00 |
0x45 |
0x04 |
0x02 |
452 – 1000W Universal Dimmer |
0x00 |
0x45 |
0x28 |
0x02 |
455 – 500 Watt Thyristor Dimmer |
0x00 |
0x45 |
0x59 |
0x02 |
458/DIM8 – 8 Channel Dimmer |
0x00 |
0x45 |
0x80 |
0x02 |
458/CTR8 – 8-Channel Ballast Controller |
0x74 |
0x45 |
0x81 |
0x02 |
458/SW8 – 8-Channel Relay Module |
0x04 |
0x45 |
0x83 |
0x02 |
460 – DALI to SDIM Converter |
0x00 |
0x46 |
0x03 |
0x02 |
472 – Din Rail 1-10V / DSI® Converter |
0x00 |
0x47 |
0x26 |
0x02 |
474 – 4 Channel Ballast Controller - Output Unit |
0x00 |
0x47 |
0x40 |
0x02 |
474 – 4 Channel Ballast Controller - Relay Unit |
0x00 |
0x47 |
0x41 |
0x02 |
490 – Blinds Unit |
0x00 |
0x49 |
0x00 |
0x02 |
494 – Relay Unit |
0x00 |
0x49 |
0x48 |
0x02 |
498 – Relay Unit |
0x00 |
0x49 |
0x86 |
0x02 |
804 – DIGIDIM 4 |
0x00 |
0x80 |
0x45 |
0x02 |
924 – LCD TouchPanel |
0x00 |
0x92 |
0x40 |
0x02 |
935 – Scene Commander (6 buttons) |
0x00 |
0x93 |
0x56 |
0x02 |
939 – Scene Commander (10 buttons) |
0x00 |
0x93 |
0x94 |
0x02 |
942 – Analogue Input Unit |
0x00 |
0x94 |
0x24 |
0x02 |
458/OPT4 – 4-Channel Options Module |
0x00 |
0x45 |
0x86 |
0x02 |
Device Type
|
Byte3 (MSByte) |
Byte2 |
Byte1 |
Byte0 (LSByte) |
No device present |
0x00 |
0x00 |
0x00 |
0x04 |
474 – 4 Channel Ballast Controller - Relay Unit |
0x00 |
0x00 |
0xF1 |
0x04 |
474 – 4 Channel Ballast Controller - Output Unit |
0x00 |
0x00 |
0xF2 |
0x04 |
458/SW8 – 8-Channel Relay Module |
0x00 |
0x00 |
0xF3 |
0x04 |
458/CTR8 – 8-Channel Ballast Controller |
0x00 |
0x00 |
0xF4 |
0x04 |
458/OPT4 – Options Module |
0x00 |
0x00 |
0xF5 |
0x04 |
498 – 8-Channel Relay Unit |
0x00 |
0x00 |
0xF6 |
0x04 |
458/DIM8 – 8-Channel Dimmer |
0x00 |
0x00 |
0xF7 |
0x04 |
HES92060 Sine Wave Dimmer |
0x00 |
0x00 |
0xF8 |
0x04 |
Ambience4 Dimmer |
0x00 |
0x00 |
0xF9 |
0x04 |
HES92020 SCR Dimmer |
0x00 |
0x00 |
0xFA |
0x04 |
HES98020 Output Unit |
0x00 |
0x00 |
0xFB |
0x04 |
HES92220 Transistor Dimmer |
0x00 |
0x00 |
0xFC |
0x04 |
HES98180-98291 Relay Unit |
0x00 |
0x00 |
0xFE |
0x04 |
Dimmer (old style, type undefined) |
0x00 |
0x00 |
0xFF |
0x04 |
Device Type |
Byte3 (MSB) |
Byte2 |
Byte1 |
Byte0 (LSByte) |
DMX No device present |
0x00 |
0x00 |
0x00 |
0x08 |
DMX Channel In |
0x00 |
0x00 |
0x01 |
0x08 |
DMX Channel Out |
0x00 |
0x00 |
0x02 |
0x08 |
Key Type |
Byte3 (MSB) |
Byte2 |
Byte1 |
Byte0 (LSByte) |
SinglePress |
0x00 |
0x00 |
0x00 |
0x01 |
TimedPress |
0x00 |
0x00 |
0x00 |
0x02 |
ToggleSolo |
0x00 |
0x00 |
0x00 |
0x03 |
ToggleBlock |
0x00 |
0x00 |
0x00 |
0x04 |
TouchDimBlock |
0x00 |
0x00 |
0x00 |
0x05 |
TouchDimSolo |
0x00 |
0x00 |
0x00 |
0x06 |
Modifier |
0x00 |
0x00 |
0x00 |
0x07 |
EdgeMode |
0x00 |
0x00 |
0x00 |
0x08 |
Slider |
0x00 |
0x00 |
0x00 |
0x09 |
AnalogueInput |
0x00 |
0x00 |
0x00 |
0x0A |
Rotary |
0x00 |
0x00 |
0x00 |
0x0B |
PIR |
0x00 |
0x00 |
0x00 |
0x0C |
ContantLight |
0x00 |
0x00 |
0x00 |
0x0D |
SliderInputUnit |
0x00 |
0x00 |
0x00 |
0x0E |
When targeted at a subnet it will respond with all of the devices types with corresponding index, as in command 104. The device type and index pairs are in this format: Device Type @ index.
If you send the following Query Device Type command (including the full address of the device):
>V:2,C:100@2.2.1#
If the DALI subnet has 2 devices, one being a 100 Rotary at index 1, and the other being a 110 Slider at index 10, then the reply will be:
?V:2,C:100@2.2.1.1=00100802@1,00110702@10#
DALI , DIGIDIM , Imagine ( SDIM ) and DMX devices are all capable of returning a description of the group.
The replies in the following examples are the default descriptions for those devices/objects. However, the reply will return group name according to the conventions you have applied to your lighting system via Designer. For example, if the group has been named 'Building' then this will be returned in the Query Description Group reply.
Note:
|
Send: Command (105), Group (1...16383)
Returns: Command (105), Group (1...16383), Group description
If you send the following Query Description Group command (including the group number):
>>V:1,C:105,G:5#
The reply will be the command sent and the reply containing the group description of the group requested i.e.
?V:1,C:105,G:5=Group 5#
If you send the following Query Description Group command (including the group number):
0x00010069 0x00000005 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the description is Group 5, then the reply will be:
0x01010069 0x00000005 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x47726F75 0x70203500
DALI , DIGIDIM, Imagine ( SDIM ) and DMX devices are all capable of returning a description of a specific device.
The replies in the following examples are the default descriptions for those devices/objects. However, the reply will return group name according to the conventions you have applied to your lighting system via Designer. For example, if the device has been named 'Ballast 10' then this will be returned in the Query Description Group reply.
Note:
|
Send: Command (106), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Returns a description of the device:
Command (106), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Device description
If you send the following Query Description Device command (including the full address of the device):
>V:1,C:106,@2.2.1.1#
If the device is called 'Ballast', then the reply will be:
?V:1,C:106,@2.2.1.1=Ballast#
If you send the following Query Description Device command (including the full address of the device):
0x0001006A 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the device is called 'Ballast', then the reply will be:
0x0101006A 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x42616C6C 0x61737400
The following set of commands are extensions to version 1 and are designed to allow for the discovery of a Helvar router system.
By broadcasting this command all Helvar routers that exist on a network, providing that they can see the message, will respond with the workgroup name to which they belong. If there are multiple workgroups, then there will be responses from all routers in all workgroups.
If you broadcast (using UDP) the following Query Workgroup Name command:
>V:2,C:107#
All routers will respond with:
?V:2,C:107=WorkgroupName#
For example, a router with workgroup name 'Restaurant' will respond with: ?V:2,C:107=Restaurant#
A router will respond to this query with the address strings of the routers that are members of the workgroup.
An address string contains the IP address of the router, and takes the form of '@10.254.1.1'.
If you send the following Query Workgroup Membership command:
>V:2,C:108#
A typical response will be:
?V:2,C:108=@10.254.1.1,@10.254.1.2,@10.254.1.3#
A router will respond to this query with the group identifiers of all groups that have been programd to the router's workgroup.
The response is a comma delimited string of group identifiers.
If you send the following Query Groups command:
>V:2,C:165#
A typical response will be:
?V:2,C:165=1,2,3,4,...,100#
A router will respond to this query with the address strings of all devices that are members of the group.
The device address string contains the cluster, router, subnet and device index, and takes the form of '@1.1.1.34'.
If you send the following Query Groups command:
>V:2,C:164,G:100#
A typical response will be:
?V:2,C:164,G:100=@1.1.1.34,@1.1.1.35,@1.1.1.36#
A router will respond to this query with the scene descriptions that are prefixed with the corresponding group, block and scene.
The scene description string contains the group, block, and scene numbers and scene description, and takes the form of '@G.B.S:Description'.
If you send the following Query Groups command:
>V:2,C:166#
A typical response will be:
?V:2,C:166=@1.1.1:Morning@1.1.2:Afternoon@1.1.3:Night#
When targeted at a load interface, the response will include all of the scene levels.
The response will contain all 136 scene levels, in a comma delimited format.
Ignores are represented by '*'. Last Level is represented by 'L'.
If you send the following Query Groups command:
>V:2,C:167@1.1.1.4#
A typical response will be:
?V:2,C:167@1.1.1.4=100,75,50,25,0,0,0,0,0,0,0,0,L,L,L,0,*,*,*,*,*,*,*,*,*,*,*,*,*,*,*,*,(33-128),*,*,*,*,*,*,*,*#
Note: (33-128) in the above example represents scenes 33 to 128.
When targeted at a load interface, the response will represent the maintenance property value.
The load interface must support the iDim Ballast range. For information, visit the iDim section of the Helvar Website.
E.g. disabled, lamp fault, missing, overtemperature, Function Test in progress, Function Test passed etc.
Send: Command (110), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Returns the device state:
Command (110), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Device State (see table below)
If you send the following Query Device State command (including the full address of the device):
>V:1,C:110,@2.2.1.1#
If the device has been disabled, then the reply will be:
?V:1,C:110,@2.2.1.1=1#
If you send the following Query Device State command (including the full address of the device):
0x0001006E 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the device has been disabled, then the reply will be:
0x0101006E 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000001
The state of a device is described by the following set of flags:
State |
Description |
Flag Value
|
NSDisabled |
Device or subdevice has been disabled, usually an IR subdevice or a DMX channel |
0x00000001 |
NSLampFailure |
Unspecified lamp problem |
0x00000002 |
NSMissing |
The device previously existed but is not currently present |
0x00000004 |
NSFaulty |
Ran out of addresses (DALI subnet) / unknown DIGIDIM control device / DALI load that keeps responding with multireplies |
0x00000008 |
NSRefreshing |
DALI subnet, DALI load or DIGIDIM control device is being discovered |
0x00000010 |
NSReserved |
Internal use only |
0x00000020 |
NSReserved |
|
0x00000040 |
NSReserved |
Internal use only |
0x00000080 |
NSEM_Resting |
The load is intentionally off whilst the control gear is being powered by the emergency supply |
0x00000100 |
NSEM_Reserved |
|
0x00000200 |
NSEM_InEmergency |
No mains power is being supplied |
0x00000400 |
NSEM_InProlong |
Mains has been restored but device is still using the emergency supply |
0x00000800 |
NSEM_FTInProgress |
The Functional Test is in progress (brief test where the control gear is being powered by the emergency supply) |
0x00001000 |
NSEM_DTInProgress |
The Duration Test is in progress. This test involves operating the control gear using the battery until the battery is completely discharged. The duration that the control gear was operational for is recorded, and then the battery recharges itself from the mains supply |
0x00002000 |
NSEM_Reserved |
|
0x00004000 |
NSEM_Reserved |
|
0x00008000 |
NSEM_DTPending |
The Duration Test has been requested but has not yet commenced. The test can be delayed if the battery is not fully charged |
0x00010000 |
NSEM_FTPending |
The Functional Test has been requested but has not yet commenced. The test can be delayed if there is not enough charge in the battery |
0x00020000 |
NSEM_BatteryFail |
Battery has failed |
0x00040000 |
NSReserved |
Internal use only |
0x00080000 |
NSReserved |
Internal use only |
0x00100000 |
NSEM_Inhibit |
Prevents an emergency fitting from going into emergency mode |
0x00200000 |
NSEM_FTRequested |
Emergency Function Test has been requested |
0x00400000 |
NSEM_DTRequested |
Emergency Duration Test has been requested |
0x00800000 |
NSEM_Unknown |
Initial state of an emergency fitting |
0x01000000 |
NSOverTemperature |
Load is over temperature/heating |
0x02000000 |
NSOverCurrent |
Too much current is being drawn by the load |
0x04000000 |
NSCommsError |
Communications error |
0x08000000 |
NSSevereError |
Indicates that a load is either over temperature or drawing too much current, or both |
0x10000000 |
NSBadReply |
Indicates that a reply to a query was malformed |
0x20000000 |
NSReserved |
|
0x40000000 |
NSDeviceMismatch |
The actual load type does not match the expected type |
0x80000000 |
Note:
|
Query whether the device has been disabled.
Send: Command (111), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Returns the lamp state:
Command (111), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Device Disabled State (1=Disabled, 0=Enabled)
If you send the following Query Device Is Disabled command (including the full address of the device):
>V:1,C:111,@1.1.2.58#
If the device has been disabled, then the reply will be:
?V:1,C:111,@1.1.2.58=1#
If you send the following Query Device Is Disabled command (including the full address of the device):
0x0001006F 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the device has been disabled, then the reply will be:
0x0101006F 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000001
Query whether the lamp has failed.
Note:
|
Send: Command (112), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Returns the lamp state:
Command (112), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Lamp Failure State (1=Failed, 0=OK)
If you send the following Query Lamp Failure command (including the full address of the device):
>V:1,C:112,@1.1.2.58#
If the lamp has failed, then the reply will be:
?V:1,C:112,@1.1.2.58=1#
If you send the following Query Lamp Failure command (including the full address of the device):
0x00010070 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the lamp has failed, then the reply will be:
0x01010070 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000001
Query whether the device is missing.
Send: Command (113), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Returns a message indicating whether the device is missing or not:
Command (113), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Device Missing State (1=Missing, 0=Present)
If you send the following Query Device Is Missing command (including the full address of the device):
>V:1,C:113,@2.2.1.1#
If the device is missing, then the reply will be:
?V:1,C:113,@2.2.1.1=1#
If you send the following Query Device Is Missing command (including the full address of the device):
0x00010072 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the device is missing, then the reply will be:
0x01010072 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000001
Query whether the device is faulty.
Send: Command (114), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Returns a message indicating whether the device is faulty or not:
Command (114), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Device Faulty State (1=Faulty, 0=OK)
If you send the following Query Device Is Faulty command (including the full address of the device):
>V:1,C:114,@2.2.1.1#
If the device is faulty, then the reply will be:
?V:1,C:114,@2.2.1.1=1#
If you send the following Query Device Is Faulty command (including the full address of the device):
0x00010071 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the device is faulty, then the reply will be:
0x01010071 0x00020002 0x00010001 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000001
Query whether the emergency ballast's battery has failed.
Note:
|
Send: Command (129), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Returns the emergency battery state:
Command (129), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Battery Failure State (1=Failed, 0=OK)
If you send the following Query Emergency Battery Failure command (including the full address of the device):
>V:1,C:129,@1.1.2.58#
If the emergency ballast's battery has failed, then the reply will be:
?V:1,C:129,@1.1.2.58=1#
If you send the following Query Emergency Battery Failure command (including the full address of the device):
0x00010081 0x00010001 0x00020058 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the emergency ballast's battery has failed, then the reply will be:
0x01010081 0x00010001 0x00020058 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000001
Note:
|
For analogue types, e.g. light measurement (Multisensor), analogue input (Analogue Input Unit).
Note:
|
Send: Command (150), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Subdevice (1..16)
Returns the measurement from the device / subdevice:
Command (150), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Subdevice (1..16), Measurement (1..100)
If you send the following Query Measurement command (including the full address of the subdevice):
>V:1,C:150,@2.2.1.1.4#
If the measurement from the subdevice is 100, then the reply will be:
?V:1,C:150,@2.2.1.1.4=100#
If you send the following Query Measurement command (including the full address of the subdevice):
0x00010096 0x00020002 0x00010001 0x00040000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the measurement from the subdevice is 100, then the reply will be:
0x01010096 0x00020002 0x00010001 0x00040000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000064
Returns the state or digital input(s) of: a device (e.g. for the PIR detector of a Multisensor - 0x01=occupied within past minute, 0x00=unoccupied); or the LEDs of a button panel; or the switch inputs of an input unit. If sent to the device level, summarises the digital input state. If sent to the subdevice level, gives the state of that subdevice’s input.
Note:
|
Send: Command (151), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Subdevice (1..16)
Returns the input state of the device / subdevice:
Command (151), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Subdevice (1..16), Input State (see below)
The majority of subdevices have on and off states and are therefore represented by 0 (OFF) or 1 (ON). For example, buttons with LEDs will either be pressed (LED on) or not pressed (LED off). See below for the exceptions.
Mini Input Unit: As there are 8 inputs on this device there will be 8 states e.g. 01001100 would be represented in ASCII as 50.
Slider: 0..100 (level in %)
Analogue Input Unit: 0..100 (level in %)
If you send the following Query Inputs command to a subdevice (including the full address of the subdevice):
>V:1,C:151,@2.2.1.1.4#
If the state of the subdevice is ON, then the reply will be:
?V:1,C:151,@2.2.1.1.4=1#
If you send the following Query Inputs command to a subdevice (including the full address of the subdevice):
0x00010097 0x00020002 0x00010001 0x00004000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the state of the subdevice is ON, then the reply will be:
0x01010097 0x00020002 0x00010001 0x00004000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000001
Note:
|
Send: Command (152), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Command (152), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Load Level (1..100)
If you send the following Query Load Level command (including the full address of the device):
>V:1,C:152,@1.1.2.15#
If the load level is 25%, then the reply will be:
?V:1,C:152,@1.1.2.15=25#
If you send the following Query Load Level command (including the full address of the device):
0x00010098 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the load level is 25%, then the reply will be:
0x01010098 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000019
Note:
|
If you send the following Query Load Level command (including the full address of the device):
>V:1,C:152,@1.1.2.15#
If the load level is set at 1% and the switch on level is 2%, then the reply will be:
?V:1,C:152,@1.1.2.15=2147483649#
If you send the following Query Load Level command (including the full address of the device):
0x00010098 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the load level is 1% and the switch on level is 2%, then the reply will be:
0x01010098 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x80000001
The ASCII and Raw reply responses, 2147483649 and 0x80000001 are synonymous. If these replies are returned following a query load level request then the device at the specified address is 'Off' even though it appears 'On'.
For further
reference, the Raw Word table denotes the response to query load level
command when device is set to 'off':
31.................24 |
23.....................16 |
15...................8 |
7....................0 |
||
Switch [31:30] |
0 0 0 0 0 0 |
0 0 0 0 0 0 0 0 |
0 0 0 0 0 0 0 0 |
0 |
Level [6:0] |
Byte 3 |
Byte 2 |
Byte 1 |
Byte 0 |
Query the power consumption of a device.
Note:
|
Send: Command (160), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Command (160), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Power (in W)
If you send the following Query Power Consumption command (including the full address of the device):
>V:1,C:160,@1.1.2.15#
If the power consumption of the device is 23 W, then the reply will be:
?V:1,C:160,@1.1.2.15=23#
If you send the following Query Power Consumption command (including the full address of the device):
0x000100A0 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the power consumption of the device is 15 W, then the reply will be:
0x010100A0 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x0000000F
Query the power consumption of all devices in a group.
Note:
|
Send: Command (161), Group (1..16383)
Command (161), Group (1..16383), Power Consumption (in Watts)
If you send the following Query Group Power Consumption command (including the group number):
>V:1,C:161,G:16#
If the group's power consumption is 105 W, then the reply will be:
?V:1,C:161,G:16=105#
If you send the following Query Group Power Consumption command (including the group number):
0x000100A1 0x00000010 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the group's power consumption is 105 W, then the reply will be:
0x010100A1 0x00000010 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000069
Note:
|
Send: Command (170), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Command (170), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Emergency Function Test Time (hh:mm:ss dd-mmm-yyyy)
If you send the following Query Emergency Function Test Time command (including the full address of the device):
>V:1,C:170,@1.1.2.15#
If the Emergency Function Test Time is 08:00 on 1st July 2009, then the reply will be:
?V:1,C:170,@1.1.2.15=08:00:00 01-Jul-2009#
The raw time value is calculated in seconds from 00:00:00, 1 January 1970.
Time Value |
Hexadecimal |
1 second |
0x00000001 |
60 seconds (1 minute) |
0x0000003C |
60 minutes (1 hour) |
0x00000E10 |
24 hours (1 day) |
0x00015180 |
1 year (365 days) |
0x01E13380 |
If you send the following Query Emergency Function Test Time command (including the full address of the device):
0x000100AA 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the Emergency Function Test Time is 08:00 on 1st July 2009, then the reply will be:
0x010100AA 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x4A3DE880
Note:
|
Send: Command (171), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Command (171), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Emergency Function Test State (combinations of the following emergency state values).
States |
Values |
Pass |
0 |
Lamp Failure |
1 |
Battery Failure |
2 |
Faulty |
4 |
Failure |
8 |
Test Pending |
16 |
Unknown |
32 |
If you send the following Query Emergency Function Test Pending command (including the full address of the device):
>V:1,C:171,@1.1.2.15#
If the Emergency Function Test is pending, then the reply will be:
?V:1,C:171,@1.1.2.15=16#
If you send the following Query Emergency Function Test Pending command (including the full address of the device):
0x000100AB 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the Emergency Function Test is pending, then the reply will be:
0x010100AB 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000010
Note:
|
Send: Command (172), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Command (172), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Emergency Duration Test Time (hh:mm:ss dd-mmm-yyyy)
If you send the following Query Emergency Duration Test Time command (including the full address of the device):
>V:1,C:172,@1.1.2.15#
If the Emergency Duration Test Time is 06:00 on 1st January 2010, then the reply will be:
?V:1,C:172,@1.1.2.15=06:00:00#
The raw time value is calculated in seconds from 00:00:00, 1 January 1970.
Time Value |
Hexadecimal |
1 second |
0x00000001 |
60 seconds (1 minute) |
0x0000003C |
60 minutes (1 hour) |
0x00000E10 |
24 hours (1 day) |
0x00015180 |
1 year (365 days) |
0x01E13380 |
If you send the following Query Emergency Duration Test Time command (including the full address of the device):
0x000100AC 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the Emergency Duration Test Time is 06:00 on 1st January 2010, then the reply will be:
0x010100AC 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x4B306060
Note:
|
Send: Command (173), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Command (173), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Emergency Duration Test Pending (combinations of the emergency state values described in command 171)
If you send the following Query Emergency Duration Test Pending command (including the full address of the device):
>V:1,C:173,@1.1.2.15#
If the Emergency Duration Test is pending, then the reply will be:
?V:1,C:173,@1.1.2.15=16#
If you send the following Query Emergency Duration Test Pending command (including the full address of the device):
0x000100AD 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the Emergency Duration Test is pending, then the reply will be:
0x010100AD 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000010
Query the remaining charge of the emergency ballast battery.
Note:
|
Send: Command (174), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Command (174), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Emergency Battery Charge (0..100%)
If you send the following Query Emergency Battery Charge command (including the full address of the emergency ballast):
>V:1,C:174,@1.1.2.15#
If the emergency ballast battery has 40% charge remaining, then the reply will be:
?V:1,C:174,@1.1.2.15=40#
If you send the following Query Emergency Battery Charge command (including the full address of the emergency ballast):
0x000100AE 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the emergency ballast battery has 40% charge remaining, then the reply will be:
0x010100AE 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000028
Query the current total running time of the emergency ballast battery.
Note:
|
Send: Command (175), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Command (175), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Emergency Battery Time (1 ... 255 hours)
If you send the following Query Emergency Battery Time command (including the full address of the emergency ballast):
>V:1,C:175,@1.1.2.15#
If the emergency ballast battery running time has been 12 hours, then the reply will be:
?V:1,C:175,@1.1.2.15=12#
If you send the following Query Emergency Battery Time command (including the full address of the emergency ballast):
0x000100AF 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the emergency ballast battery running time has been 12 hours, then the reply will be:
0x010100AF 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x0000000C
Query the current total lamp running time from any power source.
Note:
|
Send: Command (176), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255)
Command (176), Cluster (1..253), Router (1..254), Subnet (1..4), Device (1..255), Emergency Total Lamp Time (1 ... 1020 hours)
If you send the following Query Emergency Total Lamp Time command (including the full address of the emergency ballast):
>V:1,C:176,@1.1.2.15#
If the emergency ballast total lamp running time has been 100 hours, then the reply will be:
?V:1,C:176,@1.1.2.15=100#
If you send the following Query Emergency Total Lamp Time command (including the full address of the emergency ballast):
0x000100B0 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the emergency ballast total lamp running time has been 100 hours, then the reply will be:
0x010100B0 0x00010001 0x0002000F 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000064
Send: Command (185)
Returns the local system time:
Command (185), Local System Time (hh:mm:ss dd-mmm-yyyy)
If you send the following Query Time command:
>V:1,C:185#
If the time is 14:36:39 on 1st July 2009, then the reply will be:
?V:1,C:185=1245591399#
The raw time value is calculated in seconds from 00:00:00, 1 January 1970.
Time Value |
Hexadecimal |
1 second |
0x00000001 |
60 seconds (1 minute) |
0x0000003C |
60 minutes (1 hour) |
0x00000E10 |
24 hours (1 day) |
0x00015180 |
1 year (365 days) |
0x01E13380 |
If you send the following Query Time command:
0x000100B9 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the time is 14:36:39 on 1st July 2009, then the reply will be:
0x010100B9 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x4A3E3767
Send: Command (186)
Returns the longitude :
Command (186), Longitude (H ddd0mm’ss” - where H = Hemisphere, d = degrees, m = minutes and s = seconds)
If you send the following Query Longitude command:
>V:1,C:186#
If the longitude of your location is W 064° 38’21”, then the reply will be:
?V:1,C:186=232701#
Longitude is calculated from the raw value received as follows:
Note:
|
Hexadecimal |
Decimal |
Longitude |
0x0002D30C |
185100 |
W 051025’00” |
0xFFFD2CF4 |
-185100 |
E 051025’00” |
The calculation is as follows:
ddd0 = 185100 / 3600 = 51.416666666666666666666666666667 - 0.416666666666666666666666666667 (remainder) = 51
mm’ = 0.416666666666666666666666666667 (remainder) x 60 = 25.00000000000000000000000000002 - 0.00000000000000000000000000002 (remainder) = 25
ss” = 0.00000000000000000000000000002 (remainder) x 60 = 0.0000000000000000000000000012 = 0
If you send the following Query Longitude command:
0x000100BA 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the longitude of your location is W 064° 38’21”, then the reply will be:
0x010100BA 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00038CFD
This is how you calculate the longitude values from this hexadecimal value:
0x00038CFD = 232701
ddd0 = 232701 / 3600 = 64.639166666666666666666666666667 - 0.639166666666666666666666666667 (remainder) = 64
mm’ = 0.639166666666666666666666666667 (remainder) x 60 = 38.35 - 0.35 (remainder) = 38
ss” = 0.35 (remainder) x 60 = 21
Send: Command (187)
Returns the latitude :
Command (187), Latitude (H dd0mm’ss” - where H = Hemisphere, d = degrees, m = minutes and s = seconds)
If you send the following Query Latitude command:
>V:1,C:187#
If the latitude of your location is N 64° 38’21”, then the reply will be:
?V:1,C:187=232701#
The raw latitude value is calculated as per the longitude value (see above),
Note:
|
If you send the following Query Latitude command:
0x000100BB 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the latitude of your location is N 64° 38’21”, then the reply will be:
0x010100BB 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00038CFD
Send: Command (188)
Returns the timezone offset (difference in seconds, moving westward, between UTC and local time [GMT]):
Command (188), Time Difference (-12..12 hours)
If you send the following Query Time Zone command:
>V:1,C:188#
If your location is in Central Europe at 1 hour ahead of Greenwich Mean time (GMT), then the reply will be:
??V:1,C:188=-3600#
If you send the following Query Time Zone command:
>V:1,C:188#
If you are located at 6 hours offset from Greenwich Mean time (GMT), then the reply will be:
?V:1,C:188=21600#
Note:
|
If you send the following Query Time Zone command:
0x000100BC 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If you are located at 1 hour offset from Greenwich Mean time (GMT), then the reply will be:
0x010100BC 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0xFFFFF1F0
Send: Command (189)
Returns the DST:
Command (189), DST (1=ON, 0=OFF)
If you send the following Query DST command:
>V:1,C:189#
If Daylight Saving Time is enabled, then the reply will be:
?V:1,C:189=1#
If you send the following Query DST command:
0x000100BD 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If Daylight Saving Time is enabled, then the reply will be:
0x010100BD 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000001
Query the router firmware version.
Send: Command (190)
Returns the software version:
Command (190), Software Version (e.g. 4.2.2)
If you send the following Query Software Version command:
>V:1,C:190#
If the router firmware version is 4.2.2, then the reply will be:
?V:1,C:190=67240448#
If you send the following Query Software Version command:
0x000100BE 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the router firmware version is 4.2.2, then the reply will be:
0x010100BE 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x04020200
Query the HelvarNet software version.
Send: Command (191)
Returns the software version:
Command (191), HelvarNet Version (e.g. 1)
If you send the following HelvarNet Software Version command:
>V:1,C:191#
If the HelvarNet version is 1, then the reply will be:
?V:1,C:191=1#
If you send the following Query Software Version command:
0x000100BF 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000
If the Designer software version is 4.2.2, then the reply will be:
0x010100BF 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000001