Generale

Questo modulo include le funzioni per tutti i ruoli dei thread.

Riepilogo

Network Data Publisher fornisce meccanismi per limitare il numero di voci di servizio e/o prefisso (prefisso in rete o route esterna) simili nei dati di rete Thread monitorando i dati di rete e gestendo se o quando aggiungere o rimuovere voci.

Tutte le funzioni di questo modulo richiedono l'attivazione 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,
  OT_NETWORK_DIAGNOSTIC_TLV_VERSION = 24,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME = 25,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL = 26,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION = 27,
  OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION = 28,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD = 29,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST = 30,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR = 31,
  OT_NETWORK_DIAGNOSTIC_TLV_ANSWER = 32,
  OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID = 33,
  OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS = 34
}
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 del dispositivo Thread.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
enum
Rappresenta gli eventi segnalati dai callback del publisher.
otRoutePreference{
  OT_ROUTE_PREFERENCE_LOW = -1,
  OT_ROUTE_PREFERENCE_MED = 0,
  OT_ROUTE_PREFERENCE_HIGH = 1
}
enum
Definisce i valori validi per mPreference in otExternalRouteConfig e otBorderRouterConfig.

Typedef

otBorderRouterConfig typedef
Rappresenta la configurazione di un router di confine.
otDetachGracefullyCallback)(void *aContext) typedef
void(*
Questo callback informa l'applicazione che il processo di scollegamento è terminato.
otExternalRouteConfig typedef
Rappresenta una configurazione di route esterna.
otIpCounters typedef
struct otIpCounters
Rappresenta i contatori a livello di IP.
otLeaderData typedef
struct otLeaderData
Rappresenta i dati dei thread leader.
otLinkModeConfig typedef
Rappresenta una configurazione della modalità di collegamento MLE.
otLowpanContextInfo typedef
Rappresenta le informazioni sull'ID contesto 6LoWPAN associate a un prefisso nei dati di rete.
otMleCounters typedef
struct otMleCounters
Rappresenta i contatori MLE di Thread.
otNeighborInfoIterator typedef
int16_t
Utilizzato per eseguire l'iterazione attraverso la tabella vicina.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
Il tipo di puntatore definisce il callback utilizzato per notificare quando una voce "Servizio DNS/SRP" viene aggiunta o rimossa dai dati di rete Thread.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
Il tipo di puntatore definisce il callback utilizzato per notificare quando una voce di prefisso (su mesh o route esterna) viene aggiunta o rimossa dai dati di rete Thread.
otNetDataPublisherEvent typedef
Rappresenta gli eventi segnalati dai callback del publisher.
otNetworkDataIterator typedef
uint32_t
Utilizzato per eseguire l'iterazione tramite le informazioni relative ai dati di rete.
otNetworkDiagChildEntry typedef
Rappresenta una voce della tabella secondaria diagnostica di rete.
otNetworkDiagConnectivity typedef
Rappresenta un valore di connettività diagnostica di rete.
otNetworkDiagIterator typedef
uint16_t
Utilizzato per eseguire l'iterazione tramite il TLV di diagnostica di rete.
otNetworkDiagMacCounters typedef
Rappresenta un valore dei contatori MAC di diagnostica di rete.
otNetworkDiagMleCounters typedef
Rappresenta un valore dei contatori MLE di diagnostica di rete.
otNetworkDiagRoute typedef
Rappresenta il valore TLV di una route diagnostica di rete.
otNetworkDiagRouteData typedef
Rappresenta i dati di una route diagnostica di rete.
otNetworkDiagTlv typedef
Rappresenta un TLV di diagnostica di rete.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
Il puntatore viene richiamato quando viene ricevuta la risposta del test di diagnostica di rete.
otRoutePreference typedef
Definisce i valori validi per mPreference in otExternalRouteConfig e otBorderRouterConfig.
otServerConfig typedef
Rappresenta una configurazione del server.
otServiceConfig typedef
Rappresenta la configurazione di un servizio.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
Il tipo di puntatore definisce il callback per notificare il risultato di una richiesta otThreadLocateAnycastDestination().
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
Il puntatore viene chiamato ogni volta che viene ricevuto un messaggio di richiesta di rilevamento della MLE.
otThreadDiscoveryRequestInfo typedef
Rappresenta i dati della richiesta di rilevamento Thread.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Il puntatore viene chiamato ogni volta che viene ricevuto un messaggio di risposta dei genitori MLE.
otThreadParentResponseInfo typedef
Rappresenta i dati della risposta dei genitori MLE.

Funzioni

otConvertDurationInSecondsToString(uint32_t aDuration, char *aBuffer, uint16_t aSize)
void
Converte una durata uint32_t (in secondi) in una stringa leggibile.
otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Verifica se un determinato prefisso può fungere da prefisso OMR valido e se anche i dati di rete del leader contengono questo prefisso.
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Fornisci una copia completa o stabile dei dati di rete Thread della partizione.
otNetDataGetCommissioningDataset(otInstance *aInstance, otCommissioningDataset *aDataset)
void
Recupera il set di dati per la messa in servizio dai dati di rete della partizione.
otNetDataGetLength(otInstance *aInstance)
uint8_t
Ottieni la lunghezza attuale (numero di byte) dei dati di rete Thread della partizione.
otNetDataGetMaxLength(otInstance *aInstance)
uint8_t
Ottieni la lunghezza massima osservata dei dati di rete Thread dall'inizializzazione dello stack OT o dall'ultima chiamata a otNetDataResetMaxLength().
otNetDataGetNextLowpanContextInfo(otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)
Ottieni le successive informazioni sull'ID contesto 6LoWPAN nei dati di rete della partizione.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Ottieni il successivo prefisso sulla rete mesh nei dati di rete della partizione.
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Trova la route esterna successiva nei dati di rete della partizione.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Ottieni il servizio successivo nei dati di rete della partizione.
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
Recuperare la versione stabile dei dati di rete.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
Recupera la versione dei dati di rete.
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
Indica se attualmente la voce "Servizio DNS/SRP" viene aggiunta o meno ai dati di rete Thread.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Indica se una voce di prefisso pubblicata attualmente (on-mesh o route esterna) viene aggiunta o meno ai dati di rete Thread.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Richiedi la pubblicazione dell'indirizzo "DNS/SRP Service Anycast Address" nei dati di rete Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Richiedi la pubblicazione di "Indirizzo Unicast del servizio DNS/SRP" nei dati di rete Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Richiedi la pubblicazione di "Indirizzo Unicast del servizio DNS/SRP" nei dati di rete Thread.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Consente di pubblicare un prefisso di route esterna nei dati di rete Thread.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Consente di pubblicare un prefisso on-mesh nei dati di rete Thread.
otNetDataReplacePublishedExternalRoute(otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
Sostituisce una route esterna pubblicata in precedenza nei dati di rete Thread.
otNetDataResetMaxLength(otInstance *aInstance)
void
Reimposta la lunghezza massima rilevata dei dati di rete Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Imposta un callback per notificare quando un "Servizio DNS/SRP" pubblicato viene effettivamente aggiunto o rimosso dai dati di rete Thread.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Imposta un callback per notificare quando una voce di prefisso pubblicata viene effettivamente aggiunta o rimossa dai dati di rete Thread.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Controlla se i dati sullo sterzo includono un joiner.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Verifica se i dati sullo sterzo includono un joiner con un determinato valore di discerner.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Annulla la pubblicazione di qualsiasi voce del servizio DNS/SRP (Anycast o Unicast) aggiunta in precedenza dai dati di rete Thread.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Annulla la pubblicazione di un prefisso di route on-mesh o esterno pubblicato in precedenza.
otThreadBecomeChild(otInstance *aInstance)
Prova a ricollegarlo come bambino.
otThreadBecomeDetached(otInstance *aInstance)
Scollegati dalla rete Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Invia una notifica agli altri nodi nella rete (se presenti) e interrompe le operazioni del protocollo Thread.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
Converti il ruolo del dispositivo in stringa leggibile.
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Avvia una scansione di Thread Discovery.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Restituisce il timeout dell'asset secondario thread (in secondi) utilizzato durante l'uso del ruolo secondario.
otThreadGetDeviceRole(otInstance *aInstance)
Ottieni il ruolo del dispositivo.
otThreadGetDomainName(otInstance *aInstance)
const char *
Restituisce il nome di dominio Thread.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Ottieni l'ID PAN esteso IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Restituisce l'identificatore di interfaccia specificato manualmente per l'indirizzo Unicast del dominio Thread.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Restituisce i contatori IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Restituisce il file thQuerySequenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Visualizza la bagcatororGuardTime (in ore).
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Ottieni i dati di Thread Leader.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Restituisce un puntatore all'RLOC di Leader.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Procurati l'ID router di Leader.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Ottieni il peso del leader.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Restituisce l'indirizzo multicast di Thread Link-Local All Thread Nodes.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Restituisce l'indirizzo IPv6 locale rispetto al collegamento di Thread.
otThreadGetLinkMode(otInstance *aInstance)
Ottieni la configurazione della modalità di collegamento MLE.
otThreadGetMaxTimeInQueue(otInstance *aInstance)
uint32_t
Restituisce il tempo massimo in coda per i messaggi nella coda TX.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Ottiene l'indirizzo EID locale della rete mesh.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Restituisce un puntatore al prefisso locale mesh.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Restituisce i contatori MLE di Thread.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Ottieni la chiave di rete Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Ottieni otNetworkKeyRef per la chiave di rete Thread.
otThreadGetNetworkName(otInstance *aInstance)
const char *
Ottieni il nome di rete Thread.
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Visualizza il TLV di diagnostica di rete successivo nel messaggio.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Riceve le informazioni sul prossimo vicino.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
La funzione recupera l'RSSI medio per l'elemento padre del thread.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
La funzione recupera le informazioni diagnostiche relative a un router Thread come padre.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
La funzione recupera l'RSSI dell'ultimo pacchetto dall'elemento padre del thread.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Recupera l'ID partizione.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Restituisce l'indirizzo multicast di Thread Realm-Local All Thread Nodes.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Recupera l'indirizzo RLOC (Thread Routing Locator).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Scarica RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Recupera l'ALOC del servizio per l'ID servizio specificato.
otThreadGetTimeInQueueHistogram(otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval)
const uint32_t *
Visualizza l'istogramma del tempo nella coda per i messaggi nella coda di trasmissione.
otThreadGetVendorModel(otInstance *aInstance)
const char *
Recupera la stringa del modello del fornitore.
otThreadGetVendorName(otInstance *aInstance)
const char *
Recupera la stringa del nome del fornitore.
otThreadGetVendorSwVersion(otInstance *aInstance)
const char *
Ottieni la stringa della versione software del fornitore.
otThreadGetVersion(void)
uint16_t
Restituisce la versione del protocollo Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Indica se è attualmente in corso una richiesta di localizzazione anycast.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
Determina se è attualmente in corso un rilevamento dei thread MLE.
otThreadIsSingleton(otInstance *aInstance)
bool
Indica se un nodo è l'unico router della rete.
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Richiede di individuare la destinazione più vicina di un determinato indirizzo anycast.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Registra un callback per ricevere i dati della risposta dei genitori MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Reimposta i contatori IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Reimposta i contatori MLE di Thread.
otThreadResetTimeInQueueStat(otInstance *aInstance)
void
Reimposta le statistiche del tempo nella coda della coda TX.
otThreadSearchForBetterParent(otInstance *aInstance)
Avvia il processo per il figlio di cercare un elemento padre migliore mantenendo l'attuale elemento padre.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Invia un messaggio di notifica proattiva indirizzo (ADDR_NTF.ntf).
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Invia una richiesta Get diagnostica di rete.
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
Invia una richiesta di reimpostazione diagnostica di rete.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Invia un messaggio Proactive Backbone Notification (PRO_BB.ntf) sul link Backbone.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Imposta il timeout dell'asset secondario del thread (in secondi) utilizzato quando operi nel ruolo dell'account secondario.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Imposta un callback per ricevere i dati di MLE Discovery Request.
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
Imposta il nome di dominio del thread.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
Avvia l'operazione del protocollo Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Imposta l'ID PAN esteso IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Consente di impostare o cancellare l'identificatore di interfaccia specificato manualmente per l'indirizzo Unicast del dominio Thread.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Imposta un annuncio relativo al joiner Thread quando viene rilevata la rete Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Consente di impostare il valore thQuerySequenceCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Consente di impostare il valore della sessione QueryGuardTime (in ore).
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Imposta la configurazione della modalità di collegamento MLE.
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Consente di impostare il prefisso locale della rete mesh.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
Imposta la chiave di rete 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.
otThreadSetVendorModel(otInstance *aInstance, const char *aVendorModel)
Imposta la stringa del modello del fornitore.
otThreadSetVendorName(otInstance *aInstance, const char *aVendorName)
Imposta la stringa del nome del fornitore.
otThreadSetVendorSwVersion(otInstance *aInstance, const char *aVendorSwVersion)
Imposta la stringa della versione del software del fornitore.

Strutture

otBorderRouterConfig

Rappresenta la configurazione di un router di confine.

otExternalRouteConfig

Rappresenta una configurazione di route esterna.

otIpCounters

Rappresenta i contatori a livello di IP.

otLeaderData

Rappresenta i dati dei thread leader.

otLinkModeConfig

Rappresenta una configurazione della modalità di collegamento MLE.

otLowpanContextInfo

Rappresenta le informazioni sull'ID contesto 6LoWPAN associate a un prefisso nei dati di rete.

otMleCounters

Rappresenta i contatori MLE di Thread.

otNeighborInfo

Contiene le informazioni diagnostiche relative a un nodo Thread nelle vicinanze.

otNetworkDiagChildEntry

Rappresenta una voce della tabella secondaria diagnostica di rete.

otNetworkDiagConnectivity

Rappresenta un valore di connettività diagnostica di rete.

otNetworkDiagMacCounters

Rappresenta un valore dei contatori MAC di diagnostica di rete.

otNetworkDiagMleCounters

Rappresenta un valore dei contatori MLE di diagnostica di rete.

otNetworkDiagRoute

Rappresenta il valore TLV di una route diagnostica di rete.

otNetworkDiagRouteData

Rappresenta i dati di una route diagnostica di rete.

otNetworkDiagTlv

Rappresenta un TLV di diagnostica di rete.

otRouterInfo

Contiene le informazioni diagnostiche relative a un router Thread.

otServerConfig

Rappresenta una configurazione del server.

otServiceConfig

Rappresenta la configurazione di un servizio.

otThreadDiscoveryRequestInfo

Rappresenta i dati della richiesta di rilevamento Thread.

otThreadParentResponseInfo

Rappresenta i dati della risposta dei genitori MLE.

Enumerazioni

enum anonimo

 anonymous enum
Proprietà
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER

Rispondi a TLV.

OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Livello batteria TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV delle pagine dei canali.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD

TLV secondario.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST

Elenco indirizzi IPv6 figlio TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

Tabella figlio TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

Connettività TLV.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV per indirizzo esteso MAC.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV dell'elenco di indirizzi IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV dei dati leader.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

Contatori MAC TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

Timeout bambino massimo TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS

Contatori MLE TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Modalità TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV dei dati di rete.

OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID

ID query TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

TLV Route64.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR

TLV vicino router.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Indirizzo 16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Tensione di alimentazione TLV.

OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION

Versione Thread Stack TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

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

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Elenco tipi TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL

Modello TLV del fornitore.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME

Nome fornitore TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION

Versione software del fornitore TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VERSION

Versione TLV.

otDeviceRole

 otDeviceRole

Rappresenta un ruolo del dispositivo Thread.

Proprietà
OT_DEVICE_ROLE_CHILD

Il ruolo dell'elemento secondario Thread.

OT_DEVICE_ROLE_DETACHED

Attualmente non partecipa a una rete/partizione Thread.

OT_DEVICE_ROLE_DISABLED

Lo stack Thread è disattivato.

OT_DEVICE_ROLE_LEADER

Il ruolo di leader del thread.

OT_DEVICE_ROLE_ROUTER

Il ruolo Router Thread.

otNetDataPublisherEvent

 otNetDataPublisherEvent

Rappresenta gli eventi segnalati dai callback del publisher.

Proprietà
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

La voce pubblicata viene aggiunta ai dati di rete Thread.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

La voce pubblicata viene rimossa dai dati di rete Thread.

otRoutePreference

 otRoutePreference

Definisce i valori validi per mPreference in otExternalRouteConfig e otBorderRouterConfig.

Proprietà
OT_ROUTE_PREFERENCE_HIGH

Preferenza percorso elevato.

OT_ROUTE_PREFERENCE_LOW

Preferenza di percorso bassa.

OT_ROUTE_PREFERENCE_MED

Preferenza percorso media.

Typedef

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Rappresenta la configurazione di un router di confine.

otDetachGracefullyCallback

void(* otDetachGracefullyCallback)(void *aContext)

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

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

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Rappresenta una configurazione di route esterna.

otIpCounters

struct otIpCounters otIpCounters

Rappresenta i contatori a livello di IP.

otLeaderData

struct otLeaderData otLeaderData

Rappresenta i dati dei thread leader.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Rappresenta una configurazione della modalità di collegamento MLE.

otLowpanContextInfo

struct otLowpanContextInfo otLowpanContextInfo

Rappresenta le informazioni sull'ID contesto 6LoWPAN associate a un prefisso nei dati di rete.

otMleCounters

struct otMleCounters otMleCounters

Rappresenta i contatori MLE di Thread.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Utilizzato per eseguire l'iterazione attraverso la tabella vicina.

otNetDataDnsSrpServicePublisherCallback

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

Il tipo di puntatore definisce il callback utilizzato per notificare quando una voce "Servizio DNS/SRP" viene aggiunta o rimossa dai dati di rete Thread.

Al momento della rimozione, il callback viene richiamato 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 della voce (ad es. una chiamata al numero otNetDataUnpublishDnsSrpService()).

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

otNetDataPrefixPublisherCallback

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

Il tipo di puntatore definisce il callback utilizzato per notificare quando una voce di prefisso (su mesh o route esterna) viene aggiunta o rimossa dai dati di rete Thread.

Al momento della rimozione, il callback viene richiamato 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 della voce.

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

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Rappresenta gli eventi segnalati dai callback del publisher.

otNetworkDataIterator

uint32_t otNetworkDataIterator

Utilizzato per eseguire l'iterazione tramite le informazioni relative ai dati di rete.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Rappresenta una voce della tabella secondaria diagnostica di rete.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Rappresenta un valore di connettività diagnostica di rete.

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

Utilizzato per eseguire l'iterazione tramite il TLV di diagnostica di rete.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Rappresenta un valore dei contatori MAC di diagnostica di rete.

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

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

Rappresenta un valore dei contatori MLE di diagnostica di rete.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Rappresenta il valore TLV di una route diagnostica di rete.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Rappresenta i dati di una route diagnostica di rete.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Rappresenta un TLV di diagnostica di rete.

otReceiveDiagnosticGetCallback

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

Il puntatore viene richiamato quando viene ricevuta la risposta del test di diagnostica di rete.

Dettagli
Parametri
[in] aError
L'errore quando non è stato possibile ottenere la risposta.
[in] aMessage
Un puntatore al buffer dei messaggi contenente il payload della risposta Recupera diagnostica di rete ricevuto. Disponibile solo quando il valore di aError è OT_ERROR_NONE.
[in] aMessageInfo
Un puntatore alle informazioni del messaggio per aMessage. Disponibile solo quando il valore di aError è OT_ERROR_NONE.
[in] aContext
Un puntatore al contesto specifico dell'applicazione.

otRoutePreference

enum otRoutePreference otRoutePreference

Definisce i valori validi per mPreference in otExternalRouteConfig e otBorderRouterConfig.

otServerConfig

struct otServerConfig otServerConfig

Rappresenta una configurazione del server.

otServiceConfig

struct otServiceConfig otServiceConfig

Rappresenta la configurazione di un servizio.

otThreadAnycastLocatorCallback

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

Il tipo di puntatore definisce il callback per notificare il risultato di una richiesta otThreadLocateAnycastDestination().

Dettagli
Parametri
[in] aContext
Un puntatore a un contesto arbitrario (fornito quando viene registrato il callback).
[in] aError
L'errore durante la gestione della richiesta. OT_ERROR_NONE indica l'esito positivo. OT_ERROR_ANSWER_TIMEOUT indica che non è stato possibile trovare una destinazione. OT_ERROR_ABORT indica che la richiesta è stata interrotta.
[in] aMeshLocalAddress
Un puntatore all'EID locale del mesh della destinazione più vicina dell'indirizzo anycast quando aError è OT_ERROR_NONE, altrimenti NULL.
[in] aRloc16
L'RLOC16 della destinazione, se trovato, altrimenti non valido (0xfffe).

otThreadDiscoveryRequestCallback

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

Il puntatore viene chiamato ogni volta che viene ricevuto un messaggio di richiesta di rilevamento della MLE.

Dettagli
Parametri
[in] aInfo
Un puntatore ai dati di informazioni sulle richieste discovery.
[in] aContext
Un puntatore al contesto specifico dell'applicazione di callback.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Rappresenta i dati della richiesta di rilevamento Thread.

otThreadParentResponseCallback

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

Il puntatore viene chiamato ogni volta che viene ricevuto un messaggio di risposta dei genitori MLE.

Questo valore è utilizzato in otThreadRegisterParentResponseCallback().

Dettagli
Parametri
[in] aInfo
Un puntatore a una posizione sulla pila contenente i dati statistici.
[in] aContext
Un puntatore al contesto di callback specifico del client.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Rappresenta i dati della risposta dei genitori MLE.

Funzioni

otConvertDurationInSecondsToString

void otConvertDurationInSecondsToString(
  uint32_t aDuration,
  char *aBuffer,
  uint16_t aSize
)

Converte una durata uint32_t (in secondi) in una stringa leggibile.

Richiede l'attivazione di OPENTHREAD_CONFIG_UPTIME_ENABLE.

La stringa segue il formato "::" per ore, minuti, secondi (se la durata è inferiore a un giorno) oppure "

d.::" (se più lungo di un giorno).

Se la stringa risultante non rientra in aBuffer (all'interno dei suoi aSize caratteri), la stringa viene troncata, ma la stringa restituita è sempre con terminazione null.

È destinato all'uso con mAge o mConnectionTime nelle strutture otNeighborInfo o otChildInfo.

Dettagli
Parametri
[in] aDuration
Un intervallo di durata in secondi.
[out] aBuffer
Un puntatore a un array di caratteri per generare la stringa.
[in] aSize
La dimensione di aBuffer (in byte). Si consiglia di utilizzare OT_DURATION_STRING_SIZE.

otNetDataContainsOmrPrefix

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

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

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aPrefix
Un puntatore al prefisso IPv6.
Restituisce
Indica se aPrefix è un prefisso OMR valido e i dati di rete del leader contengono il prefisso OMR aPrefix.

otNetDataGet

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

Fornisci una copia completa o stabile dei dati di rete Thread della partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aStable
TRUE quando si copia la versione stabile, FALSE quando si copia la versione completa.
[out] aData
Un puntatore al buffer dei dati.
[in,out] aDataLength
Al momento dell'immissione, la dimensione del buffer di dati a cui punta aData. All'uscita, il numero di byte copiati.
Valori restituiti
OT_ERROR_NONE
I dati di rete Thread sono stati copiati in aData e aggiornati aDataLength.
OT_ERROR_NO_BUFS
Spazio in aData insufficiente per copiare completamente i dati di rete Thread.

otNetDataGetCommissioningDataset

void otNetDataGetCommissioningDataset(
  otInstance *aInstance,
  otCommissioningDataset *aDataset
)

Recupera il set di dati per la messa in servizio dai dati di rete della partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore all'istanza OpenThread.
[out] aDataset
Un puntatore a un otCommissioningDataset da compilare.

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

Ottieni la lunghezza attuale (numero di byte) dei dati di rete Thread della partizione.

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

otNetDataGetMaxLength

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

Ottieni la lunghezza massima osservata dei dati di rete Thread dall'inizializzazione dello stack OT o dall'ultima chiamata a otNetDataResetMaxLength().

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
La lunghezza massima dei dati di rete (contrazione elevata per la lunghezza dei dati di rete).

otNetDataGetNextLowpanContextInfo

otError otNetDataGetNextLowpanContextInfo(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otLowpanContextInfo *aContextInfo
)

Ottieni le successive informazioni sull'ID contesto 6LoWPAN nei dati di rete della partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in,out] aIterator
Un puntatore all'iteratore dei dati di rete. Per ottenere la prima voce di servizio, questo deve essere impostato su OT_NETWORK_DATA_ITERATOR_INIT.
[out] aContextInfo
Un puntatore al punto in cui verranno inserite le informazioni sull'ID contesto 6LoWPAN recuperate.
Valori restituiti
OT_ERROR_NONE
Sono state trovate le prossime informazioni sull'ID contesto 6LoWPAN.
OT_ERROR_NOT_FOUND
Non esistono informazioni sul contesto 6LoWPAN successivi nei dati di rete della partizione.

otNetDataGetNextOnMeshPrefix

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

Ottieni il successivo prefisso sulla rete mesh nei dati di rete della partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in,out] aIterator
Un puntatore al contesto dell'iteratore dei dati di rete. Per ottenere la prima voce on-mesh, questo deve essere impostato su OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntatore del punto in cui verranno inserite le informazioni sul prefisso mesh.
Valori restituiti
OT_ERROR_NONE
È stato trovato il successivo prefisso On Mesh.
OT_ERROR_NOT_FOUND
Non esiste alcun prefisso On Mesh successivo nei dati di rete Thread.

otNetDataGetNextRoute

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

Trova la route esterna successiva nei dati di rete della partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in,out] aIterator
Un puntatore al contesto dell'iteratore dei dati di rete. Per ottenere la prima voce di route esterna, questo deve essere impostato su OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntatore al punto in cui verranno inserite le informazioni sul percorso esterno.
Valori restituiti
OT_ERROR_NONE
Trovata la prossima route esterna.
OT_ERROR_NOT_FOUND
Non esiste alcuna voce di route esterna successiva nei dati di rete Thread.

otNetDataGetNextService

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

Ottieni il servizio successivo nei dati di rete della partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in,out] aIterator
Un puntatore al contesto dell'iteratore dei dati di rete. Per ottenere la prima voce di servizio, questo deve essere impostato su OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntatore al punto in cui verranno inserite le informazioni sul servizio.
Valori restituiti
OT_ERROR_NONE
Servizio successivo trovato.
OT_ERROR_NOT_FOUND
Non esiste alcun servizio successivo nei dati di rete della partizione.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Recuperare la versione stabile dei dati di rete.

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

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Recupera la versione dei dati di rete.

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

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Indica se attualmente la voce "Servizio DNS/SRP" viene aggiunta o meno ai dati di rete Thread.

