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

Option

Description

Default

settings
object

Properties

Option

Description

Default

locale
string

The default language

"en"

debug
boolean

Turn on debug checks. Set the logLevel to debug to additional outputs

false

authentication
object

Properties

Option	Description	Default
enabled boolean	Disable http-basic-authentication	true
secret	Secret string used for cookie signing. Should be kept secret! If it is not set, then a secret string will be generated for you, at first start. The secret string must be at least 32 characters long.
loginTime integer	The time in milliseconds to keep the session cookie if rememberMe is checked. If 0 then the cookie will be deleted on browser close.	315360000000

logLevel
string

The log level: debug, info, warn, error

"info"

httpServer
object

Properties

Option	Description	Default
enabled boolean	Should the HTTP-server be started	true
port integer	The port of the HTTP-server	80
hostname string	The hostname of the HTTP-server	""
socket string	The UNIX Socket of the HTTP-server	""

httpsServer
object

Properties

Option	Description	Default
enabled boolean	Should the HTTPS-server be started	false
port integer	The port of the HTTPS-server	443
hostname string	The hostname of the HTTPS-server	""
keyFile string	Private-Key file	"ca/pimatic-ssl/private/privkey.pem"
certFile string	Public certification file in pem-format	"ca/pimatic-ssl/public/cert.pem"
rootCertFile string	The public root certificate file of your own CA if you are using a self signed certificate. This is optional. It's just for the frontend, so that it can provide a link to the the root certificate for easy importing in mobile devices.	"ca/certs/cacert.crt"

cors
object

Properties

database
object

Properties

Option

Description

Default

client
string

The database client to use

"sqlite3"

connection
object

The connection settings for the database client

{
  "filename": "pimatic-database.sqlite"
}

deviceAttributeLogging
array of objects

Defines time constraints on how attribute value changes of logged devices shall be kept in the database. Constraints will be evaluated sequentially where a subsequent constraint may override the previous one. A constraint can be defined by device id, attribute name, and attribute type. See also Database configuration howto

[
  {
    "deviceId": "*",
    "attributeName": "*",
    "type": "*",
    "interval": "0",
    "expire": "7d"
  },
  {
    "deviceId": "*",
    "attributeName": "*",
    "type": "continuous",
    "interval": "5min",
    "expire": "7d"
  },
  {
    "deviceId": "*",
    "attributeName": "temperature",
    "type": "number",
    "expire": "1y"
  },
  {
    "deviceId": "*",
    "attributeName": "humidity",
    "type": "number",
    "expire": "1y"
  }
]

Elements

Option	Description	Default
deviceId string	The deviceId of the logged device or "*" for all devices in the matching context
attributeName string	The name of the attribute or "*" for all attributes in the matching context
type string	The type of the attribute mapping, one of: "number", "string", "boolean", "date", "discrete", "continuous", "". The default, "" is used for all applicable attribute types in the matching context	"*"
interval string	A time duration constraint on the minmum time interval between attribute value changes stored in database. If absent all attribute value changes will stored in the database. The duration is provided in miliseconds if no unit is provided. Supported units are: ms, second, seconds, s, minute, minutes, m, hour, hours, h, day, days, d, year, years, y
expire string	A time duration constraint on how long attribute values shall be kept in the database. The duration is provided in miliseconds if no unit is provided. Supported units are: ms, second, seconds, s, minute, minutes, m, hour, hours, h, day, days, d, year, years, y

messageLogging
array

Time to keep logged messages in database

[
  {
    "level": "*",
    "tags": [],
    "expire": "7d"
  },
  {
    "level": "debug",
    "tags": [],
    "expire": "0"
  }
]

deleteExpiredInterval
string

Interval for deleting expired entries from the database

"2h"

diskSyncInterval
string

Interval for writing logged entries to disk. If this value is smaller than the deleteExpiredInterval setting, then the value of this setting is used instead. Should be a multiple of deleteExpiredInterval.

"4h"

debug
boolean

Enable to show database queries and some additional outputs

false

gui
object

Properties

defaultMaxListeners
number

The number of listeners which can be registered for any single event (soft limit)

pages
array of objects

Array of GUI pages

[]

Elements

Option

Description

Default

id
string

name
string

allowedRoles
array

The roles allowed for accessing the page. If absent roles are granted access.

devices
array of objects

[]

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

Option

Description

Default

name
string

permissions
object

Properties

Option	Description	Default
pages string	Allow to list all pages with its devices (read) or edit existing pages (write)	"none"
rules string	Allow to list all rules (read) or edit existing rules (write)	"none"
variables string	Allow to list all variables (read) or edit existing variables (write)	"none"
messages string	Allow to list all messages (read) or delete existing messages (write)	"none"
events string	Allow to list all events (read) or delete existing events (write)	"none"
devices string	Allow to list all devices (read) or edit existing devices (write)	"none"
groups string	Allow to list all groups (read) or edit existing groups (write)	"none"
users string	Allow to list all users (read) or edit existing users (write)	"none"
plugins string	Allow to list all plugins (read) or edit existing plugins (write)	"none"
updates string	Allow to search for updates or additional do updating	"none"
config string	Allow to show the config (read) or edit existing config (write)	"none"
database string	Allow read and or write to the database	"none"
controlDevices boolean	Allow to control devices (switches, buttons, ...)	false
restart boolean	Allow to restart pimatic	false

Device Config Options

pimatic device config schemas

ButtonsDevice

ButtonsDevice config

Option

Description

Default

enableActiveButton
boolean

Highlight last pressed button if enabled

true

buttons
array of objects

Buttons to display

[]

Elements

InputDevice

InputDevice config

Option	Description	Default
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

VariablesDevice

VariablesDevice config

Option

Description

Default

variables
array of objects

Variables to display

[]

Elements

Option	Description	Default
name string	Name for the corresponding attribute.
expression string	The expression to use to get the value. Can be just a variable name ($myVar), a calculation ($myVar + 10) or a string interpolation ("Test: {$myVar}!")
type string	The type of the variable.	"string"
unit string	The unit of the variable. Only works if type is a number.
label string	A custom label to use in the frontend.
discrete boolean	Should be set to true if the value does not change continuously over time.
acronym string	Acronym to show as value label in the frontend

VariableInputDevice

VariableInputDevice config

Option	Description	Default
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

VariableTimeInputDevice config

Option	Description	Default
variable string	The variable to modify on input change
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

Option	Description	Default
rollingTime number	Approx. amount of time (in seconds) for shutter to close or open completely.	10

DummyContactSensor

DummyContactSensor config

DummyPresenceSensor

DummyPresenceSensor config

Option	Description	Default
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

Option	Description	Default
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

Option	Description	Default
resolution number	The interval the timer is updated in seconds	1