ANT Parameters Reference

ANT Channel Init Definitions

MAX_ANT_CHANNELS ((uint8_t)15)

The maximum number of ANT channels.

SIZE_OF_NONENCRYPTED_ANT_CHANNEL ((uint8_t)120)
SIZE_OF_ENCRYPTED_KEY ((uint8_t)16)
SIZE_OF_ENCRYPTED_ANT_CHANNEL ((uint8_t)37)
SIZE_OF_ANT_EVENT ((uint8_t)2)
MIN_ANT_TX_BURST_QUEUE_SIZE ((uint8_t)64)

Minumum burst queue size.

MIN_ANT_EVENT_QUEUE_SIZE ((uint8_t)32)

Minumum number of events in the queue.

ANT_QSIZE_IS_POWER_OF_TWO(A) ( ((A) != 0) && ((((A) - 1) & (A)) == 0) )
GET_ANT_TX_BURST_QUEUE_SIZE(usTxQueueByteSize)    ((usTxQueueByteSize > MIN_ANT_TX_BURST_QUEUE_SIZE) ? (ANT_QSIZE_IS_POWER_OF_TWO(usTxQueueByteSize) ? usTxQueueByteSize : MIN_ANT_TX_BURST_QUEUE_SIZE) : MIN_ANT_TX_BURST_QUEUE_SIZE)
GET_ANT_CHANNEL_SIZE(ucTotalNumberOfChannels)    ((ucTotalNumberOfChannels > 2) ? ((ucTotalNumberOfChannels - 2) * SIZE_OF_NONENCRYPTED_ANT_CHANNEL) : 0)
GET_ANT_ENCRYPTED_CHANNEL_SIZE(ucNumberOfEncryptedChannels)    ((ucNumberOfEncryptedChannels > 0) ? ((ucNumberOfEncryptedChannels * SIZE_OF_ENCRYPTED_ANT_CHANNEL) - SIZE_OF_ENCRYPTED_KEY) : 0)
GET_ANT_EVENT_QUEUE_SIZE(usNumberOfEvents)    ((usNumberOfEvents > MIN_ANT_EVENT_QUEUE_SIZE) ? (usNumberOfEvents * SIZE_OF_ANT_EVENT) : 0)
ANT_ENABLE_GET_REQUIRED_SPACE(ucTotalNumberOfChannels, ucNumberOfEncryptedChannels, usTxQueueByteSize, usNumberOfEvents) GET_ANT_CHANNEL_SIZE(ucTotalNumberOfChannels) +                                                                               \    GET_ANT_ENCRYPTED_CHANNEL_SIZE(ucNumberOfEncryptedChannels) +                                                                 \    GET_ANT_TX_BURST_QUEUE_SIZE(usTxQueueByteSize) +                                                                              \    GET_ANT_EVENT_QUEUE_SIZE(usNumberOfEvents)

This macro will generate the required amount of memory to be allocated for the ANT stack based on the parameters entered.

ucTotalNumberOfChannels is an unsigned char (1 octet) denoting the total number of ANT channels desired (1 to MAX_ANT_CHANNELS, defined in ant_parameters.h) ucTotalNumberOfEncryptedChannels is an unsigned char (1 octet) denoting the total number of ANT channels (0 to ucTotalNumberOfChannels) that support encryption usTxQueueByteSize is an unsigned short (2 octets) denoting the size of the transmit burst queue. Must be greater than or equal to MIN_ANT_TX_BURST_QUEUE_SIZE and a power of 2 (ie 64, 128, 256, etc). usEvtQueueSize is an unsigned short (2 octets) denoting the number of events in the event queue. Anything less than MIN_ANT_EVENT_QUEUE_SIZE will use the internal event queue memory.

Returns the memory required for the features requested. Used with sd_ant_enable().

Radio TX Power Definitions

RADIO_TX_POWER_LVL_CUSTOM ((uint8_t)0x80)

Custom tx power selection.

RADIO_TX_POWER_LVL_0 ((uint8_t)0x00)

Lowest ANT Tx power level setting. (-20dBm).

RADIO_TX_POWER_LVL_1 ((uint8_t)0x01)

ANT Tx power > Lvl 0. (-12dBm)

RADIO_TX_POWER_LVL_2 ((uint8_t)0x02)

ANT Tx power > Lvl 1. (-4dBm)

RADIO_TX_POWER_LVL_3 ((uint8_t)0x03)

ANT Tx power > Lvl 2. Default tx power level. (0dBm)

RADIO_TX_POWER_LVL_4 ((uint8_t)0x04)

ANT Tx power > Lvl 3. (+4dBm / +3dBm for nRF5340)

RADIO_TX_POWER_LVL_5 ((uint8_t)0x05)

ANT Tx power > Lvl 4. (+8dBm) (Only available on nRF52820, nRF52833, and nRF52840)

Radio Proximity Search Threshold

PROXIMITY_THRESHOLD_CUSTOM ((uint8_t)0x80)

Custom proximity search selection.

PROXIMITY_THRESHOLD_OFF ((uint8_t)0x00)

Disable proximity search detection.

PROXIMITY_THRESHOLD_1 ((uint8_t)0x01)

Proximity search detection radius > preset threshold (~ -44dBm on nRF51)

PROXIMITY_THRESHOLD_2 ((uint8_t)0x02)

Proximity search detection radius > preset threshold (~ -48dBm on nRF51).

PROXIMITY_THRESHOLD_3 ((uint8_t)0x03)

Proximity search detection radius > preset threshold (~ -52dBm on nRF51).

PROXIMITY_THRESHOLD_4 ((uint8_t)0x04)

Proximity search detection radius > preset threshold (~ -56dBm on nRF51).

PROXIMITY_THRESHOLD_5 ((uint8_t)0x05)

Proximity search detection radius > preset threshold (~ -60dBm on nRF51).

PROXIMITY_THRESHOLD_6 ((uint8_t)0x06)

Proximity search detection radius > preset threshold (~ -64dBm on nRF51).

PROXIMITY_THRESHOLD_7 ((uint8_t)0x07)

Proximity search detection radius > preset threshold (~ -68dBm on nRF51).

PROXIMITY_THRESHOLD_8 ((uint8_t)0x08)

Proximity search detection radius > preset threshold (~ -72dBm on nRF51).

PROXIMITY_THRESHOLD_9 ((uint8_t)0x09)

Proximity search detection radius > preset threshold (~ -76dBm on nRF51).

PROXIMITY_THRESHOLD_10 ((uint8_t)0x0A)

Proximity search detection radius > preset threshold (~ -80dBm on nRF51).

Assign Channel Parameters

PARAMETER_RX_NOT_TX ((uint8_t)0x00)

Bitfield for slave channel.

PARAMETER_TX_NOT_RX ((uint8_t)0x10)

Bitfield for master channel.

PARAMETER_SHARED_CHANNEL ((uint8_t)0x20)

Bitfield for enabling shared channel mode for master or slave channel.

PARAMETER_NO_TX_GUARD_BAND ((uint8_t)0x40)

Bitfield for enabling tx only mode for master channel.

PARAMETER_RX_ONLY ((uint8_t)0x40)

Bitfield for enabling rx only mode for slave channel.

Extended Assign Channel Parameters

Bitfield for enabling background searching behaviour.

EXT_PARAM_IGNORE_TRANSMISSION_TYPE ((uint8_t)0x02)

Bitfield for enabling ignore transmission type behaviour.

