nRF5 SDK for Thread v0.11.0
Data Structures | Macros | Typedefs | Enumerations | Variables
Types

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.
 

Typedefs

typedef struct otInstance otInstance
 
typedef enum otError otError
 
typedef struct otMasterKey otMasterKey
 
typedef struct otNetworkName otNetworkName
 
typedef struct otExtendedPanId otExtendedPanId
 
typedef struct otMeshLocalPrefix otMeshLocalPrefix
 
typedef struct otPSKc otPSKc
 
typedef struct otSecurityPolicy otSecurityPolicy
 
typedef uint32_t otChannelMaskPage0
 
typedef uint16_t otPanId
 
typedef uint16_t otShortAddress
 
typedef struct otExtAddress otExtAddress
 
typedef struct otIp6Address otIp6Address
 
typedef struct otMessageInfo otMessageInfo
 
typedef struct otMessage otMessage
 
typedef struct otSteeringData otSteeringData
 
typedef struct otActiveScanResult otActiveScanResult
 
typedef struct otEnergyScanResult otEnergyScanResult
 
typedef struct otOperationalDataset otOperationalDataset
 
typedef struct
otCommissioningDataset 
otCommissioningDataset
 
typedef enum otMeshcopTlvType otMeshcopTlvType
 
typedef struct otLinkModeConfig otLinkModeConfig
 
typedef struct otIp6Prefix otIp6Prefix
 
typedef uint32_t otNetworkDataIterator
 Used to iterate through Network Data information.
 
typedef struct otBorderRouterConfig otBorderRouterConfig
 
typedef struct
otExternalRouteConfig 
otExternalRouteConfig
 
typedef enum otRoutePreference otRoutePreference
 
typedef struct otServerConfig otServerConfig
 
typedef struct otServiceConfig otServiceConfig
 
typedef uint8_t otMacFilterIterator
 Used to iterate through mac filter entries.
 
typedef enum otMacFilterAddressMode otMacFilterAddressMode
 
typedef struct otMacFilterEntry otMacFilterEntry
 
typedef int16_t otNeighborInfoIterator
 Used to iterate through neighbor table.
 
typedef struct otEidCacheEntry otEidCacheEntry
 
typedef struct otLeaderData otLeaderData
 
typedef struct otMacCounters otMacCounters
 
typedef struct otIpCounters otIpCounters
 
typedef struct otBufferInfo otBufferInfo
 
typedef struct otNetifAddress otNetifAddress
 
typedef struct
otNetifMulticastAddress 
otNetifMulticastAddress
 
typedef enum otNetifInterfaceId otNetifInterfaceId
 
typedef struct otSockAddr otSockAddr
 
typedef struct otThreadLinkInfo otThreadLinkInfo
 
typedef uint8_t otLogLevel
 
typedef enum otLogRegion otLogRegion
 

Enumerations

enum  otError {
  OT_ERROR_NONE = 0, OT_ERROR_FAILED = 1, OT_ERROR_DROP = 2, OT_ERROR_NO_BUFS = 3,
  OT_ERROR_NO_ROUTE = 4, OT_ERROR_BUSY = 5, OT_ERROR_PARSE = 6, OT_ERROR_INVALID_ARGS = 7,
  OT_ERROR_SECURITY = 8, OT_ERROR_ADDRESS_QUERY = 9, OT_ERROR_NO_ADDRESS = 10, OT_ERROR_ABORT = 11,
  OT_ERROR_NOT_IMPLEMENTED = 12, OT_ERROR_INVALID_STATE = 13, OT_ERROR_NO_ACK = 14, OT_ERROR_CHANNEL_ACCESS_FAILURE = 15,
  OT_ERROR_DETACHED = 16, OT_ERROR_FCS = 17, OT_ERROR_NO_FRAME_RECEIVED = 18, OT_ERROR_UNKNOWN_NEIGHBOR = 19,
  OT_ERROR_INVALID_SOURCE_ADDRESS = 20, OT_ERROR_ADDRESS_FILTERED = 21, OT_ERROR_DESTINATION_ADDRESS_FILTERED = 22, OT_ERROR_NOT_FOUND = 23,
  OT_ERROR_ALREADY = 24, OT_ERROR_IP6_ADDRESS_CREATION_FAILURE = 26, OT_ERROR_NOT_CAPABLE = 27, OT_ERROR_RESPONSE_TIMEOUT = 28,
  OT_ERROR_DUPLICATED = 29, OT_ERROR_REASSEMBLY_TIMEOUT = 30, OT_ERROR_NOT_TMF = 31, OT_ERROR_NOT_LOWPAN_DATA_FRAME = 32,
  OT_ERROR_DISABLED_FEATURE = 33, OT_ERROR_GENERIC = 255
}
 
