Configuration Base Class

This base class defines the required configuration management API. The API includes all provisioned configuration endpoints.

class firmware.config_base.ConfigBase

Bases: object

This class defines the required configuration management API, which is pretty minimal, but provides everything needed to provision a box.

establish_config(screen: ScreenBase | None = None) → None

Call this at boot to initialize this config class, either by drawing from an existing runtime configuration file, or by creating a new one.

Parameters:

screen – If provided, this allows for the configuration class to interact with the user.

Returns:

Nothing

github_token() → str

Provides the user-entered GitHub token, which should have write access to the repo.

Returns:

A string GitHub token, like ghp_abc123….

wifi_networks() → dict

Provides all known Wi-Fi networks, including any defaults and additional entries.

Returns:

A dict of Wi-Fi entries, with keys as network names and values as network passwords