Richiede l'attivazione della funzionalità OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Valori restituiti
TRUE
La voce del servizio DNS/SRP pubblicata viene aggiunta ai dati di rete Thread.
FALSE
La voce non è stata aggiunta ai dati di rete Thread o non esistono voci da pubblicare.

otNetDataIsPrefixAdded

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

Indica se una voce di prefisso pubblicata attualmente (on-mesh o route esterna) viene aggiunta o meno ai dati di rete Thread.

Richiede l'attivazione della funzionalità OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aPrefix
Un puntatore al prefisso (NON DEVE essere NULL).
Valori restituiti
TRUE
La voce del prefisso pubblicato viene aggiunta ai dati di rete Thread.
FALSE
La voce non è stata aggiunta ai dati di rete Thread o non esistono voci da pubblicare.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Richiedi la pubblicazione dell'indirizzo "DNS/SRP Service Anycast Address" nei dati di rete Thread.

Richiede l'attivazione della funzionalità OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

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

otNetDataPublishDnsSrpServiceUnicast

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

Richiedi la pubblicazione di "Indirizzo Unicast del servizio DNS/SRP" nei dati di rete Thread.

Richiede l'attivazione della funzionalità OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

Pubblica l'"Indirizzo Unicast del servizio DNS/SRP" includendo le informazioni sull'indirizzo e sulla porta nei dati TLV del servizio.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza 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
)