enum  {
  OT_SECURITY_POLICY_OBTAIN_MASTER_KEY = 1 << 7, OT_SECURITY_POLICY_NATIVE_COMMISSIONING = 1 << 6, OT_SECURITY_POLICY_ROUTERS = 1 << 5, OT_SECURITY_POLICY_EXTERNAL_COMMISSIONER = 1 << 4,
  OT_SECURITY_POLICY_BEACONS = 1 << 3
}
 
enum  otMeshcopTlvType {
  OT_MESHCOP_TLV_CHANNEL = 0, OT_MESHCOP_TLV_PANID = 1, OT_MESHCOP_TLV_EXTPANID = 2, OT_MESHCOP_TLV_NETWORKNAME = 3,
  OT_MESHCOP_TLV_PSKC = 4, OT_MESHCOP_TLV_MASTERKEY = 5, OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6, OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,
  OT_MESHCOP_TLV_STEERING_DATA = 8, OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9, OT_MESHCOP_TLV_COMMISSIONER_ID = 10, OT_MESHCOP_TLV_COMM_SESSION_ID = 11,
  OT_MESHCOP_TLV_SECURITYPOLICY = 12, OT_MESHCOP_TLV_GET = 13, OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14, OT_MESHCOP_TLV_STATE = 16,
  OT_MESHCOP_TLV_JOINER_DTLS = 17, OT_MESHCOP_TLV_JOINER_UDP_PORT = 18, OT_MESHCOP_TLV_JOINER_IID = 19, OT_MESHCOP_TLV_JOINER_RLOC = 20,
  OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21, OT_MESHCOP_TLV_PROVISIONING_URL = 32, OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33, OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34,
  OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35, OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36, OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37, OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51,
  OT_MESHCOP_TLV_DELAYTIMER = 52, OT_MESHCOP_TLV_CHANNELMASK = 53, OT_MESHCOP_TLV_COUNT = 54, OT_MESHCOP_TLV_PERIOD = 55,
  OT_MESHCOP_TLV_SCAN_DURATION = 56, OT_MESHCOP_TLV_ENERGY_LIST = 57, OT_MESHCOP_TLV_DISCOVERYREQUEST = 128, OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129
}
 
enum  {
  OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, OT_CHANGED_THREAD_ROLE = 1 << 2, OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
  OT_CHANGED_THREAD_ML_ADDR = 1 << 4, OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
  OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, OT_CHANGED_THREAD_NETDATA = 1 << 9, OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
  OT_CHANGED_IP6_MULTICAST_SUBSRCRIBED = 1 << 12, OT_CHANGED_IP6_MULTICAST_UNSUBSRCRIBED = 1 << 13, OT_CHANGED_COMMISSIONER_STATE = 1 << 14, OT_CHANGED_JOINER_STATE = 1 << 15
}
 
enum  otRoutePreference { OT_ROUTE_PREFERENCE_LOW = -1, OT_ROUTE_PREFERENCE_MED = 0, OT_ROUTE_PREFERENCE_HIGH = 1 }
 
enum  { kMaxServiceDataSize = 252, kMaxServerDataSize = 248 }
 
enum  otMacFilterAddressMode { OT_MAC_FILTER_ADDRESS_MODE_DISABLED, OT_MAC_FILTER_ADDRESS_MODE_WHITELIST, OT_MAC_FILTER_ADDRESS_MODE_BLACKLIST }
 
enum  otDeviceRole {
  OT_DEVICE_ROLE_DISABLED = 0, OT_DEVICE_ROLE_DETACHED = 1, OT_DEVICE_ROLE_CHILD = 2, OT_DEVICE_ROLE_ROUTER = 3,
  OT_DEVICE_ROLE_LEADER = 4
}
 
enum  otNetifInterfaceId { OT_NETIF_INTERFACE_ID_THREAD = 1 }
 
