new UserConfig(registry)
Setup the user configuration handler and listeners
Parameters:
Name | Type | Description |
---|---|---|
registry |
Registry | the core registry |
- Since:
- 1.1.0
Extends
Members
-
Defaults :Object.<string, (boolean|number|string)>
-
The default user config values that the core controls
-
protected logSource :string
-
The module name to use in UI logs
- Overrides:
-
protected registry :Registry
-
the core registry
- Overrides:
-
protected system :EventEmitter
-
the application's event smitter
- Overrides:
Methods
-
protected bank() → {BankController}
-
Returns:
BankController - the core bank controller- Overrides:
-
protected db() → {Database}
-
Returns:
Database - the core database library- Overrides:
-
protected elgatoDM() → {DeviceController}
-
Returns:
DeviceController - the core device controller- Overrides:
-
get(cloneopt) → {Object.<string, (boolean|number|string)>}
-
Get all of the user configurable settings
Parameters:
Name Type Attributes Default Description clone
boolean <optional>
false `true` if a clone is needed instead of a link Returns:
Object.<string, (boolean|number|string)> - the key/value pairs -
getKey(cloneopt) → {boolean|number|string}
-
Get a specific use config setting
Parameters:
Name Type Attributes Default Description clone
boolean <optional>
false `true` if a clone is needed instead of a link Returns:
boolean | number | string - the config value -
protected graphics() → {Graphics}
-
Returns:
Graphics - the core graphics controller- Overrides:
-
protected instance() → {InstanceController}
-
Returns:
InstanceController - the core instance controller- Overrides:
-
protected io() → {InterfaceClient}
-
Returns:
InterfaceClient - the core interface client- Overrides:
-
protected log(level, message)
-
Send a log message to the UI
Parameters:
Name Type Description level
string 'debug' | 'info' | 'warn' | 'error' message
atring the message to print - Overrides:
-
protected page() → {PageController}
-
Returns:
PageController - the core page controller- Overrides:
-
protected schedule() → {ScheduleController}
-
Returns:
ScheduleController - the core schedule controller- Overrides:
-
protected services() → {ServiceController}
-
Returns:
ServiceController - the core service controller- Overrides:
-
setKey(key, value)
-
Save/update a key/value pair to the user config
Parameters:
Name Type Description key
string the key to save under value
boolean | number | string the object to save Fires:
-
protected userconfig() → {UserConfig}
-
Returns:
UserConfig - the core user config manager- Overrides: