Generic API Information

The following sections describe the frequently used TLV values

Note

The integers used in the API are little-endian, unless otherwise stated.

Status code

Every TLV Request is responded to the status code, which gives information on whether the request was processed successfully.

err_code =  8-bit unsigned integer = ‘0’ | ‘1’ | ‘2’ | ‘3’ | ’4’ | ’5’
0: ok
1: unknown command or broken TLV frame
2: internal error
3: invalid parameter
4: busy
5: operation not permitted

position

13-byte position of the node (anchor or tag).

position = x, y, z, pqf (* position coordinates *)
x = 32-bit integer (* bytes 0-3, in millimeters *)
y = 32-bit integer (* bytes 4-7, in millimeters *)
z = 32-bit integer (* bytes 8-11, in millimeters *)
pqf = 8-bit integer (* byte 12, position quality factor in percents *)

gpio_idx

Index of GPIO pins available to the user. Please refer to the index for the specific device in the list below.

  • DWM1001: 8, 12, 13, 15, 23, 27