EXT_PARAM_FREQUENCY_AGILITY ((uint8_t)0x04)

Bitfield for enabling frequency agility behaviour.

EXT_PARAM_AUTO_SHARED_SLAVE ((uint8_t)0x08)

Auto shared channel.

EXT_PARAM_FAST_INITIATION_MODE ((uint8_t)0x10)

Channel fast initiation mode.

EXT_PARAM_ASYNC_TX_MODE ((uint8_t)0x20)

Async transmit channel.

Assign Channel Types

CHANNEL_TYPE_SLAVE ((uint8_t) 0x00)

Slave channel (PARAMETER_RX_NOT_TX).

CHANNEL_TYPE_MASTER ((uint8_t) 0x10)

Master channel (PARAMETER_TX_NOT_RX).

CHANNEL_TYPE_SLAVE_RX_ONLY ((uint8_t) 0x40)

Slave rx only channel (PARAMETER_RX_NOT_TX | PARAMETER_RX_ONLY).

CHANNEL_TYPE_MASTER_TX_ONLY ((uint8_t) 0x50)

Master tx only channel (PARAMETER_TX_NOT_RX | PARAMETER_NO_TX_GUARD_BAND).

CHANNEL_TYPE_SHARED_SLAVE ((uint8_t) 0x20)

Shared slave channel (PARAMETER_RX_NOT_TX | PARAMETER_SHARED_CHANNEL).

CHANNEL_TYPE_SHARED_MASTER ((uint8_t) 0x30)

Shared master channel (PARAMETER_TX_NOT_RX | PARAMETER_SHARED_CHANNEL).

Channel ID Definitions

ANT_ID_SIZE ((uint8_t)4)

4 octet channel ID

ANT_ID_TRANS_TYPE_OFFSET ((uint8_t)3)

Transmission type offset in channel ID.

ANT_ID_DEVICE_TYPE_OFFSET ((uint8_t)2)

Device type offset in channel ID.

ANT_ID_DEVICE_NUMBER_HIGH_OFFSET ((uint8_t)1)

MSB Device number in channel ID.

ANT_ID_DEVICE_NUMBER_LOW_OFFSET ((uint8_t)0)

LSB Device number in channel ID.

ANT_ID_DEVICE_TYPE_PAIRING_FLAG ((uint8_t)0x80)

Pairing bit in device type field.

ANT_TRANS_TYPE_SHARED_ADDR_MASK ((uint8_t)0x03)

shared address mask in transmission type field

ANT_TRANS_TYPE_1_BYTE_SHARED_ADDRESS ((uint8_t)0x02)

1 byte shared address field

ANT_TRANS_TYPE_2_BYTE_SHARED_ADDRESS ((uint8_t)0x03)

2 byte shared address field

Channel Status

STATUS_CHANNEL_STATE_MASK ((uint8_t)0x03)

Channel state mask.

STATUS_UNASSIGNED_CHANNEL ((uint8_t)0x00)

Indicates channel has not been assigned.

STATUS_ASSIGNED_CHANNEL ((uint8_t)0x01)

Indicates channel has been assigned.

STATUS_SEARCHING_CHANNEL ((uint8_t)0x02)

Indicates channel is active and in searching state.

STATUS_TRACKING_CHANNEL ((uint8_t)0x03)

Indicates channel is active and in tracking state.

Standard capabilities defines

CAPABILITIES_NO_RX_CHANNELS ((uint8_t)0x01)

Bitfield in CAPABILITIES_STANDARD byte indicating no rx channel support.

CAPABILITIES_NO_TX_CHANNELS ((uint8_t)0x02)

Bitfield in CAPABILITIES_STANDARD byte indicating no tx channel support.

CAPABILITIES_NO_RX_MESSAGES ((uint8_t)0x04)

Bitfield in CAPABILITIES_STANDARD byte indicating no rx message support.

CAPABILITIES_NO_TX_MESSAGES ((uint8_t)0x08)

Bitfield in CAPABILITIES_STANDARD byte indicating no tx message support.

CAPABILITIES_NO_ACKD_MESSAGES ((uint8_t)0x10)

Bitfield in CAPABILITIES_STANDARD byte indicating no acknolwedged message support.

CAPABILITIES_NO_BURST_TRANSFER ((uint8_t)0x20)

Bitfield in CAPABILITIES_STANDARD byte indicating no burst transfer support.

Advanced capabilities defines

CAPABILITIES_NETWORK_ENABLED ((uint8_t)0x02)

Bitfield in CAPABILITIES_ADVANCED byte indicating network support.

CAPABILITIES_SERIAL_NUMBER_ENABLED ((uint8_t)0x08)

Bitfield in CAPABILITIES_ADVANCED byte indicating serial number support.

CAPABILITIES_PER_CHANNEL_TX_POWER_ENABLED ((uint8_t)0x10)

Bitfield in CAPABILITIES_ADVANCED byte indicating per channel transmit power support.

CAPABILITIES_LOW_PRIORITY_SEARCH_ENABLED ((uint8_t)0x20)

Bitfield in CAPABILITIES_ADVANCED byte indicating lower priority search support.

CAPABILITIES_SCRIPT_ENABLED ((uint8_t)0x40)

Bitfield in CAPABILITIES_ADVANCED byte indicating scripting support.

CAPABILITIES_SEARCH_LIST_ENABLED ((uint8_t)0x80)

Bitfield in CAPABILITIES_ADVANCED byte indicating include/exclude list support.

Advanced capabilities 2 defines

CAPABILITIES_LED_ENABLED ((uint8_t)0x01)

Bitfield in CAPABILITIES_ADVANCED_2 byte indicating built-in LED support.

CAPABILITIES_EXT_MESSAGE_ENABLED ((uint8_t)0x02)

Bitfield in CAPABILITIES_ADVANCED_2 byte indicating extended messaging support.

CAPABILITIES_SCAN_MODE_ENABLED ((uint8_t)0x04)

Bitfield in CAPABILITIES_ADVANCED_2 byte indicating scanning mode support.

CAPABILITIES_RESERVED ((uint8_t)0x08)

Bitfield in CAPABILITIES_ADVANCED_2 byte currently reserved for future use.

CAPABILITIES_PROX_SEARCH_ENABLED ((uint8_t)0x10)

Bitfield in CAPABILITIES_ADVANCED_2 byte indicating proximity search support.

CAPABILITIES_EXT_ASSIGN_ENABLED ((uint8_t)0x20)

Bitfield in CAPABILITIES_ADVANCED_2 byte indicating extended assign support.

CAPABILITIES_FS_ANTFS_ENABLED ((uint8_t)0x40)

Bitfield in CAPABILITIES_ADVANCED_2 byte indicating built-in FS/ANT-FS support.

CAPABILITIES_FIT1_ENABLED ((uint8_t)0x80)

Bitfield in CAPABILITIES_ADVANCED_2 byte indicating FIT1 module support.

Advanced capabilities 3 defines

CAPABILITIES_ADVANCED_BURST_ENABLED ((uint8_t)0x01)

Bitfield in CAPABILITIES_ADVANCED_3 byte indicating advanced burst support.

CAPABILITIES_EVENT_BUFFERING_ENABLED ((uint8_t)0x02)

Bitfield in CAPABILITIES_ADVANCED_3 byte indicating extended messaging support.

CAPABILITIES_EVENT_FILTERING_ENABLED ((uint8_t)0x04)

