OVOS-config

helper package to interact with the OVOS configuration

Configuration stack

OVOS merges several configuration files into a single configuration. They are loaded in the following order, with later layers overriding earlier ones:

So the effective priority is user > assistant > system > distribution > default.

AssistantConfig (runtime.conf) is the place for OVOS components (skills and plugins, e.g. automatic location detection) to persist runtime changes. Keeping these writes out of the user config means OVOS can never accidentally corrupt or overwrite settings the user authored. Use update_assistant_config(config, bus) to write to it programmatically.

Remote configuration (the old Mycroft Home / mycroft.ai backend) has been removed. RemoteConf and the Mycroft*-prefixed config classes remain as deprecated aliases and will be dropped in a future release.

Command Line usage

A small helper tool is included to quickly show, get or set config values

Quick rundown (cli):

• ovos-config get

  • Loose search (search a key or parts therof):
    
    Given an entry of

    {'PHAL': {
            'ovos-PHAL-plugin-system': {
                    'enabled': True
            },
            'ovos-PHAL-plugin-connectivity-events': {
                    'enabled': True
            },
            ... 
    }
    

    ovos-config get -k phal would yield all PHAL entries and present it to the user (and the path where they were found)

  • Strict search (search keys in a distinct location):

    ovos-config get -k /PHAL/ovos-PHAL-plugin-system/enabled

    This will output only the value or exit out if no key is found (root slash indicating a strict search)

• ovos-config set

  • Searches loosely for keys containing the query string and presents a choice to the user to define a value

    ovos-config set -k phal

    

    The type is derived from the joined config and thus can be safely cast into the user conf.
    Optionally a value (-v) can be sent as an argument.

• ovos-config autoconfigure

  Merges the recommended settings for a language (and optionally a platform, offline or online engines, and a voice) into the user configuration. The base recommends for each language include its localised wake_up word, which ends sleep mode, and its stop_recording word, which ends recording mode, each under the same hotword key in every language.

• ovos-config show

  • Get a full table of either the joined, user (-u), system (-s) or assistant (-a) configuration. This can be further refined by passing a --section, which can be listed with ovos-config show -l