Generale

Questo modulo include funzioni per tutti i ruoli delle conversazioni in thread.

Riepilogo

Il publisher dei dati di rete fornisce meccanismi per limitare il numero di voci di servizi e/o prefissi (prefissati o route esterne) simili nei dati di rete di Thread monitorando i dati di rete e gestendo se o quando aggiungere o rimuovere voci.

Tutte le funzioni in questo modulo richiedono l'abilitazione di OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE.

Enumerazioni

anonymous enum{
  OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
  OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
  OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
  OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
  OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
  OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
  OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
  OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
  OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
  OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
  OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
  OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
  OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
  OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19
}
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
Rappresenta un ruolo dispositivo Thread.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
enum
Questa enumerazione rappresenta gli eventi segnalati dai callback dell'editore.
otRoutePreference{
  OT_ROUTE_PREFERENCE_LOW = -1,
  OT_ROUTE_PREFERENCE_MED = 0,
  OT_ROUTE_PREFERENCE_HIGH = 1
}
enum
Definisce i valori validi di mPreference in otExternalRouteConfig e otBorderRouterConfig.

Defdef

otBorderRouterConfig tipodef
Questa struttura rappresenta una configurazione del router di confine.
otDetachGracefullyCallback)(void *aContext) tipodef
void(*
Questo callback informa l'applicazione che il processo di scollegamento è stato completato.
otExternalRouteConfig tipodef
Questa struttura rappresenta una configurazione di route esterna.
otIpCounters tipodef
struct otIpCounters
Questa struttura rappresenta i contatori del livello IP.
otLeaderData tipodef
struct otLeaderData
Questa struttura rappresenta i dati del leader del thread.
otLinkModeConfig tipodef
Questa struttura rappresenta una configurazione della modalità di collegamento MLE.
otMleCounters tipodef
struct otMleCounters
Questa struttura rappresenta i contatori Thread MLE.
otNeighborInfoIterator tipodef
int16_t
Utilizzato per eseguire l'iterazione attraverso la tabella adiacente.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) tipodef
void(*
Questo tipo di puntatore funzione definisce il callback utilizzato per inviare una notifica quando viene aggiunta o rimossa una voce "DNS/SRP Service" dai dati di rete Thread.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) tipodef
void(*
Questo tipo di puntatore funzione definisce il callback utilizzato per notificare l'aggiunta o la rimozione di un prefisso (su rete o route esterna) ai dati di rete Thread.
otNetDataPublisherEvent tipodef
Questa enumerazione rappresenta gli eventi segnalati dai callback dell'editore.
otNetworkDataIterator tipodef
uint32_t
Utilizzato per eseguire l'iterazione attraverso le informazioni dei dati di rete.
otNetworkDiagChildEntry tipodef
Questa struttura rappresenta una voce della tabella secondaria di diagnostica della rete.
otNetworkDiagConnectivity tipodef
Questa struttura rappresenta un valore per la connettività diagnostica di rete.
otNetworkDiagIterator tipodef
uint16_t
Utilizzato per eseguire l'iterazione tramite TLV diagnostico di rete.
otNetworkDiagMacCounters tipodef
Questa struttura rappresenta un valore dei contatori Mac di diagnostica di rete.
otNetworkDiagRoute tipodef
Questa struttura rappresenta un valore TLV route di rete diagnostica.
otNetworkDiagRouteData tipodef
Questa struttura rappresenta un percorso di diagnostica della rete.
otNetworkDiagTlv tipodef
Questa struttura rappresenta un TLV diagnostico di rete.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) tipodef
void(*
Il puntatore di questa funzione si chiama quando riceve una risposta di diagnostica di rete.
otRoutePreference tipodef
Definisce i valori validi di mPreference in otExternalRouteConfig e otBorderRouterConfig.
otServerConfig tipodef
Questa struttura rappresenta una configurazione del server.
otServiceConfig tipodef
Questa struttura rappresenta una configurazione del servizio.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) tipodef
void(*
Questo tipo di puntatore di funzione definisce il callback per informare il risultato di una richiesta di otThreadLocateAnycastDestination().
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) tipodef
void(*
Questo puntatore di funzione viene richiamato ogni volta che viene ricevuto un messaggio Richiesta MLE.
otThreadDiscoveryRequestInfo tipodef
Questa struttura rappresenta i dati della richiesta di rilevamento di thread.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) tipodef
void(*
Questo puntatore di funzione viene richiamato ogni volta che viene ricevuto un messaggio MLE Parent Response.
otThreadParentResponseInfo tipodef
Questa struttura rappresenta i dati MLE Parent Response.

Functions

otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Questa funzione controlla se un determinato prefisso può fungere da prefisso OMR valido e anche i dati di rete del leader contengono questo prefisso.
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Questo metodo fornisce una copia completa o stabile dei dati di rete della partizione.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Questa funzione riceve il successivo prefisso mesh nei dati di rete della partizione.
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Questa funzione recupera la route esterna successiva nei dati di rete della partizione.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Questa funzione riceve il servizio successivo nei dati di rete della partizione.
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
Recupero della versione dei dati di rete stabile.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
Ottieni la versione dei dati di rete.
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
Questa funzione indica se attualmente si aggiunge o meno ai dati di rete del thread la voce "Servizio DNS/SRP".
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Questa funzione indica se al momento una voce di prefisso pubblicata (su rete o route esterna) viene aggiunta o meno ai dati di rete del thread.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Questa funzione richiede la pubblicazione nei dati di rete del thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Questa funzione richiede la pubblicazione nei dati di rete del thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Questa funzione richiede la pubblicazione nei dati di rete del thread.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Questa funzione richiede un prefisso di route esterno da pubblicare nei dati della rete Thread.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Questa funzione richiede la pubblicazione di un prefisso sulla rete nei dati della rete Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Questa funzione imposta un callback per l'invio di una notifica quando un servizio "DNS/SRP" pubblicato viene effettivamente aggiunto o rimosso dai dati della rete Thread.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Questa funzione imposta un callback per la notifica quando una voce di prefisso pubblicata viene effettivamente aggiunta o rimossa dai dati della rete Thread.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Controlla se i dati relativi al volante includono una joiner.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Controlla se i dati relativi al volante includono un Joiner con un determinato valore di discerner.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Annulla la pubblicazione di qualsiasi voce di servizio DNS/SRP (Qualsiasicast o Unicast) aggiunta in precedenza dai dati di rete Thread.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Annulla la pubblicazione di un prefisso su rete o esterno esterno pubblicato in precedenza.
otThreadBecomeChild(otInstance *aInstance)
Prova a ricollegarlo come bambino.
otThreadBecomeDetached(otInstance *aInstance)
Scollegalo dalla rete Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Questa funzione invia una notifica ad altri nodi della rete (se presenti), quindi interrompe il funzionamento del protocollo Thread.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
Converti il ruolo dispositivo in una stringa leggibile.
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Questa funzione avvia una scansione di Thread Discovery.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Recupera il timeout secondario del thread quando utilizzi il ruolo secondario.
otThreadGetDeviceRole(otInstance *aInstance)
Recupera il ruolo dispositivo.
otThreadGetDomainName(otInstance *aInstance)
const char *
Recupera il nome di dominio del thread.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Ottieni l'ID PAN esteso IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Ottieni l'identificatore di interfaccia specificato manualmente per l'indirizzo Unicast del dominio del thread.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Ottieni i contatori IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Ottieni il thBREAKSequenzaCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Ottieni thcreatoracademySwitchGuardTime.
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Questa funzione riceve i dati di Thread Leader.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Questa funzione restituisce un puntatore al RLOC di Leader.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Ottieni l'ID router Leader.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Ottieni il peso del leader.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Questa funzione restituisce l'indirizzo multicast di Thread Link-Local All Thread Nodes.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Questa funzione restituisce l'indirizzo IPv6 del link locale del thread.
otThreadGetLinkMode(otInstance *aInstance)
Recupera la configurazione della modalità di collegamento MLE.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Questa funzione restituisce un puntatore all'indirizzo EID locale della rete mesh.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Questa funzione restituisce un puntatore al prefisso locale mesh.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Ottieni i contatori Thread MLE.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Recupera la chiave di rete del thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Richiedi la chiave otNetworkKeyRef per la rete Thread.
otThreadGetNetworkName(otInstance *aInstance)
const char *
Recupera il nome della rete Thread.
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Questa funzione riceve il successivo TLV diagnostico di rete nel messaggio.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Questa funzione riceve le informazioni per il vicino.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
La funzione recupera la media RSSI per l'elemento principale del thread.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
La funzione recupera le informazioni di diagnostica per un router Thread come principale.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
La funzione recupera il codice RSSI dell'ultimo pacchetto dall'elemento Thread principale.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Ottieni l'ID partizione.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Questa funzione restituisce l'indirizzo multicast di Thread Realm-Local All Thread Nodes.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Questa funzione restituisce un puntatore all'indirizzo RLOC (Thread Routing Locator).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Acquista RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Questa funzione recupera l'ALOC del servizio per il determinato ID di servizio.
otThreadGetVersion(void)
uint16_t
Questa funzione riceve la versione protocollo Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Questa funzione indica se una richiesta di trasmissione anycast è attualmente in corso.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
Questa funzione determina se è in corso un MLE Thread Discovery.
otThreadIsSingleton(otInstance *aInstance)
bool
Questa funzione indica se un nodo è l'unico router della rete.
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Questa funzione richiede la posizione più vicina di un determinato indirizzo anycast.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Questa funzione registra un callback per ricevere i dati MLE Parent Response.
otThreadResetIp6Counters(otInstance *aInstance)
void
Reimposta i contatori IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Reimposta i contatori MLE Thread.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Questa funzione invia un messaggio di notifica proattiva dell'indirizzo (ADDR_NTF.ntf).
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Invia una richiesta di diagnostica di rete.
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
Invia una richiesta di Diagnostica diagnostica di rete.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Questa funzione invia un messaggio PRO_BB.ntf (proattiva backbone notification) al link Backbone.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Impostare il timeout del publisher secondario del thread utilizzato per il ruolo secondario.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Questa funzione imposta un callback per ricevere i dati MLE Discovery Request.
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
Imposta il nome di dominio del thread.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
Questa funzione avvia il funzionamento del protocollo Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Imposta l'ID PAN esteso IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Imposta/Cancella l'identificatore interfaccia specificato manualmente per l'indirizzo unicast dominio del thread.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Questo metodo imposta la pubblicità di Thread join nel rilevamento della rete Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Imposta il thBREAKSequenzaCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Imposta il thrupSwitchGuardTime.
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Imposta la configurazione della modalità di collegamento MLE.
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Questa funzione imposta il prefisso locale mesh.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
Imposta la chiave di rete del thread.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
Imposta la chiave di rete Thread come otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Imposta il nome della rete Thread.

Strutture

otBorderRouterConfig

Questa struttura rappresenta una configurazione del router di confine.

otExternalRouteConfig

Questa struttura rappresenta una configurazione di route esterna.

otIpCounters

Questa struttura rappresenta i contatori del livello IP.

otLeaderData

Questa struttura rappresenta i dati del leader del thread.

otLinkModeConfig

Questa struttura rappresenta una configurazione della modalità di collegamento MLE.

otMleCounters

Questa struttura rappresenta i contatori Thread MLE.

Informazioni otNeighbor

Questa struttura contiene le informazioni di diagnostica per un nodo Thread adiacente.

otNetworkDiagChildEntry

Questa struttura rappresenta una voce della tabella secondaria di diagnostica della rete.

otNetworkDiagConnectivity

Questa struttura rappresenta un valore per la connettività diagnostica di rete.

otNetworkDiagMacCounters

Questa struttura rappresenta un valore dei contatori Mac di diagnostica di rete.

otNetworkDiagRoute

Questa struttura rappresenta un valore TLV route di rete diagnostica.

otNetworkDiagRouteData

Questa struttura rappresenta un percorso di diagnostica della rete.

otNetworkDiagTlv

Questa struttura rappresenta un TLV diagnostico di rete.

InformazioniotRouter

Questa struttura contiene le informazioni di diagnostica relative a un router Thread.

otServerConfig

Questa struttura rappresenta una configurazione del server.

otServiceConfig

Questa struttura rappresenta una configurazione del servizio.

otThreadDiscoveryRequestInfo

Questa struttura rappresenta i dati della richiesta di rilevamento di thread.

otThreadParentResponseInfo

Questa struttura rappresenta i dati MLE Parent Response.

Enumerazioni

enumerazione anonima

 anonymous enum
Proprietà
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Livello TLV batteria.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV di pagine del canale.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

TLV tabella secondaria.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

Connettività TLV.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV indirizzo MAC esteso.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV elenco indirizzi IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV dati leader.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

Contatori MAC TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

Numero massimo di timeout del publisher secondario (TLV).

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Modalità TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV dati di rete.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

TLV Route64.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

TLV indirizzo16.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Tensione di alimentazione TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Timeout TLV (il periodo di tempo massimo per il polling per SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Digita l'elenco TLV.

RuoloDispositiviOt

 otDeviceRole

Rappresenta un ruolo dispositivo Thread.

Proprietà
OT_DEVICE_ROLE_CHILD

Il ruolo secondario del thread.

OT_DEVICE_ROLE_DETACHED

Attualmente non partecipano a una rete/partizione Thread.

OT_DEVICE_ROLE_DISABLED

La combinazione di thread è disattivata.

OT_DEVICE_ROLE_LEADER

Il ruolo Leader di thread.

OT_DEVICE_ROLE_ROUTER

Il ruolo del router Thread.

Evento OtNetDataPublisher

 otNetDataPublisherEvent

Questa enumerazione rappresenta gli eventi segnalati dai callback dell'editore.

Proprietà
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

La voce pubblicata viene aggiunta ai dati della rete Thread.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

La voce pubblicata viene rimossa dai dati della rete Thread.

Destinazione route

 otRoutePreference

Definisce i valori validi di mPreference in otExternalRouteConfig e otBorderRouterConfig.

Proprietà
OT_ROUTE_PREFERENCE_HIGH

Preferenza di percorso elevata.

OT_ROUTE_PREFERENCE_LOW

Preferenza percorso bassa.

OT_ROUTE_PREFERENCE_MED

Preferenza percorso media.

Defdef

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Questa struttura rappresenta una configurazione del router di confine.

otDetachGracefulCallback

void(* otDetachGracefullyCallback)(void *aContext)

Questo callback informa l'applicazione che il processo di scollegamento è stato completato.

Dettagli
Parametri
[in] aContext
Un puntatore sul contesto specifico dell'applicazione.

OtExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Questa struttura rappresenta una configurazione di route esterna.

ContIpContatori

struct otIpCounters otIpCounters

Questa struttura rappresenta i contatori del livello IP.

Dati OtLeader

struct otLeaderData otLeaderData

Questa struttura rappresenta i dati del leader del thread.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Questa struttura rappresenta una configurazione della modalità di collegamento MLE.

OtMleCounter

struct otMleCounters otMleCounters

Questa struttura rappresenta i contatori Thread MLE.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Utilizzato per eseguire l'iterazione attraverso la tabella adiacente.

otNetDataDnsSrpServicePublisherCallback

void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)

Questo tipo di puntatore funzione definisce il callback utilizzato per inviare una notifica quando viene aggiunta o rimossa una voce "DNS/SRP Service" dai dati di rete Thread.

Una volta rimosso, il callback viene richiamato indipendentemente dal fatto che la voce sia stata rimossa da Publisher (ad esempio quando ci sono troppe voci simili già presenti nei dati di rete) o tramite una chiamata esplicita per annullare la pubblicazione della voce (ad esempio una chiamata a otNetDataUnpublishDnsSrpService()).

Dettagli
Parametri
[in] aEvent
Indica l'evento (se la voce è stata aggiunta o rimossa).
[in] aContext
Un puntatore sul contesto specifico dell'applicazione.

otNetDataPrefixPublisherCallback

void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

Questo tipo di puntatore funzione definisce il callback utilizzato per notificare l'aggiunta o la rimozione di un prefisso (su rete o route esterna) ai dati di rete Thread.

La rimozione viene richiamata indipendentemente dal fatto che la voce venga rimossa da Publisher (ad es. quando sono già presenti troppe voci simili nei dati di rete) o tramite una chiamata esplicita per annullare la pubblicazione.

Dettagli
Parametri
[in] aEvent
Indica l'evento (se la voce è stata aggiunta o rimossa).
[in] aPrefix
Un puntatore sulla voce di prefisso.
[in] aContext
Un puntatore sul contesto specifico dell'applicazione.

Evento OtNetDataPublisher

enum otNetDataPublisherEvent otNetDataPublisherEvent

Questa enumerazione rappresenta gli eventi segnalati dai callback dell'editore.

otNetworkDataIterator

uint32_t otNetworkDataIterator

Utilizzato per eseguire l'iterazione attraverso le informazioni dei dati di rete.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Questa struttura rappresenta una voce della tabella secondaria di diagnostica della rete.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Questa struttura rappresenta un valore per la connettività diagnostica di rete.

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

Utilizzato per eseguire l'iterazione tramite TLV diagnostico di rete.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Questa struttura rappresenta un valore dei contatori Mac di diagnostica di rete.

Per le definizioni dei campi dei membri, consulta RFC 2863.

OtNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Questa struttura rappresenta un valore TLV route di rete diagnostica.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Questa struttura rappresenta un percorso di diagnostica della rete.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Questa struttura rappresenta un TLV diagnostico di rete.

OtReceiveDiagnosticGetCallback

void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

Il puntatore di questa funzione si chiama quando riceve una risposta di diagnostica di rete.

Dettagli
Parametri
[in] aError
Errore quando non è stato possibile ricevere la risposta.
[in] aMessage
Un puntatore al buffer del messaggio contenente il payload della risposta di diagnostica di rete ricevuto. Disponibile solo quando aError è OT_ERROR_NONE.
[in] aMessageInfo
Un puntatore sul messaggio delle informazioni di aMessage. Disponibile solo quando aError è OT_ERROR_NONE.
[in] aContext
Un puntatore sul contesto specifico dell'applicazione.

Destinazione route

enum otRoutePreference otRoutePreference

Definisce i valori validi di mPreference in otExternalRouteConfig e otBorderRouterConfig.

OtServerConfig

struct otServerConfig otServerConfig

Questa struttura rappresenta una configurazione del server.

OtServiceConfig

struct otServiceConfig otServiceConfig

Questa struttura rappresenta una configurazione del servizio.

otThreadEverycastLocatorCallback

void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

Questo tipo di puntatore di funzione definisce il callback per informare il risultato di una richiesta di otThreadLocateAnycastDestination().

Dettagli
Parametri
[in] aContext
Un puntatore a un contesto arbitrario (fornito quando è registrato il callback).
[in] aError
Errore durante la gestione della richiesta. OT_ERROR_NONE indica che l'operazione è riuscita. OT_ERROR_RESPONSE_TIMEOUT indica che non è stato possibile trovare una destinazione. OT_ERROR_ABORT indica che la richiesta è stata interrotta.
[in] aMeshLocalAddress
Un puntatore al EID mesh locale della destinazione più vicina dell'indirizzo anycast quando aError è OT_ERROR_NONE, NULL negli altri casi.
[in] aRloc16
RLOC16 della destinazione se trovato, altrimenti non valido RLOC16 (0xfffe).

otThreadDiscoveryRequestCallback

void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

Questo puntatore di funzione viene richiamato ogni volta che viene ricevuto un messaggio Richiesta MLE.

Dettagli
Parametri
[in] aInfo
Un puntatore sui dati informativi della richiesta di rilevamento.
[in] aContext
Un puntatore per richiamare il contesto specifico dell'applicazione.

Informazioni otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Questa struttura rappresenta i dati della richiesta di rilevamento di thread.

otThreadParentResponseCallback

void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)

Questo puntatore di funzione viene richiamato ogni volta che viene ricevuto un messaggio MLE Parent Response.

Dettagli
Parametri
[in] aInfo
Un puntatore su un punto della pila che contiene i dati delle statistiche.
[in] aContext
Un puntatore per richiamare il contesto specifico del client.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Questa struttura rappresenta i dati MLE Parent Response.

Functions

otNetDataContainsOmrPrefix

bool otNetDataContainsOmrPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Questa funzione controlla se un determinato prefisso può fungere da prefisso OMR valido e anche i dati di rete del leader contengono questo prefisso.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aPrefix
Un puntatore al prefisso IPv6.
Restituisce
Se aPrefix è un prefisso OMR valido e i dati di rete di Leader's contengono il prefisso OMR aPrefix.

otNetDataGet

otError otNetDataGet(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

Questo metodo fornisce una copia completa o stabile dei dati di rete della partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aStable
TRUE quando copia la versione stabile, FALSE quando copia la versione completa.
[out] aData
Un puntatore sul buffer di dati.
[in,out] aDataLength
All'inserimento, le dimensioni del buffer di dati indicato da aData. All'uscita, il numero di byte copiati.

otNetDataGetNextOnMeshPrefix

otError otNetDataGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

Questa funzione riceve il successivo prefisso mesh nei dati di rete della partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in,out] aIterator
Un puntatore sul contesto dell'iteratore dei dati di rete. Per ottenere la prima voce su mesh, deve essere impostata su OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntatore dove verranno posizionate le informazioni sul prefisso di mesh.
Valori di ritorno
OT_ERROR_NONE
Trovato il prossimo prefisso On Mesh.
OT_ERROR_NOT_FOUND
Non esiste alcun prefisso di rete mesh successivo nei dati della rete Thread.

otNetDataGetNextRoute

otError otNetDataGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

Questa funzione recupera la route esterna successiva nei dati di rete della partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in,out] aIterator
Un puntatore sul contesto dell'iteratore dei dati di rete. Per ottenere la prima voce di percorso esterna, deve essere impostata su OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntatore dove verranno posizionate le informazioni sui percorsi esterni.
Valori di ritorno
OT_ERROR_NONE
Trovata la route esterna successiva riuscita.
OT_ERROR_NOT_FOUND
Nei dati della rete Thread non esiste alcuna voce di route esterna successiva.

