Radio Types

This module includes the platform abstraction for a radio frame.

Summary

Enumerations
Anonymous Enum 10{   OT_RADIO_915MHZ_OQPSK_CHANNEL_MIN = 1,   OT_RADIO_915MHZ_OQPSK_CHANNEL_MAX = 10,   OT_RADIO_915MHZ_OQPSK_CHANNEL_MASK = 0x3ff << OT_RADIO_915MHZ_OQPSK_CHANNEL_MIN,   OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MIN = 11,   OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MAX = 26,   OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MASK = 0xffff << OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MIN }	enum Defines the frequency band channel range.
Anonymous Enum 11{   OT_RADIO_CAPS_NONE = 0,   OT_RADIO_CAPS_ACK_TIMEOUT = 1 << 0,   OT_RADIO_CAPS_ENERGY_SCAN = 1 << 1,   OT_RADIO_CAPS_TRANSMIT_RETRIES = 1 << 2,   OT_RADIO_CAPS_CSMA_BACKOFF = 1 << 3,   OT_RADIO_CAPS_SLEEP_TO_TX = 1 << 4,   OT_RADIO_CAPS_TRANSMIT_SEC = 1 << 5,   OT_RADIO_CAPS_TRANSMIT_TIMING = 1 << 6,   OT_RADIO_CAPS_RECEIVE_TIMING = 1 << 7,   OT_RADIO_CAPS_RX_ON_WHEN_IDLE = 1 << 8,   OT_RADIO_CAPS_TRANSMIT_FRAME_POWER = 1 << 9,   OT_RADIO_CAPS_ALT_SHORT_ADDR = 1 << 10,   OT_RADIO_CAPS_SCHEDULED_TX = 1 << 11 }	enum Defines constants that are used to indicate different radio capabilities.
Anonymous Enum 12{   OT_IE_HEADER_SIZE = 2,   OT_CSL_IE_SIZE = 4,   OT_ACK_IE_MAX_SIZE = 16,   OT_ENH_PROBING_IE_DATA_MAX_SIZE = 2 }	enum Defines constants about size of header IE in ACK.
Anonymous Enum 13{   OT_RADIO_AVAILABILITY_MAX_DURATION_US = 60000,   OT_RADIO_AVAILABILITY_MAX_BITMAP_SIZE = (OT_RADIO_AVAILABILITY_MAX_DURATION_US / 625 + 7) / 8 }	enum Defines constants for the radio availability schedule.
Anonymous Enum 8{   OT_RADIO_FRAME_MAX_SIZE = 127,   OT_RADIO_FRAME_MIN_SIZE = 3,   OT_RADIO_SYMBOLS_PER_OCTET = 2,   OT_RADIO_BIT_RATE = 250000,   OT_RADIO_BITS_PER_OCTET = 8,   OT_RADIO_SYMBOL_RATE = 62500,   OT_RADIO_SYMBOL_TIME = 1000000 * 1 / OT_RADIO_SYMBOL_RATE,   OT_RADIO_TEN_SYMBOLS_TIME = 10 * OT_RADIO_SYMBOL_TIME,   OT_RADIO_LQI_NONE = 0,   OT_RADIO_RSSI_INVALID = 127,   OT_RADIO_POWER_INVALID = 127,   OT_RADIO_INVALID_SHORT_ADDR = 0xfffe,   OT_RADIO_BROADCAST_SHORT_ADDR = 0xffff }	enum
Anonymous Enum 9{   OT_RADIO_CHANNEL_PAGE_0 = 0,   OT_RADIO_CHANNEL_PAGE_0_MASK = (1U << OT_RADIO_CHANNEL_PAGE_0),   OT_RADIO_CHANNEL_PAGE_2 = 2,   OT_RADIO_CHANNEL_PAGE_2_MASK = (1U << OT_RADIO_CHANNEL_PAGE_2) }	enum Defines the channel page.
otRadioAvailabilitySlotDuration{   OT_RADIO_AVAILABILITY_SLOT_DURATION_625_US = 0,   OT_RADIO_AVAILABILITY_SLOT_DURATION_1250_US = 1 }	enum Defines the slot durations of the radio availability schedule.
otRadioKeyType{   OT_KEY_TYPE_LITERAL_KEY = 0,   OT_KEY_TYPE_KEY_REF = 1 }	enum Defines constants about key types.
otRadioState	enum Represents the state of a radio.