enum  otLogRegion {
  OT_LOG_REGION_API = 1, OT_LOG_REGION_MLE = 2, OT_LOG_REGION_ARP = 3, OT_LOG_REGION_NET_DATA = 4,
  OT_LOG_REGION_ICMP = 5, OT_LOG_REGION_IP6 = 6, OT_LOG_REGION_MAC = 7, OT_LOG_REGION_MEM = 8,
  OT_LOG_REGION_NCP = 9, OT_LOG_REGION_MESH_COP = 10, OT_LOG_REGION_NET_DIAG = 11, OT_LOG_REGION_PLATFORM = 12,
  OT_LOG_REGION_COAP = 13, OT_LOG_REGION_CLI = 14
}
 

Variables

OT_TOOL_PACKED_BEGIN struct
otMasterKey 
OT_TOOL_PACKED_END
 

Detailed Description

This module includes API types.

Macro Definition Documentation

#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 Documentation

This struct represents a received IEEE 802.15.4 Beacon.

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.

This structure represents a Commissioning Dataset.

This structure represents an EID cache entry.

This struct represents an energy scan result.

typedef enum otError otError

This enumeration represents error codes used throughout OpenThread.

typedef struct otExtAddress otExtAddress

This type represents the IEEE 802.15.4 Extended Address.

This structure represents an Extended PAN ID.

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.

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.

See Also
OT_LOG_LEVEL_NONE and related macros.
typedef enum otLogRegion otLogRegion

This enum represents log regions.

typedef struct otMacCounters otMacCounters

This structure represents the MAC layer counters.

Defines address mode of the mac filter.

This structure represents a Mac Filter entry.

typedef struct otMasterKey otMasterKey

This type represents a Thread Master Key.

This enumeration represents meshcop TLV types.

This structure represents a Mesh Local Prefix.

typedef struct otMessage otMessage

This type points to an OpenThread message buffer.

typedef struct otMessageInfo otMessageInfo

This structure represents the local and peer IPv6 socket addresses.

This structure represents an IPv6 network interface unicast address.

This enumeration represents the list of allowable values for an InterfaceId.

This structure represents an IPv6 network interface multicast address.

typedef struct otNetworkName otNetworkName

This structure represents a Network Name.

This structure represents an Active or Pending Operational Dataset.

typedef uint16_t otPanId

This type represents the IEEE 802.15.4 PAN ID.

typedef struct otPSKc otPSKc

This structure represents PSKc.

Defines valid values for member mPreference in otExternalRouteConfig and otBorderRouterConfig.

This structure represent Security Policy.

This structure represents a Server configuration.

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.

This structure represents the steering data.

This structure represents link-specific information for messages received from the Thread radio.

Enumeration Type Documentation

anonymous enum

This enumeration defines the Security Policy TLV flags.

Enumerator
OT_SECURITY_POLICY_OBTAIN_MASTER_KEY 

Obtaining the Master Key.

OT_SECURITY_POLICY_NATIVE_COMMISSIONING 

Native Commissioning.

OT_SECURITY_POLICY_ROUTERS 

Routers enabled.

OT_SECURITY_POLICY_EXTERNAL_COMMISSIONER 

External Commissioner allowed.

OT_SECURITY_POLICY_BEACONS 

Beacons enabled.

anonymous enum

This enumeration represents flags that indicate what configuration or state has changed within OpenThread.

Enumerator
OT_CHANGED_IP6_ADDRESS_ADDED 

IPv6 address was added.

OT_CHANGED_IP6_ADDRESS_REMOVED 

IPv6 address was removed.

OT_CHANGED_THREAD_ROLE 

Role (disabled, detached, child, router, leader) changed.

OT_CHANGED_THREAD_LL_ADDR 

The link-local address changed.

OT_CHANGED_THREAD_ML_ADDR 

The mesh-local address changed.

OT_CHANGED_THREAD_RLOC_ADDED 

RLOC was added.

OT_CHANGED_THREAD_RLOC_REMOVED 

RLOC was removed.

OT_CHANGED_THREAD_PARTITION_ID 

Partition ID changed.

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER 

Thread Key Sequence changed.

OT_CHANGED_THREAD_NETDATA 

Thread Network Data changed.

OT_CHANGED_THREAD_CHILD_ADDED 

Child was added.

