#include <tile_toa_module.h>
Data Fields |
|
| uint8_t * | tile_id |
| uint8_t * | auth_key |
| toa_channel_t * | channels |
| uint8_t * | queue |
| uint16_t | queue_size |
| uint8_t | num_channels |
| uint8_t * | mic_failure_count |
| uint8_t * | auth_failure_count |
| uint32_t * | channel_open_count |
| uint32_t * | authenticate_count |
| uint16_t * | tka_closed_channel_count |
| int(* | send_response )(uint8_t *data, uint16_t len) |
| int(* | associate )(uint8_t *aco, uint8_t *authorization_type) |
Detailed Description
Tile Over-the-air API module.
This module is used by Tile Lib in order to implement its over-the-air protocol.
Field Documentation
| int(* tile_toa_module::associate)(uint8_t *aco, uint8_t *authorization_type) |
Optional callback called when an authentication is happenning (can be set to NULL). It is mostly needed for Commissioning Tiles using an Interim TileID, Key.
- Parameters
-
[in] aco,: The 24-bit Authentication Cypher Offset generated [in] authorization_type,: Pointer to authorization type. [out] authorization_type,: set to the right value if an authorization is required (ie 1 for Button Press).
- Returns
- See TILE_ERROR_CODES .
| uint8_t* tile_toa_module::auth_failure_count |
Diagnostic info: counts the authentication failures
| uint8_t* tile_toa_module::auth_key |
Auth Key – 128-bit master key for Tile Nodes. Example: {0x14, 0x27, 0xe3, 0x03, 0xa2, 0x51, 0xc5, 0xb5, 0x07, 0x2a, 0xa9, 0x81, 0xa9, 0x42, 0x8a, 0x43}.
| uint32_t* tile_toa_module::authenticate_count |
Diagnostic info: counts the number of TOA Authenticate Commands received
| uint32_t* tile_toa_module::channel_open_count |
Diagnostic info: counts the Number of successfull TOA Channel Open (with a successfull authentication)
| toa_channel_t * tile_toa_module::channels |
Pointer to an array of toa_channel_t structures. It is recommended to use 4 channels, but if memory is a constraint then the number can be decreased.
| uint8_t* tile_toa_module::mic_failure_count |
Diagnostic info: counts the mic failures
| uint8_t tile_toa_module::num_channels |
Number of channels contained in the channels array.
| uint8_t* tile_toa_module::queue |
Pointer to a buffer for queueing TOA messages.
| uint16_t tile_toa_module::queue_size |
Size of buffer used for TOA queue. Recommended to be at least size 100 for one channel, and add 40 for each additional channel.
| int(* tile_toa_module::send_response)(uint8_t *data, uint16_t len) |
Send a TOA Response.
- Parameters
-
[in] data,: Pointer to the TOA Response. [in] len,: Length of the TOA Response.
| uint8_t* tile_toa_module::tile_id |
Tile ID – 64-bit identifier for Tile Nodes. Example: {0x1a, 0x95, 0xd9, 0x97, 0xf0, 0xf2, 0x66, 0x07}.
| uint16_t* tile_toa_module::tka_closed_channel_count |
Diagnostic info: counts the number of TOA channel close triggered by TKA
- external/tile/tile_lib/modules/tile_toa_module.h