Router/Leader

Questo modulo include funzioni per router e leader dei thread.

Riepilogo

Enumerazioni
otCacheEntryState enum
Questa enumerazione definisce lo stato di inserimento della cache EID.
otNeighborTableEvent{
  OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
} 		enum
Questa enumerazione definisce le costanti utilizzate in otNeighborTableCallback per indicare le modifiche nella tabella adiacente.

Defdef
otCacheEntryInfo tipodef
Questa struttura rappresenta una voce di cache EID.
otCacheEntryIterator tipodef
Questo tipo rappresenta un iteratore utilizzato per l'iterazione tramite le voci della tabella cache EID.
otCacheEntryState tipodef
Questa enumerazione definisce lo stato di inserimento della cache EID.
otChildIp6AddressIterator tipodef
uint16_t
Utilizzata per eseguire l'iterazione tramite indirizzi IPv6 di una voce secondaria Thread.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) tipodef
void(*
Questo puntatore di funzione viene chiamato per informare che è presente una modifica nella tabella del campo adiacente.

Functions
otThreadBecomeLeader(otInstance *aInstance)
Diventa un leader e avvia una nuova partizione.
otThreadBecomeRouter(otInstance *aInstance)
Tenta di diventare un router.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
La funzione conserva le informazioni di diagnostica relative a un Soggetto secondario associato in base al suo ID figlio o RLOC16.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
La funzione conserva le informazioni di diagnostica per un bambino secondario associato in base all'indice della tabella interna.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Questa funzione recupera l'indirizzo IPv6 successivo (utilizzando un iteratore) per un determinato elemento secondario.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
Recupera il parametro CONTEXT_ID_REUSE_DELAY utilizzato nel ruolo di Leader.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
Ottieni la porta UDP di join.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
Ottieni il peso del leader del thread quando utilizzi il ruolo di leader.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
Ottieni il numero massimo di bambini attualmente consentito.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
Questa funzione consente di ottenere il numero massimo di indirizzi IP che ogni minore MTD può registrare con il dispositivo come genitore.
otThreadGetMaxRouterId(otInstance *aInstance)
uint8_t
La funzione restituisce l'ID router massimo consentito.
otThreadGetNetworkIdTimeout(otInstance *aInstance)
uint8_t
Recupera il parametro NETWORK_ID_TIMEOUT utilizzato nel ruolo router.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Questa funzione recupera la successiva voce di cache EID (utilizzando un iteratore).
otThreadGetParentPriority(otInstance *aInstance)
int8_t
Ottieni la priorità principale assegnata.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
Ottieni l'ID partizione leader del thread che utilizzi per il ruolo di leader.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
Scarica il thread PSKc.
otThreadGetPskcRef(otInstance *aInstance)
Recupera il riferimento chiave al file PSKc del thread.
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
Recupera il parametro ROUTER_DOWNGRADE_Threshold utilizzato nel ruolo router.
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
Questa funzione riceve l'intervallo di ID router che possono essere assegnati ai nodi all'interno della rete Thread.
otThreadGetRouterIdSequence(otInstance *aInstance)
uint8_t
Controlla la sequenza attuale dell'ID router.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
La funzione conserva le informazioni di diagnostica per un determinato router Thread.
otThreadGetRouterSelectionJitter(otInstance *aInstance)
uint8_t
Recupera il parametro ROUTER_SELECTION_JITTER utilizzato nel ruolo REED/Router.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
uint8_t
Recupera il parametro ROUTER_UPGRADE_THRESHOLD nel ruolo REED.
otThreadIsRouterEligible(otInstance *aInstance)
bool
Questo metodo indica se il dispositivo è idoneo o meno per il router.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
void
Questa funzione registra una funzione di callback della tabella vicina.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
Rilascia un ID router che è stato assegnato dal dispositivo nel ruolo di leader.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
Questa funzione consente di specificare se il dispositivo è stato commissionato tramite CCM.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
void
Imposta il parametro CONTEXT_ID_REUSE_DELAY utilizzato nel ruolo di Leader.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
Imposta la porta UDP di join.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
Imposta la ponderazione del leader del thread quando utilizzi il ruolo Leader.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
Imposta il numero massimo di bambini attualmente consentiti.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
Questa funzione imposta/ripristina il numero massimo di indirizzi IP che ogni Soggetto secondario MTD può registrare con questo dispositivo come principale.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
Imposta il parametro NETWORK_ID_TIMEOUT utilizzato nel ruolo di Leader.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
Imposta la priorità principale.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
Imposta l'ID partizione leader del thread preferito utilizzato per agire nel ruolo di leader.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
Imposta l'ID router preferito.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
Imposta il thread PSKc.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
Imposta il thread PSKc.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Imposta il parametro ROUTER_DOWNGRADE_THRESHOLD utilizzato nel ruolo di leader.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
Questa funzione determina se il dispositivo è idoneo o meno per il router.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
Questa funzione imposta l'intervallo di ID router che possono essere assegnati ai nodi all'interno della rete Thread.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
void
Imposta il parametro ROUTER_SELECTION_JITTER utilizzato nel ruolo REED/Router.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Imposta il parametro ROUTER_UPGRADE_THRESHOLD utilizzato nel ruolo di leader.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
Imposta i dati del volante fuori dalla banda.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
Questa funzione consente di stabilire se attivare o meno la soglia della versione TLV del criterio di sicurezza per il routing (campo VR).

Strutture
otCacheEntryInfo

Questa struttura rappresenta una voce di cache EID.

otCacheEntryIterator

Questo tipo rappresenta un iteratore utilizzato per l'iterazione tramite le voci della tabella cache EID.

Informazioni otChild

Questa struttura contiene le informazioni di diagnostica per un Thread Child.

otNeighborTableEntryInfo

Questo tipo rappresenta le informazioni di voce di una tabella adiacente (secondario o router) e viene utilizzato come parametro nel callback della tabella adiacente otNeighborTableCallback.

Enumerazioni

OtCacheEntryState

 otCacheEntryState

Questa enumerazione definisce lo stato di inserimento della cache EID.

Evento otNeighborTable

 otNeighborTableEvent

Questa enumerazione definisce le costanti utilizzate in otNeighborTableCallback per indicare le modifiche nella tabella adiacente.

Proprietà
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

È in corso l'aggiunta di un bambino o ragazzo.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

La modalità di un bambino/a esistente viene cambiata.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

È in corso la rimozione di un bambino.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

È in corso l'aggiunta di un router.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

È in corso la rimozione di un router.

Defdef

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Questa struttura rappresenta una voce di cache EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

Questo tipo rappresenta un iteratore utilizzato per l'iterazione tramite le voci della tabella cache EID.

Per inizializzare l'iteratore e partire dalla prima voce nella tabella della cache, imposta tutti i relativi campi sulla struttura su zero (ad esempio memset dell'iteratore a zero.

OtCacheEntryState

enum otCacheEntryState otCacheEntryState

Questa enumerazione definisce lo stato di inserimento della cache EID.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Utilizzata per eseguire l'iterazione tramite indirizzi IPv6 di una voce secondaria Thread.

otNeighborTableCallback

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

Questo puntatore di funzione viene chiamato per informare che è presente una modifica nella tabella del campo adiacente.

Dettagli
Parametri
[in] aEvent
Un flag dell'evento.
[in] aEntryInfo
Un puntatore sulle informazioni delle voci della tabella.

Functions

oThreadThreadLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

Diventa un leader e avvia una nuova partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Valori di ritorno
OT_ERROR_NONE
È diventato un leader e ha avviato una nuova partizione.
OT_ERROR_INVALID_STATE
Thread disattivato.

otThreadDiventaRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Tenta di diventare un router.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Valori di ritorno
OT_ERROR_NONE
Tentativo di tentare di diventare un router.
OT_ERROR_INVALID_STATE
Thread disattivato.

otThreadGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

La funzione conserva le informazioni di diagnostica relative a un Soggetto secondario associato in base al suo ID figlio o RLOC16.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aChildId
L'ID figlio o RLOC16 per il bambino secondario associato.
[out] aChildInfo
Un puntatore relativo alla posizione in cui vengono posizionate le informazioni secondarie.
Valori di ritorno
OT_ERROR_NONE
aChildInfo è stato aggiornato correttamente con le informazioni per l'ID specificato.
OT_ERROR_NOT_FOUND
Nessun bambino valido con questo ID bambino.
OT_ERROR_INVALID_ARGS
Se aChildInfo è NULL.

otThreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

La funzione conserva le informazioni di diagnostica per un bambino secondario associato in base all'indice della tabella interna.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aChildIndex
L'indice della tabella.
[out] aChildInfo
Un puntatore relativo alla posizione in cui vengono posizionate le informazioni secondarie.
Valori di ritorno
OT_ERROR_NONE
aChildInfo è stato aggiornato correttamente con le informazioni per l'indice specificato.
OT_ERROR_NOT_FOUND
Nessun elemento secondario valido in questo indice.
OT_ERROR_INVALID_ARGS
aChildInfo è NULL oppure aChildIndex non rientra nell'intervallo (superiore all'indice della tabella massimo).
Vedi anche:
otGetMaxAllowedChild