otNetDataGetNextService

otError otNetDataGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

Questa funzione riceve il servizio successivo nei dati di rete della partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in,out] aIterator
Un puntatore sul contesto dell'iteratore dei dati di rete. Per ottenere la prima voce di servizio, deve essere impostato su OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un suggerimento sulla posizione in cui verranno inserite le informazioni sul servizio.
Valori di ritorno
OT_ERROR_NONE
Il servizio successivo è stato trovato.
OT_ERROR_NOT_FOUND
Non esistono servizi successivi nei dati di rete della partizione.

Versione OtNetDataGetStable

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Recupero della versione dei dati di rete stabile.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
La versione dei dati di rete stabile.

OtNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Ottieni la versione dei dati di rete.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
La versione dei dati di rete.

otNetDataIsDnsSrpServiceAggiunto

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Questa funzione indica se attualmente si aggiunge o meno ai dati di rete del thread la voce "Servizio DNS/SRP".

Questa funzione richiede l'abilitazione della funzionalità OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Valori di ritorno
TRUE
La voce relativa al servizio DNS/SRP pubblicato viene aggiunta ai dati della rete Thread.
FALSE
La voce non viene aggiunta ai dati di rete di Thread o non esiste una voce da pubblicare.

otNetDataIsPrefixAggiunto

bool otNetDataIsPrefixAdded(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Questa funzione indica se al momento una voce di prefisso pubblicata (su rete o route esterna) viene aggiunta o meno ai dati di rete del thread.

Questa funzione richiede l'abilitazione della funzionalità OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aPrefix
Un puntatore sul prefisso (NON DEVE essere NULL).
Valori di ritorno
TRUE
La voce prefisso pubblicata viene aggiunta ai dati della rete Thread.
FALSE
La voce non viene aggiunta ai dati di rete di Thread o non esiste una voce da pubblicare.

otNetDataPublishDnsSrpServiceQualsiasicast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Questa funzione richiede la pubblicazione nei dati di rete del thread.

Questa funzione richiede l'abilitazione della funzionalità OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Una chiamata a questa funzione rimuoverà e sostituirà qualsiasi voce "Servizio DNS/SRP" precedentemente pubblicata (dalla chiamata precedente a una qualsiasi delle funzioni otNetDataPublishDnsSrpService{Type}()).

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aSequenceNUmber
Il numero di sequenza del servizio Anycast DNS/SRP.

otNetDataPublishDnsSrpServiceUnicast

void otNetDataPublishDnsSrpServiceUnicast(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint16_t aPort
)

Questa funzione richiede la pubblicazione nei dati di rete del thread.

Questa funzione richiede l'abilitazione della funzionalità OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Una chiamata a questa funzione rimuoverà e sostituirà qualsiasi voce "Servizio DNS/SRP" precedentemente pubblicata (dalla chiamata precedente a una qualsiasi delle funzioni otNetDataPublishDnsSrpService{Type}()).

Questa funzione pubblica "DNS/SRP Service Unicast Address" includendo l'indirizzo e le informazioni sulle porte nei dati del TLV del servizio.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aAddress
L'indirizzo del server DNS/SRP da pubblicare (NON DEVE essere NULL).
[in] aPort
Il numero di porta del server SRP da pubblicare.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Questa funzione richiede la pubblicazione nei dati di rete del thread.

Questa funzione richiede l'abilitazione della funzionalità OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Una chiamata a questa funzione rimuoverà e sostituirà qualsiasi voce "Servizio DNS/SRP" precedentemente pubblicata (dalla chiamata precedente a una qualsiasi delle funzioni otNetDataPublishDnsSrpService{Type}()).

A differenza di otNetDataPublishDnsSrpServiceUnicast(), che richiede la comunicazione dell'indirizzo pubblicato e include le informazioni nei dati del TLV del servizio, questa funzione utilizza il numero EID locale della rete mesh del dispositivo e include le informazioni nei dati del TLV del server.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aPort
Il numero di porta del server SRP da pubblicare.

OtNetDataPublishPublishExternalRoute

otError otNetDataPublishExternalRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

Questa funzione richiede un prefisso di route esterno da pubblicare nei dati della rete Thread.

Questa funzione richiede l'abilitazione della funzionalità OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Possono essere pubblicate solo voci stabili (ad es.aConfig.mStable DEVE essere TRUE.

Una chiamata successiva a questo metodo sostituirà una richiesta precedente relativa allo stesso prefisso. In particolare, se la nuova chiamata cambia solo i flag (ad es. il livello di preferenza) e il prefisso viene già aggiunto ai dati di rete, la modifica ai flag viene visualizzata immediatamente nei dati di rete. In questo modo, le voci esistenti nei Dati di rete non vengono rimosse bruscamente. Tieni presente che una modifica del livello di preferenza può causare una rimozione della voce dai dati di rete in seguito alla determinazione di altri nodi che pubblicano lo stesso prefisso con la stessa preferenza o una con un livello superiore.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aConfig
La configurazione di route esterna da pubblicare (NON DEVE essere NULL).
Valori di ritorno
OT_ERROR_NONE
La route esterna è stata pubblicata.
OT_ERROR_INVALID_ARGS
aConfig non è valido (prefisso errato, combinazioni di flag non valide o non stabile).
OT_ERROR_NO_BUFS
Impossibile allocare una voce per la nuova richiesta. Il publisher supporta un numero limitato di voci (condivise tra prefisso su rete e route esterna) determinate dalla configurazione OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataPublishOnMeshPrefix

otError otNetDataPublishOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

Questa funzione richiede la pubblicazione di un prefisso sulla rete nei dati della rete Thread.

Questa funzione richiede l'abilitazione della funzionalità OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Possono essere pubblicate solo voci stabili (ad es.aConfig.mStable DEVE essere TRUE.

Una chiamata successiva a questo metodo sostituirà una richiesta precedente relativa allo stesso prefisso. In particolare, se la nuova chiamata cambia solo i flag (ad es. il livello di preferenza) e il prefisso viene già aggiunto ai dati di rete, la modifica ai flag viene visualizzata immediatamente nei dati di rete. In questo modo, le voci esistenti nei Dati di rete non vengono rimosse bruscamente. Tieni presente che una modifica del livello di preferenza può causare una rimozione della voce dai dati di rete in seguito alla determinazione di altri nodi che pubblicano lo stesso prefisso con la stessa preferenza o una con un livello superiore.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aConfig
La configurazione del prefisso sulla rete da pubblicare (NON DEVE essere NULL).
Valori di ritorno
OT_ERROR_NONE
Il prefisso on-mesh è stato pubblicato.
OT_ERROR_INVALID_ARGS
aConfig non è valido (prefisso errato, combinazioni di flag non valide o non stabile).
OT_ERROR_NO_BUFS
Impossibile allocare una voce per la nuova richiesta. Il publisher supporta un numero limitato di voci (condivise tra prefisso su rete e route esterna) determinate dalla configurazione OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataSetDnsSrpServicePublisherCallback

void otNetDataSetDnsSrpServicePublisherCallback(
  otInstance *aInstance,
  otNetDataDnsSrpServicePublisherCallback aCallback,
  void *aContext
)

Questa funzione imposta un callback per l'invio di una notifica quando un servizio "DNS/SRP" pubblicato viene effettivamente aggiunto o rimosso dai dati della rete Thread.

Una chiamata successiva a questa funzione sostituisce qualsiasi funzione di callback impostata in precedenza.

Questa funzione richiede l'abilitazione della funzionalità OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aCallback
Il puntatore della funzione di callback (può essere NULL se non è necessario).
[in] aContext
Un puntatore che rimanda al contesto specifico dell'applicazione (utilizzato quando viene richiamato aCallback).

otNetDataSetPrefixPublisherCallback

void otNetDataSetPrefixPublisherCallback(
  otInstance *aInstance,
  otNetDataPrefixPublisherCallback aCallback,
  void *aContext
)

Questa funzione imposta un callback per la notifica quando una voce di prefisso pubblicata viene effettivamente aggiunta o rimossa dai dati della rete Thread.

Una chiamata successiva a questa funzione sostituisce qualsiasi funzione di callback impostata in precedenza.

Questa funzione richiede l'abilitazione della funzionalità OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aCallback
Il puntatore della funzione di callback (può essere NULL se non è necessario).
[in] aContext
Un puntatore che rimanda al contesto specifico dell'applicazione (utilizzato quando viene richiamato aCallback).

otNetDataSteeringDataCheckChecker

otError otNetDataSteeringDataCheckJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

Controlla se i dati relativi al volante includono una joiner.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aEui64
Un puntatore verso IEEE EUI-64 di Joiner.
Valori di ritorno
OT_ERROR_NONE
aEui64 è incluso nei dati di guida.
OT_ERROR_INVALID_STATE
Nessun dato sull'sterzo presente.
OT_ERROR_NOT_FOUND
aEui64 non è incluso nei dati di guida.

otNetDataSteeringDataCheckjoinerWithDiscerner

otError otNetDataSteeringDataCheckJoinerWithDiscerner(
  otInstance *aInstance,
  const struct otJoinerDiscerner *aDiscerner
)

Controlla se i dati relativi al volante includono un Joiner con un determinato valore di discerner.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDiscerner
Un puntatore su Joiner Discerner.
Valori di ritorno
OT_ERROR_NONE
aDiscerner è incluso nei dati di guida.
OT_ERROR_INVALID_STATE
Nessun dato sull'sterzo presente.
OT_ERROR_NOT_FOUND
aDiscerner non è incluso nei dati di guida.

otNetDataPubblicazioneDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Annulla la pubblicazione di qualsiasi voce di servizio DNS/SRP (Qualsiasicast o Unicast) aggiunta in precedenza dai dati di rete Thread.

Il servizio OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE deve essere attivato.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.

otNetDataPubblicazionePrefix

otError otNetDataUnpublishPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Annulla la pubblicazione di un prefisso su rete o esterno esterno pubblicato in precedenza.

Il servizio OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE deve essere attivato.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aPrefix
Il prefisso di cui annullare la pubblicazione (NON DEVE essere NULL).
Valori di ritorno
OT_ERROR_NONE
La pubblicazione del prefisso è stata annullata.
OT_ERROR_NOT_FOUND
Impossibile trovare il prefisso nell'elenco pubblicato.

otThreadDiventaChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Prova a ricollegarlo come bambino.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Valori di ritorno
OT_ERROR_NONE
Tentativo di tentativo di diventare figlio secondario riuscito.
OT_ERROR_INVALID_STATE
Thread disattivato.

otThreadDiventaDetaching

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Scollegalo dalla rete Thread.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Valori di ritorno
OT_ERROR_NONE
Scollegato dalla rete Thread.
OT_ERROR_INVALID_STATE
Thread disattivato.

otThreadDetachGraceful

otError otThreadDetachGracefully(
  otInstance *aInstance,
  otDetachGracefullyCallback aCallback,
  void *aContext
)

Questa funzione invia una notifica ad altri nodi della rete (se presenti), quindi interrompe il funzionamento del protocollo Thread.

Invia un rilascio di indirizzo se è un router o imposta il timeout secondario su 0 se è un figlio.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aCallback
Un puntatore a una funzione che viene richiamata al termine dello scollegamento.
[in] aContext
Un puntatore per richiamare il contesto specifico dell'applicazione.
Valori di ritorno
OT_ERROR_NONE
Scollegamento riuscito.
OT_ERROR_BUSY
Lo scollegamento è già in corso.

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Converti il ruolo dispositivo in una stringa leggibile.

Dettagli
Parametri
[in] aRole
Il ruolo del dispositivo da convertire.
Restituisce
Una stringa che rappresenta aRole.

OtThreadDiscover

otError otThreadDiscover(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aPanId,
  bool aJoiner,
  bool aEnableEui64Filtering,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

Questa funzione avvia una scansione di Thread Discovery.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aScanChannels
Un bit Vettore che indica quali canali cercare (ad es. OT_CHANNEL_11_MASK).
[in] aPanId
Il filtro ID PAN (impostato su PAN per trasmettere) per disattivare il filtro.
[in] aJoiner
Valore del flag Joiner nel TLV della richiesta di rilevamento.
[in] aEnableEui64Filtering
TRUE per filtrare le risposte in EUI-64, in caso contrario FALSE.
[in] aCallback
Il puntatore del mouse su una funzione chiamata in seguito alla ricezione di una risposta di rilevamento MLE o di una scansione.
[in] aCallbackContext
Un puntatore sul contesto specifico dell'applicazione.
Valori di ritorno
OT_ERROR_NONE
Scansione rilevamento thread riuscita.
OT_ERROR_INVALID_STATE
L'interfaccia IPv6 non è abilitata (netif non è attivo).
OT_ERROR_NO_BUFS
Impossibile allocare il messaggio per la richiesta di rilevamento.
OT_ERROR_BUSY
La scansione di Thread Discovery è già in corso.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Recupera il timeout secondario del thread quando utilizzi il ruolo secondario.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Il valore di Timeout del thread secondario in secondi.
Vedi anche:
otThreadSetChildTimeout

Ruolo OtThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Recupera il ruolo dispositivo.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Valori di ritorno
OT_DEVICE_ROLE_DISABLED
La combinazione di thread è disattivata.
OT_DEVICE_ROLE_DETACHED
Al momento il dispositivo non partecipa a una rete/partizione Thread.
OT_DEVICE_ROLE_CHILD
Il dispositivo è attualmente operativo come bambino secondario Thread.
OT_DEVICE_ROLE_ROUTER
Attualmente il dispositivo funziona come router Thread.
OT_DEVICE_ROLE_LEADER
Al momento il dispositivo funziona come leader di Thread.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Recupera il nome di dominio del thread.

Questa funzione è disponibile solo dal thread 1.2,

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Un puntatore sul nome di dominio del thread.
Vedi anche:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Ottieni l'ID PAN esteso IEEE 802.15.4.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Un puntatore posizionato sull'ID PAN esteso IEEE 802.15.4.
Vedi anche:
otThreadSetExtendedPanId

otThreadGetFixDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Ottieni l'identificatore di interfaccia specificato manualmente per l'indirizzo Unicast del dominio del thread.

Questa funzione è disponibile solo dal thread 1.2 quando è abilitato OPENTHREAD_CONFIG_DUA_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Un puntatore che cerca l'identificatore dell'interfaccia impostato manualmente o NULL, se non è stato impostato.
Vedi anche:
otThreadSetFixDuaInterfaceIdentifier

Contatori otThreadGetIp6

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Ottieni i contatori IPv6.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Un puntatore sui contatori IPv6.

otThreadGetKeySequenzaCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Ottieni il thBREAKSequenzaCounter.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Il valore thBREAKSequenzaCounter.
Vedi anche:
otThreadSetKeySequenzaCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Ottieni thcreatoracademySwitchGuardTime.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Il valore thcreatoracademySwitchGuardTime (in ore).
Vedi anche:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Questa funzione riceve i dati di Thread Leader.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aLeaderData
Un puntatore sul punto in cui vengono posizionati i dati della variante leader.
Valori di ritorno
OT_ERROR_NONE
I dati della variante sono stati recuperati.
OT_ERROR_DETACHED
Attualmente non collegato.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Questa funzione restituisce un puntatore al RLOC di Leader.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aLeaderRloc
Un puntatore sul RLOC di Leader.
Valori di ritorno
OT_ERROR_NONE
La RLOC di Leader è stata scritta su aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc era NULL.
OT_ERROR_DETACHED
Attualmente non collegato a una partizione thread.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Ottieni l'ID router Leader.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
L'ID router di Leader.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Ottieni il peso del leader.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Il peso del leader.

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Questa funzione restituisce l'indirizzo multicast di Thread Link-Local All Thread Nodes.

L'indirizzo è un indirizzo Unicast basato su prefisso locale Mlinkcast [RFC 3306], con:

  • fls impostato su 3 (P = 1 e T = 1)
  • ambito impostato su 2
  • impostato su 64
  • prefisso di rete impostato sul prefisso locale mesh
  • ID gruppo impostato su 1

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Un puntatore che rimanda all'indirizzo multicast di Thread Link-Local All Thread Nodes.

Indirizzo otThreadGetLinkLocalIp6

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Questa funzione restituisce l'indirizzo IPv6 del link locale del thread.

L'indirizzo locale del link al thread viene derivato utilizzando l'indirizzo esteso IEEE802.15.4 come identificatore dell'interfaccia.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Un puntatore che rimanda all'indirizzo IPv6 del link locale del thread.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Recupera la configurazione della modalità di collegamento MLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
La configurazione della modalità di collegamento MLE.
Vedi anche:
otThreadSetLinkMode

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Questa funzione restituisce un puntatore all'indirizzo EID locale della rete mesh.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Un puntatore sull'indirizzo EID locale della rete mesh.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Questa funzione restituisce un puntatore al prefisso locale mesh.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Un puntatore sul prefisso locale mesh.

otThreadGetMleCounter

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Ottieni i contatori Thread MLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Un puntatore sui contatori ML ML.

oThreadThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Recupera la chiave di rete del thread.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aNetworkKey
Un puntatore su otNetworkkey per restituire la chiave di rete Thread.
Vedi anche:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Richiedi la chiave otNetworkKeyRef per la rete Thread.

Questa funzione richiede che sia abilitata la funzionalità di compilazione OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Riferimento alla chiave di rete Thread archiviata in memoria.
Vedi anche:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Recupera il nome della rete Thread.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Un puntatore sul nome della rete di Thread.
Vedi anche:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

otError otThreadGetNextDiagnosticTlv(
  const otMessage *aMessage,
  otNetworkDiagIterator *aIterator,
  otNetworkDiagTlv *aNetworkDiagTlv
)

Questa funzione riceve il successivo TLV diagnostico di rete nel messaggio.

Una chiamata successiva a questa funzione è consentita solo quando il valore corrente restituito è OT_ERROR_NONE.

Dettagli
Parametri
[in] aMessage
Un puntatore a un messaggio.
[in,out] aIterator
Un puntatore al contesto dell'iteratore della diagnostica di rete. Per ottenere il primo TLV diagnostico di rete, deve essere impostato su OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Un puntatore nel punto in cui verranno posizionate le informazioni sul TLV diagnostico di rete.
Valori di ritorno
OT_ERROR_NONE
È stato trovato il TLV diagnostico di rete successivo.
OT_ERROR_NOT_FOUND
Nel messaggio non esiste il TLV diagnostico di rete successivo.
OT_ERROR_PARSE
Analisi della successiva diagnostica di rete non riuscita.

otThreadGetNextNeighborInfo

otError otThreadGetNextNeighborInfo(
  otInstance *aInstance,
  otNeighborInfoIterator *aIterator,
  otNeighborInfo *aInfo
)

Questa funzione riceve le informazioni per il vicino.

Viene utilizzato per scorrere le voci della tabella adiacente.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in,out] aIterator
Un puntatore al contesto dell'iteratore. Per ottenere la prima voce adiacente, deve essere impostato su OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Un suggerimento sulle informazioni relative al vicino.
Valori di ritorno
OT_ERROR_NONE
È stata trovata la prossima voce della vicina nella tabella.
OT_ERROR_NOT_FOUND
Nella tabella non esiste alcuna voce adiacente.
OT_ERROR_INVALID_ARGS
aIterator o aInfo era NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

La funzione recupera la media RSSI per l'elemento principale del thread.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aParentRssi
Un puntatore sul punto in cui deve essere posizionato il RSSI principale.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

La funzione recupera le informazioni di diagnostica per un router Thread come principale.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aParentInfo
Un puntatore nel punto in cui vengono posizionate le informazioni del router principale.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

La funzione recupera il codice RSSI dell'ultimo pacchetto dall'elemento Thread principale.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aLastRssi
Un suggerimento relativo alla posizione dell'ultimo RSSI.
Valori di ritorno
OT_ERROR_NONE
Recupero dei dati RSSI riuscito.
OT_ERROR_FAILED
Impossibile recuperare i dati RSSI.
OT_ERROR_INVALID_ARGS
aLastRssi è NULL.

ID otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Ottieni l'ID partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
ID della partizione.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Questa funzione restituisce l'indirizzo multicast di Thread Realm-Local All Thread Nodes.

L'indirizzo è un indirizzo Multcast basato su prefisso Unicast locale [RFC 3306], con:

  • fls impostato su 3 (P = 1 e T = 1)
  • ambito impostato su 3
  • impostato su 64
  • prefisso di rete impostato sul prefisso locale mesh
  • ID gruppo impostato su 1

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Un puntatore per l'indirizzo multicast di Thread Realm-Local All Thread Nodes.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Questa funzione restituisce un puntatore all'indirizzo RLOC (Thread Routing Locator).

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Un puntatore sull'indirizzo RLOC (Thread Routing Locator).

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Acquista RLOC16.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
RLOC16.

otThreadGetServiceAloc

otError otThreadGetServiceAloc(
  otInstance *aInstance,
  uint8_t aServiceId,
  otIp6Address *aServiceAloc
)

Questa funzione recupera l'ALOC del servizio per il determinato ID di servizio.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aServiceId
ID servizio per ottenere ALOC.
[out] aServiceAloc
Un puntatore per generare l'ALOC del servizio. NON DEVE ESSERE NULLO.
Valori di ritorno
OT_ERROR_NONE
Recupero dell'ALOC del servizio riuscito.
OT_ERROR_DETACHED
L'interfaccia di Thread non è attualmente collegata a una partizione del thread.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Questa funzione riceve la versione protocollo Thread.

Dettagli
Restituisce
la versione del protocollo Thread.

otThreadIsQualsiasicastFindInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Questa funzione indica se una richiesta di trasmissione anycast è attualmente in corso.

Questa funzione è disponibile solo quando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE è abilitato.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
TRUE se è attualmente in corso una richiesta di individuazione anycast, FALSE altrimenti.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Questa funzione determina se è in corso un MLE Thread Discovery.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

Questa funzione indica se un nodo è l'unico router della rete.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Valori di ritorno
TRUE
È l'unico router nella rete.
FALSE
È un elemento secondario o non è un singolo router della rete.

otThreadFindWithDestination

otError otThreadLocateAnycastDestination(
  otInstance *aInstance,
  const otIp6Address *aAnycastAddress,
  otThreadAnycastLocatorCallback aCallback,
  void *aContext
)

Questa funzione richiede la posizione più vicina di un determinato indirizzo anycast.

Questa funzione è disponibile solo quando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE è abilitato.

Se è in corso una richiesta precedente, una chiamata successiva a questa funzione annullerà e sostituirà la richiesta precedente.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aAnycastAddress
L'indirizzo anycast da individuare. NON DEVE essere NULL.
[in] aCallback
La funzione di callback per segnalare il risultato.
[in] aContext
Un contesto arbitrario utilizzato con aCallback.
Valori di ritorno
OT_ERROR_NONE
La richiesta è stata avviata. Verrà richiamato aCallback per segnalare il risultato.
OT_ERROR_INVALID_ARGS
aAnycastAddress non è un indirizzo anycast valido oppure aCallback è NULL.
OT_ERROR_NO_BUFS
Fuori dal buffer per preparare e inviare il messaggio di richiesta.

otThreadRegisterParentResponseCallback

void otThreadRegisterParentResponseCallback(
  otInstance *aInstance,
  otThreadParentResponseCallback aCallback,
  void *aContext
)

Questa funzione registra un callback per ricevere i dati MLE Parent Response.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aCallback
Un puntatore a una funzione che viene richiamata alla ricezione di un messaggio MLE Parent Response.
[in] aContext
Un puntatore per richiamare il contesto specifico del client.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Reimposta i contatori IPv6.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Reimposta i contatori MLE Thread.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.

otThreadSendAddressNotification

void otThreadSendAddressNotification(
  otInstance *aInstance,
  otIp6Address *aDestination,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid
)

Questa funzione invia un messaggio di notifica proattiva dell'indirizzo (ADDR_NTF.ntf).

Questa funzione è disponibile solo quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE è abilitato.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDestination
La destinazione a cui inviare il messaggio ADDR_NTF.ntf.
[in] aTarget
L'indirizzo target del messaggio ADDR_NTF.ntf.
[in] aMlIid
L'ML-IID del messaggio ADDR_NTF.ntf.

otThreadSendDiagnosticGet

otError otThreadSendDiagnosticGet(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

Invia una richiesta di diagnostica di rete.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDestination
Un puntatore sull'indirizzo di destinazione.
[in] aTlvTypes
Un array di tipi di TLV diagnostici di rete.
[in] aCount
Numero di tipi in aTlvTypes.
[in] aCallback
Un puntatore a una funzione chiamata quando riceve la risposta di diagnostica di rete o NULL per disabilitare il callback.
[in] aCallbackContext
Un puntatore sul contesto specifico dell'applicazione.
Valori di ritorno
OT_ERROR_NONE
DIAG_GET.req in coda.
OT_ERROR_NO_BUFS
Buffer di messaggio insufficienti per inviare DIAG_GET.req

otThreadSendDiagnosticReimposta

otError otThreadSendDiagnosticReset(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount
)

Invia una richiesta di Diagnostica diagnostica di rete.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDestination
Un puntatore sull'indirizzo di destinazione.
[in] aTlvTypes
Un array di tipi di TLV diagnostici di rete. Al momento è consentito solo il tipo 9.
[in] aCount
Numero di tipi in ATlvTypes
Valori di ritorno
OT_ERROR_NONE
DIAG_RST.ntf inserito in coda.
OT_ERROR_NO_BUFS
Buffer di messaggio insufficienti per inviare DIAG_RST.ntf.

otThreadSendProactiveBackboneNotification

otError otThreadSendProactiveBackboneNotification(
  otInstance *aInstance,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid,
  uint32_t aTimeSinceLastTransaction
)

Questa funzione invia un messaggio PRO_BB.ntf (proattiva backbone notification) al link Backbone.

Questa funzione è disponibile solo quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE è abilitato.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aTarget
L'indirizzo target del messaggio PRO_BB.ntf.
[in] aMlIid
L'ML-IID del messaggio PRO_BB.ntf.
[in] aTimeSinceLastTransaction
Tempo dall'ultima transazione (in secondi).
Valori di ritorno
OT_ERROR_NONE
PRO_BB.ntf inviato correttamente il link backbone.
OT_ERROR_NO_BUFS
Se i buffer di messaggio sono insufficienti.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Impostare il timeout del publisher secondario del thread utilizzato per il ruolo secondario.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aTimeout
Il valore in timeout in secondi.
Vedi anche:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

void otThreadSetDiscoveryRequestCallback(
  otInstance *aInstance,
  otThreadDiscoveryRequestCallback aCallback,
  void *aContext
)

Questa funzione imposta un callback per ricevere i dati MLE Discovery Request.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aCallback
Un puntatore a una funzione che viene richiamata alla ricezione di un messaggio MLE Discovery Request.
[in] aContext
Un puntatore per richiamare il contesto specifico dell'applicazione.

OtThreadSetDomainName

otError otThreadSetDomainName(
  otInstance *aInstance,
  const char *aDomainName
)

Imposta il nome di dominio del thread.

Questa funzione è disponibile solo dal thread 1.2, Questa funzione ha esito positivo solo quando i protocolli Thread sono disabilitati.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDomainName
Un puntatore sul nome di dominio del thread.
Valori di ritorno
OT_ERROR_NONE
Impostazione del nome di dominio del thread riuscita.
OT_ERROR_INVALID_STATE
I protocolli Thread sono abilitati.
Vedi anche:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Questa funzione avvia il funzionamento del protocollo Thread.

L'interfaccia deve essere attiva durante la chiamata a questa funzione.

La chiamata a questa funzione con aEnabled impostata su FALSE interrompe gli eventuali processi in corso di scollegamento avviati da otThreadDetachGraceious(). Il relativo callback verrà chiamato.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aEnabled
TRUE se il thread è attivato, altrimenti FALSE.
Valori di ritorno
OT_ERROR_NONE
Operazione del protocollo Thread avviata.
OT_ERROR_INVALID_STATE
L'interfaccia di rete non era attiva.

OtThreadSetExtendedPanId

otError otThreadSetExtendedPanId(
  otInstance *aInstance,
  const otExtendedPanId *aExtendedPanId
)

Imposta l'ID PAN esteso IEEE 802.15.4.

Questa funzione può essere chiamata solo quando i protocolli Thread sono disattivati. Una chiamata riuscita a questa funzione invalida i set di dati operativi attivi e in attesa in memoria non volatile.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aExtendedPanId
Un puntatore posizionato sull'ID PAN esteso IEEE 802.15.4.
Valori di ritorno
OT_ERROR_NONE
Impostazione dell'ID PAN esteso riuscita.
OT_ERROR_INVALID_STATE
I protocolli Thread sono abilitati.
Vedi anche:
otThreadGetExtendedPanId

otThreadSetFidDuaInterfaceIdentifier

otError otThreadSetFixedDuaInterfaceIdentifier(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

Imposta/Cancella l'identificatore interfaccia specificato manualmente per l'indirizzo unicast dominio del thread.

Questa funzione è disponibile solo dal thread 1.2 quando è abilitato OPENTHREAD_CONFIG_DUA_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aIid
Un puntatore sull'identificatore di interfaccia da impostare o NULL da cancellare.
Valori di ritorno
OT_ERROR_NONE
L'identificatore di interfaccia è stato impostato/cancellato correttamente.
OT_ERROR_INVALID_ARGS
L'identificatore di interfaccia specificato è riservato.
Vedi anche:
otThreadGetFixDuaInterfaceIdentifier

OtThreadSetjoinerAdvertising

otError otThreadSetJoinerAdvertisement(
  otInstance *aInstance,
  uint32_t aOui,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

Questo metodo imposta la pubblicità di Thread join nel rilevamento della rete Thread.

La pubblicità di Thread Joiner viene utilizzata per consentire a un Joiner di pubblicizzare le proprie informazioni specifiche per l'applicazione (ad esempio, ID fornitore, ID prodotto, Discriminatore ecc.) tramite un TLV annunciato da una nuova proposta e per rendere tali informazioni disponibili per i Commissioner o i Candidati candidati senza interazione umana.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aOui
Il valore OUI del fornitore IEEE che verrà incluso nella pubblicità uniter. Verranno utilizzati solo i byte meno significativi e il byte più significativo verrà ignorato.
[in] aAdvData
Un puntatore sull'annuncio avanzato che verrà incluso nella pubblicità unita.
[in] aAdvDataLength
La lunghezza in byte di AdvData.
Valori di ritorno
OT_ERROR_NONE
Impostazione corretta della pubblicità per Joiner.
OT_ERROR_INVALID_ARGS
AdvData non valido.

otThreadSetKeySequenzaCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Imposta il thBREAKSequenzaCounter.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aKeySequenceCounter
Il valore thBREAKSequenzaCounter.
Vedi anche:
otThreadGetKeySequenzaCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Imposta il thrupSwitchGuardTime.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aKeySwitchGuardTime
Il valore thcreatoracademySwitchGuardTime (in ore).
Vedi anche:
otThreadGetKeySwitchGuardTime

OtThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Imposta la configurazione della modalità di collegamento MLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aConfig
Un puntatore sulla configurazione della modalità link.
Valori di ritorno
OT_ERROR_NONE
Impostazione della modalità di collegamento MLE riuscita.
Vedi anche:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

otError otThreadSetMeshLocalPrefix(
  otInstance *aInstance,
  const otMeshLocalPrefix *aMeshLocalPrefix
)

Questa funzione imposta il prefisso locale mesh.

Questa funzione ha esito positivo solo quando i protocolli Thread sono disabilitati. Una chiamata riuscita a questa funzione invalida i set di dati operativi attivi e in attesa in memoria non volatile.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aMeshLocalPrefix
Un puntatore sul prefisso locale mesh.
Valori di ritorno
OT_ERROR_NONE
Impostazione del prefisso locale mesh riuscita.
OT_ERROR_INVALID_STATE
I protocolli Thread sono abilitati.

OtThreadSetNetworkKey

otError otThreadSetNetworkKey(
  otInstance *aInstance,
  const otNetworkKey *aKey
)

Imposta la chiave di rete del thread.

Questa funzione ha esito positivo solo quando i protocolli Thread sono disabilitati. Una chiamata riuscita a questa funzione invalida i set di dati operativi attivi e in attesa in memoria non volatile.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aKey
Un puntatore su un buffer contenente la chiave di rete Thread.
Valori di ritorno
OT_ERROR_NONE
Impostazione della chiave di rete del thread riuscita.
OT_ERROR_INVALID_STATE
I protocolli Thread sono abilitati.
Vedi anche:
otThreadGetNetworkKey

OtThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Imposta la chiave di rete Thread come otNetworkKeyRef.

Questa funzione ha esito positivo solo quando i protocolli Thread sono disabilitati. Una chiamata riuscita a questa funzione invalida i set di dati operativi attivi e in attesa in memoria non volatile.

Questa funzione richiede che sia abilitata la funzionalità di compilazione OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aKeyRef
Riferimento alla chiave di rete del thread.
Valori di ritorno
OT_ERROR_NONE
Impostazione della chiave di rete del thread riuscita.
OT_ERROR_INVALID_STATE
I protocolli Thread sono abilitati.
Vedi anche:
otThreadGetNetworkKeyRef

NomeAppSetSetNetworkNetwork

otError otThreadSetNetworkName(
  otInstance *aInstance,
  const char *aNetworkName
)

Imposta il nome della rete Thread.

Questa funzione ha esito positivo solo quando i protocolli Thread sono disabilitati. Una chiamata riuscita a questa funzione invalida i set di dati operativi attivi e in attesa in memoria non volatile.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aNetworkName
Un puntatore sul nome della rete di Thread.
Valori di ritorno
OT_ERROR_NONE
Impostazione del nome della rete Thread riuscita.
OT_ERROR_INVALID_STATE
I protocolli Thread sono abilitati.
Vedi anche:
otThreadGetNetworkName

Macro

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Lunghezza massima della pubblicità congiunta.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Inizializzatore per otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Lunghezza del valore massima del TLV base di thread.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Valore per inizializzare otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Dimensioni della voce della tabella secondaria di diagnostica di rete.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Inizializzatore per otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Numero massimo di tipi di TLV diagnostici di rete da richiedere o reimpostare.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

ID massimo router.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Dimensione massima dei dati del server in byte. Limite teorico, praticamente molto inferiore.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Dimensione massima dei dati del servizio in byte.

Risorse

Gli argomenti di riferimento per l'API OpenThread provengono dal codice sorgente, disponibile su GitHub. Per ulteriori informazioni o per contribuire alla nostra documentazione, consulta la sezione Risorse.