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

Istanza

Questo modulo include funzioni che controllano l'istanza di OpenThread.

Riepilogo

Enumerazioni

anonymous enum{
  OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
  OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
  OT_CHANGED_THREAD_ROLE = 1 << 2,
  OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
  OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
  OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
  OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
  OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
  OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
  OT_CHANGED_THREAD_NETDATA = 1 << 9,
  OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
  OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
  OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
  OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
  OT_CHANGED_THREAD_CHANNEL = 1 << 14,
  OT_CHANGED_THREAD_PANID = 1 << 15,
  OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
  OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
  OT_CHANGED_NETWORK_KEY = 1 << 18,
  OT_CHANGED_PSKC = 1 << 19,
  OT_CHANGED_SECURITY_POLICY = 1 << 20,
  OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
  OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
  OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
  OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
  OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
  OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
  OT_CHANGED_JOINER_STATE = 1 << 27,
  OT_CHANGED_ACTIVE_DATASET = 1 << 28,
  OT_CHANGED_PENDING_DATASET = 1 << 29
}
enum
Questa enumerazione definisce i flag passati come parte di otStateChangedCallback.

Defin

otChangedFlags Typedef
uint32_t
Questo tipo rappresenta un campo di bit che indica lo stato/la configurazione specifica che è cambiato.
otInstance Typedef
struct otInstance
Questa struttura rappresenta la struttura delle istanze OpenThread.
otStateChangedCallback)(otChangedFlags aFlags, void *aContext) Typedef
void(*
Il puntatore della funzione viene chiamato per inviare notifiche relative a determinate modifiche dello stato o della configurazione all'interno di OpenThread.

Functions

otGetRadioVersionString(otInstance *aInstance)
const char *
Questa funzione riceve la stringa di versione della radio OpenThread.
otGetVersionString(void)
const char *
Questa funzione riceve la stringa di versione OpenThread.
otInstanceErasePersistentInfo(otInstance *aInstance)
Questa funzione cancella tutte le informazioni persistenti di OpenThread (impostazioni di rete) archiviate sulla memoria non volatile.
otInstanceFactoryReset(otInstance *aInstance)
void
Elimina tutte le impostazioni memorizzate nella memoria non volatile e attiva il ripristino della piattaforma.
otInstanceFinalize(otInstance *aInstance)
void
Questa funzione disattiva la libreria OpenThread.
otInstanceGetUptime(otInstance *aInstance)
uint64_t
Questa funzione restituisce il tempo di attività attuale dell'istanza (in msec).
otInstanceGetUptimeAsString(otInstance *aInstance, char *aBuffer, uint16_t aSize)
void
Questa funzione restituisce il tempo di attività attuale dell'istanza come stringa leggibile.
otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize)
Questa funzione inizializza la libreria OpenThread.
otInstanceInitSingle(void)
Questa funzione inizializza la singola istanza statica della libreria OpenThread.
otInstanceIsInitialized(otInstance *aInstance)
bool
Questa funzione indica se l'istanza è valida o inizializzata.
otInstanceReset(otInstance *aInstance)
void
Questo metodo attiva il ripristino della piattaforma.
otInstanceResetRadioStack(otInstance *aInstance)
void
Questo metodo reimposta gli stati interni dello stack radio OpenThread.
otRemoveStateChangeCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
Questa funzione rimuove un callback per indicare quando determinati stati o configurazioni cambiano all'interno di OpenThread.
otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
Questa funzione registra un callback per indicare quando determinati stati o configurazioni cambiano all'interno di OpenThread.

Enumerazioni

enumerazione anonima

 anonymous enum

Questa enumerazione definisce i flag passati come parte di otStateChangedCallback.

Proprietà
OT_CHANGED_ACTIVE_DATASET

Set di dati operativo attivo modificato.

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

Nuovo canale Thread in attesa del gestore canali modificato.

OT_CHANGED_COMMISSIONER_STATE

Stato Commissioner modificato.

OT_CHANGED_IP6_ADDRESS_ADDED

L'indirizzo IPv6 è stato aggiunto.

OT_CHANGED_IP6_ADDRESS_REMOVED

L'indirizzo IPv6 è stato rimosso.

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

