Configuration is done through config.yml The parent folder of the file can be specified with -c PATH or --config PATH. If nothing is specified the file config.yml is searched in the subdirectory HABApp in
- the current working directory
- the venv directory
- the user home
If the config does not yet exist in the folder a blank configuration will be created
directories:
logging: log # If the filename for the logfile in logging.yml is not absolute it will be placed in this directory
rules: rules # All *.py files in this folder (and subfolders) will be loaded. Load order will be alphabetical by path.
param: param # Optional, this is the folder where the parameter files will be created and loaded from
config: config # Folder from which configuration files for openHAB will be loaded
lib: lib # Custom modules, libraries and files can be placed there.
# (!) Attention (!):
# Don't create rule instances in files inside the lib folder! It will lead to strange behaviour.
location: # Specify the location where your HABApp instance is running
latitude: 0.0 # The value is used to calculate the Sunrise/Sunset etc accordingly
longitude: 0.0
elevation: 0.0
openhab:
ping:
enabled: true # If enabled the configured item will show how long it takes to send an update from HABApp
# and get the updated value back in milliseconds
item: 'HABApp_Ping' # Name of the NumberItem that will show the ping
interval: 10 # Seconds between two pings
connection:
url: http://localhost:8080
user: ''
password: ''
general:
listen_only: False # If True HABApp will not change any value on the openHAB instance.
# Useful for testing rules from another machine.
wait_for_openhab: True # If True HABApp will wait for items from the openHAB instance
# before loading any rules on startup
mqtt:
connection:
identifier: HABApp
host: ''
port: 8883
user: ''
password: ''
tls:
enabled: false # Enable TLS for the connection
insecure: false # Validate server hostname in server certificate
ca cert: '' # Path to a CA certificate that will be treated as trusted
# (e.g. when using a self signed certificate)
subscribe: # Changes to Subscribe get picked up without restarting HABApp
qos: 0 # Default QoS for subscribing
topics:
- '#' # Subscribe to this topic, qos is default QoS
- ['my/topic', 1] # Subscribe to this topic with explicit QoS
publish:
qos: 0 # Default QoS when publishing values
retain: false # Default retain flag when publishing values
general:
listen_only: False # If True HABApp will not publish any value to the broker.
# Useful for testing rules from another machine.It's possible to use environment variables and files (e.g. docker secrets) in the configuration. See the easyconfig documentation for the exact syntax and examples.
All possible configuration options are described here. Not all entries are created by default in the config file and one should take extra care when changing those entries.