OT_CHANGED_THREAD_CHILD_REMOVED 

Child was removed.

OT_CHANGED_IP6_MULTICAST_SUBSRCRIBED 

Subscribed to a IPv6 multicast address.

OT_CHANGED_IP6_MULTICAST_UNSUBSRCRIBED 

Unsubscribed from a IPv6 multicast address.

OT_CHANGED_COMMISSIONER_STATE 

Commissioner state changed.

OT_CHANGED_JOINER_STATE 

Joiner state changed.

anonymous enum
Enumerator
kMaxServiceDataSize 

Maximum size of Service Data in bytes.

kMaxServerDataSize 

Maximum size of Server Data in bytes. This is theoretical limit, practical one is much lower.

Represents a Thread device role.

Enumerator
OT_DEVICE_ROLE_DISABLED 

The Thread stack is disabled.

OT_DEVICE_ROLE_DETACHED 

Not currently participating in a Thread network/partition.

OT_DEVICE_ROLE_CHILD 

The Thread Child role.

OT_DEVICE_ROLE_ROUTER 

The Thread Router role.

OT_DEVICE_ROLE_LEADER 

The Thread Leader role.

enum otError

This enumeration represents error codes used throughout OpenThread.

Enumerator
OT_ERROR_NONE 

No error.

OT_ERROR_FAILED 

Operational failed.

OT_ERROR_DROP 

Message was dropped.

OT_ERROR_NO_BUFS 

Insufficient buffers.

OT_ERROR_NO_ROUTE 

No route available.

OT_ERROR_BUSY 

Service is busy and could not service the operation.

OT_ERROR_PARSE 

Failed to parse message or arguments.

OT_ERROR_INVALID_ARGS 

Input arguments are invalid.

OT_ERROR_SECURITY 

Security checks failed.

OT_ERROR_ADDRESS_QUERY 

Address resolution requires an address query operation.

OT_ERROR_NO_ADDRESS 

Address is not in the source match table.

OT_ERROR_ABORT 

Operation was aborted.

OT_ERROR_NOT_IMPLEMENTED 

Function or method is not implemented.

OT_ERROR_INVALID_STATE 

Cannot complete due to invalid state.

OT_ERROR_NO_ACK 

No acknowledgment was received after macMaxFrameRetries (IEEE 802.15.4-2006).

OT_ERROR_CHANNEL_ACCESS_FAILURE 

A transmission could not take place due to activity on the channel, i.e., the CSMA-CA mechanism has failed (IEEE 802.15.4-2006).

OT_ERROR_DETACHED 

Not currently attached to a Thread Partition.

OT_ERROR_FCS 

FCS check failure while receiving.

OT_ERROR_NO_FRAME_RECEIVED 

No frame received.

OT_ERROR_UNKNOWN_NEIGHBOR 

Received a frame from an unknown neighbor.

OT_ERROR_INVALID_SOURCE_ADDRESS 

Received a frame from an invalid source address.

OT_ERROR_ADDRESS_FILTERED 

Received a frame filtered by the address filter (whitelisted or blacklisted).

OT_ERROR_DESTINATION_ADDRESS_FILTERED 

Received a frame filtered by the destination address check.

OT_ERROR_NOT_FOUND 

The requested item could not be found.

OT_ERROR_ALREADY 

The operation is already in progress.

OT_ERROR_IP6_ADDRESS_CREATION_FAILURE 

The creation of IPv6 address failed.

OT_ERROR_NOT_CAPABLE 

Operation prevented by mode flags

OT_ERROR_RESPONSE_TIMEOUT 

Coap response or acknowledgment or DNS response not received.

OT_ERROR_DUPLICATED 

Received a duplicated frame.

OT_ERROR_REASSEMBLY_TIMEOUT 

Message is being dropped from reassembly list due to timeout.

OT_ERROR_NOT_TMF 

Message is not a TMF Message.

OT_ERROR_NOT_LOWPAN_DATA_FRAME 

Received a non-lowpan data frame.

OT_ERROR_DISABLED_FEATURE 

A feature/functionality disabled by build-time configuration options.

OT_ERROR_GENERIC 

Generic error (should not use).

This enum represents log regions.

Enumerator
OT_LOG_REGION_API 

OpenThread API.

OT_LOG_REGION_MLE 

MLE.