Richiedi la pubblicazione di "Indirizzo Unicast del servizio DNS/SRP" nei dati di rete Thread.

Richiede l'attivazione della funzionalità OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

A differenza di otNetDataPublishDnsSrpServiceUnicast(), che richiede che venga fornito l'indirizzo pubblicato e che include le informazioni nei dati TLV del servizio, questa funzione utilizza l'EID locale del mesh del dispositivo e include le informazioni nei dati TLV del server.

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

otNetDataPublishExternalRoute

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

Consente di pubblicare un prefisso di route esterna nei dati di rete Thread.

Richiede l'attivazione della funzionalità OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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

Una chiamata successiva a questo metodo sostituirà una richiesta precedente per lo stesso prefisso. In particolare, se la nuova chiamata cambia solo i flag (ad esempio, livello di preferenza) e il prefisso è già stato aggiunto nei dati di rete, la modifica dei flag si riflette immediatamente nei dati di rete. Ciò garantisce che le voci esistenti nei dati di rete non vengano rimosse bruscamente. Tieni presente che una modifica del livello di preferenza può potenzialmente causare in un secondo momento la rimozione della voce dai dati di rete dopo aver determinato che sono presenti altri nodi che pubblicano lo stesso prefisso con la stessa preferenza o una preferenza superiore.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aConfig
La configurazione della route esterna da pubblicare (NON DEVE essere NULL).
Valori restituiti
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 assegnare una voce per la nuova richiesta. Il publisher supporta un numero limitato di voci (condivise tra prefisso on-mesh e route esterna) determinato dalla configurazione OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataPublishOnMeshPrefix

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

