Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Router/leader

Questo modulo include funzioni per router e leader di tipo Thread.

Riepilogo

Enumerazioni

otCacheEntryState enum
Questa enumerazione definisce lo stato della voce di 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.

Defin

otCacheEntryInfo Typedef
Questa struttura rappresenta una voce della cache EID.
otCacheEntryIterator Typedef
Questo tipo rappresenta un iteratore utilizzato per eseguire l'iterazione tramite le voci della tabella cache EID.
otCacheEntryState Typedef
Questa enumerazione definisce lo stato della voce di cache EID.
otChildIp6AddressIterator Typedef
uint16_t
Utilizzato per eseguire l'iterazione tramite indirizzi IPv6 di una voce secondaria del thread.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) Typedef
void(*
Il puntatore della funzione viene richiamato per notificare un cambiamento nella tabella adiacente.

Functions

otThreadBecomeLeader(otInstance *aInstance)
Diventa un leader e avvia una nuova partizione.
otThreadBecomeRouter(otInstance *aInstance)
Prova a diventare un router.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
Recupera le informazioni diagnostiche per un bambino secondario allegato tramite il relativo ID bambino o RLOC16.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
La funzione conserva le informazioni di diagnostica relative a un elemento secondario collegato in base all'indice della tabella interna.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Questa funzione riceve il successivo indirizzo IPv6 (utilizzando un iteratore) per un determinato elemento secondario.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
Ottieni il parametro CONTEXT_ID_REUSE_DELAY utilizzato nel ruolo di Leader.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
Recupera la porta UDP Joiner.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
Visualizza la ponderazione del leader del thread utilizzata quando operi nel ruolo di Leader.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
Recupera il numero massimo di bambini attualmente consentiti.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
Recupera il numero massimo di indirizzi IP che ogni figlio MTD può registrare con questo dispositivo come principale.
otThreadGetMaxRouterId(otInstance *aInstance)
uint8_t
La funzione restituisce l'ID massimo consentito del router.
otThreadGetNetworkIdTimeout(otInstance *aInstance)
uint8_t
Recupera il parametro NETWORK_ID_TIMEOUT utilizzato nel ruolo Router.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Questa funzione ottiene la prossima voce della cache EID (utilizzando un iteratore).
otThreadGetParentPriority(otInstance *aInstance)
int8_t
Recupera la priorità assegnata per l'elemento principale.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
Ottieni l'ID partizione leader del thread preferito utilizzato nel ruolo di leader.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
Scarica il thread PSKc.
otThreadGetPskcRef(otInstance *aInstance)
Ottieni riferimento chiave a Thread PSKc archiviato.
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 consentiti per i nodi all'interno della rete thread.
otThreadGetRouterIdSequence(otInstance *aInstance)
uint8_t
Recupera la sequenza di ID router attuale.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
La funzione conserva le informazioni di diagnostica relative a 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
Ottieni il parametro ROUTER_UPGRADE_THRESHOLD utilizzato 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 adiacente.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
Rilascia un ID router assegnato dal dispositivo nel ruolo di Leader.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
Questa funzione indica se il dispositivo è stato commissionato mediante 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 Joiner.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
Imposta la ponderazione del leader del thread utilizzata quando si utilizza il ruolo Leader.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
Consente di impostare il numero massimo di figli attualmente consentiti.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
Consente di impostare o ripristinare il numero massimo di indirizzi IP che ogni minore MTD può registrare con questo dispositivo come principale.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
Imposta il parametro NETWORK_ID_TIMEOUT utilizzato nel ruolo 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 quando operi nel ruolo di leader.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
Imposta l'ID router che preferisci.
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 Leader.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
Questa funzione stabilisce se il dispositivo è idoneo o meno al router.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
Questa funzione imposta l'intervallo di ID router che è possibile assegnare 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 dal cinturino.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
Questa funzione imposta se la soglia di versione TLV dei criteri di sicurezza per il routing (campo VR) è abilitata.

Struttura

otCacheEntryInfo

Questa struttura rappresenta una voce della cache EID.

otCacheEntryIterator

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

OtChildInfo

Questa struttura contiene informazioni di diagnostica per un Thread secondario.

otNeighborTableEntryInfo

Questo tipo rappresenta un dato di inserimento della tabella adiacente (secondario o router) e viene utilizzato come parametro nel callback otNeighborTableCallback della tabella adiacente.

Enumerazioni

otCacheEntryState

 otCacheEntryState

Questa enumerazione definisce lo stato della voce di cache EID.

otNeighborTableEvent

 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 minore.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

È cambiata la modalità di un bambino/a esistente.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

Un bambino viene rimosso.

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.

Defin

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Questa struttura rappresenta una voce della cache EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

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

Per inizializzare l'iteratore e iniziare dalla prima voce della tabella della cache, imposta tutti i relativi campi nella struttura su zero (ad es. memset l'iteratore fino a zero).