Typedefs
otExtAddress	typedef struct otExtAddress Represents the IEEE 802.15.4 Extended Address.
otLinkMetrics	typedef struct otLinkMetrics Represents what metrics are specified to query.
otMacKey	typedef struct otMacKey Represents a MAC Key.
otMacKeyMaterial	typedef struct otMacKeyMaterial
otMacKeyRef	typedef otCryptoKeyRef Represents a MAC Key Ref used by PSA.
otPanId	typedef uint16_t Represents the IEEE 802.15.4 PAN ID.
otRadioAvailability	typedef struct otRadioAvailability Represents the radio availability schedule.
otRadioAvailabilitySlotDuration	typedef enum otRadioAvailabilitySlotDuration Defines the slot durations of the radio availability schedule.
otRadioCaps	typedef uint16_t Represents radio capabilities.
otRadioCoexMetrics	typedef struct otRadioCoexMetrics The following are valid radio state transitions:
otRadioFrame	typedef struct otRadioFrame Represents an IEEE 802.15.4 radio frame.
otRadioIeInfo	typedef struct otRadioIeInfo Represents the Time IE (Information Element) related information of a radio frame.
otRadioState	typedef enum otRadioState Represents the state of a radio.
otRadioTime32	typedef uint32_t Represents a 32-bit radio time in microseconds.
otRadioTime64	typedef uint64_t Represents a 64-bit radio time in microseconds referenced to a continuous monotonic local radio clock.
otShortAddress	typedef uint16_t Represents the IEEE 802.15.4 Short Address.

Variables
OT_TOOL_PACKED_END	OT_TOOL_PACKED_BEGIN struct otExtAddress

Macros
CSL_IE_HEADER_BYTES_HI 0x0d	Fixed CSL IE header second byte.
CSL_IE_HEADER_BYTES_LO 0x04	Fixed CSL IE header first byte.
OT_EXT_ADDRESS_SIZE 8	Size of an IEEE 802.15.4 Extended Address (bytes)
OT_MAC_KEY_SIZE 16	Size of the MAC Key in bytes.
OT_PANID_BROADCAST 0xffff	IEEE 802.15.4 Broadcast PAN ID.
OT_TOOL_PACKED_END	Compiler-specific indication at the end of a byte packed class or struct.

Structs
otExtAddress	Represents the IEEE 802.15.4 Extended Address.
otLinkMetrics	Represents what metrics are specified to query.
otMacKey	Represents a MAC Key.
otMacKeyMaterial	Represents a MAC Key.
otRadioAvailability	Represents the radio availability schedule.
otRadioCoexMetrics	The following are valid radio state transitions:
otRadioFrame	Represents an IEEE 802.15.4 radio frame.
otRadioIeInfo	Represents the Time IE (Information Element) related information of a radio frame.

Enumerations

Anonymous Enum 10

 Anonymous Enum 10

Defines the frequency band channel range.

Properties
OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MASK	2.4 GHz IEEE 802.15.4-2006
OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MAX	2.4 GHz IEEE 802.15.4-2006
OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MIN	2.4 GHz IEEE 802.15.4-2006
OT_RADIO_915MHZ_OQPSK_CHANNEL_MASK	915 MHz IEEE 802.15.4-2006
OT_RADIO_915MHZ_OQPSK_CHANNEL_MAX	915 MHz IEEE 802.15.4-2006
OT_RADIO_915MHZ_OQPSK_CHANNEL_MIN	915 MHz IEEE 802.15.4-2006

Anonymous Enum 11

 Anonymous Enum 11

Defines constants that are used to indicate different radio capabilities.

See otRadioCaps.

Properties
OT_RADIO_CAPS_ACK_TIMEOUT	Radio supports AckTime event.
OT_RADIO_CAPS_ALT_SHORT_ADDR	Radio supports setting alternate short address.
OT_RADIO_CAPS_CSMA_BACKOFF	Radio supports CSMA backoff for frame tx (but no retry).
OT_RADIO_CAPS_ENERGY_SCAN	Radio supports Energy Scans.
OT_RADIO_CAPS_NONE	Radio supports no capability.
OT_RADIO_CAPS_RECEIVE_TIMING	Radio supports rx at specific time.
OT_RADIO_CAPS_RX_ON_WHEN_IDLE	Radio supports RxOnWhenIdle handling.
OT_RADIO_CAPS_SCHEDULED_TX	Radio supports scheduling frame TX (otPlatRadioScheduleTx()).
OT_RADIO_CAPS_SLEEP_TO_TX	Radio supports direct transition from sleep to TX with CSMA.
OT_RADIO_CAPS_TRANSMIT_FRAME_POWER	Radio supports setting per-frame transmit power.
OT_RADIO_CAPS_TRANSMIT_RETRIES	Radio supports tx retry logic with collision avoidance (CSMA).
OT_RADIO_CAPS_TRANSMIT_SEC	Radio supports tx security.
OT_RADIO_CAPS_TRANSMIT_TIMING	Radio supports tx at specific time (using mTxDelay).