Consente di pubblicare un prefisso on-mesh nei dati di rete Thread.

Richiede l'attivazione della funzionalità OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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

Una chiamata successiva a questo metodo sostituirà una richiesta precedente per lo stesso prefisso. In particolare, se la nuova chiamata cambia solo i flag (ad esempio, livello di preferenza) e il prefisso è già stato aggiunto nei dati di rete, la modifica dei flag si riflette immediatamente nei dati di rete. Ciò garantisce che le voci esistenti nei dati di rete non vengano rimosse bruscamente. Tieni presente che una modifica del livello di preferenza può potenzialmente causare in un secondo momento la rimozione della voce dai dati di rete dopo aver determinato che sono presenti altri nodi che pubblicano lo stesso prefisso con la stessa preferenza o una preferenza superiore.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aConfig
La configurazione del prefisso on-mesh da pubblicare (NON DEVE essere NULL).
Valori restituiti
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 assegnare una voce per la nuova richiesta. Il publisher supporta un numero limitato di voci (condivise tra prefisso on-mesh e route esterna) determinato dalla configurazione OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataReplacePublishedExternalRoute

otError otNetDataReplacePublishedExternalRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix,
  const otExternalRouteConfig *aConfig
)

Sostituisce una route esterna pubblicata in precedenza nei dati di rete Thread.

