![]() |
![]() |
|
Z-Stack API Reference
8.31.00.00
|
Macros | |
| #define | ATTRID_LOCATION_TYPE 0x0000 |
| The LocationType attribute is 8 bits long and is divided into bit fields. | |
| #define | ATTRID_LOCATION_METHOD 0x0001 |
| The LocationMethod attribute hpdls the method value. | |
| #define | ATTRID_LOCATION_AGE 0x0002 |
| #define | ATTRID_LOCATION_QUALITY_MEASURE 0x0003 |
| #define | ATTRID_LOCATION_NUM_DEVICES 0x0004 |
| #define | ATTRID_LOCATION_COORDINATE1 0x0010 |
| Represent orthogonal linear coordinates x in meters as coordenate1 / 10. | |
| #define | ATTRID_LOCATION_COORDINATE2 0x0011 |
| Represent orthogonal linear coordinates y in meters as coordenate2 / 10. | |
| #define | ATTRID_LOCATION_COORDINATE3 0x0012 |
| Represent orthogonal linear coordinates z in meters as coordenate3 / 10. | |
| #define | ATTRID_LOCATION_POWER 0x0013 |
| #define | ATTRID_LOCATION_PATH_LOSS_EXPONENT 0x0014 |
| #define | ATTRID_LOCATION_REPORT_PERIOD 0x0015 |
| #define | ATTRID_LOCATION_CALC_PERIOD 0x0016 |
| #define | ATTRID_LOCATION_NUM_RSSI_MEASUREMENTS 0x0017 |
| #define | LOCATION_TYPE_ABSOLUTE 0x01 |
| #define | LOCATION_TYPE_2_D 0x02 |
| #define | LOCATION_TYPE_COORDINATE_SYSTEM 0x0C |
| #define | LOCATION_METHOD_LATERATION 0x00 |
| #define | LOCATION_METHOD_SIGNPOSTING 0x01 |
| #define | LOCATION_METHOD_RF_FINGER_PRINT 0x02 |
| #define | LOCATION_METHOD_OUT_OF_BAND 0x03 |
| #define | LOCATION_METHOD_CENTRALIZED 0x04 |
| #define | COMMAND_LOCATION_SET_ABSOLUTE 0x00 |
| #define | COMMAND_LOCATION_SET_DEV_CFG 0x01 |
| #define | COMMAND_LOCATION_GET_DEV_CFG 0x02 |
| This command is used to request the location parameters of a device. | |
| #define | COMMAND_LOCATION_GET_DATA 0x03 |
| #define | COMMAND_LOCATION_RSSI_RESPONSE 0x04 |
| This command is sent by a device in response to an RSSI Request command. | |
| #define | COMMAND_LOCATION_SEND_PINGS 0x05 |
| #define | COMMAND_LOCATION_ANCHOR_NODE_ANNOUNCE 0x06 |
| #define | COMMAND_LOCATION_DEV_CFG_RSP 0x00 |
| #define | COMMAND_LOCATION_DATA_RSP 0x01 |
| #define | COMMAND_LOCATION_DATA_NOTIF 0x02 |
| #define | COMMAND_LOCATION_COMPACT_DATA_NOTIF 0x03 |
| #define | COMMAND_LOCATION_RSSI_PING 0x04 |
| #define | COMMAND_LOCATION_RSSI_REQUEST 0x05 |
| #define | COMMAND_LOCATION_RSSI_REPORT_RSSI_MEASUREMENTS 0x06 |
| #define | COMMAND_LOCATION_REQUEST_OWN 0x07 |
| #define ATTRID_LOCATION_AGE 0x0002 |
The LocationAge attribute indicates the amount of time, measured in seconds, that has transpired since the location information was last calculated.
| #define ATTRID_LOCATION_CALC_PERIOD 0x0016 |
The CalculationPeriod attribute specifies the time in milliseconds between successive calculations of the device's location.
| #define ATTRID_LOCATION_NUM_DEVICES 0x0004 |
The NumberOfDevices attribute is the number of devices whose location data were used to calculate the last location value.
| #define ATTRID_LOCATION_NUM_RSSI_MEASUREMENTS 0x0017 |
The NumberRSSIMeasurements attribute specifies the number of RSSI measurements to be used to generate one location estimate.
| #define ATTRID_LOCATION_PATH_LOSS_EXPONENT 0x0014 |
The PathLossExponent attribute specifies the value of the Path Loss Exponent n, an exponent that describes the rate at which the signal power decays with increasing distance from the transmitter.
| #define ATTRID_LOCATION_POWER 0x0013 |
The Power attribute specifies the value of the average power P0, measured in dBm, received at a reference distance of one meter from the transmitter.
| #define ATTRID_LOCATION_QUALITY_MEASURE 0x0003 |
The QualityMeasure attribute is a measure of confidence in the corresponding location information.
| #define ATTRID_LOCATION_REPORT_PERIOD 0x0015 |
The ReportingPeriod attribute specifies the time in seconds between successive reports of the device's location by means of the Location Data Notification command.
| #define COMMAND_LOCATION_ANCHOR_NODE_ANNOUNCE 0x06 |
This command is sent by an anchor node when it joins the network, if it is already commissioned with the coordinates, to announce itself so that the central device knows the exact position of that device.
| #define COMMAND_LOCATION_COMPACT_DATA_NOTIF 0x03 |
This command is identical in format and use to the Location Data Notification command, except that the Power, Path Loss Exponent and Location Method fields are not included.
| #define COMMAND_LOCATION_DATA_NOTIF 0x02 |
This command is sent periodically by a device to announce its location information and channel parameters.
| #define COMMAND_LOCATION_DATA_RSP 0x01 |
This command is sent by a device in response to a request for location information and channel parameters.
| #define COMMAND_LOCATION_DEV_CFG_RSP 0x00 |
This command is sent by a device in response to a Get Device Configuration command.
| #define COMMAND_LOCATION_GET_DATA 0x03 |
This command is used to request a device's location information and channel parameters.
| #define COMMAND_LOCATION_RSSI_PING 0x04 |
This command is sent periodically by a device to enable listening devices to measure the received signal strength in the absence of other transmissions from that device. The period is given by the ReportingPeriod attribute.
| #define COMMAND_LOCATION_RSSI_REPORT_RSSI_MEASUREMENTS 0x06 |
This command is sent by a device to report its measurements of the link between itself and one or more neighbors.
| #define COMMAND_LOCATION_RSSI_REQUEST 0x05 |
A device uses this command to ask one, more, or all its one-hop neighbors for the (mean) RSSI value they hear from itself.
| #define COMMAND_LOCATION_SEND_PINGS 0x05 |
This command is used to alert a node to start sending multiple packets so that all its one-hop neighbors can calculate the mean RSSI value of the radio link.
| #define COMMAND_LOCATION_SET_ABSOLUTE 0x00 |
This command is used to set a device's absolute (known, not calculated) location and the channel parameters corresponding to that location.
| #define COMMAND_LOCATION_SET_DEV_CFG 0x01 |
This command is used to set a device's location parameters, which will be used for calculating and reporting measured 5098 location. This command is invalid unless the Absolute bit of the LocationType attribute has a value of 0.