Anonymous Enum 12

 Anonymous Enum 12

Defines constants about size of header IE in ACK.

Properties
OT_ACK_IE_MAX_SIZE	Max length for header IE in ACK.
OT_CSL_IE_SIZE	Size of CSL IE content in bytes.
OT_ENH_PROBING_IE_DATA_MAX_SIZE	Max length of Link Metrics data in Vendor-Specific IE.
OT_IE_HEADER_SIZE	Size of IE header in bytes.

Anonymous Enum 13

 Anonymous Enum 13

Defines constants for the radio availability schedule.

Properties
OT_RADIO_AVAILABILITY_MAX_BITMAP_SIZE	The maximum size (in bytes) of a radio availability slots bitmap. Derived from OT_RADIO_AVAILABILITY_MAX_DURATION_US and the shortest slot duration (625 us), i.e., 96 slots.
OT_RADIO_AVAILABILITY_MAX_DURATION_US	The maximum duration of a radio availability schedule (us).

Anonymous Enum 8

 Anonymous Enum 8

Properties
OT_RADIO_BITS_PER_OCTET	Number of bits per octet.
OT_RADIO_BIT_RATE	2.4 GHz IEEE 802.15.4 (bits per second)
OT_RADIO_BROADCAST_SHORT_ADDR	Broadcast short address.
OT_RADIO_FRAME_MAX_SIZE	aMaxPHYPacketSize (IEEE 802.15.4-2006)
OT_RADIO_FRAME_MIN_SIZE	Minimal size of frame FCS + CONTROL.
OT_RADIO_INVALID_SHORT_ADDR	Invalid short address.
OT_RADIO_LQI_NONE	LQI measurement not supported.
OT_RADIO_POWER_INVALID	Invalid or unknown power value.
OT_RADIO_RSSI_INVALID	Invalid or unknown RSSI value.
OT_RADIO_SYMBOLS_PER_OCTET	2.4 GHz IEEE 802.15.4-2006
OT_RADIO_SYMBOL_RATE	The O-QPSK PHY symbol rate when operating in the 780MHz, 915MHz, 2380MHz, 2450MHz.
OT_RADIO_SYMBOL_TIME	Symbol duration time in unit of microseconds.
OT_RADIO_TEN_SYMBOLS_TIME	Time for 10 symbols in unit of microseconds.

Anonymous Enum 9

 Anonymous Enum 9

Defines the channel page.

Properties
OT_RADIO_CHANNEL_PAGE_0	2.4 GHz IEEE 802.15.4-2006
OT_RADIO_CHANNEL_PAGE_0_MASK	2.4 GHz IEEE 802.15.4-2006
OT_RADIO_CHANNEL_PAGE_2	915 MHz IEEE 802.15.4-2006
OT_RADIO_CHANNEL_PAGE_2_MASK	915 MHz IEEE 802.15.4-2006

otRadioAvailabilitySlotDuration

 otRadioAvailabilitySlotDuration

Defines the slot durations of the radio availability schedule.

Properties
OT_RADIO_AVAILABILITY_SLOT_DURATION_1250_US	1.25 milliseconds.
OT_RADIO_AVAILABILITY_SLOT_DURATION_625_US	625 microseconds.

otRadioKeyType

 otRadioKeyType

Defines constants about key types.

Properties
OT_KEY_TYPE_KEY_REF	Use Reference to Key.
OT_KEY_TYPE_LITERAL_KEY	Use Literal Keys.

otRadioState

 otRadioState

Represents the state of a radio.

Initially, a radio is in the Disabled state.

Typedefs

otExtAddress

struct otExtAddress otExtAddress

Represents the IEEE 802.15.4 Extended Address.

otLinkMetrics

struct otLinkMetrics otLinkMetrics

Represents what metrics are specified to query.

otMacKey

struct otMacKey otMacKey

Represents a MAC Key.

otMacKeyMaterial

struct otMacKeyMaterial otMacKeyMaterial

otMacKeyRef

otCryptoKeyRef otMacKeyRef

Represents a MAC Key Ref used by PSA.

otPanId

uint16_t otPanId

Represents the IEEE 802.15.4 PAN ID.

otRadioAvailability

struct otRadioAvailability otRadioAvailability

Represents the radio availability schedule.

