Skill Settings

Search…
Skill Settings
Skill settings allow users to customize their experience or authenticate with external services. Learn how to create and use settings in your Skill.
Skill settings provide the ability for users to configure a Skill using a web-based interface. This is often used to:
Change default behaviors - such as the sound used for users alarms.
Authenticate with external services - such as Spotify
Enter longer data as text rather than by voice - such as the IP address of the users Home Assistant server.
Skill settings are completely optional.
Define settings for a Skill
To define our Skills settings we use a settingsmeta.json or settingsmeta.yaml file. This file must be in the root directory of the Skill and must follow a specific structure.
Example settings file
To see it in action, lets look at a simple example from the Mycroft Date-Time Skill. First using the JSON syntax as a settingsmeta.json file:
1
{
2
    "skillMetadata": {
3
        "sections": [
4
            {
5
                "name": "Display",
6
                "fields": [
7
                    {
8
                        "name": "show_time",
9
                        "type": "checkbox",
10
                        "label": "Show digital clock when idle",
11
                        "value": "true"
12
                    }
13
                ]
14
            }
15
        ]
16
    }
17
}
Copied!
Now, here is the same settings, as it would be defined with YAML in a settingsmeta.yaml file:
1
skillMetadata:
2
   sections:
3
      - name: Display
4
        fields:
5
          - name: show_time
6
            type: checkbox
7
            label: Show digital clock when idle
8
            value: "true"
Copied!
Notice that the value of false is surrounded by "quotation marks". This is because Mycroft expects a string of "true" or "false" rather than a Boolean.
Both of these files would result in the same settings block.
It is up to your personal preference which syntax you choose.
Structure of the settingsmeta file
Whilst the syntax differs, the structure of these two filetypes is the same. This starts at the top level of the file by defining a skillMetadata object. This object must contain one or more sections elements.
Sections
Each section represents a group of settings that logically sit together. This enables us to display the settings more clearly in the web interface for users.
In the simple example above we have just one section. However the Spotify Skill settings contains two sections. The first is for Spotify Account authentication, and the second section contains settings to define your default playback device.
Each section must contain a name attribute that is used as the heading for that section, and an Array of fields.
Fields
Each section has one or more fields. Each field is a setting available to the user. Each field takes four properties:
name (String)
The name of the field is used by the Skill to get and set the value of the field. It will not usually be displayed to the user, unless the label property has not been set.
type (Enum)
The data type of this field. The supported types are:
text: any kind of text
email: text validated as an email address
checkbox: boolean, True or False
number: text validated as a number
password: text hidden from view by default
select: a drop-down menu of options
label: special field to display text for information purposes only. No name or value is required for a label field.
label (String)
The text to be displayed above the setting field.
value (String)
The initial value of the field.
Examples for each type of field are provided in JSON and YAML at the end of this page.
Using settings in your Skill
Once settings have been defined using a settingsmeta file, they will be presented to the user on their personal Skill Settings page.
When settings are fetched from the Mycroft server, they are saved into a settings.json file. This file is automatically created when a Skill is loaded even if the Skill does not have any settings. Your Skill then accesses the settings from this file. Nowadays the file is located in the Skill's XDG_CONFIG_DIR (usually ~/config/mycroft/skills/<skillname>), however if a settings.json file already exists in the Skill's root directory (the deprecated location) that location is used for compatibility.
Reading settings
Skill settings are available on the MycroftSkill class and inherit from a Python Dict. This means that you can use it just like you would any other Python dictionary.
To access the show_time variable from our example above we would use the Dict.get method:
1
self.settings.get('show_time')
Copied!
If the setting we are trying to access is not available, the get method will return None. Instead of assigning this to a variable and then testing for None, we can provide a default value as the second argument to the get method.
1
self.settings.get('show_time', False)
Copied!
In this example, if the settings have not been received, or the show_time setting has not been assigned, it will return the default value False.
A few warnings
We recommend using the Dict.get method above rather than accessing the setting directly with:
1
self.settings['show_time']
Copied!
Directly referencing the value may throw a KeyError if the setting has not yet been fetched from the server.
It is also important to note that the settings dictionary will not be available in your Skills __init__ method as this is setting up your Skills Class. You should instead use an initialize method which is called after the Skill is fully constructed and registered with the system. More detail is available at:
Lifecycle Methods
Handling settings changes
Each Mycroft device will check for updates to a users settings regularly, and write these to the Skills settings.json. To perform some action when settings are updated, you can register a callback function in your Skill.
1
def initialize(self):
2
  self.settings_change_callback = self.on_settings_changed
3
  self.on_settings_changed()
4
​
5
def on_settings_changed(self):
6
  show_time = self.settings.get('show_time', False)
7
  self.trigger_time_display(show_time)
