Query Replies Table
   

In this Topic Hide

ASCII Format

Raw Format

Word / Parameter Formats

Cluster Count

Router Count

Cluster IDs

Cluster Member (Router) IDs

Last Scene In Block (LSIB)

Device Type

Device State

Device Disabled State

Lamp Failure State

Device Faulty State

Device Missing State

Battery Failure State

Measurement

Input State

Load Level

Power Consumption

Local System Time

Test Status

Test Result

Battery Charge

Longitude

Latitude

Designer Version

HelvarNet Version

 

Notes:

  • See Word / Parameter Formats for guidance on Words in raw format and parameters in ASCII format.

  • A query reply is prefixed with the query command that was sent.

  • When you send a query command, if you have entered an invalid parameter or it has been sent to a device, router or cluster that does not exist, then, instead of a reply, you will receive an error message describing what is wrong with the command. See Error / Diagnostic Messages.

ASCII Format

Name

Reply Description

101 - Query Clusters  

List of cluster IDs (separated by comma delimiter)

102 - Query Routers

List of router IDs (separated by comma delimiter)

103 - Query LSIB

LSIB, 1..16

104 - Query Device Type

Device Type

105- Query Description Group

Group Description, an ASCII extended character set response describing the group queried

106- Query Description Device

Device Description, an ASCII extended character set response describing the device queried

110 - Query Device State

Device State, a decimal value, that when broken down into its binary form, represents the states where each state is represented by 1 or 0  

111 - Query Device Is Disabled

Device Disabled State, 1 = 'Disabled' or 0 = 'Enabled'

112 - Query Lamp Failure

Lamp Failure State, 1 = 'Failed' or 0 = OK

113 - Query Device Is Faulty

Device Faulty State, 1 = 'Faulty' or 0 = OK

114 - Query Device Is Missing

Device Missing State, 1 = 'Missing' or 0 = 'Present'

129 - Query Emergency Battery Failure

Battery Failure State, 1 = 'Failed' or 0 = OK

150 - Query Measurement

Measurement, 1..100 (%) or 0..200 light sensor level

151 - Query Inputs

Input State, a decimal value, that when broken down into its binary form, represents the input states where each state is represented by 1 or 0

152 - Query Load Level

Load Level, 1..100 (%)

160 - Query Power Consumption

Power, Watts (W)

161 - Query Group Power Consumption

Power, Watts (W)

170 - Query Emergency Function Test Time

Time test was completed (Local System Time, a decimal value that represents the number of seconds since 1st January 1970)

171 - Query Emergency Function Test State

Test Status, a decimal value that accounts for combinations of the state values described in the Emergency State Values table

172 - Query Emergency Duration Test Time

Time test was completed (Local System Time, a decimal value that represents the number of seconds since 1st January 1970)

173 - Query Emergency Duration Test State

Test Status, a decimal value that accounts for combinations of the state values described in the Emergency State Values table

174 - Query Emergency Battery Charge

Battery Charge, 0-100 (%)

175 - Query Emergency Battery Time

Battery Time. A decimal value for the time the lamp has been running from the batteries. 0 ... 255 hours

176 - Query Emergency Total Lamp Time

Total Lamp Time. A decimal value for the amount of time the lamp has been running on all power supplies.

185 - Query Time

Local System Time, a decimal value that represents the number of seconds since 1st January 1970

186 - Query Longitude

Longitude, a signed decimal value that represents the hemisphere, hours, minutes and seconds of the longitudinal line from GMT

187 - Query Latitude

Latitude,  a signed decimal value that represents the hemisphere, hours, minutes and seconds of the latitudinal line from GMT

188 - Query Time Zone

Time Difference, a decimal value that represents the number of seconds for the longitudinal location of the time line from GMT

189 - Query Daylight Saving Time

DST,  1 = 'On' or 0 = 'Off'

190 - Query Software Version

Designer Version (Major Version, Step Stone Version, Point Release Version), a decimal value, that when broken down into its hexadecimal form shows the version parts in their respective octets

191 - Query HelvarNet Version

HelvarNet Version

Raw Format

Name

Word 11 (32b)

Word 12 (32b)

W13
(32b)

W14
(32b)

W15
(32b)

 

W16
(32b)