Richiede l'attivazione della funzionalità OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Se non esiste una route esterna corrispondente a aPrefix pubblicata in precedenza, questa funzione si comporta in modo simile a otNetDataPublishExternalRoute(), ovvero avvierà il processo di pubblicazione di aConfig come route esterna nei dati di rete Thread.

Se è presente una voce di route pubblicata in precedenza corrispondente a aPrefix, verrà sostituita con il nuovo prefisso di aConfig.

  • Se aPrefix è già stato aggiunto nei dati di rete, la modifica del nuovo prefisso in aConfig viene immediatamente riflessa nei dati di rete. Ciò garantisce che le voci di route nei dati di rete non vengano rimosse bruscamente e che la transizione da aPrefisso al nuovo prefisso sia fluida.
  • Se il precedente aPrefix pubblicato non è stato aggiunto ai dati di rete, verrà sostituito con il nuovo prefisso aConfig, ma non verrà aggiunto immediatamente. Al contrario, inizierà il processo di pubblicazione nei dati di rete (monitorando i dati di rete per determinare se/se aggiungere il prefisso, a seconda del numero di prefissi simili presenti nei dati di rete).

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aPrefix
Il prefisso di route esterna pubblicato in precedenza da sostituire.
[in] aConfig
La configurazione della route esterna da pubblicare.
Valori restituiti
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 assegnare una voce per la nuova richiesta. Il publisher supporta un numero limitato di voci (condivise tra prefisso on-mesh e route esterna) determinato dalla configurazione OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

Reimposta la lunghezza massima rilevata dei dati di rete Thread.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Vedi anche:
otNetDataGetMaxLength

otNetDataSetDnsSrpServicePublisherCallback

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

Imposta un callback per notificare quando un "Servizio DNS/SRP" pubblicato viene effettivamente aggiunto o rimosso dai dati di rete Thread.

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

Richiede l'attivazione della funzionalità OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

otNetDataSetPrefixPublisherCallback

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

Imposta un callback per notificare quando una voce di prefisso pubblicata viene effettivamente aggiunta o rimossa dai dati di rete Thread.

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

Richiede l'attivazione della funzionalità OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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

otNetDataSteeringDataCheckJoiner

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

Controlla se i dati sullo sterzo includono un joiner.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aEui64
Un'indicazione dello standard IEEE EUI-64 del Joiner.
Valori restituiti
OT_ERROR_NONE
aEui64 è incluso nei dati sulle indicazioni.
OT_ERROR_INVALID_STATE
Nessun dato sullo sterzo presente.
OT_ERROR_NOT_FOUND
aEui64 non è incluso nei dati sulle indicazioni.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

Verifica se i dati sullo sterzo includono un joiner con un determinato valore di discerner.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aDiscerner
Un'indicazione per Joiner Discerner.
Valori restituiti
OT_ERROR_NONE
aDiscerner è incluso nei dati sulle indicazioni.
OT_ERROR_INVALID_STATE
Nessun dato sullo sterzo presente.
OT_ERROR_NOT_FOUND
aDiscerner non è incluso nei dati sulle indicazioni.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

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

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE deve essere abilitato.

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

otNetDataUnpublishPrefix

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

Annulla la pubblicazione di un prefisso di route on-mesh o esterno pubblicato in precedenza.

OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE deve essere abilitato.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aPrefix
Il prefisso per l'annullamento della pubblicazione (NON DEVE essere NULL).
Valori restituiti
OT_ERROR_NONE
La pubblicazione del prefisso è stata annullata correttamente.
OT_ERROR_NOT_FOUND
Impossibile trovare il prefisso nell'elenco pubblicato.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Prova a ricollegarlo come bambino.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Valori restituiti
OT_ERROR_NONE
Tentativo di diventare bambino iniziato correttamente.
OT_ERROR_INVALID_STATE
Il thread è disabilitato.

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Scollegati dalla rete Thread.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Valori restituiti
OT_ERROR_NONE
Disconnessione dalla rete Thread riuscita.
OT_ERROR_INVALID_STATE
Il thread è disabilitato.

otThreadDetachGracefully

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

Invia una notifica agli altri nodi nella rete (se presenti) e interrompe le operazioni del protocollo Thread.

Invia un rilascio di indirizzo se si tratta di un router o imposta il timeout dell'indirizzo su 0 se è un router.

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

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Converti il ruolo del dispositivo in 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
)