Bitfield in CAPABILITIES_ADVANCED_3 byte indicating event filtering support.

CAPABILITIES_HIGH_DUTY_SEARCH_MODE_ENABLED ((uint8_t)0x08)

Bitfield in CAPABILITIES_ADVANCED_3 byte indicating high duty search mode support.

CAPABILITIES_ACTIVE_SEARCH_SHARING_MODE_ENABLED ((uint8_t)0x10)

Bitfield in CAPABILITIES_ADVANCED_3 byte indicating active search sharing mode support.

CAPABILITIES_RADIO_COEX_CONFIG_ENABLED ((uint8_t)0x20)

Bitfield in CAPABILITIES_ADVANCED_3 byte indicating radio coexistence configuration support.

CAPABILITIES_SELECTIVE_DATA_UPDATE_ENABLED ((uint8_t)0x40)

Bitfield in CAPABILITIES_ADVANCED_3 byte indicating selective rx data update support.

CAPABILITIES_ENCRYPTED_CHANNEL_ENABLED ((uint8_t)0x80)

Bitfield in CAPABILITIES_ADVANCED_3 byte indicating encrypted channel support.

Advanced capabilities 4 defines

CAPABILITIES_RFACTIVE_NOTIFICATION_ENABLED ((uint8_t)0x01)

Bitfield in CAPABILITIES_ADVANCED_4 byte indicating rfactive notification support.

CAPABILITIES_DATA_FILTERING_ENABLED ((uint8_t)0x02)

Bitfield in CAPABILITIES_ADVANCED_4 byte indicating data filtering support.

Bitfield in CAPABILITIES_ADVANCED_4 byte indicating search uplink support.

CAPABILITIES_GROUP_TRANSMITTER_INITIATION_ENABLED ((uint8_t)0x08)

Bitfield in CAPABILITIES_ADVANCED_4 byte indicating group transmitter initiation support.

CAPABILITIES_TIME_BASE_ENABLED ((uint8_t)0x10)

Bitfield in CAPABILITIES_ADVANCED_4 byte indicating extended time base support.

CAPABILITIES_TIME_SYNC_ENABLED ((uint8_t)0x20)

Bitfield in CAPABILITIES_ADVANCED_4 byte indicating time sync support.

CAPABILITIES_PA_LNA_SUPPORT_ENABLED ((uint8_t)0x40)

Bitfield in CAPABILITIES_ADVANCED_4 byte indicating PA/LNA support.

Advanced capabilities 5 defines

CAPABILITIES_CHANNEL_START_OFFSET_ENABLED ((uint8_t)0x01)

Bitfield in CAPABILITIES_ADVANCED_5 byte indicating channel start offset support.

Bitfield in CAPABILITIES_ADVANCED_5 byte indicating background searching channel uplink support.

CAPABILITIES_ID_MATCH_FIX_ON_SHARED_CHANNEL_RXBURST ((uint8_t)0x04)

Bitfield in CAPABILITIES_ADVANCED_5 byte indicating id match fix for shared channel rx burst transfer.

Rx Burst Message Sequencing Defines

CHANNEL_NUMBER_MASK ((uint8_t)0x1F)

Valid bitfields for channel number.

SEQUENCE_NUMBER_MASK ((uint8_t)0xE0)

Valid bitfields for burst sequence.

SEQUENCE_NUMBER_ROLLOVER ((uint8_t)0x60)

Sequence rollover.

SEQUENCE_FIRST_MESSAGE ((uint8_t)0x00)

Sequence indicating first burst message.

SEQUENCE_LAST_MESSAGE ((uint8_t)0x80)

Sequence indicating last burst message.

SEQUENCE_NUMBER_INC ((uint8_t)0x20)

Incremental sequence value.

Tx Burst Handler Request Segment Defines

BURST_SEGMENT_CONTINUE ((uint8_t)0x00)

Bitfield for indicating continuation of burst data segment (no starting or ending burst packet).

BURST_SEGMENT_START ((uint8_t)0x01)

Bitfield for indicating burst data segment containing starting burst packet.

BURST_SEGMENT_END ((uint8_t)0x02)

Bitfield for indicating burst data segment containing ending burst packet.

ANT Library Config

ANT_LIB_CONFIG_MASK_ALL ((uint8_t)0xFF)

libary configuration mask

ANT_LIB_CONFIG_RADIO_CONFIG_ALWAYS ((uint8_t)0x01)

Bitfield intended for platform specific configuration (unused)

ANT_LIB_CONFIG_MESG_OUT_INC_TIME_STAMP ((uint8_t)0x20)

Bitfield for enabling extended rx messages including ant time stamp field.

ANT_LIB_CONFIG_MESG_OUT_INC_RSSI ((uint8_t)0x40)

Bitfield for enabling extended rx messages including RSSI measurement field.

ANT_LIB_CONFIG_MESG_OUT_INC_DEVICE_ID ((uint8_t)0x80)

Bitfield for enabling extended rx messages including device ID field.

Extended Data Message Bitfield Definitions

ANT_EXT_MESG_BITFIELD_DEVICE_ID ((uint8_t)0x80)

Bitfield for indicating device ID field present in extended data message after the extended message bitfield byte.

ANT_EXT_MESG_BITFIELD_RSSI ((uint8_t)0x40)

Bitfield for indicating RSSI field present in extended data message after device id field (if present)

ANT_EXT_MESG_BITFIELD_TIME_STAMP ((uint8_t)0x20)

Bitfield for indicating timestamp field present in extended data message after rssi/agc field (if present)

ANT_EXT_MESG_BIFIELD_EXTENSION ((uint8_t)0x01)

Bitfield reserved.

RSSI Definitions in Extended Data Message

RSSI_TYPE_DBM_EXT_MESG_FIELD_SIZE ((uint8_t)3)

Extended bitfield message size for DBM type RSSI measurement.

RSSI_TYPE_OFFSET ((uint8_t)0)

RSSI type offset in RSSI field in extended data message.

RSSI_DBM_TYPE ((uint8_t)0x20)

RSSI type indicating support for DBM measurement.

RSSI_TYPE_DBM_VALUE ((uint8_t)1)

Offset of DBM value in RSSI field.

RSSI_TYPE_DBM_SETTING ((uint8_t)2)

Offset of DBM threshold configuration in RSSI field.

Reset/Startup Mesg Codes

RESET_FLAGS_MASK ((uint8_t)0xE0)

Message code mask.

RESET_SUSPEND ((uint8_t)0x80)

Startup/Reset from suspend mode.

RESET_SYNC ((uint8_t)0x40)

Startup/Reset from synchronous reset.

RESET_CMD ((uint8_t)0x20)

Startup/Reset from ant message reset command.

RESET_WDT ((uint8_t)0x02)

Startup/Reset from watchdog timeout.

RESET_RST ((uint8_t)0x01)

Startup/Reset from HW reset pin.

RESET_POR ((uint8_t)0x00)

Startup/Reset from HW power on reset.

Event Filtering

FILTER_EVENT_RX_SEARCH_TIMEOUT ((uint16_t)0x0001)

Bitfield for filtering EVENT_RX_SEARCH_TIMEOUT.

FILTER_EVENT_RX_FAIL ((uint16_t)0x0002)

Bitfield for filtering EVENT_RX_FAIL.

FILTER_EVENT_TX ((uint16_t)0x0004)

Bitfield for filtering EVENT_TX.

