pi_portal.modules.configuration.user_config

User configuration.

class pi_portal.modules.configuration.user_config.TypeUserConfig[source]

Typed representation of user configuration.

class pi_portal.modules.configuration.user_config.TypeUserConfigGPIO[source]

Typed representation of a GPIO connected device.

class pi_portal.modules.configuration.user_config.TypeUserConfigTemperatureSensors[source]

Typed representation of GPIO connected temperature sensors.

class pi_portal.modules.configuration.user_config.UserConfiguration[source]

User configuration.

load(file_path='config.json')[source]

Load and validate the end user’s configuration file.

Parameters:

file_path (str, default: 'config.json') – The path to the file to load.

Return type:

None

load_json_file(json_file_location)

Load a JSON file from the filesystem and return it as a Python object.

Parameters:

json_file_location (Union[Path, str]) – The path to the source file.

Return type:

Any

Returns:

The loaded JSON object.

validate()[source]

Validate the end user’s configuration file.

Raises:

UserConfigurationException

Return type:

None

exception pi_portal.modules.configuration.user_config.UserConfigurationException[source]

Raised during validation of end user configuration.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.