MojoScale Studio Docs
API Reference

kv

Key-value storage native Berry module.

All modules Open Studio
Studio Docs Storage

import kv

The kv module provides lightweight persistent storage through firmware-backed NVS-style keys. Use it for small configuration values, flags, and last-known state.

Quick example

import kv
kv.set("mode", "auto")
mode = kv.get("mode", "manual")
exists = kv.exists("mode")

importkv

Key-value storage native Berry module.

The kv module provides lightweight persistent storage through firmware-backed NVS-style keys. Use it for small configuration values, flags, and last-known state.

API 5 available

kv.set(key: any, value: any) -> bool

Store a string value under a key.

Parameters
Name Type Pass as Required Description
key any positional or keyword Yes Storage key.
value any positional or keyword Yes Value to persist.
Returns

bool Boolean-like native success value.

kv.get(key: any, default: any = None) -> any

Read a value from storage.

Parameters
Name Type Pass as Required Description
key any positional or keyword Yes Storage key.
default any positional or keyword No Optional value returned when the key is missing.
Returns

any Stored value or the provided default.

kv.delete(key: any) -> bool

Delete a key from storage.

Parameters
Name Type Pass as Required Description
key any positional or keyword Yes Storage key to remove.
Returns

bool Boolean-like native success value.

kv.exists(key: any) -> bool

Check whether a key exists.

Parameters
Name Type Pass as Required Description
key any positional or keyword Yes Storage key.
Returns

bool True when the key exists, otherwise False.

kv.keys(prefix: any = None) -> list

List stored keys.

Parameters
Name Type Pass as Required Description
prefix any positional or keyword No Optional native prefix filter, if supported by firmware.
Returns

list List-like native value of key names.