FILTER_EVENT_TRANSFER_RX_FAILED ((uint16_t)0x0008)

Bitfield for filtering EVENT_TRANSFER_RX_FAILED.

FILTER_EVENT_TRANSFER_TX_COMPLETED ((uint16_t)0x0010)

Bitfield for filtering EVENT_TRANSFER_TX_COMPLETED.

FILTER_EVENT_TRANSFER_TX_FAILED ((uint16_t)0x0020)

Bitfield for filtering EVENT_TRANSFER_TX_FAILED.

FILTER_EVENT_CHANNEL_CLOSED ((uint16_t)0x0040)

Bitfield for filtering EVENT_CHANNEL_CLOSED.

Bitfield for filtering EVENT_RX_FAIL_GO_TO_SEARCH.

FILTER_EVENT_CHANNEL_COLLISION ((uint16_t)0x0100)

Bitfield for filtering EVENT_CHANNEL_COLLISION.

FILTER_EVENT_TRANSFER_TX_START ((uint16_t)0x0200)

Bitfield for filtering EVENT_TRANSFER_TX_START.

Selective Data Update Mask Configuration Defines

INVALID_SDU_MASK ((uint8_t)0xFF)

Selective data update configuration invalid mask. Used to disable SDU for a particular channel.

SDU_MASK_ACK_CONFIG_BIT ((uint8_t)0x80)

Selective data acknowledge config bit. Use to enable SDU for acknowledged data in addition to broadcast data.

Advanced Burst Configuration Defines

ADV_BURST_MODE_DISABLE ((uint8_t)0x00)

Set to disable advanced burst transfers.

ADV_BURST_MODE_ENABLE ((uint8_t)0x01)

Set to enable advanced burst transfers.

ADV_BURST_MODES_MAX_SIZE ((uint8_t)0x03)

Maximum allowable value for advanced burst packets size configuration.

ADV_BURST_MODES_SIZE_8_BYTES ((uint8_t)0x01)

8-bytes packet size for maximum 20kbps advanced burst transfer rate

ADV_BURST_MODES_SIZE_16_BYTES ((uint8_t)0x02)

16-bytes packet size for maximum 40kbps advanced burst transfer rate

ADV_BURST_MODES_SIZE_24_BYTES ((uint8_t)0x03)

24-bytes packet size for maximum 60kbps advanced burst transfer rate

ADV_BURST_MODES_MASK ((uint8_t)0x03)

Bitfield mask for advanced burst modes.

ADV_BURST_MODES_FREQ_HOP ((uint8_t)0x01)

Bitfield for required/optional frequency hopping mode during advanced burst.

ADV_BURST_MODES_RESERVED0 ((uint8_t)0x02)

Bitfield reserved.

Encrypted Channel Defines

ENCRYPTION_DISABLED_MODE ((uint8_t) 0x00)

Set encryption mode to disabled.

ENCRYPTION_BASIC_REQUEST_MODE ((uint8_t) 0x01)

Enable encryption mode with basic request (crypto ID exchange)

ENCRYPTION_USER_DATA_REQUEST_MODE ((uint8_t) 0x02)

Enable encryption mode with user data request (crypto ID + custom user data exchange)

MAX_SUPPORTED_ENCRYPTION_MODE ENCRYPTION_USER_DATA_REQUEST_MODE

Maximum supported encryption mode.

ENCRYPTION_USER_DATA_SIZE ((uint8_t)19)

Maximum size of custom user data.

ENCRYPTION_INFO_SET_CRYPTO_ID ((uint8_t)0x00)

Set configured crypto ID to be exchanged during encryption negotiation.

ENCRYPTION_INFO_SET_CUSTOM_USER_DATA ((uint8_t)0x01)

Set configured custom user data to be exchanged during encryption negotation.

ENCRYPTION_INFO_SET_RNG_SEED ((uint8_t)0x02)

Set RNG seed. Platform specific.

ENCRYPTION_INFO_GET_SUPPORTED_MODE ((uint8_t)0x00)

Get supported encrytped mode.

ENCRYPTION_INFO_GET_CRYPTO_ID ((uint8_t)0x01)

Get configured crypto ID to be exchanged during encryption negotiation.

ENCRYPTION_INFO_GET_CUSTOM_USER_DATA ((uint8_t)0x02)

Get configured custom user data to be exchanged during encryption negotiation.

RFActive Notification Defines

RFACTIVE_NOTIFICATION_DISABLED_MODE ((uint8_t)0x00)

Set RF Active notification mode to disabled.

RFACTIVE_NOTIFICATION_ONE_TIME_MODE ((uint8_t)0x01)

Set to generate RF Active notification event for only 1 time.

RFACTIVE_NOTIFICATION_CONTINUOUS_MODE ((uint8_t)0x02)

Set to generate RF Active notification event continuously.

RFACTIVE_NOTIFICATION_MIN_TIME_THRESHOLD ((uint16_t)0x00A4)

Minimum time threshold of 5ms in 32768 time base.

WakeOn RF Activity Defines

WAKEON_RF_ACTIVITY_NONE ((uint8_t)0x00)

Disable wakeon.

WAKEON_RF_ACTIVITY_TX ((uint8_t)0x01)

Enable wakeon for ANT RF transmission windows.

WAKEON_RF_ACTIVITY_RX ((uint8_t)0x02)

Enable wakeon for ANT RF reception windows.

WAKEON_RF_ACTIVITY_ALL ((uint8_t)0x03)

(WAKE_ON_RF_ACTIVITY_TX | WAKE_ON_RF_ACTIVITY_RX))

Enhanced Channel Spacing Defines

ENHANCED_CHANNEL_SPACING_DISABLE ((uint8_t)0x00)

Disable enhanced channel spacing.

ENHANCED_CHANNEL_SPACING_ENABLE ((uint8_t)0x01)

Enable enhanced channel spacing.

Channel Allocated Spacing Defines

ALLOCATED_SPACING_TYPE_1 ((uint16_t)164)

Spacing allocation for uni-directional broadcast message spacing, ~5.0ms.

ALLOCATED_SPACING_TYPE_2 ((uint16_t)263)

Spacing allocation for bi-directional broadcast message spacing, ~8.0ms.

ALLOCATED_SPACING_TYPE_3 ((uint16_t)279)

Spacing allocation for uni-directional acknowledged message spacing, ~8.5ms.

ALLOCATED_SPACING_TYPE_4 ((uint16_t)378)

Spacing allocation for bi-directional acknowledged message spacing, ~11.5ms.

ALLOCATED_SPACING_MIN ALLOCATED_SPACING_TYPE_1

set DC to DC Defines

DC_TO_DC_OFF ((uint8_t)0x00)

Turn DC to DC off.

DC_TO_DC_ON ((uint8_t)0x01)

Turn DC to DC on.

High Duty Search Defines

HIGH_DUTY_SEARCH_DISABLE ((uint8_t)0x00)

Disable high duty search.

HIGH_DUTY_SEARCH_ENABLE ((uint8_t)0x01)

Enable high duty search.

HIGH_DUTY_SEARCH_SUPPRESSION_NONE ((uint8_t)0x00)

No high priority search supression cycles.

HIGH_DUTY_SEARCH_SUPPRESSION_DEFAULT ((uint8_t)0x03)

Default setting for search suppression (750ms everty 1.25s)

HIGH_DUTY_SEARCH_SUPPRESSION_FULL ((uint8_t)0x05)