otCacheEntryState

enum otCacheEntryState otCacheEntryState

Questa enumerazione definisce lo stato della voce di cache EID.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Utilizzato per eseguire l'iterazione tramite indirizzi IPv6 di una voce secondaria del thread.

otNeighborTableCallback

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

Il puntatore della funzione viene richiamato per notificare un cambiamento nella tabella adiacente.

Dettagli
Parametri
[in] aEvent
Un flag dell'evento.
[in] aEntryInfo
Un puntatore che indica le informazioni relative alla tabella.

Functions

otThreadDiventaLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

Diventa un leader e avvia una nuova partizione.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Valori restituiti
OT_ERROR_NONE
Diventare leader e avviare una nuova partizione
OT_ERROR_INVALID_STATE
Thread disattivato.

otThreadDiventaRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Prova a diventare un router.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Valori restituiti
OT_ERROR_NONE
Tentativo di attivare il router come riuscito.
OT_ERROR_INVALID_STATE
Thread disattivato.

otThreadGetChildInfoById

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

Recupera le informazioni diagnostiche per un bambino secondario allegato tramite il relativo ID bambino o RLOC16.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aChildId
L'ID figlio o RLOC16 per l'ID secondario allegato.
[out] aChildInfo
Un puntatore che indica dove vengono posizionate le informazioni dell'oggetto secondario.
Valori restituiti
OT_ERROR_NONE
aChildInfo è stato aggiornato correttamente con le informazioni relative all'ID specificato.
OT_ERROR_NOT_FOUND
Nessuna richiesta secondaria valida 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 relative a un elemento secondario collegato in base all'indice della tabella interna.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aChildIndex
L'indice della tabella.
[out] aChildInfo
Un puntatore che indica dove vengono posizionate le informazioni dell'oggetto secondario.
Valori restituiti
OT_ERROR_NONE
aChildInfo è stato aggiornato con le informazioni per l'indice specificato.
OT_ERROR_NOT_FOUND
Nessuna risorsa secondaria valida in questo indice.
OT_ERROR_INVALID_ARGS
aChildInfo è NULL o aChildIndex è fuori intervallo (superiore al valore massimo dell'indice della tabella).
Vedi anche:
otGetMaxAllowedChildren

otThreadGetChildNextIp6Address

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

Questa funzione riceve il successivo indirizzo IPv6 (utilizzando un iteratore) per un determinato elemento secondario.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aChildIndex
L'indice secondario.
[in,out] aIterator
Un puntatore all'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 si trova l'indirizzo successivo del bambino (se l'operazione è riuscita).
Valori restituiti
OT_ERROR_NONE
Trovato correttamente l'indirizzo IPv6 successivo (aAddress aggiornato).
OT_ERROR_NOT_FOUND
Il publisher secondario non ha una voce successiva di indirizzo IPv6.
OT_ERROR_INVALID_ARGS
aIterator o aAddress sono NULL oppure il dominio secondario aChildIndex non è valido.
Vedi anche:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Ottieni il parametro CONTEXT_ID_REUSE_DELAY utilizzato nel ruolo di Leader.

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

otThreadGetjoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Recupera la porta UDP Joiner.

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

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Visualizza la ponderazione del leader del thread utilizzata quando operi nel ruolo di Leader.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Il valore della ponderazione della variante leader del thread.
Vedi anche:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Recupera il numero massimo di bambini attualmente consentiti.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Il numero massimo di bambini attualmente consentiti.
Vedi anche:
otThreadSetMaxAllowedChildren

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

Recupera il numero massimo di indirizzi IP che ogni figlio MTD può registrare con questo dispositivo come principale.

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

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

La funzione restituisce l'ID massimo consentito del router.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza 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 a un'istanza OpenThread.
Restituisce
Il valore NETWORK_ID_TIMEOUT.
Vedi anche:
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry

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

Questa funzione ottiene la prossima voce della cache EID (utilizzando un iteratore).

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aEntryInfo
Un puntatore che indica dove vengono posizionate le informazioni della voce della cache EID.
[in,out] aIterator
Un puntatore a un iteratore. Verrà aggiornato in modo da passare alla voce successiva relativa all'esito positivo. Per ottenere la prima voce, inizializza l'iteratore impostando tutti i campi su zero (ad es. memset la struttura dell'iteratore a zero).
Valori restituiti
OT_ERROR_NONE
aEntryInfo completato correttamente per la prossima voce della cache EID.
OT_ERROR_NOT_FOUND
Non ci sono altre voci nella tabella della cache dell'indirizzo.

otThreadGetPriorityPriorità

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Recupera la priorità assegnata per l'elemento principale.

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

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Ottieni l'ID partizione leader del thread preferito utilizzato nel ruolo di leader.

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

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Scarica il thread PSKc.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aPskc
Un puntatore a otPskc per restituire il PSKc di thread recuperato.
Vedi anche:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Ottieni riferimento chiave a Thread PSKc archiviato.

Questa funzione richiede l'attivazione della funzionalità al momento della build OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza 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 a un'istanza 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 consentiti per i nodi all'interno della rete thread.

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

Sequenza otThreadGetRouterId

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Recupera la sequenza di ID router attuale.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
La sequenza di ID router.

otThreadGetRouterInfo

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

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

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aRouterId
L'ID router o RLOC16 di un determinato router.
[out] aRouterInfo
Un puntatore che indica dove si trovano le informazioni del router.
Valori restituiti
OT_ERROR_NONE
Le informazioni sul router per l'ID specificato sono state recuperate.
OT_ERROR_NOT_FOUND
Nessuna voce del 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 a un'istanza OpenThread.
Restituisce
Il valore ROUTER_SELECTION_JITTER.
Vedi anche:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Ottieni il parametro ROUTER_UPGRADE_THRESHOLD utilizzato nel ruolo REED.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza 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 a un'istanza OpenThread.
Valori restituiti
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 adiacente.

Il callback fornito (se non NULL) verrà richiamato quando viene apportata una modifica nella tabella adiacente (ad es. viene aggiunta/rimossa una voce secondaria del router o un bambino esistente) o viene modificata la modalità di un bambino esistente.

Le chiamate successive a questo metodo sovrascriveranno il callback precedente. Tieni presente che questo callback viene richiamato durante l'aggiornamento della tabella adiacente o secondario e sempre prima di otStateChangedCallback.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aCallback
Un puntatore alla funzione di gestore del callback.

otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Rilascia un ID router assegnato dal dispositivo nel ruolo di Leader.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aRouterId
L'ID router da rilasciare. Intervallo valido: [0, 62].
Valori restituiti
OT_ERROR_NONE
ID router riuscito.
OT_ERROR_INVALID_ARGS
aRouterId non rientra nell'intervallo [0, 62].
OT_ERROR_INVALID_STATE
Attualmente il dispositivo non è leader.
OT_ERROR_NOT_FOUND
L'ID router non è attualmente allocato.

otThreadSetCcmAttivato

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Questa funzione indica se il dispositivo è stato commissionato mediante CCM.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aEnabled
TRUE se il dispositivo è stato commissionato utilizzando CCM, FALSE in caso contrario.

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 a un'istanza OpenThread.
[in] aDelay
Il valore CONTEXT_ID_REUSE_DELAY.
Vedi anche:
otThreadGetContextIdReuseDelay

OtThreadSetjoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Imposta la porta UDP Joiner.

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

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Imposta la ponderazione del leader del thread utilizzata quando si utilizza il ruolo Leader.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aWeight
Il valore della ponderazione della variante leader del thread.
Vedi anche:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Consente di impostare il numero massimo di figli attualmente consentiti.

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

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aMaxChildren
Il numero massimo consentito di elementi secondari.
Valori restituiti
OT_ERROR_NONE
Impostazione del CPC max riuscita
OT_ERROR_INVALID_ARGS
Se aMaxChildren non è nell'intervallo [1, OPENThread_CONFIG_MLE_MAX_CHILDREN].
OT_ERROR_INVALID_STATE
Se il thread non viene interrotto.
Vedi anche:
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Consente di impostare o ripristinare il numero massimo di indirizzi IP che ogni minore MTD può registrare con questo dispositivo come principale.

Passa 0 per cancellare l'impostazione e ripristinare il valore predefinito.

Disponibile quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE è attivato.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aMaxIpAddresses
Il numero massimo di indirizzi IP che ogni bambino MTD può registrare con questo dispositivo come principale. 0 per cancellare l'impostazione e ripristinare l'impostazione predefinita.
Valori restituiti
OT_ERROR_NONE
Il numero è stato impostato/cancellato correttamente.
OT_ERROR_INVALID_ARGS
Se 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 Leader.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza 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 a un'istanza OpenThread.
[in] aParentPriority
Il valore di priorità padre.
Valori restituiti
OT_ERROR_NONE
Impostazione della priorità padre riuscita.
OT_ERROR_INVALID_ARGS
Se il valore di priorità padre 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 quando operi nel ruolo di leader.

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

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Imposta l'ID router che preferisci.

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 casualmente. Questa proprietà può essere impostata solo quando il ruolo del dispositivo è scollegato o disattivato.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aRouterId
L'ID router preferito.
Valori restituiti
OT_ERROR_NONE
ID router preferito impostato.
OT_ERROR_INVALID_STATE
Impossibile impostare (il ruolo non è scollegato o disabilitato)

OtThreadSetPskc

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

Imposta il thread PSKc.

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

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aPskc
Un puntatore al nuovo Thread PSKc.
Valori restituiti
OT_ERROR_NONE
Impostazione del thread PSKc riuscita.
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 l'attivazione della funzionalità al momento della build OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

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

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aKeyRef
Riferimento chiave al nuovo thread PSKc.
Valori restituiti
OT_ERROR_NONE
Impostazione del thread PSKc riuscita.
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 Leader.

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

otThreadSetRouterIdoneo

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Questa funzione stabilisce se il dispositivo è idoneo o meno al router.

Se aEligible è false e il dispositivo è attualmente in funzione come router, con questa chiamata il dispositivo si disconnetterà e tenterà di ricollegarlo come bambino.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aEligible
TRUE per configurare il dispositivo come idoneo per il router, FALSE in caso contrario.
Valori restituiti
OT_ERROR_NONE
Impostazione idonea per il router riuscita.
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 è possibile assegnare ai nodi all'interno della rete thread.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aMinRouterId
L'ID minimo del router.
[in] aMaxRouterId
L'ID massimo del router.
Valori restituiti
OT_ERROR_NONE
Intervallo impostato correttamente.
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 a un'istanza 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 a un'istanza 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 dal cinturino.

L'opzione di configurazione OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE deve essere impostata in modo da consentire l'impostazione del controllo dei dati fuori banda.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aExtAddress
Indirizzo utilizzato per aggiornare i dati di guida. Tutti gli zeri per cancellare i dati di sterzo (nessun dato di sterzo). Tutti gli 0xFF per impostare il filtro dello sterzo/filtro bloom per accettare/consentire tutti. Uno specifico EUI64 che viene poi aggiunto all'attuale filtro dello sterzo/dati.

otThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Questa funzione imposta se la soglia di versione TLV dei criteri di sicurezza per il routing (campo VR) è abilitata.

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

Macro

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Inizializzatore per otChildIP6AddressIterator.

Risorse

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