home-automaton

README

Home Automation

Distributed home automation system written in a variety of languages. Largely a learning opportunity rather than a production-ready system.

API Specification

All responses will have the form:

{
    "data": "Mixed type holding the content of the response"
}

Individual service's READMEs will only detail the expected value of the data field.

Errors

An error will be indicated by a non-2xx status code. The response will include a message.

{
    "message": "Description of what went wrong"
}

Controllers

Controllers must implement a standardised interface for fetching and updating device state.

GET service.controller.x/device/<device-identifier>

• 200: success

{
    "identifier": "table-lamp",
    "name": "Table Lamp",
    "type": "light",
    "controller_name": "service.controller.hue",
    "state": {
        "brightness": {
            "type": "int",
            "min": 0,
            "max": 254,
            "interpolation": "continuous",
            "value": 100
        }
    }
}