Indirizzo otThreadGetChildNextIp6

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

Questa funzione recupera l'indirizzo IPv6 successivo (utilizzando un iteratore) per un determinato elemento secondario.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aChildIndex
L'indice figlio.
[in,out] aIterator
Un puntatore sull'iteratore. In caso di esito positivo, l'iteratore verrà aggiornato in modo da puntare alla voce successiva nell'elenco. Per ottenere il primo indirizzo IPv6, l'iteratore deve essere impostato su OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
Un puntatore a un indirizzo IPv6 in cui viene posizionato il prossimo indirizzo secondario (in caso di esito positivo).
Valori di ritorno
OT_ERROR_NONE
Trovato il prossimo indirizzo IPv6 (aAddress è stato aggiornato).
OT_ERROR_NOT_FOUND
Il publisher secondario non ha un indirizzo IPv6 successivo.
OT_ERROR_INVALID_ARGS
aIterator o aAddress sono NULL oppure il valore secondario di aChildIndex non è valido.
Vedi anche:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Recupera il parametro CONTEXT_ID_REUSE_DELAY utilizzato nel ruolo di Leader.

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

otThreadGetjoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Ottieni la porta UDP di join.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Il numero della porta UDP di unione.
Vedi anche:
otThreadSetjoinerUdpPort

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Ottieni il peso del leader del thread quando utilizzi il ruolo di leader.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Il valore del peso del leader del thread.
Vedi anche:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChild

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Ottieni il numero massimo di bambini attualmente consentito.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Il numero massimo di bambini attualmente consentito.
Vedi anche:
otThreadSetMaxAllowedChild

