Configuration

The top-level configuration file of an application is named application.yaml and defines what modules form the application and what is the configuration of each module.

Recommendation

It is not strictly required to name the file application.yaml, but please do. We also recommend placing the whole configuration into a separate folder named after the application (e.g. vokovice01 if your neighborhood is Vokovice).

application.yaml file

An example:

version: '1'
modules:
    meadow:
    influxdb:
    pan:
    gateway:
        local-can-id: 0x1f0
    homeserver_main:
        type: homeserver
        login: mylogin:mypassword
    homeserver_testing:
        type: homeserver
        login: test:test
    hapbridge:
        config: ./homekit/config.yaml
    grafana:

version

Version field denotes the version of the configuration file. Currently has to be 1.

modules

Defines what modules will form the application. Each module has its unique name within the application (in the example above: gateway, homeserver_main, homeserver_testing, …). It also has its type. The type can be omitted if it’s the same as the module’s name. The rest is module-specific and documented for each module separately.

<module name>:
    type: <module type> // can be omitted if it's the same as <module name>
    ... // the rest depends on the <module type>

For configuration of each module, see Modules.