Full suppression of high priority search.

HIGH_DUTY_SEARCH_RESTART_INTERVAL_DEFAULT ((uint16_t)56)

Default restart interval (~1.7ms) used by high duty search.

CRC Mode Defines

CRC_MODE_STANDARD_ANT ((uint8_t)0x00)

Standard CRC Mode used for ANT.

CRC_MODE_3BYTE ((uint8_t)0x01)

Extended 3-byte mode.

CRC_MODE_DEFAULT CRC_MODE_STANDARD_ANT

Channel Start Offset Defines

CHANNEL_START_OFFSET_NONE ((uint16_t)0x0000)

No offset specified.

CHANNEL_START_OFFSET_MIN ((uint16_t)0x010A)

Minimum channel start offset configuration (~8.12ms)

CHANNEL_START_OFFSET_MAX ((uint16_t)0x7FFF)

Maximum channel start offset configuration (~1s)

CHANNEL_START_OFFSET_DEFAULT CHANNEL_START_OFFSET_NONE

Channel Events and Command Response Codes

RESPONSE_NO_ERROR ((uint8_t)0x00)

Command response with no error.

NO_EVENT ((uint8_t)0x00)

No Event.

EVENT_RX_SEARCH_TIMEOUT ((uint8_t)0x01)

ANT stack generated event when rx searching state for the channel has timed out.

EVENT_RX_FAIL ((uint8_t)0x02)

ANT stack generated event when synchronous rx channel has missed receiving an ANT packet.

EVENT_TX ((uint8_t)0x03)

ANT stack generated event when synchronous tx channel has occurred.

EVENT_TRANSFER_RX_FAILED ((uint8_t)0x04)

ANT stack generated event when the completion of rx transfer has failed.

EVENT_TRANSFER_TX_COMPLETED ((uint8_t)0x05)

ANT stack generated event when the completion of tx transfer has succeeded.

EVENT_TRANSFER_TX_FAILED ((uint8_t)0x06)

ANT stack generated event when the completion of tx transfer has failed.

EVENT_CHANNEL_CLOSED ((uint8_t)0x07)

ANT stack generated event when channel has closed.

ANT stack generated event when synchronous rx channel has lost tracking and is entering rx searching state.

EVENT_CHANNEL_COLLISION ((uint8_t)0x09)

ANT stack generated event during a multi-channel setup where an instance of the current synchronous channel is blocked by another synchronous channel.

EVENT_TRANSFER_TX_START ((uint8_t)0x0A)

ANT stack generated event when the start of tx transfer is occuring.

EVENT_RX_DATA_OVERFLOW ((uint8_t)0x0B)

ANT stack generated event when data has been blocked due to latency in application event servicing.

EVENT_TRANSFER_NEXT_DATA_BLOCK ((uint8_t)0x11)

ANT stack generated event when the stack requires the next transfer data block for tx transfer continuation or completion.

CHANNEL_IN_WRONG_STATE ((uint8_t)0x15)

Command response on attempt to perform an action from the wrong channel state.

CHANNEL_NOT_OPENED ((uint8_t)0x16)

Command response on attempt to communicate on a channel that is not open.

CHANNEL_ID_NOT_SET ((uint8_t)0x18)

Command response on attempt to open a channel without setting the channel ID.

CLOSE_ALL_CHANNELS ((uint8_t)0x19)

Command response when attempting to start scanning mode, when channels are still open.

TRANSFER_IN_PROGRESS ((uint8_t)0x1F)

Command response on attempt to communicate on a channel with a TX transfer in progress.

TRANSFER_SEQUENCE_NUMBER_ERROR ((uint8_t)0x20)

Command response when sequence number of burst message or burst data segment is out of order.

TRANSFER_IN_ERROR ((uint8_t)0x21)

Command response when transfer error has occured on supplied burst message or burst data segment.

TRANSFER_BUSY ((uint8_t)0x22)

Command response when transfer is busy and cannot process supplied burst message or burst data segment.

MESSAGE_SIZE_EXCEEDS_LIMIT ((uint8_t)0x27)

Command response if a data message is provided that is too large.

INVALID_MESSAGE ((uint8_t)0x28)

Command response when the message has an invalid parameter.

INVALID_NETWORK_NUMBER ((uint8_t)0x29)

Command response when an invalid network number is provided.

INVALID_LIST_ID ((uint8_t)0x30)

Command response when the provided list ID or size exceeds the limit.

INVALID_SCAN_TX_CHANNEL ((uint8_t)0x31)

Command response when attempting to transmit on channel 0 when in scan mode.

INVALID_PARAMETER_PROVIDED ((uint8_t)0x33)

Command response when an invalid parameter is specified in a configuration message.

EVENT_QUE_OVERFLOW ((uint8_t)0x35)

ANT stack generated event when the event queue in the stack has overflowed and drop 1 or 2 events.

EVENT_ENCRYPT_NEGOTIATION_SUCCESS ((uint8_t)0x38)

ANT stack generated event when connecting to an encrypted channel has succeeded.

EVENT_ENCRYPT_NEGOTIATION_FAIL ((uint8_t)0x39)

ANT stack generated event when connecting to an encrypted channel has failed.

EVENT_RFACTIVE_NOTIFICATION ((uint8_t)0x3A)

ANT stack generated event when the time to next synchronous channel RF activity exceeds configured time threshold.

EVENT_CONNECTION_START ((uint8_t)0x3B)

Application generated event used to indicate when starting a connection to a channel.

EVENT_CONNECTION_SUCCESS ((uint8_t)0x3C)

Application generated event used to indicate when successfuly connected to a channel.

EVENT_CONNECTION_FAIL ((uint8_t)0x3D)

Application generated event used to indicate when failed to connect to a channel.

EVENT_CONNECTION_TIMEOUT ((uint8_t)0x3E)

Application generated event used to indicate when connecting to a channel has timed out.

EVENT_CONNECTION_UPDATE ((uint8_t)0x3F)

Application generated event used to indicate when connection parameters have been updated.

NO_RESPONSE_MESSAGE ((uint8_t)0x50)

Command response type intended to indicate that no serial reply message should be generated.

EVENT_RX ((uint8_t)0x80)

ANT stack generated event indicating received data (eg. broadcast, acknowledge, burst) from the channel.

EVENT_BLOCKED ((uint8_t)0xFF)

ANT stack generated event that should be ignored (eg. filtered events will generate this)

Message ID’s

MESG_INVALID_ID ((uint8_t)0x00)

invalid ANT message ID

MESG_EVENT_ID ((uint8_t)0x01)

ANT stack - channel event ID.

MESG_VERSION_ID ((uint8_t)0x3E)

ANT stack - version message ID.

MESG_RESPONSE_EVENT_ID ((uint8_t)0x40)

ANT stack - channel/response event ANT message ID.

MESG_UNASSIGN_CHANNEL_ID ((uint8_t)0x41)

ANT stack - channel unassign message ID.

MESG_ASSIGN_CHANNEL_ID ((uint8_t)0x42)

ANT stack - channel assign message ID.

MESG_CHANNEL_MESG_PERIOD_ID ((uint8_t)0x43)

ANT stack - channel period message ID.

MESG_CHANNEL_SEARCH_TIMEOUT_ID ((uint8_t)0x44)

ANT stack - channel (high priority) search timeout message ID.

MESG_CHANNEL_RADIO_FREQ_ID ((uint8_t)0x45)