Iscritto a un indirizzo multicast IPv6.

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

Iscrizione annullata a un indirizzo multicast IPv6.

OT_CHANGED_JOINER_STATE

Stato unione modificato.

OT_CHANGED_NETWORK_KEY

Chiave di rete modificata.

OT_CHANGED_PENDING_DATASET

Set di dati operativo in attesa modificato.

OT_CHANGED_PSKC

PSKc modificato.

OT_CHANGED_SECURITY_POLICY

Criterio di sicurezza modificato.

OT_CHANGED_SUPPORTED_CHANNEL_MASK

Maschera del canale supportata modificata.

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

Configurazione del router backbone locale modificata.

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

Stato del router backbone modificato.

OT_CHANGED_THREAD_CHANNEL

Canale di rete del thread modificato.

OT_CHANGED_THREAD_CHILD_ADDED

Il bambino è stato aggiunto.

OT_CHANGED_THREAD_CHILD_REMOVED

Il bambino è stato rimosso.

OT_CHANGED_THREAD_EXT_PANID

ID PAN esteso della rete thread modificato.

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

Sequenza di tasti del thread modificata.

OT_CHANGED_THREAD_LL_ADDR

L'indirizzo locale del link è cambiato.

OT_CHANGED_THREAD_ML_ADDR

L'indirizzo locale del mesh è stato modificato.

OT_CHANGED_THREAD_NETDATA

Thread Dati di rete modificati.

OT_CHANGED_THREAD_NETIF_STATE

Stato dell'interfaccia di rete thread modificato.

OT_CHANGED_THREAD_NETWORK_NAME

Nome rete di thread modificato.

OT_CHANGED_THREAD_PANID

ID PAN della rete thread modificato.

OT_CHANGED_THREAD_PARTITION_ID

ID partizione cambiato.

OT_CHANGED_THREAD_RLOC_ADDED

RLOC è stato aggiunto.

OT_CHANGED_THREAD_RLOC_REMOVED

RLOC è stato rimosso.

OT_CHANGED_THREAD_ROLE

Ruolo (disattivato, scollegato, figlio, router, leader) modificato.

Defin

OtChangedFlags

uint32_t otChangedFlags

Questo tipo rappresenta un campo di bit che indica lo stato/la configurazione specifica che è cambiato.

Vedi le definizioni di OT_CHANGED_*.

OtInstance

struct otInstance otInstance

Questa struttura rappresenta la struttura delle istanze OpenThread.

OtStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

Il puntatore della funzione viene chiamato per inviare notifiche relative a determinate modifiche dello stato o della configurazione all'interno di OpenThread.

Dettagli
Parametri
[in] aFlags
Un campo di bit che indica uno stato specifico che è cambiato. Vedi le definizioni di OT_CHANGED_*.
[in] aContext
Un puntatore al contesto specifico dell'applicazione.

Functions

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Questa funzione riceve la stringa di versione della radio OpenThread.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Un puntatore alla versione radio di OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Questa funzione riceve la stringa di versione OpenThread.

Dettagli
Restituisce
Un puntatore alla versione OpenThread.

otInstanceResetPersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Questa funzione cancella tutte le informazioni persistenti di OpenThread (impostazioni di rete) archiviate sulla memoria non volatile.

Il reset è riuscito solo se il dispositivo è in stato/ruolo disabled.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Valori restituiti
OT_ERROR_NONE
Tutte le informazioni/lo stato permanente sono state eliminate.
OT_ERROR_INVALID_STATE
Il dispositivo non si trova in stato/ruolo disabled.

OtInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Elimina tutte le impostazioni memorizzate nella memoria non volatile e attiva il ripristino della piattaforma.

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

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Questa funzione disattiva la libreria OpenThread.

Chiama questa funzione quando OpenThread non è più in uso.

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

OtInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

Questa funzione restituisce il tempo di attività attuale dell'istanza (in msec).

Questa funzione richiede che sia abilitato OPENTHREAD_CONFIG_UPTIME_ENABLE.

Il tempo di attività è dato come numero di millisecondi da quando l'istanza di OpenThread è stata inizializzata.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
Il tempo di attività (numero di millisecondi).