Avvia una scansione di Thread Discovery.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aScanChannels
Un vettore di bit che indica quali canali cercare (ad es. OT_CHANNEL_11_MASK).
[in] aPanId
Filtro ID PAN (impostato su PAN trasmissione per disattivare il filtro).
[in] aJoiner
Valore del flag Joiner nel TLV della richiesta di rilevamento.
[in] aEnableEui64Filtering
TRUE per filtrare le risposte su EUI-64, altrimenti FALSE.
[in] aCallback
Un puntatore a una funzione chiamata alla ricezione di una risposta di rilevamento MLE o di una scansione viene completato.
[in] aCallbackContext
Un puntatore al contesto specifico dell'applicazione.
Valori restituiti
OT_ERROR_NONE
Analisi di rilevamento Thread avviata.
OT_ERROR_INVALID_STATE
L'interfaccia IPv6 non è abilitata (netif non è attiva).
OT_ERROR_NO_BUFS
Impossibile allocare il messaggio per la richiesta di rilevamento.
OT_ERROR_BUSY
La scansione di rilevamento dei thread è già in corso.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Restituisce il timeout dell'asset secondario thread (in secondi) utilizzato durante l'uso del ruolo secondario.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Il valore Thread Child Timeout in secondi.
Vedi anche:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Ottieni il ruolo del dispositivo.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Valori restituiti
OT_DEVICE_ROLE_DISABLED
Lo stack Thread è disattivato.
OT_DEVICE_ROLE_DETACHED
Al momento il dispositivo non fa parte di una partizione/rete Thread.
OT_DEVICE_ROLE_CHILD
Al momento il dispositivo funziona come dispositivo secondario Thread.
OT_DEVICE_ROLE_ROUTER
Al momento il dispositivo funziona come router Thread.
OT_DEVICE_ROLE_LEADER
Al momento il dispositivo funziona come Thread Leader.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Restituisce il nome di dominio Thread.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Un puntatore al nome di dominio 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 a un'istanza OpenThread.
Restituisce
Un puntatore all'ID PAN esteso IEEE 802.15.4.
Vedi anche:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Restituisce l'identificatore di interfaccia specificato manualmente per l'indirizzo Unicast del dominio Thread.

Disponibile quando OPENTHREAD_CONFIG_DUA_ENABLE è abilitato.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Un puntatore all'identificatore interfaccia impostato manualmente oppure NULL se non è stato impostato alcun identificatore.
Vedi anche:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Restituisce i contatori IPv6.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Un puntatore ai contatori IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Restituisce il file thQuerySequenceCounter.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Il valore thglossarySequenceCounter.
Vedi anche:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Visualizza la bagcatororGuardTime (in ore).

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

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Ottieni i dati di Thread Leader.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aLeaderData
Un puntatore al punto in cui sono posizionati i dati sulla variante leader.
Valori restituiti
OT_ERROR_NONE
Dati leader recuperati correttamente.
OT_ERROR_DETACHED
Attualmente non collegato.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Restituisce un puntatore all'RLOC di Leader.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aLeaderRloc
Un puntatore all'RLOC del leader.
Valori restituiti
OT_ERROR_NONE
L'RLOC del leader è stato scritto correttamente in aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc era NULL.
OT_ERROR_DETACHED
Attualmente non collegato a una partizione Thread.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Procurati l'ID router di Leader.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
L'ID router del leader.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Ottieni il peso del leader.

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

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Restituisce l'indirizzo multicast di Thread Link-Local All Thread Nodes.

L'indirizzo è un link-local Unicast prefisso-Based Multicast Indirizzo [RFC 3306], con:

  • flgs impostato su 3 (P = 1 e T = 1)
  • scop 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 a un'istanza OpenThread.
Restituisce
Un puntatore all'indirizzo multicast Link-Locale Thread per tutti i nodi Thread.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Restituisce l'indirizzo IPv6 locale rispetto al collegamento di Thread.

L'indirizzo locale del link Thread viene derivato utilizzando l'indirizzo esteso IEEE802.15.4 come identificatore di interfaccia.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Un puntatore all'indirizzo IPv6 locale rispetto al collegamento di Thread.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Ottieni la configurazione della modalità di collegamento MLE.

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

otThreadGetMaxTimeInQueue

uint32_t otThreadGetMaxTimeInQueue(
  otInstance *aInstance
)

Restituisce il tempo massimo in coda per i messaggi nella coda TX.

Richiede OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

Il tempo nella coda viene tracciato solo per le trasmissioni dirette e viene misurato come il tempo che intercorre tra il momento in cui un messaggio viene aggiunto alla coda di trasmissione fino a quando non viene passato al livello MAC per la trasmissione o viene ignorato.

Le statistiche raccolte possono essere reimpostate chiamando otThreadResetTimeInQueueStat().

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Il tempo di coda massimo in millisecondi per tutti i messaggi nella coda TX (fino ad ora).

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Ottiene l'indirizzo EID locale della rete mesh.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Un puntatore all'indirizzo EID locale mesh.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Restituisce un puntatore al prefisso locale mesh.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Un puntatore al prefisso locale mesh.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Restituisce i contatori MLE di Thread.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Un puntatore ai contatori MLE di Thread.

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Ottieni la chiave di rete Thread.

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

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Ottieni otNetworkKeyRef per la chiave di rete Thread.

Richiede l'abilitazione della funzionalità in fase di build OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

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

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Ottieni il nome di rete Thread.

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

otThreadGetNextDiagnosticTlv

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

Visualizza il TLV di diagnostica di rete successivo nel messaggio.

Richiede OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

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

Dettagli
Parametri
[in] aMessage
Un puntatore a un messaggio.
[in,out] aIterator
Un puntatore al contesto dell'iteratore di diagnostica di rete. Per ottenere il primo TLV di diagnostica di rete, deve essere impostato su OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Un puntatore al punto in cui verranno inserite le informazioni TLV di diagnostica di rete.
Valori restituiti
OT_ERROR_NONE
Trovato il prossimo TLV di diagnostica di rete.
OT_ERROR_NOT_FOUND
Nel messaggio non sono presenti altri TLV di diagnostica di rete.
OT_ERROR_PARSE
Analisi della diagnostica di rete successiva non riuscita.

otThreadGetNextNeighborInfo

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

Riceve le informazioni sul prossimo vicino.

Viene utilizzato per scorrere le voci della tabella dei vicini.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in,out] aIterator
Un puntatore al contesto dell'iteratore. Per ottenere la prima voce del vicino, il valore deve essere impostato su OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Un puntatore alle informazioni relative ai vicini.
Valori restituiti
OT_ERROR_NONE
È stata trovata la voce vicina successiva nella tabella.
OT_ERROR_NOT_FOUND
Nella tabella non sono presenti voci vicine successive.
OT_ERROR_INVALID_ARGS
aIterator o aInfo era NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

La funzione recupera l'RSSI medio per l'elemento padre del thread.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aParentRssi
Un puntatore al punto in cui deve essere posizionato l'RSSI principale.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

La funzione recupera le informazioni diagnostiche relative a un router Thread come padre.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aParentInfo
Un puntatore al punto in cui sono inserite le informazioni del router principale.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

La funzione recupera l'RSSI dell'ultimo pacchetto dall'elemento padre del thread.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aLastRssi
Un puntatore al punto in cui deve essere posizionato l'ultimo RSSI.
Valori restituiti
OT_ERROR_NONE
Dati RSSI recuperati.
OT_ERROR_FAILED
Impossibile recuperare i dati RSSI.
OT_ERROR_INVALID_ARGS
aLastRssi è NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Recupera l'ID partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
L'ID partizione.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Restituisce l'indirizzo multicast di Thread Realm-Local All Thread Nodes.

L'indirizzo è un realm-local Unicast Prefisso-Based Multicast Indirizzo [RFC 3306], con:

  • flgs impostato su 3 (P = 1 e T = 1)
  • scop 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 a un'istanza OpenThread.
Restituisce
Un puntatore all'indirizzo multicast Thread Realm-Local All Thread Nodes.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Recupera l'indirizzo RLOC (Thread Routing Locator).

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

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Scarica RLOC16.

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

otThreadGetServiceAloc

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

