Configuring Interfaces

Interfaces are a method of interacting with the controller from a client perspective, such as HTTP(S), WS(S), MQTT or other such technologies. These are not devices that can be controlled, please see Configuring Gateways for devices like Zigbee or ModBus controllers.

At current Interfaces must be configured by adding a file to the appropriate configuration directory, they can not yet be configured at runtime.

Configuration files must be located in the <config>/interfaces directory, see Running for the default location on your operating system, each interface is defined by a JSON file.

The name of the file will be the name of the interface, and may be refered to as such by an interface, or application running in the controller.

HTTP

The HTTP configuration file should contain a Config stanza with at least the Port to open the http server, and the APIS to enable. At current only v1 API is available.

{
    "Type": "http",
    "Config": {
        "Port": 3000,
        "EnabledAPIs": [
            "v1"
        ]
    }
}