otInstanceGetUptimeAsString

void otInstanceGetUptimeAsString(
  otInstance *aInstance,
  char *aBuffer,
  uint16_t aSize
)

Questa funzione restituisce il tempo di attività attuale dell'istanza come stringa leggibile.

Questa funzione richiede che sia abilitato OPENTHREAD_CONFIG_UPTIME_ENABLE.

La stringa segue il formato "::." per ore, minuti, secondi e millisecondo (se il tempo di attività è inferiore a un giorno) o "

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

Se la stringa risultante non rientra in aBuffer (nei suoi aSize caratteri), la stringa verrà troncata ma la stringa restituita è sempre null-terminata.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aBuffer
Un puntatore a un array di caratteri per generare la stringa.
[in] aSize
Le dimensioni di aBuffer (in byte). È consigliabile utilizzare OT_UPTIME_STRING_SIZE.

OtInstanceInit

otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

Questa funzione inizializza la libreria OpenThread.

Questa funzione inizializza OpenThread e lo prepara per le chiamate API OpenThread successive. Questa funzione deve essere chiamata prima di qualsiasi altra chiamata a OpenThread.

Questa funzione è disponibile e può essere utilizzata solo quando il supporto di più istanze OpenThread è abilitato.

Dettagli
Parametri
[in] aInstanceBuffer
Il buffer per OpenThread da utilizzare per l'allocazione della struttura otInstance.
[in,out] aInstanceBufferSize
All'input, le dimensioni di aInstanceBuffer. Nell'output, se non è presente spazio sufficiente per otInstance, il numero di byte richiesti per otInstance.
Restituisce
Un puntatore alla nuova istanza OpenThread.
Vedi anche:
otInstanceFinalize

OtInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

Questa funzione inizializza la singola istanza statica della libreria OpenThread.

Questa funzione inizializza OpenThread e lo prepara per le chiamate API OpenThread successive. Questa funzione deve essere chiamata prima di qualsiasi altra chiamata a OpenThread.

Questa funzione è disponibile e può essere utilizzata solo quando il supporto per più istanze OpenThread è disabilitato.

Dettagli
Restituisce
Un puntatore alla singola istanza OpenThread.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Questa funzione indica se l'istanza è valida o inizializzata.

L'istanza è considerata valida se viene acquisita e inizializzata utilizzando otInstanceInitSingle() (in una singola istanza) o otInstanceInit() (in una singola istanza). Una chiamata successiva a otInstanceFinalize() fa sì che l'istanza venga considerata non inizializzata.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Restituisce
TRUE se l'istanza specificata è valida/inizializzata, FALSE in caso contrario.

OtInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Questo metodo attiva il ripristino della piattaforma.

Il processo di reset assicura che tutto lo stato/le informazioni di OpenThread (memorizzate nella memoria volatile) venga cancellato. Tieni presente che otPlatformReset non cancella gli stati o le informazioni permanenti salvati nella memoria non volatile.

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

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

Questo metodo reimposta gli stati interni dello stack radio OpenThread.

I callback e le configurazioni vengono conservati.

Questa API è disponibile solo nelle build radio (OPENTHREAD_RADIO = 1).

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

otRimuoviStatoModificaCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Questa funzione rimuove un callback per indicare quando determinati stati o configurazioni cambiano all'interno di OpenThread.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aCallback
Un puntatore a una funzione chiamata con determinate modifiche di stato o configurazione.
[in] aContext
Un puntatore al contesto specifico dell'applicazione.

OtSetStateChangedCallback

otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Questa funzione registra un callback per indicare quando determinati stati o configurazioni cambiano all'interno di OpenThread.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aCallback
Un puntatore a una funzione chiamata con determinate modifiche di stato o configurazione.
[in] aContext
Un puntatore al contesto specifico dell'applicazione.
Valori restituiti
OT_ERROR_NONE
Aggiunta del callback all'elenco dei callback.
OT_ERROR_ALREADY
Il callback è già stato registrato.
OT_ERROR_NO_BUFS
Impossibile aggiungere il callback a causa di vincoli delle risorse.

Macro

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

Dimensioni consigliate per la rappresentazione stringa del tempo di attività.

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.