Recupera l'ALOC del servizio per l'ID servizio specificato.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aServiceId
ID servizio per cui ottenere ALOC.
[out] aServiceAloc
Un puntatore per l'output del servizio ALOC. NON DEVE ESSERE NULLO.
Valori restituiti
OT_ERROR_NONE
L'ALOC del servizio è stato recuperato.
OT_ERROR_DETACHED
L'interfaccia Thread non è attualmente collegata a una partizione Thread.

otThreadGetTimeInQueueHistogram

const uint32_t * otThreadGetTimeInQueueHistogram(
  otInstance *aInstance,
  uint16_t *aNumBins,
  uint32_t *aBinInterval
)

Visualizza l'istogramma del tempo nella coda per i messaggi nella coda di trasmissione.

Richiede OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

Viene raccolto l'istogramma del tempo nella coda dei messaggi nella coda di trasmissione. Il tempo nella coda viene tracciato solo per le trasmissioni dirette e viene misurato come il tempo che intercorre tra il momento in cui un messaggio viene aggiunto alla coda di trasmissione fino a quando non viene passato al livello MAC per la trasmissione o viene ignorato.

L'istogramma viene restituito sotto forma di array di valori uint32_t con voci aNumBins. La prima voce nell'array (con indice 0) rappresenta il numero di messaggi con un tempo nella coda inferiore a aBinInterval. La seconda voce rappresenta il numero di messaggi con un tempo nella coda maggiore o uguale a aBinInterval, ma inferiore a 2 * aBinInterval. e così via. L'ultima voce rappresenta il numero di messaggi con tempo nella coda maggiore o uguale a (aNumBins - 1) * aBinInterval.

Le statistiche raccolte possono essere reimpostate chiamando otThreadResetTimeInQueueStat(). Le informazioni sull'istogramma vengono raccolte dopo l'inizializzazione dell'istanza OpenThread o dall'ultima volta in cui la raccolta delle statistiche è stata reimpostata chiamando il otThreadResetTimeInQueueStat().

I puntatori aNumBins e aBinInterval NON DEVONO essere NULL.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aNumBins
Puntatore per restituire il numero di bin nell'istogramma (lunghezza dell'array).
[out] aBinInterval
Puntatore per restituire la durata dell'intervallo del bin dell'istogramma in millisecondi.
Restituisce
Un puntatore a un array di voci aNumBins che rappresentano le informazioni sull'istogramma raccolte.

otThreadGetVendorModel

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

Recupera la stringa del modello del fornitore.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
La stringa del modello del fornitore.

otThreadGetVendorName

const char * otThreadGetVendorName(
  otInstance *aInstance
)

Recupera la stringa del nome del fornitore.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
La stringa del nome del fornitore.

otThreadGetVendorSwVersion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

Ottieni la stringa della versione software del fornitore.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
La stringa della versione sw del fornitore.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Restituisce la versione del protocollo Thread.

Dettagli
Restituisce
la versione del protocollo Thread.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Indica se è attualmente in corso una richiesta di localizzazione anycast.

È disponibile solo quando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE è abilitato.

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

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Determina se è attualmente in corso un rilevamento dei thread MLE.

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

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

Indica se un nodo è l'unico router della rete.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Valori restituiti
TRUE
È l'unico router della rete.
FALSE
È un router secondario o non è un singolo router della rete.

otThreadLocateAnycastDestination

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

Richiede di individuare la destinazione più vicina di un determinato indirizzo anycast.

È 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 a un'istanza 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 restituiti
OT_ERROR_NONE
La richiesta è stata avviata. aCallback verrà richiamato 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
)

Registra un callback per ricevere i dati della risposta dei genitori MLE.

Richiede OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aCallback
Un puntatore a una funzione che viene richiamata alla ricezione di un messaggio di risposta del genitore MLE.
[in] aContext
Un puntatore al contesto di callback specifico del client.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Reimposta i contatori IPv6.

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

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Reimposta i contatori MLE di Thread.

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

otThreadResetTimeInQueueStat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

Reimposta le statistiche del tempo nella coda della coda TX.

Richiede OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

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

otThreadSearchForBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

Avvia il processo per il figlio di cercare un elemento padre migliore mantenendo l'attuale elemento padre.

Deve essere utilizzata quando il dispositivo è collegato come bambino.

Dettagli
Valori restituiti
OT_ERROR_NONE
La procedura per cercare un genitore migliore è stata avviata.
OT_ERROR_INVALID_STATE
Il ruolo del dispositivo non è secondario.

otThreadSendAddressNotification

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

Invia un messaggio di notifica proattiva indirizzo (ADDR_NTF.ntf).

È disponibile solo quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE è abilitato.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aDestination
La destinazione da cui inviare il messaggio ADDR_NTF.ntf.
[in] aTarget
L'indirizzo di destinazione 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 Get diagnostica di rete.

Richiede OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aDestination
Un puntatore all'indirizzo di destinazione.
[in] aTlvTypes
Un array di tipi di TLV di diagnostica di rete.
[in] aCount
Numero di tipi in aTlvTypes.
[in] aCallback
Un puntatore a una funzione che viene richiamata quando viene ricevuta la risposta Diagnostica di rete oppure NULL per disattivare il callback.
[in] aCallbackContext
Un puntatore al contesto specifico dell'applicazione.
Valori restituiti
OT_ERROR_NONE
Il file DIAG_GET.req è stato messo in coda.
OT_ERROR_NO_BUFS
Buffer dei messaggi disponibili insufficienti per inviare DIAG_GET.req.

otThreadSendDiagnosticReset

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

Invia una richiesta di reimpostazione diagnostica di rete.

Richiede OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aDestination
Un puntatore all'indirizzo di destinazione.
[in] aTlvTypes
Un array di tipi di TLV di diagnostica di rete. Attualmente è consentito solo il tipo 9.
[in] aCount
Numero di tipi in aTlvTypes
Valori restituiti
OT_ERROR_NONE
DIAG_RST.ntf messo in coda.
OT_ERROR_NO_BUFS
Buffer dei messaggi disponibili insufficienti per inviare DIAG_RST.ntf.

otThreadSendProactiveBackboneNotification

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

Invia un messaggio Proactive Backbone Notification (PRO_BB.ntf) sul link Backbone.

È disponibile solo quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE è abilitato.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aTarget
L'indirizzo di destinazione del messaggio PRO_BB.ntf.
[in] aMlIid
L'ML-IID del messaggio PRO_BB.ntf.
[in] aTimeSinceLastTransaction
Tempo trascorso dall'ultima transazione (in secondi).
Valori restituiti
OT_ERROR_NONE
Invio di PRO_BB.ntf sul link backbone riuscito.
OT_ERROR_NO_BUFS
Se i buffer dei messaggi disponibili non sono sufficienti.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Imposta il timeout dell'asset secondario del thread (in secondi) utilizzato quando operi nel ruolo dell'account secondario.

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

otThreadSetDiscoveryRequestCallback

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

Imposta un callback per ricevere i dati di MLE Discovery Request.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aCallback
Un puntatore a una funzione che viene richiamata alla ricezione di un messaggio di richiesta di rilevamento MLE.
[in] aContext
Un puntatore al contesto specifico dell'applicazione di callback.

otThreadSetDomainName

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

Imposta il nome di dominio del thread.

Ha esito positivo solo quando i protocolli Thread sono disabilitati.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aDomainName
Un puntatore al nome di dominio Thread.
Valori restituiti
OT_ERROR_NONE
Nome di dominio Thread impostato.
OT_ERROR_INVALID_STATE
I protocolli Thread sono abilitati.
Vedi anche:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Avvia l'operazione del protocollo Thread.

