---
title: "Settings"
canonical_url: https://developer.repebble.com/pebbleos/docs/samples/subsys/settings/store/
last_updated: 2026-11-18
sdk_version: 4.44
---
# Settings

Source: https://developer.repebble.com/pebbleos/docs/samples/subsys/settings/store/

This sample keeps a settings file, a store of key-value records in a single file on the [file system](https://developer.repebble.com/pebbleos/docs/subsystems/fs.md). Each write appends a record, so a reset never leaves a value half written; the file is compacted when the dead records fill it.

It counts its runs in a record kept from one run to the next, writes and reads two more, lists them all with `pbl_settings_each()` and deletes one. Keys and values are bytes: the keys here are strings without their terminator. A watch, registered before the file is written, reports each change.

Run:

`pbl samples samples/subsys/settings/store`

Boards:

every board

## Sources

src/main.c

```
#include \<errno.h\>#include \<stdint.h\>#include \<stdio.h\>#include \<string.h\>#include \<pbl/fs/fs.h\>#include \<pbl/fs/pfs.h\>#include \<pbl/settings/settings.h\>#define FILE\_NAME "/sample-settings"#define FILE\_SPACE 1024/\* Keys and values are bytes; these keys are strings without their terminator. \*/#define KEY(str) (str), (sizeof(str) - 1U)static struct pbl\_fs\_mount s\_mount = {.mnt\_point = "/", .ops = &pbl\_fs\_pfs\_ops};static struct pbl\_settings\_file s\_file;static void prv\_changed(const void \*key, size\_t key\_len, uint32\_t last\_modified, void \*user\_data) {printf("settings: changed %.\*s\n", (int)key\_len, (const char \*)key);}static struct pbl\_settings\_watch s\_watch = {.name = FILE\_NAME,.cb = prv\_changed,};static bool prv\_print\_record(struct pbl\_settings\_file \*file, struct pbl\_settings\_record \*info,void \*context) {char key[PBL\_SETTINGS\_KEY\_MAX\_LEN + 1] = {0};unsigned int \*count = context;/\* Deleted records are visited too, with no value. \*/if (info-\>val\_len == 0) {return true;}pbl\_settings\_read\_key(file, key, info-\>key\_len);printf("settings: record %s, %u bytes\n", key, (unsigned int)info-\>val\_len);(\*count)++;return true;}int main(void) {char name[16] = {0};uint32\_t runs = 0;uint8\_t level = 3;unsigned int count = 0;size\_t len;int ret;ret = pbl\_fs\_mount(&s\_mount);if (ret \< 0) {fprintf(stderr, "settings: mount failed (%d)\n", ret);return ret;}/\* Watches are registered once, before the file is written, and see every later write. \*/pbl\_settings\_watch\_add(&s\_watch);ret = pbl\_settings\_open(&s\_file, FILE\_NAME, FILE\_SPACE);if (ret \< 0) {fprintf(stderr, "settings: open failed (%d)\n", ret);return ret;}/\* A value kept from the last run, if any. \*/if (pbl\_settings\_get(&s\_file, KEY("runs"), &runs, sizeof(runs)) == -ENOENT) {printf("settings: first run on this flash\n");}runs++;ret = pbl\_settings\_set(&s\_file, KEY("runs"), &runs, sizeof(runs));if (ret \< 0) {fprintf(stderr, "settings: set failed (%d)\n", ret);goto close;}printf("settings: run %u\n", (unsigned int)runs);ret = pbl\_settings\_set(&s\_file, KEY("name"), "Pebble", strlen("Pebble"));if (ret == 0) {ret = pbl\_settings\_set(&s\_file, KEY("level"), &level, sizeof(level));}if (ret \< 0) {fprintf(stderr, "settings: set failed (%d)\n", ret);goto close;}/\* Leave room for the terminator. \*/len = pbl\_settings\_get\_len(&s\_file, KEY("name"));ret = len \< sizeof(name) ? pbl\_settings\_get(&s\_file, KEY("name"), name, len) : -ENOSPC;printf("settings: name is %s\n", ret == 0 ? name : "missing");level = 0;ret = pbl\_settings\_get(&s\_file, KEY("level"), &level, sizeof(level));printf("settings: level is %u\n", ret == 0 ? level : 0U);printf("settings: reading 4 bytes of a 1-byte value: %s\n",pbl\_settings\_get(&s\_file, KEY("level"), &runs, sizeof(runs)) == -ERANGE ? "-ERANGE" : "read");pbl\_settings\_each(&s\_file, prv\_print\_record, &count);printf("settings: %u records\n", count);ret = pbl\_settings\_delete(&s\_file, KEY("level"));if (ret \< 0) {fprintf(stderr, "settings: delete failed (%d)\n", ret);goto close;}printf("settings: level exists after deleting it: %s\n",pbl\_settings\_exists(&s\_file, KEY("level")) ? "yes" : "no");printf("Sample done\n");close:pbl\_settings\_close(&s\_file);return ret;}
```

## Output

```
settings: changed runs
settings: run \d+
settings: changed name
settings: changed level
settings: name is Pebble
settings: level is 3
settings: reading 4 bytes of a 1-byte value: -ERANGE
settings: 3 records
settings: changed level
settings: level exists after deleting it: no
Sample done
```

Generated from PebbleOS [7753e801d](https://github.com/coredevices/pebbleos/commit/7753e801d93d20f2d37534ce2fa69d9952015237). This page is maintained in the pebbleos repository: [docs/samples/subsys/settings/store.md](https://github.com/coredevices/pebbleos/blob/7753e801d93d20f2d37534ce2fa69d9952015237/docs/samples/subsys/settings/store.md).
