Réglages
Ce module inclut l'abstraction de plate-forme pour le stockage non volatile des paramètres.
Sommaire
Les fonctions | |
---|---|
otPlatSettingsAdd ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength) | Ajoute une valeur à un paramètre. |
otPlatSettingsDeinit ( otInstance *aInstance) | void Effectue toute désinitialisation du sous-système de paramètres, si nécessaire. |
otPlatSettingsDelete ( otInstance *aInstance, uint16_t aKey, int aIndex) | Supprime un paramètre du magasin de paramètres. |
otPlatSettingsGet ( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength) | Récupère la valeur d'un paramètre. |
otPlatSettingsInit ( otInstance *aInstance) | void Effectue toute initialisation du sous-système de paramètres, si nécessaire. |
otPlatSettingsSet ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength) | Définit ou remplace la valeur d'un paramètre. |
otPlatSettingsWipe ( otInstance *aInstance) | void Supprime tous les paramètres du magasin de paramètres. |
Les fonctions
otPlatSettingsAdd
otError otPlatSettingsAdd( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
Ajoute une valeur à un paramètre.
Cette fonction ajoute la valeur à un paramètre identifié par une clé, sans remplacer aucune valeur existante.
Notez que l'implémentation sous-jacente n'est pas requise pour maintenir l'ordre des éléments associés à une clé spécifique. La valeur ajoutée peut être ajoutée à la fin, au début ou même quelque part au milieu. L'ordre de toutes les valeurs préexistantes peut également changer.
L'appel réussi de cette fonction peut entraîner la réorganisation de paramètres non liés avec plusieurs valeurs.
Détails | |||||||||
---|---|---|---|---|---|---|---|---|---|
Paramètres |
| ||||||||
Valeurs de retour |
|
otPlatSettingsDeinit
void otPlatSettingsDeinit( otInstance *aInstance )
Effectue toute désinitialisation du sous-système de paramètres, si nécessaire.
Détails | |||
---|---|---|---|
Paramètres |
|
otPlatSettingsSupprimer
otError otPlatSettingsDelete( otInstance *aInstance, uint16_t aKey, int aIndex )
Supprime un paramètre du magasin de paramètres.
Cette fonction supprime une valeur spécifique du paramètre identifié par une clé du magasin de paramètres.
Notez que l'implémentation sous-jacente n'est pas requise pour maintenir l'ordre des éléments associés à une clé spécifique.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
| ||||||
Valeurs de retour |
|
otPlatSettingsGet
otError otPlatSettingsGet( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength )
Récupère la valeur d'un paramètre.
Cette fonction récupère la valeur du paramètre identifié par aKey et l'écrit dans la mémoire pointée par aValue. Il écrit ensuite la longueur sur l'entier pointé par aValueLength. La valeur initiale de aValueLength est le nombre maximal d'octets à écrire dans aValue.
Cette fonction peut être utilisée pour vérifier l'existence d'une clé sans récupérer la valeur en définissant aValue et aValueLength sur NULL. Vous pouvez également vérifier la longueur du paramètre sans le récupérer en définissant uniquement aValue sur NULL.
Notez que l'implémentation de stockage sous-jacente n'est pas requise pour conserver l'ordre des paramètres avec plusieurs valeurs. L'ordre de ces valeurs PEUT changer après TOUTE opération d'écriture dans la mémoire.
Détails | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Paramètres |
| ||||||||||
Valeurs de retour |
|
otPlatSettingsInit
void otPlatSettingsInit( otInstance *aInstance )
Effectue toute initialisation pour le sous-système de paramètres, si nécessaire.
Détails | |||
---|---|---|---|
Paramètres |
|
otPlatSettingsSet
otError otPlatSettingsSet( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
Définit ou remplace la valeur d'un paramètre.
Cette fonction définit ou remplace la valeur d'un paramètre identifié par une clé. S'il y avait plus d'une valeur précédemment associée à une clé, elles sont toutes supprimées et remplacées par cette seule entrée.
L'appel de cette fonction avec succès peut entraîner la réorganisation de paramètres non liés avec plusieurs valeurs.
Détails | |||||||||
---|---|---|---|---|---|---|---|---|---|
Paramètres |
| ||||||||
Valeurs de retour |
|
otPlatSettingsWipe
void otPlatSettingsWipe( otInstance *aInstance )
Supprime tous les paramètres du magasin de paramètres.
Cette fonction supprime tous les paramètres du magasin de paramètres, le réinitialisant à son état d'usine initial.
Détails | |||
---|---|---|---|
Paramètres |
|