Fork me on GitHub

Configuration Options

This page lists all configuration options and device included in the pimatic core framework that can be used in the config.json file. See the Getting Started Guide for more details about it.

Config Options

pimatic config
OptionDescriptionDefault
settings
object
Properties
pages
array of objects
Array of GUI pages
[]
Elements
groups
array of objects
Array of groups
[]
Elements
plugins
array of objects
Array of plugins to load
[]
Elements
devices
array of objects
Array of device definitions
[]
Elements
rules
array of objects
Array of rules
[]
Elements
variables
array
Array of variables
[]
users
array of objects
Array of users
[
  {
    "username": "admin",
    "password": "",
    "role": "admin"
  }
]
Elements
roles
array of objects
Array of user roles
[
  {
    "name": "admin",
    "permissions": {
      "pages": "write",
      "rules": "write",
      "variables": "write",
      "messages": "write",
      "events": "write",
      "devices": "write",
      "groups": "write",
      "plugins": "write",
      "updates": "write",
      "config": "write",
      "controlDevices": true,
      "restart": true
    }
  },
  {
    "name": "resident",
    "permissions": {
      "pages": "read",
      "rules": "read",
      "variables": "read",
      "messages": "read",
      "events": "read",
      "devices": "none",
      "groups": "none",
      "plugins": "none",
      "updates": "none",
      "config": "none",
      "controlDevices": true,
      "restart": false
    }
  }
]
Elements

Device Config Options

pimatic device config schemas

ButtonsDevice

ButtonsDevice config
OptionDescriptionDefault
buttons
array of objects
Buttons to display
[]
Elements

VariablesDevice

VariablesDevice config
OptionDescriptionDefault
variables
array of objects
Variables to display
[]
Elements

VariableInputDevice

VariablesDevice config
OptionDescriptionDefault
variable
string
The variable to modify on input change
type
string
The type of the input
"string"
min
number
Minimum value for numeric values
max
number
Maximum value for numeric values
step
number
Step size for minus and plus buttons for numeric values
1

VariableTimeInputDevice

TimeVariablesDevice config
OptionDescriptionDefault
variable
string
The variable to modify on input change
type
string
The type of the input
"string"
min
string
Minimum time to be set
max
string
Maximum time to be set
step
number
Step size in minutes for minus and plus buttons
15

DummySwitch

DummySwitch config

DummyDimmer

DummyDimmer config

DummyShutter

DummyShutter config
OptionDescriptionDefault
rollingTime
number
Approx. amount of time (in seconds) for shutter to close or open completely.
10

DummyContactSensor

DummyContactSensor config

DummyPresenceSensor

DummyPresenceSensor config
OptionDescriptionDefault
autoReset
boolean
Reset the state to absent after resetTime
true
resetTime
integer
Time after that the presence value is reseted to absent.
10000

DummyHeatingThermostat

DummyHeatingThermostat config options
OptionDescriptionDefault
comfyTemp
number
The defined comfy temperature
21
ecoTemp
number
The defined eco mode temperature
17
guiShowValvePosition
boolean
Show the valve position in the GUI
true
guiShowModeControl
boolean
Show the mode buttons in the GUI
true
guiShowPresetControl
boolean
Show the preset temperatures in the GUI
true
guiShowTemperatureInput
boolean
Show the temperature input spinbox in the GUI
true

DummyTemperatureSensor

DummyTemperatureSensor config options

Timer

timer config
OptionDescriptionDefault
resolution
number
The interval the timer is updated in seconds
1