Indirizzi otThreadGetMaxChildIpAddress

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

Questa funzione consente di ottenere il numero massimo di indirizzi IP che ogni minore MTD può registrare con il dispositivo come genitore.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Il numero massimo di indirizzi IP che ogni minore MTD può registrare con questo dispositivo come principale.
Vedi anche:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

La funzione restituisce l'ID router massimo consentito.

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

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Recupera il parametro NETWORK_ID_TIMEOUT utilizzato nel ruolo router.

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

otThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

Questa funzione recupera la successiva voce di cache EID (utilizzando un iteratore).

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aEntryInfo
Un puntatore relativo alla posizione in cui si trovano le informazioni sulla voce di cache EID.
[in,out] aIterator
Un puntatore su un iteratore. Verrà aggiornato in modo da puntare alla prossima voce relativa al successo. Per ottenere la prima voce, inizializza l'iteratore impostando tutti i relativi campi su zero (ad es. memset della struttura dell'iteratore a zero.
Valori di ritorno
OT_ERROR_NONE
aEntryInfo compilato per la successiva voce di cache EID.
OT_ERROR_NOT_FOUND
Nessun'altra voce nella tabella della cache degli indirizzi.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Ottieni la priorità principale assegnata.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Il valore di priorità padre assegnato, -2 significa che non è assegnato.
Vedi anche:
otThreadSetParentPriority

ID otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Ottieni l'ID partizione leader del thread che utilizzi per il ruolo di leader.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Restituisce
Il valore dell'ID partizione leader thread.

OtThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Scarica il thread PSKc.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aPskc
Un puntatore a otPskc per restituire la stringa PSKc recuperata.
Vedi anche:
otThreadSetPskc

OtThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Recupera il riferimento chiave al file PSKc del 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 chiave a PSKc
Vedi anche:
otThreadSetPskcRef

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Recupera il parametro ROUTER_DOWNGRADE_Threshold utilizzato nel ruolo router.

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

otThreadGetRouterIdRange

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

Questa funzione riceve l'intervallo di ID router che possono essere assegnati ai nodi all'interno della rete Thread.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[out] aMinRouterId
L'ID minimo del router.
[out] aMaxRouterId
L'ID router massimo.
Vedi anche:
otThreadSetRouterIdRange

otThreadGetRouterIdSequenza

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Controlla la sequenza attuale dell'ID router.

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

otThreadGetRouterInfo

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