ANT stack - channel radio frequency message ID.

MESG_NETWORK_KEY_ID ((uint8_t)0x46)

ANT stack - network key message ID.

MESG_RADIO_TX_POWER_ID ((uint8_t)0x47)

ANT stack - transmit power message ID.

MESG_RADIO_CW_MODE_ID ((uint8_t)0x48)

ANT stack - CW test mode message ID.

MESG_SEARCH_WAVEFORM_ID ((uint8_t)0x49)

ANT stack - search waveform message ID.

MESG_SYSTEM_RESET_ID ((uint8_t)0x4A)

ANT application - system reset message ID.

MESG_OPEN_CHANNEL_ID ((uint8_t)0x4B)

ANT stack - channel open message ID.

MESG_CLOSE_CHANNEL_ID ((uint8_t)0x4C)

ANT stack - channel close message ID.

MESG_REQUEST_ID ((uint8_t)0x4D)

ANT stack - request message ID.

MESG_BROADCAST_DATA_ID ((uint8_t)0x4E)

ANT stack - broadcast message ID.

MESG_ACKNOWLEDGED_DATA_ID ((uint8_t)0x4F)

ANT stack - acknowledged message ID.

MESG_BURST_DATA_ID ((uint8_t)0x50)

ANT stack - burst message ID.

MESG_CHANNEL_ID_ID ((uint8_t)0x51)

ANT stack - channel ID message ID.

MESG_CHANNEL_STATUS_ID ((uint8_t)0x52)

ANT stack - channel status message ID.

MESG_RADIO_CW_INIT_ID ((uint8_t)0x53)

ANT stack - CW test mode init message ID.

MESG_CAPABILITIES_ID ((uint8_t)0x54)

ANT stack - capabilities message ID.

MESG_CHANNEL_CRC_MODE_ID ((uint8_t)0x58)

ANT stack - channel CRC mode message ID.

MESG_ID_LIST_ADD_ID ((uint8_t)0x59)

ANT stack - inc/exc list add message ID.

MESG_ID_LIST_CONFIG_ID ((uint8_t)0x5A)

ANT stack - inc/exc list config message ID.

MESG_OPEN_RX_SCAN_ID ((uint8_t)0x5B)

ANT stack - rx scanning channel open message ID.

MESG_EXT_BROADCAST_DATA_ID ((uint8_t)0x5D)

ANT application - extended broadcast message ID.

MESG_EXT_ACKNOWLEDGED_DATA_ID ((uint8_t)0x5E)

ANT application - extended acknowledged message ID.

MESG_EXT_BURST_DATA_ID ((uint8_t)0x5F)

ANT application - extended burst message ID.

MESG_CHANNEL_RADIO_TX_POWER_ID ((uint8_t)0x60)

ANT stack - channel transmit power message ID.

MESG_SET_LP_SEARCH_TIMEOUT_ID ((uint8_t)0x63)

ANT stack - channel (low priority) search timeout message ID.

MESG_RX_EXT_MESGS_ENABLE_ID ((uint8_t)0x66)

ANT stack - extended rx message enable message ID.

MESG_ANTLIB_CONFIG_ID ((uint8_t)0x6E)

ANT stack - lib config message ID.

MESG_STARTUP_MESG_ID ((uint8_t)0x6F)

ANT application - startup message ID.

MESG_AUTO_FREQ_CONFIG_ID ((uint8_t)0x70)

ANT stack - frequency agility config message ID.

MESG_PROX_SEARCH_CONFIG_ID ((uint8_t)0x71)

ANT stack - proximity search config message ID.

MESG_ADV_BURST_DATA_ID ((uint8_t)0x72)

ANT stack - advanced burst data message ID.

MESG_COEX_PRIORITY_CONFIG_ID ((uint8_t)0x73)

ANT stack - coexistence priority config message ID.

MESG_EVENT_BUFFERING_CONFIG_ID ((uint8_t)0x74)

ANT application - event buffering config message ID.

MESG_SET_SEARCH_CH_PRIORITY_ID ((uint8_t)0x75)

ANT stack - search channel priority config message ID.

MESG_HIGH_DUTY_SEARCH_MODE_ID ((uint8_t)0x77)

ANT stack - high duty search config message ID.

MESG_CONFIG_ADV_BURST_ID ((uint8_t)0x78)

ANT stack - advanced burst config message ID.

MESG_EVENT_FILTER_CONFIG_ID ((uint8_t)0x79)

ANT stack - event filtering config message ID.

MESG_SDU_CONFIG_ID ((uint8_t)0x7A)

ANT stack - selective data update config message ID.

MESG_SDU_SET_MASK_ID ((uint8_t)0x7B)

ANT stack - selective data update mask message ID.

MESG_ENCRYPT_ENABLE_ID ((uint8_t)0x7D)

ANT stack - channel encryption mode enable message ID.

MESG_SET_ENCRYPT_KEY_ID ((uint8_t)0x7E)

ANT stack - channel encryption key config message ID.

MESG_SET_ENCRYPT_INFO_ID ((uint8_t)0x7F)

ANT stack - channel encryption info config message ID.

MESG_ACTIVE_SEARCH_SHARING_ID ((uint8_t)0x81)

ANT stack - active seach sharing config message ID.

MESG_COEX_ADV_PRIORITY_CONFIG_ID ((uint8_t)0x82)

ANT stack - advanced/platform specific coexistence priority config message ID.

MESG_RFACTIVE_NOTIFICATION_ID ((uint8_t)0x84)

ANT stack - RF active notification config message ID.

MESG_PA_LNA_CONFIG_ID ((uint8_t)0x88)

ANT stack - PA/LNA support config message ID.

MESG_ECS_ENABLE_ID ((uint8_t)0x89)

ANT stack - enhanced channel spacing enable message ID.

MESG_PENDING_TRANSMIT_CLEAR_ID ((uint8_t)0x8C)

ANT stack - pending transmit clear message ID.

MESG_STACK_ENABLE_DISABLE_ID ((uint8_t)0xD3)

ANT stack - enable/disable config message ID.

Extended Message ID’s

MSG_EXT_ID_MASK ((uint8_t)0xE0)

ANT message ID extension mask.

MESG_EXT_ID_0 ((uint8_t)0xE0)

ANT message ID extension 0xE1.

MESG_EXT_ID_1 ((uint8_t)0xE1)

ANT message ID 0xE1 extension.

MESG_EXT_ID_2 ((uint8_t)0xE2)

ANT message ID 0xE2 extension.

MESG_EXT_ID_3 ((uint8_t)0xE3)

ANT message ID 0xE3 extension.

MESG_EXT_ID_4 ((uint8_t)0xE4)

ANT message ID 0xE4 extension.

MESG_EXT_RESPONSE_ID ((uint16_t)0xE000)

Reserved for future use. ANT response messages using extended message IDs.

MESG_EXT_REQUEST_ID ((uint16_t)0xE100)

Reserved for future use. ANT request messages using extended message IDs.

Debug Message ID’s

MESG_DEBUG_ID ((uint8_t)0xF0)

Message Sizes

