Our website is under construction. Please stay tuned!

API Generic Data Types

ID

Node IDentifier. This is a unique 64-bit number. It is derived from a fixed prefix 0xDECA, MCU unique Chip ID and DW1000/DW3000 unique Part ID in this format: 0xDECA + 28 bits MCU unique Chip ID + 20 bits DW1000 unique Part ID.

id = ? 64-bit integer ?


Status Code

Status code returned by every command.

  • ‘0’ (ok)

  • ‘1’ (unknown command or broken tlv frame)

  • ‘2’ (internal error)

  • ‘3’ (invalid parameter)

  • ‘4’ (busy)

  • ‘5’ (operation not permitted)

  • ‘6’ (checksum error)

  • ‘7’ (IO error)

  • ‘8’ (not supported)

  • ‘9’ (reset required and command needs to be sent again)


Position

Position of the node (anchor or tag).

  • position = x, y, z, pqf (position coordinates)

    • x = ? 32-bit integer ? (in millimeters)

    • y = ? 32-bit integer ? (in millimeters)

    • z = ? 32-bit integer ? (in millimeters)

    • pqf = ? 8-bit integer ? (position quality factor in percents)


gpio_idx

Note

The pin index might be different on supported devices, the detail information will be provided soon, please stay tuned!

Index of GPIO pins available to the user.

gpio_idx = ‘2’ | ‘8’ | ‘9’ | ‘10’ | ‘12’ | ‘13’ | ‘14’ | ‘15’ | ‘22’ | ‘23’ | ‘27’ | ‘30’ | ‘31’ (pin 2 is reserved in low-power mode, pins 22, 30, 31 are reserved if LEDs are enabled)


fw_version

  • fw_version = maj, min, patch, ver (firmware version)

    • maj = ? 8-bit number ? (MAJOR)

    • min = ? 8-bit number ? (MINOR)

    • patch = ? 8-bit number ? (PATCH)

    • ver = res, var

    • res = ? 4-bit number ? (RESERVED)

    • var = ? 4-bit number ? (VARIANT)