La funzione conserva le informazioni di diagnostica per un determinato router Thread.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aRouterId
L'ID router o RLOC16 per un determinato router.
[out] aRouterInfo
Un puntatore relativo alla posizione in cui vengono posizionate le informazioni del router.
Valori di ritorno
OT_ERROR_NONE
Recupero delle informazioni del router per l'ID specificato riuscito.
OT_ERROR_NOT_FOUND
Nessuna voce relativa al router con l'ID specificato.
OT_ERROR_INVALID_ARGS
aRouterInfo è NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Recupera il parametro ROUTER_SELECTION_JITTER utilizzato nel ruolo REED/Router.

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

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Recupera il parametro ROUTER_UPGRADE_THRESHOLD nel ruolo REED.

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

otThreadIsRouterIdoneo

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Questo metodo indica se il dispositivo è idoneo o meno per il router.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
Valori di ritorno
TRUE
Se il dispositivo è idoneo per il router.
FALSE
Se il dispositivo non è idoneo per il router.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Questa funzione registra una funzione di callback della tabella vicina.

Il callback fornito (se non NULL) viene richiamato quando viene apportata una modifica alla tabella dei vicini (ad esempio, viene aggiunta/rimossa una voce secondaria in un router o una voce adiacente del router o viene modificata la modalità bambino esistente).

Le chiamate successive a questo metodo sovrascriveranno la richiamata precedente. Tieni presente che questo callback viene richiamato mentre la tabella adiacente o secondaria viene aggiornata e sempre prima del valore otStateChangedCallback.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aCallback
Un puntatore che rimanda alla funzione di gestore di callback.

otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Rilascia un ID router che è stato assegnato dal dispositivo nel ruolo di leader.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aRouterId
L'ID router da rilasciare. L'intervallo valido è [0, 62].
Valori di ritorno
OT_ERROR_NONE
ID router reso disponibile.
OT_ERROR_INVALID_ARGS
aRouterId non è compreso nell'intervallo [0, 62].
OT_ERROR_INVALID_STATE
Al momento il dispositivo non funziona come leader.
OT_ERROR_NOT_FOUND
L'ID router non è attualmente allocato.

otThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Questa funzione consente di specificare se il dispositivo è stato commissionato tramite CCM.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aEnabled
TRUE se il dispositivo è stato commissionato con CCM, FALSE altrimenti.

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Imposta il parametro CONTEXT_ID_REUSE_DELAY utilizzato nel ruolo di Leader.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aDelay
Il valore CONTEXT_ID_REUSE_DELAY.
Vedi anche:
otThreadGetContextIdReuseDelay

otThreadSetjoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Imposta la porta UDP di join.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aJoinerUdpPort
Il numero della porta UDP di unione.
Valori di ritorno
OT_ERROR_NONE
Impostazione porta UDP Joiner riuscita.
Vedi anche:
otThreadGetjoinerUdpPort

Peso OtThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Imposta la ponderazione del leader del thread quando utilizzi il ruolo Leader.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aWeight
Il valore del peso del leader del thread.
Vedi anche:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChild

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Imposta il numero massimo di bambini attualmente consentiti.

Questo parametro può essere impostato solo quando il funzionamento del protocollo Thread è stato interrotto.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aMaxChildren
Il numero massimo consentito di bambini e ragazzi.
Valori di ritorno
OT_ERROR_NONE
Impostazione del CPC max riuscita
OT_ERROR_INVALID_ARGS
Se aMaxChildren non è compreso nell'intervallo [1, OPENthread_CONFIG_MLE_MAX_CHILDREN].
OT_ERROR_INVALID_STATE
Se il thread non viene interrotto.
Vedi anche:
otThreadGetMaxAllowedChild

Indirizzi otThreadSetMaxChildIpAddress

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Questa funzione imposta/ripristina il numero massimo di indirizzi IP che ogni Soggetto secondario MTD può registrare con questo dispositivo come principale.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aMaxIpAddresses
Il numero massimo di indirizzi IP che ogni minore MTD può registrare con questo dispositivo come principale. 0 per cancellare l'impostazione e ripristinare l'impostazione predefinita.
Valori di ritorno
OT_ERROR_NONE
Il numero è stato impostato/cancellato correttamente.
OT_ERROR_INVALID_ARGS
Se il numero supera il numero massimo consentito.
Vedi anche:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Imposta il parametro NETWORK_ID_TIMEOUT utilizzato nel ruolo di Leader.

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

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Imposta la priorità principale.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aParentPriority
Il valore di priorità principale.
Valori di ritorno
OT_ERROR_NONE
Priorità principale impostata.
OT_ERROR_INVALID_ARGS
Se il valore di priorità principale non è compreso tra 1, 0, -1 e -2.
Vedi anche:
otThreadGetParentPriority

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Imposta l'ID partizione leader del thread preferito utilizzato per agire nel ruolo di leader.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aPartitionId
Il valore dell'ID partizione leader thread.

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Imposta l'ID router preferito.