W17
(32b)

W18
(32b)

W19
(32b)

101 - Query Clusters

Cluster Count (total no. of clusters), 0

Cluster IDs

32 bytes in total, arranged as 8x32 bit words; a bit field detailing the existence of the clusters 1-253
(bits 0, 254 and 255 are always zero)

C2

C3

C4

C5

C6

C7

C8

102 - Query Routers

Router Count (total no. of routers), 0

Router IDs

32 bytes in total, arranged as 8x32 bit words; a bit field detailing the existence of the routers 1-254
(bits 0, 255 are always zero)

R2

R3

R4

R5

R6

R7

R8

103 - Query LSIB

LSIB, 1..16

 

104 - Query Device Type

Device Type

105 - Query Description Group

Group Description

Group Description (visible in additional word 8x32 bit word if the group description is longer than four ASCII extended display characters)

 

 

 

 

 

 

 

105 - Query Description Device

Device Description

Device Description

(visible in additional word 8x32 bit words if the group description is longer than four ASCII extended display characters)

 

 

 

 

 

 

 

 

 

110 - Query Device State

Device State

111 - Query Device Is Disabled

Device Disabled State, 1=Disabled / 0=OK

112 - Query Lamp Failure

Lamp Failure State, 1=Failed / 0=OK

113 - Query Device Is Faulty

Device Faulty State, 1=Faulty / 0=OK

114 - Query Device Is Missing

Device Missing State, 1=Missing / 0=OK

129 - Query Emergency Battery Failure

Battery Failure State, 1=Failed / 0=OK

150 - Query Measurement

Measurement, 1..100(%)

151 - Query Inputs

Input State

152 - Query Load Level

Load Level, 1..100(%)

160 - Query Power Consumption

Power, Watts(W)

161 - Query Group Power Consumption

Power, Watts(W)

170 - Query Emergency Function Test Time

Local System Time, no. of seconds since 00:00:00, 1st Jan 1970

171 - Query Emergency Function Test State

Test Status

172 - Query Emergency Duration Test Time

Local System Time, no. of seconds since 00:00:00, 1st Jan 1970

173 - Query Emergency Function Test State

Test Status, Pending=1 / Ready=0

174 - Query Emergency Battery Charge

Battery Charge, 0-100(%)

175 - Query Emergency Battery Lamp Time

Battery Time. The time the lamp has been running from the batteries. 0 ...255 hours

 

176 - Query Emergency Battery Total Lamp Time

Battery Total Lamp Time. The amount of time the lamp has been running on all power supplies. 0 ...255 hours

185 - Query Time

Local System Time, no. of seconds since 00:00:00, 1st Jan 1970

186 - Query Longitude

Longitude

A signed 32 bit value, W=Positive, E=Negative

187 - Query Latitude

Latitude

A signed 32 bit value, N=Positive, S=Negative

188 - Query Time Zone

Time Zone

A signed 32 bit integer representing the seconds from GMT; each time zone is represented by an hour (3600 seconds). Western zones are negative and Eastern zones are positive

189 - Query Daylight Saving Time

DST (LSBit),  1=On / 0=Off

190 - Query Software Version

Version number:

Byte 3 (MSB)=Major Version

Byte 2=Step Stone Version

Byte 1=Point Release Version

191 - Query HelvarNet Version

Version number

Word / Parameter Formats

Note:

Cluster Count

Raw Format

31.................................................24

23...............................................16

15.....................................................8

7..................................................0

Cluster Count  [31:16]

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

Byte 3

Byte 2

Byte 1

Byte 0

Router Count

Raw Format

31.................................................24

23...............................................16

15.....................................................8

7..................................................0

Router Count  [31:16]

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

Byte 3

Byte 2

Byte 1

Byte 0

Cluster IDs

Raw Format

31.................................................24

23.................................................16

15...................................................8

7....................................................0

Cluster IDs [31:0]

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Cluster IDs = 1..253

Cluster Member (Router) IDs

Raw Format

31.................................................24

23.................................................16

15...................................................8

7....................................................0

Router IDs [31:0]

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Cluster Member IDs = 1..254

Last Scene In Block (LSIB)

Raw Format

31.................................................24

23.................................................16

15..................................................8

7....................................................0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

