This module includes API types. More...
Data Structures | |
struct | otMasterKey |
struct | otNetworkName |
struct | otExtendedPanId |
struct | otMeshLocalPrefix |
struct | otPSKc |
struct | otSecurityPolicy |
struct | otExtAddress |
struct | otIp6Address |
struct | otMessageInfo |
struct | otMessage |
struct | otSteeringData |
struct | otActiveScanResult |
struct | otEnergyScanResult |
struct | otOperationalDataset |
struct | otCommissioningDataset |
struct | otLinkModeConfig |
struct | otIp6Prefix |
struct | otBorderRouterConfig |
struct | otExternalRouteConfig |
struct | otServerConfig |
struct | otServiceConfig |
struct | otMacFilterEntry |
struct | otNeighborInfo |
struct | otChildInfo |
struct | otRouterInfo |
struct | otEidCacheEntry |
struct | otLeaderData |
struct | otMacCounters |
struct | otIpCounters |
struct | otBufferInfo |
struct | otNetifAddress |
struct | otNetifMulticastAddress |
struct | otSemanticallyOpaqueIidGeneratorData |
struct | otSockAddr |
struct | otThreadLinkInfo |
Macros | |
#define | OT_IP6_IID_SIZE 8 |
Size of an IPv6 Interface Identifier (bytes) | |
#define | OT_MASTER_KEY_SIZE 16 |
Size of the Thread Master Key (bytes) | |
#define | OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19 |
#define | OT_NETWORK_NAME_MAX_SIZE 16 |
Maximum size of the Thread Network Name field (bytes) | |
#define | OT_EXT_PAN_ID_SIZE 8 |
Size of a Thread PAN ID (bytes) | |
#define | OT_MESH_LOCAL_PREFIX_SIZE 8 |
Size of the Mesh Local Prefix (bytes) | |
#define | OT_PSKC_MAX_SIZE 16 |
Maximum size of the PSKc (bytes) | |
#define | OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6 |
Minimum size of the Commissioning Passphrase. | |
#define | OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255 |
Maximum size of the Commissioning Passphrase. | |
#define | OT_EXT_ADDRESS_SIZE 8 |
Size of an IEEE 802.15.4 Extended Address (bytes) | |
#define | OT_IP6_PREFIX_SIZE 8 |
Size of an IPv6 prefix (bytes) | |
#define | OT_IP6_ADDRESS_SIZE 16 |
Size of an IPv6 address (bytes) | |
#define | OT_PANID_BROADCAST 0xffff |
IEEE 802.15.4 Broadcast PAN ID. | |
#define | OT_CHANNEL_11_MASK (1 << 11) |
Channel 11. | |
#define | OT_CHANNEL_12_MASK (1 << 12) |
Channel 12. | |
#define | OT_CHANNEL_13_MASK (1 << 13) |
Channel 13. | |
#define | OT_CHANNEL_14_MASK (1 << 14) |
Channel 14. | |
#define | OT_CHANNEL_15_MASK (1 << 15) |
Channel 15. | |
#define | OT_CHANNEL_16_MASK (1 << 16) |
Channel 16. | |
#define | OT_CHANNEL_17_MASK (1 << 17) |
Channel 17. | |
#define | OT_CHANNEL_18_MASK (1 << 18) |
Channel 18. | |
#define | OT_CHANNEL_19_MASK (1 << 19) |
Channel 19. | |
#define | OT_CHANNEL_20_MASK (1 << 20) |
Channel 20. | |
#define | OT_CHANNEL_21_MASK (1 << 21) |
Channel 21. | |
#define | OT_CHANNEL_22_MASK (1 << 22) |
Channel 22. | |
#define | OT_CHANNEL_23_MASK (1 << 23) |
Channel 23. | |
#define | OT_CHANNEL_24_MASK (1 << 24) |
Channel 24. | |
#define | OT_CHANNEL_25_MASK (1 << 25) |
Channel 25. | |
#define | OT_CHANNEL_26_MASK (1 << 26) |
Channel 26. | |
#define | OT_CHANNEL_ALL 0xffffffff |
All channels. | |
#define | OT_STEERING_DATA_MAX_LENGTH 16 |
Max steering data length (bytes) | |
#define | OT_NETWORK_DATA_ITERATOR_INIT 0 |
Initializer for otNetworkDataIterator. | |
#define | OT_MAC_FILTER_FIXED_RSS_DISABLED 127 |
#define | OT_MAC_FILTER_ITERATOR_INIT 0 |
Initializer for otMacFilterIterator. | |
#define | OT_NEIGHBOR_INFO_ITERATOR_INIT 0 |
Initializer for otNeighborInfoIterator. | |
Variables | |
OT_TOOL_PACKED_BEGIN struct otMasterKey | OT_TOOL_PACKED_END |
This module includes API types.
#define OT_MAC_FILTER_FIXED_RSS_DISABLED 127 |
Used to indicate no fixed received signal strength was set
#define OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19 |
Maximum Number of Network Diagnostic TLV Types to Request or Reset.
typedef struct otActiveScanResult otActiveScanResult |
This struct represents a received IEEE 802.15.4 Beacon.
typedef struct otBorderRouterConfig otBorderRouterConfig |
This structure represents a Border Router configuration.
typedef struct otBufferInfo otBufferInfo |
This structure represents the message buffer information.
typedef uint32_t otChannelMaskPage0 |
This type represents Channel Mask Page 0.
typedef struct otCommissioningDataset otCommissioningDataset |
This structure represents a Commissioning Dataset.
typedef struct otEidCacheEntry otEidCacheEntry |
This structure represents an EID cache entry.
typedef struct otEnergyScanResult otEnergyScanResult |
This struct represents an energy scan result.
typedef struct otExtAddress otExtAddress |
This type represents the IEEE 802.15.4 Extended Address.
typedef struct otExtendedPanId otExtendedPanId |
This structure represents an Extended PAN ID.
typedef struct otExternalRouteConfig otExternalRouteConfig |
This structure represents an External Route configuration.
typedef struct otInstance otInstance |
This type represents the OpenThread instance structure.
typedef struct otIp6Address otIp6Address |
This type represents an IPv6 address.
typedef struct otIp6Prefix otIp6Prefix |
This type represents an IPv6 prefix.
typedef struct otIpCounters otIpCounters |
This structure represents the IP level counters
typedef struct otLeaderData otLeaderData |
This structure represents the Thread Leader Data.
typedef struct otLinkModeConfig otLinkModeConfig |
This structure represents an MLE Link Mode configuration.
typedef uint8_t otLogLevel |
Log levels.
Implementation note: Log Levels are defines so that embedded implementations can eliminate code at compile time via #if/#else/#endif. See openthread/platform/logging.h
for details.
typedef enum otLogRegion otLogRegion |
This enum represents log regions.
typedef struct otMacCounters otMacCounters |
This structure represents the MAC layer counters.
typedef enum otMacFilterAddressMode otMacFilterAddressMode |
Defines address mode of the mac filter.
typedef struct otMacFilterEntry otMacFilterEntry |
This structure represents a Mac Filter entry.
typedef struct otMasterKey otMasterKey |
This type represents a Thread Master Key.
typedef enum otMeshcopTlvType otMeshcopTlvType |
This enumeration represents meshcop TLV types.
typedef struct otMeshLocalPrefix otMeshLocalPrefix |
This structure represents a Mesh Local Prefix.
typedef struct otMessageInfo otMessageInfo |
This structure represents the local and peer IPv6 socket addresses.
typedef struct otNetifAddress otNetifAddress |
This structure represents an IPv6 network interface unicast address.
typedef enum otNetifInterfaceId otNetifInterfaceId |
This enumeration represents the list of allowable values for an InterfaceId.
typedef struct otNetifMulticastAddress otNetifMulticastAddress |
This structure represents an IPv6 network interface multicast address.
typedef struct otNetworkName otNetworkName |
This structure represents a Network Name.
typedef struct otOperationalDataset otOperationalDataset |
This structure represents an Active or Pending Operational Dataset.
typedef uint16_t otPanId |
This type represents the IEEE 802.15.4 PAN ID.
typedef enum otRoutePreference otRoutePreference |
Defines valid values for member mPreference in otExternalRouteConfig and otBorderRouterConfig.
typedef struct otSecurityPolicy otSecurityPolicy |
This structure represent Security Policy.
typedef struct otServerConfig otServerConfig |
This structure represents a Server configuration.
typedef struct otServiceConfig otServiceConfig |
This structure represents a Service configuration.
typedef uint16_t otShortAddress |
This type represents the IEEE 802.15.4 Short Address.
typedef struct otSockAddr otSockAddr |
This structure represents an IPv6 socket address.
typedef struct otSteeringData otSteeringData |
This structure represents the steering data.
typedef struct otThreadLinkInfo otThreadLinkInfo |
This structure represents link-specific information for messages received from the Thread radio.
anonymous enum |
This enumeration defines the Security Policy TLV flags.
anonymous enum |
This enumeration represents flags that indicate what configuration or state has changed within OpenThread.
anonymous enum |
enum otDeviceRole |
Represents a Thread device role.
enum otError |
This enumeration represents error codes used throughout OpenThread.
enum otLogRegion |
This enum represents log regions.
enum otMeshcopTlvType |
This enumeration represents meshcop TLV types.
enum otNetifInterfaceId |
enum otRoutePreference |
Defines valid values for member mPreference in otExternalRouteConfig and otBorderRouterConfig.
Enumerator | |
---|---|
OT_ROUTE_PREFERENCE_LOW |
Low route preference. |
OT_ROUTE_PREFERENCE_MED |
Medium route preference. |
OT_ROUTE_PREFERENCE_HIGH |
High route preference. |