Radio Types
This module includes the platform abstraction for a radio frame.
Summary
Typedefs |
|
---|---|
otExtAddress
|
typedefstruct otExtAddress
Represents the IEEE 802.15.4 Extended Address. |
otLinkMetrics
|
typedefstruct otLinkMetrics
Represents what metrics are specified to query. |
otMacKey
|
typedefstruct otMacKey
Represents a MAC Key. |
otMacKeyMaterial
|
typedefstruct otMacKeyMaterial
|
otMacKeyRef
|
typedef Represents a MAC Key Ref used by PSA. |
otPanId
|
typedefuint16_t
Represents the IEEE 802.15.4 PAN ID. |
otRadioCaps
|
typedefuint16_t
Represents radio capabilities. |
otRadioCoexMetrics
|
typedefstruct otRadioCoexMetrics
The following are valid radio state transitions: |
otRadioFrame
|
typedefstruct otRadioFrame
Represents an IEEE 802.15.4 radio frame. |
otRadioIeInfo
|
typedefstruct otRadioIeInfo
Represents the IEEE 802.15.4 Header IE (Information Element) related information of a radio frame. |
otRadioState
|
typedefenum otRadioState
Represents the state of a radio. |
otShortAddress
|
typedefuint16_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. |
otRadioCoexMetrics |
The following are valid radio state transitions: |
otRadioFrame |
Represents an IEEE 802.15.4 radio frame. |
otRadioIeInfo |
Represents the IEEE 802.15.4 Header IE (Information Element) related information of a radio frame. |
Enumerations
Anonymous Enum 11
Anonymous Enum 11
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 12
Anonymous Enum 12
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 |
Anonymous Enum 13
Anonymous Enum 13
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 14
Anonymous Enum 14
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_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. |
Anonymous Enum 15
Anonymous Enum 15
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. |
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
otMacKeyMaterial
struct otMacKeyMaterial otMacKeyMaterial
otPanId
uint16_t otPanId
Represents the IEEE 802.15.4 PAN ID.
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.
otRadioIeInfo
struct otRadioIeInfo otRadioIeInfo
Represents the IEEE 802.15.4 Header IE (Information Element) related information of a radio frame.
otRadioState
enum otRadioState otRadioState
Represents the state of a radio.
Initially, a radio is in the Disabled state.
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.