OT_LOG_REGION_ARP 

EID-to-RLOC mapping.

OT_LOG_REGION_NET_DATA 

Network Data.

OT_LOG_REGION_ICMP 

ICMPv6.

OT_LOG_REGION_IP6 

IPv6.

OT_LOG_REGION_MAC 

IEEE 802.15.4 MAC.

OT_LOG_REGION_MEM 

Memory.

OT_LOG_REGION_NCP 

NCP.

OT_LOG_REGION_MESH_COP 

Mesh Commissioning Protocol.

OT_LOG_REGION_NET_DIAG 

Network Diagnostic.

OT_LOG_REGION_PLATFORM 

Platform.

OT_LOG_REGION_COAP 

CoAP.

OT_LOG_REGION_CLI 

CLI.

Defines address mode of the mac filter.

Enumerator
OT_MAC_FILTER_ADDRESS_MODE_DISABLED 

Address filter is disabled.

OT_MAC_FILTER_ADDRESS_MODE_WHITELIST 

Whitelist address filter mode is enabled.

OT_MAC_FILTER_ADDRESS_MODE_BLACKLIST 

Blacklist address filter mode is enabled.

This enumeration represents meshcop TLV types.

Enumerator
OT_MESHCOP_TLV_CHANNEL 

meshcop Channel TLV

OT_MESHCOP_TLV_PANID 

meshcop Pan Id TLV

OT_MESHCOP_TLV_EXTPANID 

meshcop Extended Pan Id TLV

OT_MESHCOP_TLV_NETWORKNAME 

meshcop Network Name TLV

OT_MESHCOP_TLV_PSKC 

meshcop PSKc TLV

OT_MESHCOP_TLV_MASTERKEY 

meshcop Network Master Key TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE 

meshcop Network Key Sequence TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX 

meshcop Mesh Local Prefix TLV

OT_MESHCOP_TLV_STEERING_DATA 

meshcop Steering Data TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC 

meshcop Border Agent Locator TLV

OT_MESHCOP_TLV_COMMISSIONER_ID 

meshcop Commissioner ID TLV

OT_MESHCOP_TLV_COMM_SESSION_ID 

meshcop Commissioner Session ID TLV

OT_MESHCOP_TLV_SECURITYPOLICY 

meshcop Security Policy TLV

OT_MESHCOP_TLV_GET 

meshcop Get TLV

OT_MESHCOP_TLV_ACTIVETIMESTAMP 

meshcop Active Timestamp TLV

OT_MESHCOP_TLV_STATE 

meshcop State TLV

OT_MESHCOP_TLV_JOINER_DTLS 

meshcop Joiner DTLS Encapsulation TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT 

meshcop Joiner UDP Port TLV

OT_MESHCOP_TLV_JOINER_IID 

meshcop Joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC 

meshcop Joiner Router Locator TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK 

meshcop Joiner Router KEK TLV

OT_MESHCOP_TLV_PROVISIONING_URL 

meshcop Provisioning URL TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV 

meshcop Vendor Name TLV

OT_MESHCOP_TLV_VENDOR_MODEL_TLV 

meshcop Vendor Model TLV

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV 

meshcop Vendor SW Version TLV

OT_MESHCOP_TLV_VENDOR_DATA_TLV 

meshcop Vendor Data TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV 

meshcop Vendor Stack Version TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP 

meshcop Pending Timestamp TLV

OT_MESHCOP_TLV_DELAYTIMER 

meshcop Delay Timer TLV

OT_MESHCOP_TLV_CHANNELMASK 

meshcop Channel Mask TLV

OT_MESHCOP_TLV_COUNT 

meshcop Count TLV

OT_MESHCOP_TLV_PERIOD 

meshcop Period TLV

OT_MESHCOP_TLV_SCAN_DURATION 

meshcop Scan Duration TLV

OT_MESHCOP_TLV_ENERGY_LIST 

meshcop Energy List TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST 

meshcop Discovery Request TLV

OT_MESHCOP_TLV_DISCOVERYRESPONSE 

meshcop Discovery Response TLV

This enumeration represents the list of allowable values for an InterfaceId.

Enumerator
OT_NETIF_INTERFACE_ID_THREAD 

The Thread Network interface ID.

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.


Documentation feedback | Developer Zone | Subscribe | Updated