Quando diventa un router/leader, il nodo tenta di utilizzare questo ID router. Se l'ID router preferito non è impostato o se non può essere utilizzato, viene scelto un ID router generato in modo casuale. Questa proprietà può essere impostata solo quando il ruolo del dispositivo è scollegato o disattivato.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aRouterId
L'ID router preferito.
Valori di ritorno
OT_ERROR_NONE
Impostazione dell'ID router preferito riuscita.
OT_ERROR_INVALID_STATE
Impossibile configurare (il ruolo non è scollegato o disattivato)

OtThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

Imposta il thread PSKc.

Questa funzione avrà esito positivo solo quando i protocolli Thread sono disattivati. Una chiamata a questa funzione eseguita correttamente annullerà anche i set di dati operativi attivi e in attesa nella memoria non volatile.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aPskc
Un puntatore sul nuovo PSKc di thread.
Valori di ritorno
OT_ERROR_NONE
Impostazione PSKc del thread completata.
OT_ERROR_INVALID_STATE
I protocolli Thread sono abilitati.
Vedi anche:
otThreadGetPskc

OtThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Imposta il thread PSKc.

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

Questa funzione avrà esito positivo solo quando i protocolli Thread sono disattivati. Una chiamata a questa funzione eseguita correttamente annullerà anche i set di dati operativi attivi e in attesa nella memoria non volatile.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aKeyRef
Riferimento chiave al nuovo PSKc di thread.
Valori di ritorno
OT_ERROR_NONE
Impostazione PSKc del thread completata.
OT_ERROR_INVALID_STATE
I protocolli Thread sono abilitati.
Vedi anche:
otThreadGetPskcRef

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Imposta il parametro ROUTER_DOWNGRADE_THRESHOLD utilizzato nel ruolo di leader.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aThreshold
Il valore ROUTER_DOWNGRADE_THRESHOLD.
Vedi anche:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterIdoneo

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Questa funzione determina se il dispositivo è idoneo o meno per il router.

Se aEligible è falso e il dispositivo è attualmente in funzione come router, questa chiamata causerà lo scollegamento del dispositivo e il tentativo di ricollegarsi come bambino.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aEligible
TRUE per configurare il dispositivo come idoneo per il router, FALSE altrimenti.
Valori di ritorno
OT_ERROR_NONE
La configurazione idonea al router è stata impostata correttamente.
OT_ERROR_NOT_CAPABLE
Il dispositivo non può diventare un router.

otThreadSetRouterIdRange

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

Questa funzione imposta l'intervallo di ID router che possono essere assegnati ai nodi all'interno della rete Thread.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aMinRouterId
L'ID minimo del router.
[in] aMaxRouterId
L'ID router massimo.
Valori di ritorno
OT_ERROR_NONE
Impostazione dell'intervallo riuscita.
OT_ERROR_INVALID_ARGS
aMinRouterId > aMaxRouterId, o l'intervallo non è coperto da [0, 62].
Vedi anche:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Imposta il parametro ROUTER_SELECTION_JITTER utilizzato nel ruolo REED/Router.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aRouterJitter
Il valore ROUTER_SELECTION_JITTER.
Vedi anche:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Imposta il parametro ROUTER_UPGRADE_THRESHOLD utilizzato nel ruolo di leader.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aThreshold
Il valore ROUTER_UPGRADE_THRESHOLD.
Vedi anche:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Imposta i dati del volante fuori dalla banda.

Deve essere impostata l'opzione di configurazione OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE per consentire l'impostazione dei dati di guida fuori banda.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aExtAddress
Indirizzo utilizzato per aggiornare i dati di guida. Tutti gli zeri per cancellare i dati del volante (nessun dato del volante). Tutti i 0xFF per impostare dati del volante/filtro bloom per accettare/consentire tutto Uno specifico EUI64 che viene quindi aggiunto all'attuale filtro dati/fiori.

otThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Questa funzione consente di stabilire se attivare o meno la soglia della versione TLV del criterio di sicurezza per il routing (campo VR).

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza di OpenThread.
[in] aEnabled
TRUE per abilitare la soglia di versione TLV dei criteri di sicurezza per il routing, altrimenti utilizza FALSE.

Macro

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Inizializzatore per otChildIP6AddressIterator.

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.