The radio availability schedule is a periodic map of mNumSlots slots, each lasting mSlotDuration. The schedule starts at mStartTime and repeats every mNumSlots slots. The schedule duration (mNumSlots multiplied by mSlotDuration) MUST NOT be longer than OT_RADIO_AVAILABILITY_MAX_DURATION_US.

The bitmaps are MSB-first: slot i corresponds to bit 7 - (i % 8) of byte i / 8, i.e., (bitmap[i / 8] >> (7 - (i % 8))) & 1. Only the first mNumSlots bits of each bitmap are used. The remaining bits SHOULD be set to 0 and are ignored by OpenThread.

In mAvailableSlots, a bit value of 1 indicates that the slot is available for Thread, and 0 indicates that it is unavailable (e.g., occupied by BT or 2.4GHz WiFi).

In mPreferredSlots, a bit value of 1 indicates that the slot is preferred for Thread, and 0 indicates that it is not preferred. The preferred slots MUST be a subset of the available slots, i.e., a bit MUST be 0 in mPreferredSlots if the corresponding bit is 0 in mAvailableSlots. OpenThread treats a slot as preferred only if it is set in both bitmaps. If there is no preference among the available slots, mPreferredSlots MUST be set to the same value as mAvailableSlots.

otRadioAvailabilitySlotDuration

enum otRadioAvailabilitySlotDuration otRadioAvailabilitySlotDuration

Defines the slot durations of the radio availability schedule.

otRadioCaps

uint16_t otRadioCaps

Represents radio capabilities.

The value is a bit-field indicating the capabilities supported by the radio. See OT_RADIO_CAPS_* definitions.

otRadioCoexMetrics

struct otRadioCoexMetrics otRadioCoexMetrics

The following are valid radio state transitions:

(Radio ON) +----+ Enable() +-+ Receive() +---+ Transmit() +----+ | |----->| |----->| |-------->| | | Disabled | | Sleep | | Receive | | Transmit | | |<-----| |<-----| |<--------| | +----+ Disable() +-+ Sleep() +---+ Receive() +----+ (Radio OFF) or signal TransmitDone

During the IEEE 802.15.4 data request command the transition Sleep->Receive->Transmit can be shortened to direct transition from Sleep to Transmit if the platform supports the OT_RADIO_CAPS_SLEEP_TO_TX capability. Represents radio coexistence metrics.

otRadioFrame

struct otRadioFrame otRadioFrame

Represents an IEEE 802.15.4 radio frame.

otRadioIeInfo

struct otRadioIeInfo otRadioIeInfo

Represents the Time IE (Information Element) related information of a radio frame.

This structure is only used by the experimental Time Synchronization service feature (enabled via OPENTHREAD_CONFIG_TIME_SYNC_ENABLE).

otRadioState

enum otRadioState otRadioState

Represents the state of a radio.

Initially, a radio is in the Disabled state.

otRadioTime32

uint32_t otRadioTime32

Represents a 32-bit radio time in microseconds.

This type holds the lower 32 bits (least significant bits) of a full 64-bit radio time (otRadioTime64).

It is used in APIs such as otPlatRadioReceiveAt() and otPlatRadioUpdateCslSampleTime() and as the transmission delay base time (mTxDelayBaseTime) in otRadioFrame. It is important for radio platform implementations to correctly account for its roll-over.

otRadioTime64

uint64_t otRadioTime64

Represents a 64-bit radio time in microseconds referenced to a continuous monotonic local radio clock.

This type is returned by otPlatRadioGetNow(), used as the target transmission time in otPlatRadioScheduleTx(), and used as the timestamp field (mTimestamp) in radio frames (otRadioFrame).

otShortAddress

uint16_t otShortAddress

Represents the IEEE 802.15.4 Short Address.

Variables

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otExtAddress OT_TOOL_PACKED_END

Macros

CSL_IE_HEADER_BYTES_HI

 CSL_IE_HEADER_BYTES_HI 0x0d

Fixed CSL IE header second byte.

CSL_IE_HEADER_BYTES_LO

 CSL_IE_HEADER_BYTES_LO 0x04

Fixed CSL IE header first byte.

OT_EXT_ADDRESS_SIZE

 OT_EXT_ADDRESS_SIZE 8

Size of an IEEE 802.15.4 Extended Address (bytes)

OT_MAC_KEY_SIZE

 OT_MAC_KEY_SIZE 16

Size of the MAC Key in bytes.

OT_PANID_BROADCAST

 OT_PANID_BROADCAST 0xffff

IEEE 802.15.4 Broadcast PAN ID.

OT_TOOL_PACKED_END

 OT_TOOL_PACKED_END

Compiler-specific indication at the end of a byte packed class or struct.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.