LSIB [7:0]

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

LSIB = 1..16

Device Type

Raw Format

31.................................................24

23.................................................16

15...................................................8

7....................................................0

Device Type [31:0]

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Refer to Query Device Type section

Device State

Raw Format

31.................................................24

23.................................................16

15.....................................................8

7..................................................0

Device State [31:0]

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Refer to Query Device State section

Device Disabled State

Raw Format

31.................................................24

23.................................................16

15.......................................................8

7.........................................................0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

1

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Device Disabled State = 1 (Disabled) or 0 (OK)

Lamp Failure State

Raw Format

31.................................................24

23.................................................16

15.......................................................8

7.........................................................0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

1

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Lamp Failure State = 1 (Failed) / 0 (OK)

Device Faulty State

Raw Format

31.................................................24

23.................................................16

15.......................................................8

7.........................................................0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

1

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Device Faulty State = 1 (Faulty) / 0 (OK)

Device Missing State

Raw Format

31.................................................24

23.................................................16

15.......................................................8

7.........................................................0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

1

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Device Missing State = 1 (Missing) / 0 (OK)

Battery Failure State

Raw Format

31.................................................24

23.................................................16

15.......................................................8

7.........................................................0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

1

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Battery Failure State = 1 (Failed) / 0 (OK)

Measurement

Raw Format

31.................................................24

23.................................................16

15..................................................8

7................................................0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

Measurement [6:0]

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Measurement = 1..100 or the reading from the Light Sensor subdevice of the Multisensor

Input State

Raw Format

31.................................................24

23.................................................16

15..................................................8

7................................................0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

Inputs [7:0]

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Refer to Query Inputs section

Load Level

Raw Format

31.................................................24

23.................................................16

15..................................................8

7................................................0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

Load Level [6:0]

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Load Level = 0..100

Power Consumption

Raw Format

31.................................................24

23.................................................16

15.....................................................8

7..................................................0

Power [31:0]

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Power = W

Local System Time

Raw Format

31.................................................24

23....................................................16

15.....................................................8

7.......................................................0

Local System Time [31:0]

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

The local system time value is calculated in seconds from 00:00:00, 1 January 1970.

ASCII

Hexadecimal

System Time Value

1

0x00000001

1 second

60

0x0000003C

60 seconds (1 minute)

3600

0x00000E10

60 minutes (1 hour)

86400

0x00015180

24 hours (1 day)

31536000

0x01E13380

1 year (365 days)

Test Status

Raw Format

31.................................................24

23.................................................16

15.......................................................8

7.........................................................0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

1

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Test Status = 1 (Pending) / 0 (Ready)

Test Result

Raw Format

31.................................................24

23.................................................16

15.......................................................8

7.........................................................0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

1

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Test Result = 1 (Passed) / 0 (Failed)

Battery Charge

Raw Format

31.................................................24

23.................................................16

15.......................................................8

7.........................................................0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

Battery Charge [6:0]

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Battery Charge = 0-100

Longitude

Raw Format

Longitude is calculated from the raw value received as follows:

W 051025’00” = (51 x 3600 seconds) + (25 x 60 seconds)  + (0 x 1 seconds) = 185100

Note:

  •  E = negative of W (for Hex, use two’s complement to represent negative values).

 

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 = 25

ss” = 0.00000000000000000000000000002 x 60 = 0.0000000000000000000000000012 = 0

ASCII Format

Longitude = a signed decimal value that represents the hemisphere, hours, minutes and seconds of the longitudinal line from GMT, e.g. "185100".

Latitude

Latitude is as per longitude (see above).

Note:

  • S = negative of N (for Hex, use two’s complement to represent negative values).

Designer Version

Raw Format

31.................................................24

23.................................................16

15.......................................................8

7.........................................................0

Designer Version [31:0]

0

0

0

0

0

0

0

0

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

Designer Version = a decimal value, that when broken down into its hexadecimal form shows the version parts in their respective octets, e.g. v 4.2.2 = 67371520

HelvarNet Version

Raw Format

31.................................................24

23.................................................16

15.......................................................8

7.........................................................0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

1

Byte 3

Byte 2

Byte 1

Byte 0

ASCII Format

HelvarNet Version = X  (e.g. 1)

Related Topics