xous-core/services/early_settings/README.md

18 lines
757 B
Markdown
Raw Permalink Normal View History

2023-04-21 16:10:36 +00:00
# `early_settings`
This crate provides a service and API to access settings stored in the first 4096 bytes of FLASH.
Settings stored there do not contain any personal identifiable information.
2023-04-21 16:10:36 +00:00
Settings currently stored here:
- keymap
- early sleep flag
**Do not store any personal informations here, user settings must go into `libs/userprefs`!**
This scratch area is provided for extreme edge cases:
- keymap must live here because users need to write their password in order to mount PDDB
- early sleep is used in the "lock device" lifecycle, placing it here is the most convenient thing to do to achieve that use-case
If you're thinking of placing something in here please open an issue or shoot us a Matrix message on `#xous-apps:matrix.org`.