Improve docs within mycroft-conf
Clarified the merging process.  Also remove unused skill-sepecif settings.
// '/etc/mycroft/mycroft.conf'), or at the USER level (typically in the
// file '~/.mycroft/mycroft.conf').
//
- // The Override: comment indicates at what level (if any) this is
- // overridden by the system to a value besides the default shown here.
+ // The load order of settings is:
+ // DEFAULT
+ // REMOTE
+ // SYSTEM
+ // USER
+ //
+ // The Override: comments below indicates where these settings are generally
+ // set outside of this file. The load order is always followed, so an
+ // individual systems can still apply changes at the SYSTEM or USER levels.
// Language used for speech-to-text and text-to-speech.
// Code is a BCP-47 identifier (https://tools.ietf.org/html/bcp47), lowercased
// TODO: save unmodified, lowercase upon demand
- // Override: none
"lang": "en-us",
// Measurement units, either 'metric' or 'english'
"opt_in": false,
// Play a beep when system begins to listen?
- // Override: none
"confirm_listening": true,
// File locations of sounds to play for system events
- // Override: none
"sounds": {
"start_listening": "snd/start_listening.wav",
"end_listening": "snd/end_listening.wav"
},
// General skill values
- // Override: none
"skills": {
// Directory to look for user skills
"directory": "~/.mycroft/skills",
},
// Address of the REMOTE server
- // Override: none
"server": {
"url": "https://api.mycroft.ai",
"version": "v1",
},
// The mycroft-core messagebus' websocket
- // Override: none
"websocket": {
"host": "0.0.0.0",
"port": 8181,
},
// Settings used for any precise wake words
- // Override: none
"precise": {
"dist_url": "https://raw.githubusercontent.com/MycroftAI/precise-data/dist/",
"models_url": "https://raw.githubusercontent.com/MycroftAI/precise-data/models/"
},
// Level of logs to store, one of "CRITICAL", "ERROR", "WARNGIN", "INFO", "DEBUG"
- // Override: none
"log_level": "DEBUG",
// Messagebus types that will NOT be output to logs
- // Override: none
"ignore_logs": ["enclosure.mouth.viseme", "enclosure.mouth.display"],
// Settings related to remote sessions
// be removed from this file.
// =================================================================
- "wifi": {
- "setup": false
- },
"ConfigurationSkill": {
"max_delay": 60
},
- "WikipediaSkill": {
- "max_results": 5,
- "max_phrases": 2
- },
"WolframAlphaSkill": {
"api_key": "",
"proxy": true
},
"WeatherSkill": {
"api_key": "",
- "proxy": true,
- "temperature": "fahrenheit"
+ "proxy": true
},
"NPRNewsSkill": {
"url_rss": "http://www.npr.org/rss/podcast.php?id=500005"
