Contiki 3.x
Macros | Functions
settings.h File Reference

Settings Manager. More...

#include <stdint.h>
#include <string.h>
#include "dev/eeprom.h"
#include "sys/cc.h"

Go to the source code of this file.

Macros

#define TCC(a, b)   ((a)+(b)*256)
 Two-character constant macro.
 
#define SETTINGS_KEY_EUI64   TCC('E','8')
 EUI64 Address, 8 bytes.
 
#define SETTINGS_KEY_EUI48   TCC('E','6')
 
#define SETTINGS_KEY_CHANNEL   TCC('C','H')
 
#define SETTINGS_KEY_TXPOWER   TCC('T','P')
 
#define SETTINGS_KEY_PAN_ID   TCC('P','N')
 
#define SETTINGS_KEY_PAN_ADDR   TCC('P','A')
 
#define SETTINGS_KEY_AES128KEY   TCC('S','K')
 
#define SETTINGS_KEY_AES128ENABLED   TCC('S','E')
 
#define SETTINGS_KEY_HOSTNAME   TCC('H','N')
 
#define SETTINGS_KEY_DOMAINNAME   TCC('D','N')
 
#define SETTINGS_KEY_RDC_INDEX   TCC('R','D')
 
#define SETTINGS_KEY_CHANNEL_MASK   TCC('C','M')
 
#define SETTINGS_LAST_INDEX   0xFF
 Use this when you want to retrieve the last item.
 
#define SETTINGS_INVALID_KEY   0xFFFF
 Returned when key is invalid. More...
 
#define SETTINGS_INVALID_ITER   EEPROM_NULL
 Returned if no (further) element was found. More...
 

Functions

settings_status_t settings_get (settings_key_t key, uint8_t index, uint8_t *value, settings_length_t *value_size)
 Fetches the value associated with the given key. More...
 
settings_status_t settings_add (settings_key_t key, const uint8_t *value, settings_length_t value_size)
 Adds the given key-value pair to the end of the settings store. More...
 
uint8_t settings_check (settings_key_t key, uint8_t index)
 Checks to see if the given key exists. More...
 
void settings_wipe (void)
 Reinitializes all of the EEPROM used by settings. More...
 
settings_status_t settings_set (settings_key_t key, const uint8_t *value, settings_length_t value_size)
 Sets the value for the given key. More...
 
settings_status_t settings_delete (settings_key_t key, uint8_t index)
 Removes the given key (at the given index) from the settings store. More...
 
settings_iter_t settings_iter_begin ()
 Will return SETTINGS_INVALID_ITER if the settings store is empty. More...
 
settings_iter_t settings_iter_next (settings_iter_t iter)
 Will return SETTINGS_INVALID_ITER if at the end of settings list. More...
 

Detailed Description

Settings Manager.

Author
Robert Quattlebaum darco.nosp@m.@dee.nosp@m.pdarc.nosp@m..com

Definition in file settings.h.