Token Manager#

Routines for working with tokens.

Introduction#

The token system stores such non-volatile information as the manufacturing ID, channel number, transmit power, and various pieces of information that the application needs to be persistent between device power cycles. The token system is design to abstract implementation details and simplify interacting with differing non-volatile systems. The majority of tokens are stored in NVM3 or Simulated EEPROM (both use Flash) where they can be rewritten. Manufacturing tokens are stored in dedicated regions of flash and are not designed to be rewritten.

The NVM3 component is the preferred method and should be used on its own for data storage if SimEE has not been used. Token Manager is not required to access NVM3 data. The NVM3 system has its own APIs for interacting with NVM3.

The Token Manager is only used if existing systems already have SimEE. Token Manager enables SimEE data storage with the same API for accessing NVM3 or SimEE storage.

By default the Token Manager pulls in the NVM3 component for storage. The "Token Manager using NVM3" still requires the "Token Manager" component. If the SimEE1 or SimEE2 component is added into the project alongside the Token Manager, then SimEE1 or SimEE2 will be used for storage. If the Sim EEPROM 2 to NVM3 Upgrade component is added to the project alongside the Token Manager, then the upgrade will run at startup to transition as much stored data as possible into NVM3 format. When using the upgrade component don't include NVM3 or SimEE2 components. Once an upgrade is run, it would be possible to use stock Token Manager since Token Manager defaults to NVM3.