zephyr

History

Marcin Niestroj daee6cb4a9 settings: file: change FS (or file system) wording to File Currently there is inconsistency in repository file names, APIs, Kconfig options and documentation around file / file-system backend for settings storage, as both "file" and "FS (file system)" are used. As an example, there is `CONFIG_SETTINGS_FS` Kconfig option, but the file that implements this settings backend is called `settings_file.c`. Another example are names of static functions that implement settings storage API: `settings_file_load()`, `settings_file_save()` and `settings_fs_storage_get()`. This backend is actually storing all settings in a single file, so it makes sense to use "File" as the name of backend, instead of a more general "FS" (which would make sense if several files would be used to store settings). Fix inconsistency in used wording in the tree and unify it to "settings file backend". This naming is more precise to how the implementation looks. It will also make it easier to grep through the codebase and analyze existing code. Deprecate settings_mount_fs_backend() function and all Kconfig options starting with `CONFIG_SETTINGS_FS`. Signed-off-by: Marcin Niestroj <m.niestroj@emb.dev>		2022-11-24 09:36:31 +01:00
..
boards	settings: file: change FS (or file system) wording to File	2022-11-24 09:36:31 +01:00
src	settings: file: change FS (or file system) wording to File	2022-11-24 09:36:31 +01:00
CMakeLists.txt
prj.conf
README.rst
sample.yaml

README.rst

.. _settings_subsys_sample:

Settings sample
###############

Overview
********

This is a simple application demonstrating use of the settings runtime
configuration module. In this application some configuration values are loaded
from persistent storage and exported to persistent storage using different
settings method. The example shows how to implement module handlers, how to
register them.

Requirements
************

* A board with settings support, for instance: nrf52840dk_nrf52840
* Or qemu_x86 target

Building and Running
********************

This sample can be found under :zephyr_file:`samples/subsys/settings` in
the Zephyr tree.

The sample can be build for several platforms, the following commands build the
application for the qemu_x86.

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/settings
   :host-os: unix
   :board: qemu_x86
   :goals: run
   :compact:

After running the image to the board the output on the console shows the
settings manipulation messages.

Sample Output
=============

.. code-block:: console

   ***** Booting Zephyr OS build v2.1.0-rc1-123-g41091eb1d5e0 *****

   *** Settings usage example ***

   settings subsys initialization: OK.
   subtree <alpha> handler registered: OK
   subtree <alpha/beta> has static handler

   ##############
   # iteration 0
   ##############

   =================================================
   basic load and save using registered handlers

   load all key-value pairs using registered handlers
   loading all settings under <beta> handler is done
   loading all settings under <alpha> handler is done

   save <alpha/beta/voltage> key directly: OK.

   load <alpha/beta> key-value pairs using registered handlers
   <alpha/beta/voltage> = -3025
   loading all settings under <beta> handler is done

   save all key-value pairs using registered handlers
   export keys under <beta> handler
   export keys under <alpha> handler

   load all key-value pairs using registered handlers
   export keys under <beta> handler
   export keys under <alpha> handler

   =================================================
   loading subtree to destination provided by the caller

   direct load: <alpha/length/2>
   direct load: <alpha/length/1>
   direct load: <alpha/length>
     direct.length = 100
     direct.length_1 = 41
     direct.length_2 = 59

   =================================================
   Delete a key-value pair

   immediate load: OK.
     <alpha/length> value exist in the storage
   delete <alpha/length>: OK.
     Can't to load the <alpha/length> value as expected

   =================================================
   Service a key-value pair without dedicated handlers

   <gamma> = 0 (default)
   save <gamma> key directly: OK.
   ...