MESG_INVALID_SIZE ((uint8_t)0)
MESG_VERSION_SIZE ((uint8_t)20)
MESG_RESPONSE_EVENT_SIZE ((uint8_t)3)
MESG_UNASSIGN_CHANNEL_SIZE ((uint8_t)1)
MESG_ASSIGN_CHANNEL_SIZE ((uint8_t)3)
MESG_CHANNEL_MESG_PERIOD_SIZE ((uint8_t)3)
MESG_CHANNEL_SEARCH_TIMEOUT_SIZE ((uint8_t)2)
MESG_CHANNEL_RADIO_FREQ_SIZE ((uint8_t)2)
MESG_NETWORK_KEY_SIZE ((uint8_t)9)
MESG_RADIO_TX_POWER_SIZE ((uint8_t)2)
MESG_RADIO_CW_MODE_SIZE ((uint8_t)3)
MESG_RADIO_CW_INIT_SIZE ((uint8_t)1)
MESG_SEARCH_WAVEFORM_SIZE ((uint8_t)3)
MESG_SYSTEM_RESET_SIZE ((uint8_t)1)
MESG_OPEN_CHANNEL_SIZE ((uint8_t)1)
MESG_OPEN_CHANNEL_WITH_OFFSET_SIZE ((uint8_t)3)
MESG_CLOSE_CHANNEL_SIZE ((uint8_t)1)
MESG_REQUEST_SIZE ((uint8_t)2)
MESG_CHANNEL_ID_SIZE ((uint8_t)5)
MESG_CHANNEL_STATUS_SIZE ((uint8_t)2)
MESG_CAPABILITIES_SIZE ((uint8_t)9)
MESG_CHANNEL_CRC_MODE_SIZE ((uint8_t)2)
MESG_ID_LIST_ADD_SIZE ((uint8_t)6)
MESG_ID_LIST_CONFIG_SIZE ((uint8_t)3)
MESG_OPEN_RX_SCAN_SIZE ((uint8_t)2)
MESG_CHANNEL_RADIO_TX_POWER_SIZE ((uint8_t)2)
MESG_SET_LP_SEARCH_TIMEOUT_SIZE ((uint8_t)2)
MESG_RX_EXT_MESGS_ENABLE_SIZE ((uint8_t)2)
MESG_ANTLIB_CONFIG_SIZE ((uint8_t)2)
MESG_STARTUP_MESG_SIZE ((uint8_t)1)
MESG_AUTO_FREQ_CONFIG_SIZE ((uint8_t)4)
MESG_PROX_SEARCH_CONFIG_SIZE ((uint8_t)2)
MESG_COEX_PRIORITY_CONFIG_REQ_SIZE ((uint8_t)9)
MESG_EVENT_BUFFERING_CONFIG_REQ_SIZE ((uint8_t)6)
MESG_SET_SEARCH_CH_PRIORITY_SIZE ((uint8_t)2)
MESG_HIGH_DUTY_SEARCH_MODE_EN_SIZE ((uint8_t)2)
MESG_HIGH_DUTY_SEARCH_MODE_REQ_SIZE ((uint8_t)5)
MESG_CONFIG_ADV_BURST_REQ_CAPABILITIES_SIZE ((uint8_t)4)
MESG_CONFIG_ADV_BURST_REQ_CONFIG_SIZE ((uint8_t)10)
MESG_EVENT_FILTER_CONFIG_REQ_SIZE ((uint8_t)3)
MESG_CONFIG_ENCRYPT_REQ_CAPABILITIES_SIZE ((uint8_t)2)
MESG_CONFIG_ENCRYPT_REQ_CONFIG_ID_SIZE ((uint8_t)5)
MESG_CONFIG_ENCRYPT_REQ_CONFIG_USER_DATA_SIZE ((uint8_t)20)
MESG_CONFIG_ENCRYPT_REQ_CURRENT_CTR ((uint8_t)17)
MESG_ACTIVE_SEARCH_SHARING_REQ_SIZE ((uint8_t)2)
MESG_COEX_ADV_PRIORITY_CONFIG_REQ_SIZE ((uint8_t)9)
MESG_RFACTIVE_NOTIFICATION_SIZE ((uint8_t)4)
MESG_PA_LNA_CONFIG_SIZE ((uint8_t)5)
MESG_ECS_ENABLE_SIZE ((uint8_t)2)
MESG_PENDING_TRANSMIT_CLEAR_SIZE ((uint8_t)1)
MESG_PENDING_TRANSMIT_GET_SIZE ((uint8_t)2)
MESG_STACK_ENABLE_DISABLE_SIZE ((uint8_t)2)

ANT serial message structure

Defines for accesssing ANT_MESSAGE members variables

ANT_MESSAGE_ulForceAlign ulForceAlign
ANT_MESSAGE_aucMessage aucMessage
ANT_MESSAGE_ucSize stMessage.ucSize
ANT_MESSAGE_aucFramedData stMessage.uFramedData.aucFramedData
ANT_MESSAGE_ucMesgID stMessage.uFramedData.stFramedData.ucMesgID
ANT_MESSAGE_aucMesgData stMessage.uFramedData.stFramedData.uMesgData.aucMesgData
ANT_MESSAGE_ucChannel stMessage.uFramedData.stFramedData.uMesgData.stMesgData.uData0.ucChannel
ANT_MESSAGE_ucSubID stMessage.uFramedData.stFramedData.uMesgData.stMesgData.uData0.ucSubID
ANT_MESSAGE_aucPayload stMessage.uFramedData.stFramedData.uMesgData.stMesgData.aucPayload
ANT_MESSAGE_sExtMesgBF stMessage.uFramedData.stFramedData.uMesgData.stMesgData.sExtMesgBF
ANT_MESSAGE_ucExtMesgBF stMessage.uFramedData.stFramedData.uMesgData.stMesgData.sExtMesgBF.ucExtMesgBF
ANT_MESSAGE_stExtMesgBF stMessage.uFramedData.stFramedData.uMesgData.stMesgData.sExtMesgBF.stExtMesgBF
ANT_MESSAGE_aucExtData stMessage.uFramedData.stFramedData.uMesgData.stMesgData.aucExtData
ANT_MESSAGE_ucCheckSum stMessage.ucCheckSum

Baudrate enum.

Must be in sequential ascending order

BAUDRATE_TYPE used as index in asBaudLookup[] array BAUDRATE_TYPE used as left bitshift into BAUD_SUPPORTED_BITFIELD bitfield

enum BAUDRATE_TYPE

Values:

enumerator BAUDRATE_TYPE_Baud1200
enumerator BAUDRATE_TYPE_Baud2400
enumerator BAUDRATE_TYPE_Baud4800
enumerator BAUDRATE_TYPE_Baud9600
enumerator BAUDRATE_TYPE_Baud19200
enumerator BAUDRATE_TYPE_Baud38400
enumerator BAUDRATE_TYPE_Baud50000
enumerator BAUDRATE_TYPE_Baud57600
enumerator BAUDRATE_TYPE_Baud115200
enumerator BAUDRATE_TYPE_Baud230400
enumerator BAUDRATE_TYPE_Baud460800
enumerator BAUDRATE_TYPE_Baud921600

Defines

ANT_VERSION_STRING "1.03.00"

ANT Version String.

ANT version number

ANT_CLOCK_FREQUENCY ((uint32_t)32768)

ANT Clock Definition.

ANT system clock frequency.

ANT_STANDARD_DATA_PAYLOAD_SIZE ((uint8_t)8)

ANT Message Payload Size.

Standard data payload size

ANT_TIME_BASE_ANT ((uint8_t)0x00)

Local ANT time (2 byte time stamp)

ANT_TIME_BASE_ALT1 ((uint8_t)0x01)

