Esempio

Questo modulo include funzioni che controllano l'istanza OpenThread.

Sommario

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_MASTER_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 che vengono passati come parte di `otStateChangedCallback` .

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_MASTER_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 che vengono passati come parte di otStateChangedCallback .

Typedef
`otChangedFlags`	typedef `uint32_t` Questo tipo rappresenta un campo di bit che indica lo stato / la configurazione specifica che è stata modificata.
`otInstance`	typedef `struct otInstance` Questa struttura rappresenta la struttura dell'istanza OpenThread.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Questo puntatore a funzione viene chiamato per notificare determinate modifiche alla configurazione o allo stato all'interno di OpenThread.

Funzioni
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Questa funzione ottiene la stringa della versione della radio OpenThread.
`otGetVersionString (void)`	`const char *` Questa funzione ottiene la stringa della versione OpenThread.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Questa funzione cancella tutte le informazioni persistenti OpenThread (impostazioni di rete) archiviate nella memoria non volatile.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Questo metodo elimina tutte le impostazioni archiviate nella memoria non volatile, quindi attiva il ripristino della piattaforma.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Questa funzione disabilita la libreria OpenThread.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Questa funzione inizializza la libreria OpenThread.
`otInstanceInitSingle (void)`	`otInstance *` Questa funzione inizializza la singola istanza statica della libreria OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Questa funzione indica se l'istanza è valida / inizializzata.
`otInstanceReset ( otInstance *aInstance)`	`void` Questo metodo attiva un ripristino della piattaforma.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Questa funzione rimuove un callback per indicare quando una determinata configurazione o stato cambia all'interno di OpenThread.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Questa funzione registra un callback per indicare quando una determinata configurazione o stato cambia in OpenThread.

Enumerazioni

enumerazione anonima

 anonymous enum

Questa enumerazione definisce i flag che vengono 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 sospeso di Channel Manager modificato.
`OT_CHANGED_COMMISSIONER_STATE`	Lo stato del Commissario è cambiato.
`OT_CHANGED_IP6_ADDRESS_ADDED`	È stato aggiunto l'indirizzo IPv6.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	L'indirizzo IPv6 è stato rimosso.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Sottoscritto a un indirizzo multicast IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Annullamento della sottoscrizione a un indirizzo multicast IPv6.
`OT_CHANGED_JOINER_STATE`	Lo stato del falegname è cambiato.
`OT_CHANGED_MASTER_KEY`	Chiave principale modificata.
`OT_CHANGED_PENDING_DATASET`	Set di dati operativi in sospeso modificato.
`OT_CHANGED_PSKC`	PSKc è cambiato.
`OT_CHANGED_SECURITY_POLICY`	La politica di sicurezza è cambiata.
`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`	Lo stato del router backbone è cambiato.
`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`	L'ID PAN esteso della rete di thread è stato modificato.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Sequenza tasti thread modificata.
`OT_CHANGED_THREAD_LL_ADDR`	L'indirizzo link-local è cambiato.
`OT_CHANGED_THREAD_ML_ADDR`	L'indirizzo mesh locale è cambiato.
`OT_CHANGED_THREAD_NETDATA`	Dati di rete thread modificati.
`OT_CHANGED_THREAD_NETIF_STATE`	Lo stato dell'interfaccia di rete del thread è cambiato.
`OT_CHANGED_THREAD_NETWORK_NAME`	Il nome della rete del thread è cambiato.
`OT_CHANGED_THREAD_PANID`	ID PAN rete thread modificato.
`OT_CHANGED_THREAD_PARTITION_ID`	ID partizione modificato.
`OT_CHANGED_THREAD_RLOC_ADDED`	È stato aggiunto RLOC.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC è stato rimosso.
`OT_CHANGED_THREAD_ROLE`	Ruolo (disabilitato, scollegato, figlio, router, leader) è cambiato.

Typedef

otChangedFlags

uint32_t otChangedFlags

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

Vedi le definizioni OT_CHANGED_* .

otInstance

struct otInstance otInstance

Questa struttura rappresenta la struttura dell'istanza OpenThread.

otStateChangedCallback

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

Questo puntatore a funzione viene chiamato per notificare determinate modifiche alla configurazione o allo stato all'interno di OpenThread.

Dettagli

Parametri

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

Funzioni

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Questa funzione ottiene la stringa della versione della radio OpenThread.

Dettagli

Parametri

[in] aInstance

Puntatore a un'istanza di OpenThread.

ritorna

Un puntatore alla versione della radio OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Questa funzione ottiene la stringa della versione OpenThread.

Dettagli
ritorna	Un puntatore alla versione OpenThread.

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

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

La cancellazione ha successo solo se il dispositivo è in stato / ruolo disabled .

Dettagli

Parametri

[in] aInstance

Puntatore a un'istanza di OpenThread.

Valori restituiti

`OT_ERROR_NONE`	Tutte le informazioni / lo stato persistenti sono stati cancellati correttamente.
`OT_ERROR_INVALID_STATE`	Il dispositivo non è in stato / ruolo `disabled` .

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Questo metodo elimina tutte le impostazioni archiviate nella memoria non volatile, quindi attiva il ripristino della piattaforma.

Dettagli

Parametri

[in] aInstance

Puntatore a un'istanza di OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Questa funzione disabilita la libreria OpenThread.

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

Dettagli

Parametri

[in] aInstance

Puntatore a un'istanza di OpenThread.

otInstanceInit

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

Questa funzione inizializza la libreria OpenThread.

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

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

Dettagli

Parametri

`[in] aInstanceBuffer`	Il buffer per OpenThread da utilizzare per l'allocazione della struttura otInstance.
`[in,out] aInstanceBufferSize`	In input, la dimensione di aInstanceBuffer. In uscita, se non c'è abbastanza spazio per otInstance, il numero di byte richiesti per otInstance.

ritorna

Un puntatore alla nuova istanza di OpenThread.

Guarda 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 successive chiamate API OpenThread. 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
ritorna	Un puntatore alla singola istanza di OpenThread.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

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

L'istanza è considerata valida se viene acquisita e inizializzata utilizzando otInstanceInitSingle() (nel caso di istanza singola) o otInstanceInit() (nel caso di più istanze). Una chiamata successiva a otInstanceFinalize() fa sì che l'istanza venga considerata come non inizializzata.

Dettagli

Parametri

[in] aInstance

Puntatore a un'istanza di OpenThread.

ritorna

TRUE se l'istanza data è valida / inizializzata, FALSE altrimenti.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Questo metodo attiva un ripristino della piattaforma.

Il processo di ripristino garantisce che tutte le informazioni / stato di OpenThread (archiviate nella memoria volatile) vengano cancellate. Si noti che otPlatformReset non cancella alcuno stato / informazioni persistenti salvati nella memoria non volatile.

Dettagli

Parametri

[in] aInstance

Puntatore a un'istanza di OpenThread.

otRemoveStateChangeCallback

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

Questa funzione rimuove un callback per indicare quando una determinata configurazione o stato cambia in OpenThread.

Dettagli

Parametri

`[in] aInstance`	Puntatore a un'istanza di OpenThread.
`[in] aCallback`	Puntatore a una funzione chiamata con determinate modifiche alla configurazione o allo stato.
`[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 una determinata configurazione o stato cambia in OpenThread.

Dettagli

Parametri

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

Valori restituiti

`OT_ERROR_NONE`	Aggiunta la richiamata all'elenco delle richiamate.
`OT_ERROR_ALREADY`	La richiamata era già registrata.
`OT_ERROR_NO_BUFS`	Impossibile aggiungere la richiamata a causa di vincoli di risorse.