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

Impostazioni

Questo modulo include l'astrazione della piattaforma per l'archiviazione non volatile delle impostazioni.

Riepilogo

Enumerazioni

anonymous enum{
  OT_SETTINGS_KEY_ACTIVE_DATASET = 0x0001,
  OT_SETTINGS_KEY_PENDING_DATASET = 0x0002,
  OT_SETTINGS_KEY_NETWORK_INFO = 0x0003,
  OT_SETTINGS_KEY_PARENT_INFO = 0x0004,
  OT_SETTINGS_KEY_CHILD_INFO = 0x0005,
  OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY = 0x0007,
  OT_SETTINGS_KEY_DAD_INFO = 0x0008,
  OT_SETTINGS_KEY_SRP_ECDSA_KEY = 0x000b,
  OT_SETTINGS_KEY_SRP_CLIENT_INFO = 0x000c,
  OT_SETTINGS_KEY_SRP_SERVER_INFO = 0x000d,
  OT_SETTINGS_KEY_BR_ULA_PREFIX = 0x000f,
  OT_SETTINGS_KEY_BR_ON_LINK_PREFIXES = 0x0010
}
enum
Questa enumerazione definisce le chiavi delle impostazioni.

Functions

otPlatSettingsAdd(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
Aggiunge un valore a un'impostazione.
otPlatSettingsDeinit(otInstance *aInstance)
void
Se necessario, esegue l'inizializzazione per il sottosistema Impostazioni.
otPlatSettingsDelete(otInstance *aInstance, uint16_t aKey, int aIndex)
Rimuove un'impostazione dallo store delle impostazioni.
otPlatSettingsGet(otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength)
Consente di recuperare il valore di un'impostazione.
otPlatSettingsInit(otInstance *aInstance, const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength)
void
Se necessario, esegue l'inizializzazione per il sottosistema Impostazioni.
otPlatSettingsSet(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
Imposta o sostituisce il valore di un'impostazione.
otPlatSettingsWipe(otInstance *aInstance)
void
Rimuove tutte le impostazioni dallo store delle impostazioni.

Enumerazioni

enumerazione anonima

 anonymous enum

Questa enumerazione definisce le chiavi delle impostazioni.

Nota: quando si aggiunge una nuova chiave di impostazioni, se le impostazioni corrispondenti alla chiave contengono informazioni sensibili per la sicurezza, lo sviluppatore DEVE aggiungere la chiave all'array aSensitiveKeys che viene passato in otPlatSettingsInit().

Proprietà
OT_SETTINGS_KEY_ACTIVE_DATASET

Set di dati operativo attivo.

OT_SETTINGS_KEY_BR_ON_LINK_PREFIXES

Prefissi telefonici locali collegati al collegamento BR.

OT_SETTINGS_KEY_BR_ULA_PREFIX

Prefisso ULA BR.

OT_SETTINGS_KEY_CHILD_INFO

Informazioni sull'oggetto secondario.

OT_SETTINGS_KEY_DAD_INFO

Informazioni per il rilevamento di indirizzi duplicati (DAD).

OT_SETTINGS_KEY_NETWORK_INFO

Thread informazioni sulla rete.

OT_SETTINGS_KEY_PARENT_INFO

Informazioni sull'organizzazione principale.

OT_SETTINGS_KEY_PENDING_DATASET

Set di dati operativi in attesa.

OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY

Chiave SLAAC per generare IID semanticamente opaco.

OT_SETTINGS_KEY_SRP_CLIENT_INFO

Le informazioni sul client SRP (indirizzo del server SRP selezionato).

OT_SETTINGS_KEY_SRP_ECDSA_KEY

Coppia di chiavi pubblica/privata ECDSA di client SRP.

OT_SETTINGS_KEY_SRP_SERVER_INFO

Informazioni sul server SRP (porta UDP)

Functions

otPlatSettingsAdd

otError otPlatSettingsAdd(
  otInstance *aInstance,
  uint16_t aKey,
  const uint8_t *aValue,
  uint16_t aValueLength
)

Aggiunge un valore a un'impostazione.

Questa funzione aggiunge il valore a un'impostazione identificata da aKey, senza sostituire i valori esistenti.

Tieni presente che l'implementazione sottostante non è necessaria per mantenere l'ordine degli elementi associati a una chiave specifica. Il valore aggiunto può essere aggiunto alla fine, all'inizio o anche a metà. Anche l'ordine dei valori preesistenti può cambiare.

Se chiami questa funzione con successo, le impostazioni non correlate con più valori potrebbero essere riordinate.

Lo stack OpenThread garantisce di utilizzare il metodo otPlatSettingsAdd() per un aKey precedentemente gestito da otPlatSettingsAdd() (ovvero contiene uno o più elementi) oppure è vuoto e/o completamente eliminato (non contiene alcun valore).

Il livello Piattaforma può fare affidamento su questo fatto per ottimizzare l'implementazione.

Dettagli
Parametri
[in] aInstance
La struttura dell'istanza OpenThread.
[in] aKey
La chiave associata all'impostazione da modificare.
[in] aValue
Un puntatore da cui leggere il nuovo valore dell'impostazione. NON DEVE essere NULL se aValueLength è diverso da zero.
[in] aValueLength
La lunghezza dei dati a cui fa riferimento aValue. Può essere zero.
Valori restituiti
OT_ERROR_NONE
L'impostazione specificata è stata aggiunta o aggiunta gradualmente.
OT_ERROR_NOT_IMPLEMENTED
Questa funzione non è implementata su questa piattaforma.
OT_ERROR_NO_BUFS
Spazio esaurito per archiviare l'impostazione specificata.

OtPlatSettingsDeinit

void otPlatSettingsDeinit(
  otInstance *aInstance
)

Se necessario, esegue l'inizializzazione per il sottosistema Impostazioni.

Dettagli
Parametri
[in] aInstance
La struttura dell'istanza OpenThread.

Impostazioni otPlatDelete

otError otPlatSettingsDelete(
  otInstance *aInstance,
  uint16_t aKey,
  int aIndex
)

Rimuove un'impostazione dallo store delle impostazioni.

Questa funzione elimina un valore specifico dall'impostazione identificata da aKey nell'archivio delle impostazioni.

Tieni presente che l'implementazione sottostante non è necessaria per mantenere l'ordine degli elementi associati a una chiave specifica.

Dettagli
Parametri
[in] aInstance
La struttura dell'istanza OpenThread.
[in] aKey
La chiave associata all'impostazione richiesta.
[in] aIndex
L'indice del valore da rimuovere. Se il valore è impostato su -1, tutti i valori per questo elemento aKey verranno rimossi.
Valori restituiti
OT_ERROR_NONE
La chiave e l'indice specificati sono stati trovati e rimossi.
OT_ERROR_NOT_FOUND
Impossibile trovare la chiave o l'indice specificato nell'archivio delle impostazioni.
OT_ERROR_NOT_IMPLEMENTED
Questa funzione non è implementata su questa piattaforma.

Impostazioni otPlatGet

otError otPlatSettingsGet(
  otInstance *aInstance,
  uint16_t aKey,
  int aIndex,
  uint8_t *aValue,
  uint16_t *aValueLength
)

Consente di recuperare il valore di un'impostazione.

Questa funzione recupera il valore dell'impostazione identificata da aKey e lo scrive nella memoria indicata da aValue. Quindi scrive la lunghezza dell'intero pari a aValueLength. Il valore iniziale di aValueLength rappresenta il numero massimo di byte da scrivere in aValue.

Questa funzione può essere utilizzata per verificare l'esistenza di una chiave senza recuperare il valore impostando aValue e aValueLength su NULL. Puoi anche verificare la lunghezza dell'impostazione senza recuperarla impostando solo aValue su NULL.

Tieni presente che l'implementazione dello spazio di archiviazione sottostante non è necessaria per mantenere l'ordine delle impostazioni con più valori. L'ordine di questi valori POTREBBERO cambiare dopo qualsiasi operazione di scrittura nello store.

Dettagli
Parametri
[in] aInstance
La struttura dell'istanza OpenThread.
[in] aKey
La chiave associata all'impostazione richiesta.
[in] aIndex
L'indice dell'elemento specifico da ottenere.
[out] aValue
Un puntatore a dove deve essere scritto il valore dell'impostazione. Può essere impostato su NULL se stai solo testando per verificare la presenza o la durata di un'impostazione.
[in,out] aValueLength
Un puntatore alla lunghezza del valore. Quando viene richiamato, questo puntatore deve rimandare a un numero intero contenente la dimensione massima del valore che può essere scritta in aValue. Al ritorno, viene registrata la lunghezza effettiva dell'impostazione. Può essere impostato su NULL se esegui un controllo della presenza di persone.
Valori restituiti
OT_ERROR_NONE
L'impostazione specificata è stata trovata e recuperata.
OT_ERROR_NOT_FOUND
Impossibile trovare l'impostazione specificata nello store delle impostazioni.
OT_ERROR_NOT_IMPLEMENTED
Questa funzione non è implementata su questa piattaforma.

otPlatSettingsInit

void otPlatSettingsInit(
  otInstance *aInstance,
  const uint16_t *aSensitiveKeys,
  uint16_t aSensitiveKeysLength
)

Se necessario, esegue l'inizializzazione per il sottosistema Impostazioni.

Questa funzione imposta anche le chiavi sensibili che devono essere archiviate nell'area protetta.

Tieni presente che la memoria indicata da aSensitiveKeys NON DEVE essere rilasciata prima che aInstance venga eliminato.

Dettagli
Parametri
[in] aInstance
La struttura dell'istanza OpenThread.
[in] aSensitiveKeys
Un puntatore a un array contenente l'elenco di chiavi sensibili. Può essere NULL solo se aSensitiveKeysLength è 0, il che significa che non ci sono chiavi sensibili.
[in] aSensitiveKeysLength
Il numero di voci nell'array aSensitiveKeys.

OtPlatSettingsSet

otError otPlatSettingsSet(
  otInstance *aInstance,
  uint16_t aKey,
  const uint8_t *aValue,
  uint16_t aValueLength
)

Imposta o sostituisce il valore di un'impostazione.

Questa funzione imposta o sostituisce il valore di un'impostazione identificata da aKey.

Se chiami questa funzione con successo, le impostazioni non correlate con più valori potrebbero essere riordinate.

Lo stack OpenThread garantisce di utilizzare il metodo otPlatSettingsSet() per un aKey precedentemente impostato utilizzando otPlatSettingsSet() (ovvero contiene un singolo valore) oppure è vuoto e/o completamente eliminato (non contiene alcun valore).

Il livello Piattaforma può fare affidamento su questo fatto per ottimizzare l'implementazione.

Dettagli
Parametri
[in] aInstance
La struttura dell'istanza OpenThread.
[in] aKey
La chiave associata all'impostazione da modificare.
[in] aValue
Un puntatore da cui leggere il nuovo valore dell'impostazione. NON DEVE essere NULL se aValueLength è diverso da zero.
[in] aValueLength
La lunghezza dei dati a cui fa riferimento un valore aValue. Può essere zero.
Valori restituiti
OT_ERROR_NONE
L'impostazione specificata è stata modificata o modificata in modo graduale.
OT_ERROR_NOT_IMPLEMENTED
Questa funzione non è implementata su questa piattaforma.
OT_ERROR_NO_BUFS
Spazio esaurito per archiviare l'impostazione specificata.

Cancellazione dati otPlat

void otPlatSettingsWipe(
  otInstance *aInstance
)

Rimuove tutte le impostazioni dallo store delle impostazioni.

Questa funzione elimina tutte le impostazioni dall'archivio impostazioni, ripristinando lo stato di fabbrica iniziale.

Dettagli
Parametri
[in] aInstance
La struttura dell'istanza OpenThread.

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.