mbed-os-examples / Mbed OS mbed-os-example-nvstore

NVStore example for Mbed OS. This is an example of an application that uses the NVStore APIs. The application invokes the NVStore APIs and prints the results after each such invocation.

Required hardware

• An [FRDM-K64F](http://os.mbed.com/platforms/FRDM-K64F/) development board.
• A micro-USB cable.

# Other hardware

Although the board shown in this examples is K64F, the example should work on any Mbed enabled hardware supporting the internal flash driver (has "FLASH" in the "device_has" in targets/target.json file).

Getting started

1. Import the example.

``` mbed import mbed-os-example-nvstore cd mbed-os-example-nvstore ```

2. Keep the default NVStore configuration, which uses the last two sectors (4KB each) as NVStore areas.

3. Compile and generate binary.

For example, for `GCC`:

``` mbed compile -t GCC_ARM -m K64F ```

4. Open a serial console session with the target platform using the following parameters:

• Baud rate: 115200
• Data bits: 8
• Stop bits: 1
• Parity: None

5. Copy the application `mbed-os-example-nvstore.bin` in the folder `mbed-os-example-nvstore/BUILD/<TARGET NAME>/<PLATFORM NAME>` onto the target board.

6. Press the RESET button on the board to run the program

7. The serial console should now display a series of results following the NVStore API invocations.

8. Now copy `mbed_app-8KB-areas.json` to `mbed_app.json`. This should use 8KB areas (two pairs of last sectors) as NVStore areas.

9. Repeat steps 3-7. Notice the changes in prints of area addresses and sizes and with the amount of possible keys this configuration can hold.

10. To restore the default configuration, copy `mbed_app-default-areas.json` to `mbed_app.json`.

Troubleshooting

If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it.

--- Mbed OS NVStore example ---
Init NVStore. Return code is 0 \(as expected\).
NVStore size is \d+.
NVStore max number of keys is \d+ \(out of 255 possible ones in this flash configuration\).
NVStore areas:
Area 0: address 0x[0-9a-fA-F]+, size \d+ \(0x[0-9a-fA-F]+\).
Area 1: address 0x[0-9a-fA-F]+, size \d+ \(0x[0-9a-fA-F]+\).
Reset NVStore. Return code is 0 (as expected).
Set key 1 to value 1000. Return code is 0 \(as expected\).
Set key 1 to value 2000. Return code is 0 \(as expected\).
Set key 1 to value 3000. Return code is 0 \(as expected\).
Get key 1. Value is 3000. Return code is 0 \(as expected\).
Delete key 1. Return code is 0 \(as expected\).
Get key 1. Return code is -3 \(as expected\).
Set key 12 once to value 50. Return code is 0 \(as expected\).
Set key 12 to value 100. Return code is -9 \(as expected\).
Get key 12. Value is 50. Return code is 0 \(as expected\).
Data size for key 12 is 4. Return code is 0 \(as expected\).

--- Mbed OS NVStore example done. ---