RTC1 (4 byte time stamp)

ANT_TIME_BASE_ALT2 ((uint8_t)0x02)

RTC2 (4 byte time stamp), not available on nRF52810.

MESG_TX_SYNC ((uint8_t)0xA4)
MESG_RX_SYNC ((uint8_t)0xA5)
MESG_SYNC_SIZE ((uint8_t)1)
MESG_SIZE_SIZE ((uint8_t)1)
MESG_ID_SIZE ((uint8_t)1)
MESG_CHANNEL_NUM_SIZE ((uint8_t)1)
MESG_EXT_MESG_BF_SIZE ((uint8_t)1)
MESG_CHECKSUM_SIZE ((uint8_t)1)
MESG_DATA_SIZE ((uint8_t)9)
ANT_EXT_MESG_DEVICE_ID_FIELD_SIZE ((uint8_t)4)
ANT_EXT_MESG_RSSI_FIELD_SIZE ((uint8_t)3)
ANT_EXT_MESG_TIME_STAMP_FIELD_SIZE ((uint8_t)2)
ANT_EXT_MESG_ALT_TIME_STAMP_FIELD_SIZE ((uint8_t)4)
ANT_EXT_STRING_SIZE ((uint8_t)17)
MESG_ANT_MAX_PAYLOAD_SIZE ANT_STANDARD_DATA_PAYLOAD_SIZE
MESG_MAX_EXT_DATA_SIZE (ANT_EXT_MESG_DEVICE_ID_FIELD_SIZE + ANT_EXT_MESG_RSSI_FIELD_SIZE + ANT_EXT_MESG_ALT_TIME_STAMP_FIELD_SIZE + ANT_EXT_STRING_SIZE)
MESG_MAX_DATA_SIZE (MESG_ANT_MAX_PAYLOAD_SIZE + MESG_EXT_MESG_BF_SIZE + MESG_MAX_EXT_DATA_SIZE)
MESG_MAX_SIZE_VALUE (MESG_MAX_DATA_SIZE + MESG_CHANNEL_NUM_SIZE)
MESG_BUFFER_SIZE (MESG_SIZE_SIZE + MESG_ID_SIZE + MESG_CHANNEL_NUM_SIZE + MESG_MAX_DATA_SIZE + MESG_CHECKSUM_SIZE)

Message buffer size.

MESG_FRAMED_SIZE (MESG_ID_SIZE + MESG_CHANNEL_NUM_SIZE + MESG_MAX_DATA_SIZE)
MESG_HEADER_SIZE (MESG_SYNC_SIZE + MESG_SIZE_SIZE + MESG_ID_SIZE)
MESG_FRAME_SIZE (MESG_HEADER_SIZE + MESG_CHECKSUM_SIZE)
MESG_MAX_SIZE (MESG_MAX_DATA_SIZE + MESG_FRAME_SIZE)
MESG_SIZE_OFFSET (MESG_SYNC_SIZE)
MESG_ID_OFFSET (MESG_SYNC_SIZE + MESG_SIZE_SIZE)
MESG_DATA_OFFSET (MESG_HEADER_SIZE)

Typedefs

typedef union ANT_MESSAGE ANT_MESSAGE

The structure that holds ANT messages.

struct ANT_TIME_STAMP_CONFIG
#include <>

Time stamp configuration structure.

Public Members

uint8_t ucTimeBase

Time base Time Base Defines.

bool bTimeStampEnabled

False: Time stamp NOT used, True: Time stamp is used.

struct ANT_TIME_SYNC_CONFIG
#include <>

Time synchronization configuration structure.

Public Members

uint8_t ucTimeBase

Time base Time Base Defines.

bool bInvalidationEnabled

False: Invalidation is NOT used, True: Invalidation is used.

uint8_t ucInvalidationByte

The byte used to indicate an invalid time sync packet.

struct ANT_HIGH_DUTY_SEARCH_CONFIG
#include <>

Used with the get/set high duty search config commands.

Public Members

uint8_t bEnable

Enable or disable high duty search. See HIGH_DUTY_SEARCH defines in ant_parameters.h.

uint8_t ucSearchSuppressionWindows

Number of windows to apply suppression for. See HIGH_DUTY_SEARCH defines in ant_parameters.h.

uint16_t usRestartInterval

Restart interval is reset back to default when high duty search is disabled.

Restart interval. Use default value of HIGH_DUTY_SEARCH_RESTART_INTERVAL_DEFAULT unless otherwise specified. See HIGH_DUTY_SEARCH defines in ant_parameters.h

struct ANT_PA_LNA_CONFIG
#include <>

The structure that holds configuration for PA/LNA GPIO outputs during radio events.

Public Members

bool bEnabled

Indicates that PA pin toggling is enabled.

Indicates that LNA pin toggling is enabled.

uint8_t ucGPIO

Selects the GPIO used to control the PA.

Selects the GPIO used to control the LNA.

bool bActiveState

Active state. 1 - Active high, 0 - Active low.

struct ANT_PA_LNA_CONFIG::[anonymous] PA_CONFIG
struct ANT_PA_LNA_CONFIG::[anonymous] LNA_CONFIG
uint8_t ucGPIOTECh

GPIOTE channel used to control PA and LNA pins.

uint8_t ucPPIChEnable

PPI channel used to control the PA/LNA signal before EVENTS_READY. Must be different from ucPPIChDisable.

uint8_t ucPPIChDisable

PPI channel used to control the PA/LNA signal during EVENTS_DISABLED. Must be different from ucPPIChEnable.

union ANT_MESSAGE
#include <>

The structure that holds ANT messages.

Public Members

uint32_t ulForceAlign
uint8_t aucMessage[(((uint8_t)1) + ((uint8_t)1) + ((uint8_t)1) + (((uint8_t)8) + ((uint8_t)1) + (((uint8_t)4) + ((uint8_t)3) + ((uint8_t)4) + ((uint8_t)17))) + ((uint8_t)1))]
uint8_t ucSize
uint8_t aucFramedData[(((uint8_t)1) + ((uint8_t)1) + (((uint8_t)8) + ((uint8_t)1) + (((uint8_t)4) + ((uint8_t)3) + ((uint8_t)4) + ((uint8_t)17))))]
uint8_t ucMesgID
uint8_t aucMesgData[((((uint8_t)8) + ((uint8_t)1) + (((uint8_t)4) + ((uint8_t)3) + ((uint8_t)4) + ((uint8_t)17))) + ((uint8_t)1))]
uint8_t ucChannel
uint8_t ucSubID
union ANT_MESSAGE::[anonymous]::[anonymous]::[anonymous]::[anonymous]::[anonymous]::[anonymous] uData0
uint8_t aucPayload[((uint8_t)8)]
EXT_MESG_BF sExtMesgBF
uint8_t aucExtData[(((uint8_t)4) + ((uint8_t)3) + ((uint8_t)4) + ((uint8_t)17))]
struct ANT_MESSAGE::[anonymous]::[anonymous]::[anonymous]::[anonymous]::[anonymous] stMesgData
union ANT_MESSAGE::[anonymous]::[anonymous]::[anonymous]::[anonymous] uMesgData
struct ANT_MESSAGE::[anonymous]::[anonymous]::[anonymous] stFramedData
union ANT_MESSAGE::[anonymous]::[anonymous] uFramedData
uint8_t ucCheckSum
struct ANT_MESSAGE::[anonymous] stMessage