L'interfaccia deve essere attiva quando chiami questa funzione.

Se chiami questa funzione con aEnabled impostato su FALSE, tutti i processi in corso di scollegamento iniziati da otThreadDetachGracefully() verranno chiamati.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aEnabled
TRUE se Thread è abilitato, FALSE in caso contrario.
Valori restituiti
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.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aExtendedPanId
Un puntatore all'ID PAN esteso IEEE 802.15.4.
Valori restituiti
OT_ERROR_NONE
ID PAN esteso impostato.
OT_ERROR_INVALID_STATE
I protocolli Thread sono abilitati.
Vedi anche:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

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

Consente di impostare o cancellare l'identificatore di interfaccia specificato manualmente per l'indirizzo Unicast del dominio Thread.

Disponibile quando OPENTHREAD_CONFIG_DUA_ENABLE è abilitato.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aIid
Un puntatore all'identificatore interfaccia da impostare o NULL per cancellare.
Valori restituiti
OT_ERROR_NONE
L'identificatore interfaccia è stato impostato/cancellato correttamente.
OT_ERROR_INVALID_ARGS
L'identificatore interfaccia specificato è riservato.
Vedi anche:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

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

Imposta un annuncio relativo al joiner Thread quando viene rilevata la rete Thread.

La pubblicità per la fusione con Thread viene utilizzata per consentire a un Joiner di pubblicizzare le proprie informazioni specifiche per la propria applicazione (ad esempio ID fornitore, ID prodotto, discriminatore e così via) tramite una nuova proposta di TLV per la pubblicità per il joiner e per rendere queste informazioni disponibili ai Commissari o candidati senza intervento umano.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aOui
Il valore OUI IEEE del fornitore che verrà incluso nella pubblicità del joiner. Verranno utilizzati solo i 3 byte meno significativi, mentre quello più significativo verrà ignorato.
[in] aAdvData
Un puntatore all'oggetto AdvData che verrà incluso nell'annuncio del joiner.
[in] aAdvDataLength
La lunghezza di AdvData in byte.
Valori restituiti
OT_ERROR_NONE
Annuncio del joiner impostato.
OT_ERROR_INVALID_ARGS
AdvData non valido.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Consente di impostare il valore thQuerySequenceCounter.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aKeySequenceCounter
Il valore thglossarySequenceCounter.
Vedi anche:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Consente di impostare il valore della sessione QueryGuardTime (in ore).

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aKeySwitchGuardTime
Il valore thGCPSwitchGuardTime (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 a un'istanza OpenThread.
[in] aConfig
Un puntatore alla configurazione della Modalità di collegamento.
Valori restituiti
OT_ERROR_NONE
La configurazione della modalità di collegamento MLE è stata impostata.
Vedi anche:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

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

Consente di impostare il prefisso locale della rete mesh.

Ha successo solo quando i protocolli Thread sono disabilitati. Una chiamata riuscita a questa funzione rende non validi i set di dati operativi attivi e in attesa nella memoria non volatile.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aMeshLocalPrefix
Un puntatore al prefisso locale mesh.
Valori restituiti
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 Thread.

Ha successo solo quando i protocolli Thread sono disabilitati. Una chiamata riuscita a questa funzione rende non validi i set di dati operativi attivi e in attesa nella memoria non volatile.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aKey
Un puntatore a un buffer contenente la chiave di rete Thread.
Valori restituiti
OT_ERROR_NONE
Chiave di rete Thread impostata.
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.

Ha successo solo quando i protocolli Thread sono disabilitati. Una chiamata riuscita a questa funzione rende non validi i set di dati operativi attivi e in attesa nella memoria non volatile.

Richiede l'abilitazione della funzionalità in fase di build OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aKeyRef
Riferimento alla chiave di rete Thread.
Valori restituiti
OT_ERROR_NONE
Chiave di rete Thread impostata.
OT_ERROR_INVALID_STATE
I protocolli Thread sono abilitati.
Vedi anche:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

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

Imposta il nome della rete Thread.

Ha successo solo quando i protocolli Thread sono disabilitati. Una chiamata riuscita a questa funzione rende non validi i set di dati operativi attivi e in attesa nella memoria non volatile.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aNetworkName
Un puntatore al nome di rete Thread.
Valori restituiti
OT_ERROR_NONE
Nome di rete Thread impostato correttamente.
OT_ERROR_INVALID_STATE
I protocolli Thread sono abilitati.
Vedi anche:
otThreadGetNetworkName

otThreadSetVendorModel

otError otThreadSetVendorModel(
  otInstance *aInstance,
  const char *aVendorModel
)

Imposta la stringa del modello del fornitore.

Richiede OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorModel deve essere in formato UTF8 con lunghezza massima di 32 caratteri (MAX_VENDOR_MODEL_TLV_LENGTH). La lunghezza massima non include il carattere \0 null.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aVendorModel
La stringa del modello del fornitore.
Valori restituiti
OT_ERROR_NONE
Modello del fornitore impostato.
OT_ERROR_INVALID_ARGS
aVendorModel non è valido (troppo lungo o non UTF8).

otThreadSetVendorName

otError otThreadSetVendorName(
  otInstance *aInstance,
  const char *aVendorName
)

Imposta la stringa del nome del fornitore.

Richiede OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorName deve essere in formato UTF8 con lunghezza massima di 32 caratteri (MAX_VENDOR_NAME_TLV_LENGTH). La lunghezza massima non include il carattere \0 null.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aVendorName
La stringa del nome del fornitore.
Valori restituiti
OT_ERROR_NONE
Nome del fornitore impostato.
OT_ERROR_INVALID_ARGS
aVendorName non è valido (troppo lungo o non UTF8).

otThreadSetVendorSwVersion

otError otThreadSetVendorSwVersion(
  otInstance *aInstance,
  const char *aVendorSwVersion
)

Imposta la stringa della versione del software del fornitore.

Richiede OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorSwVersion deve essere in formato UTF8 con lunghezza massima di 16 caratteri(MAX_VENDOR_SW_VERSION_TLV_LENGTH). La lunghezza massima non include il carattere \0 null.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aVendorSwVersion
La stringa della versione del software del fornitore.
Valori restituiti
OT_ERROR_NONE
La versione del software del fornitore è stata impostata.
OT_ERROR_INVALID_ARGS
aVendorSwVersion non è valido (troppo lungo o non UTF8).

Macro

OT_DURATION_STRING_SIZE

 OT_DURATION_STRING_SIZE 21

Dimensione consigliata per la rappresentazione stringa della durata di uint32_t in secondi.

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Lunghezza massima della pubblicità del joiner.

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 massima del valore del TLV di Thread Base.

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

Dimensione 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_MAX_THREAD_STACK_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

Lunghezza massima della versione TLV dello stack Thread.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

Lunghezza massima del TLV del modello del fornitore.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

Lunghezza massima del TLV del nome del fornitore.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

Lunghezza massima del TLV della versione SW del fornitore.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

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

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

ID router massimo.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Dimensione massima dei dati del server in byte. Limite teorico, praticamente molto più basso.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Dimensione massima dei dati di servizio in byte.

Risorse

Gli argomenti di riferimento dell'API OpenThread provengono dal codice sorgente, disponibile su GitHub. Per saperne di più o per contribuire alla nostra documentazione, consulta la sezione Risorse.