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 }	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 
 }

enum

Questa enumerazione definisce i flag che vengono passati come parte di otStateChangedCallback .

typedef
`otChangedFlags`	typedef `uint32_t` Questo tipo rappresenta un campo bit che indica lo stato / la configurazione specifici che sono stati modificati.
`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 di configurazione o di stato in OpenThread.

funzioni
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Questa funzione ottiene la stringa di versione radio OpenThread.
`otGetVersionString (void)`	`const char *` Questa funzione ottiene la stringa della versione di OpenThread.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Questa funzione cancella tutte le informazioni persistenti di 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 avvia 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 o meno.
`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 determinate configurazioni o stati cambiano all'interno di OpenThread.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Questa funzione registra un callback per indicare quando determinate configurazioni o stati cambiano all'interno di OpenThread.

enumerazioni

enum anonimo

 anonymous enum

Questa enumerazione definisce i flag che vengono passati come parte di otStateChangedCallback .

Proprietà
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Channel Manager nuovo canale Thread in sospeso modificato.
`OT_CHANGED_COMMISSIONER_STATE`	Lo stato del commissario è cambiato.
`OT_CHANGED_IP6_ADDRESS_ADDED`	Indirizzo IPv6 aggiunto.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	L'indirizzo IPv6 è stato rimosso.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Abbonato a un indirizzo multicast IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Annullato l'iscrizione a un indirizzo multicast IPv6.
`OT_CHANGED_JOINER_STATE`	Lo stato del falegname è cambiato.
`OT_CHANGED_MASTER_KEY`	Chiave principale modificata.
`OT_CHANGED_PSKC`	PSKc è cambiato.
`OT_CHANGED_SECURITY_POLICY`	Politica di sicurezza modificata.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Maschera di canale supportata modificata.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	La configurazione del router backbone locale è stata modificata.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Lo stato del router backbone è cambiato.
`OT_CHANGED_THREAD_CHANNEL`	Il canale della rete di thread è cambiato.
`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 chiave thread modificata.
`OT_CHANGED_THREAD_LL_ADDR`	L'indirizzo del collegamento locale è cambiato.
`OT_CHANGED_THREAD_ML_ADDR`	L'indirizzo mesh-local è cambiato.
`OT_CHANGED_THREAD_NETDATA`	Thread Network Data modificato.
`OT_CHANGED_THREAD_NETIF_STATE`	Lo stato dell'interfaccia di rete del thread è cambiato.
`OT_CHANGED_THREAD_NETWORK_NAME`	Il nome della rete di thread è cambiato.
`OT_CHANGED_THREAD_PANID`	L'ID PAN della rete thread è stato modificato.
`OT_CHANGED_THREAD_PARTITION_ID`	ID partizione modificato.
`OT_CHANGED_THREAD_RLOC_ADDED`	RLOC è stato aggiunto.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC è stato rimosso.
`OT_CHANGED_THREAD_ROLE`	Il ruolo (disabilitato, distaccato, figlio, router, leader) è cambiato.

typedef

otChangedFlags

uint32_t otChangedFlags

Questo tipo rappresenta un campo bit che indica lo stato / la configurazione specifici che sono stati modificati.

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 di configurazione o di stato in OpenThread.

Dettagli

parametri

`[in] aFlags`	Un campo bit che indica lo stato specifico che è stato modificato. 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 di versione radio OpenThread.

Dettagli

parametri

[in] aInstance

Un puntatore a un'istanza OpenThread.

ritorna

Un puntatore alla versione radio OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Questa funzione ottiene la stringa della versione di OpenThread.

Dettagli
ritorna	Un puntatore alla versione OpenThread.

otInstanceErasePersistentInfo

 otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

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

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

Dettagli

parametri

[in] aInstance

Un puntatore a un'istanza OpenThread.

Valori di restituzione

`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 avvia il ripristino della piattaforma.

Dettagli

parametri

[in] aInstance

Un puntatore a un'istanza OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Questa funzione disabilita la libreria OpenThread.

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

Dettagli

parametri

[in] aInstance

Un puntatore a un'istanza 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 allocare la struttura otInstance.
`[in,out] aInstanceBufferSize`	All'input, la dimensione di aInstanceBuffer. In uscita, se non abbastanza spazio per otInstance, il numero di byte richiesti per otInstance.

ritorna

Un puntatore alla nuova istanza 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 OpenThread.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

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

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

Dettagli

parametri

[in] aInstance

Un puntatore a un'istanza OpenThread.

ritorna

VERO se l'istanza fornita è valida / inizializzata, FALSO altrimenti.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Questo metodo attiva un ripristino della piattaforma.

Il processo di ripristino assicura che tutto lo stato / informazioni OpenThread (memorizzati nella memoria volatile) venga cancellato. Notare che otPlatformReset non cancella alcuno stato persistente / informazioni salvate nella memoria non volatile.

Dettagli

parametri

[in] aInstance

Un puntatore a un'istanza OpenThread.

otRemoveStateChangeCallback

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

Questa funzione rimuove un callback per indicare quando determinate configurazioni o stati 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 configurazione o di 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 determinate configurazioni o stati 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 configurazione o di stato.
`[in] aContext`	Un puntatore al contesto specifico dell'applicazione.

Valori di restituzione

`OT_ERROR_NONE`	Aggiunto il callback all'elenco dei callback.
`OT_ERROR_ALREADY`	Il callback era già registrato.
`OT_ERROR_NO_BUFS`	Impossibile aggiungere il callback a causa di vincoli di risorse.