Copied!
In the example above, we have registered the on_settings_changed method to be our callback function. We have then immediately called the method to perform the relevant actions when the Skill is being initialized even though the Skills settings have not changed.
In the on_settings_changed method we have assigned the value of the show_time setting to a local variable. Then we have passed it as an argument to another method in our Skill that will trigger the display of the time based on its value.
Writing to settings
Your Skill can reassign a setting locally, however these values remain local and cannot be pushed to the server. To do this we assign a value like you would with any other dictionary key.
1
self.settings['show_time'] = True
Copied!
The new value for the show_time setting will persist until a new setting is assigned locally by the Skill, or remotely by the user clicking save on the web view.
Settings Field Examples
Label Field
JSON
YAML
1
{
2
    "skillMetadata": {
3
        "sections": [
4
            {
5
                "name": "Label Field Example",
6
                "fields": [
7
                    {
8
                        "type": "label",
9
                        "label": "This is descriptive text."
10
                    }
11
                ]
12
            }
13
        ]
14
    }
15
}
Copied!
1
skillMetadata:
2
   sections:
3
      - name: Label Field Example
4
        fields:
5
          - type: label
6
            label: This is descriptive text.
Copied!
Text Field
JSON
YAML
1
{
2
    "skillMetadata": {
3
        "sections": [
4
            {
5
                "name": "Text Field Example",
6
                "fields": [
7
                    {
8
                        "name": "my_string",
9
                        "type": "text",
10
                        "label": "Enter any text",
11
                        "value": ""
12
                    }
13
                ]
14
            }
15
        ]
16
    }
17
}
Copied!
1
skillMetadata:
2
   sections:
3
      - name: Text Field Example
4
        fields:
5
          - name: my_string
6
            type: text
7
            label: Enter any text
8
            value:
Copied!
Email
JSON
YAML
1
{
2
    "skillMetadata": {
3
        "sections": [
4
            {
5
                "name": "Email Field Example",
6
                "fields": [
7
                    {
8
                        "name": "my_email_address",
9
                        "type": "email",
10
                        "label": "Enter your email address",
11
                        "value": ""
12
                    }
13
                ]
14
            }
15
        ]
16
    }
17
}
Copied!
1
skillMetadata:
2
   sections:
3
      - name: Email Field Example
4
        fields:
5
          - name: my_email_address
6
            type: email
7
            label: Enter your email address
8
            value:
Copied!
Checkbox
JSON
YAML
1
{
2
    "skillMetadata": {
3
        "sections": [
4
            {
5
                "name": "Checkbox Field Example",
6
                "fields": [
7
                    {
8
                        "name": "my_boolean",
9
                        "type": "checkbox",
10
                        "label": "This is an example checkbox. It creates a Boolean value.",
11
                        "value": "false"
12
                    }
13
                ]
14
            }
15
        ]
16
    }
17
}
Copied!
1
skillMetadata:
2
   sections:
3
      - name: Checkbox Field Example
4
        fields:
5
          - name: my_boolean
6
            type: checkbox
7
            label: This is an example checkbox. It creates a Boolean value.
8
            value: "false"
Copied!
Number
JSON
YAML
1
{
2
    "skillMetadata": {
3
        "sections": [
4
            {
5
                "name": "Number Field Example",
6
                "fields": [
7
                    {
8
                        "name": "my_number",
9
                        "type": "number",
10
                        "label": "Enter any number",
11
                        "value": "7"
12
                    }
13
                ]
14
            }
15
        ]
16
    }
17
}
Copied!
1
skillMetadata:
2
   sections:
3
      - name: Number Field Example
4
        fields:
5
          - name: my_number
6
            type: number
7
            label: Enter any number
8
            value: 7
Copied!
Password
JSON
YAML
1
{
2
    "skillMetadata": {
3
        "sections": [
4
            {
5
                "name": "Password Field Example",
6
                "fields": [
7
                    {
8
                        "name": "my_password",
9
                        "type": "password",
10
                        "label": "Enter your password",
11
                        "value": ""
12
                    }
13
                ]
14
            }
15
        ]
16
    }
17
}
Copied!
1
skillMetadata:
2
   sections:
3
      - name: Password Field Example
4
        fields:
5
          - name: my_password
6
            type: password
7
            label: Enter your password
8
            value:
Copied!
Select
JSON
YAML
1
{
2
    "skillMetadata": {
3
        "sections": [
4
            {
5
                "name": "Select Field Example",
6
                "fields": [
7
                    {
8
                      "name": "my_selected_option",
9
                      "type": "select",
10
                      "label": "Select an option",
11
                      "options": "Option 1|option_one;Option 2|option_two;Option 3|option_three",
12
                      "value": "option_one"
13
                    }
14
                ]
15
            }
16
        ]
17
    }
18
}
Copied!
1
skillMetadata:
2
   sections:
3
      - name: Select Field Example
4
        fields:
5
          - name: my_selected_option
6
            type: select
7
            label: Select an option
8
            options: Option 1|option_one;Option 2|option_two;Option 3|option_three
9
            value: option_one
Copied!
Logging
Dependencies
Last modified 1yr ago
Copy link
Contents
Define settings for a Skill
Example settings file
Structure of the settingsmeta file
Using settings in your Skill
Reading settings
Handling settings changes
Writing to settings
Settings Field Examples