home-iot-api (1.0.0)

Download OpenAPI specification:

The API for the EatBacon IOT project

Device

getDevices

returns all registered devices

query Parameters

skip	integer <int32> number of records to skip
limit	integer <int32> max number of records to return

Responses

Response samples

200

Content type

application/json

["http://10.0.0.225:8080"
]

register

Request Body schema: application/json

uri	string <uri>
id	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"uri": "http://10.0.0.220:8080",
"id": "0729a580-2240-11e6-9eb5-0002a5d5c51b"
}

Z-Wave

setDimmer

path Parameters

deviceId required	string
value required	integer <int32> [ 0 .. 100 ]

Responses

Response samples

200

Content type

application/json

{"code": 0,
"message": "everything is ok"
}

setDimmerTimer

sets a dimmer to a specific value on a timer

path Parameters

deviceId required	string
value required	integer <int32>
timeunit required	integer <int32>

query Parameters

units

string

Default: "milliseconds"

Enum: "seconds" "minutes" "milliseconds"

Responses

Response samples

200

Content type

application/json

{"code": 0,
"message": "everything is ok"
}

getSwitchState

path Parameters

deviceId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"lastUpdate": "2019-08-24T14:15:22Z",
"level": 0
}

setSwitch

path Parameters

deviceId required	string
value required	string Enum: "true" "false"

Responses

Response samples

200

Content type

application/json

{"code": 0,
"message": "everything is ok"
}

setSwitchTimer

sets a switch to a specific value on a timer

path Parameters

deviceId required	string
value required	string Enum: "true" "false"
minutes required	integer <int32>

Responses

Response samples

200

Content type

application/json

{"code": 0,
"message": "everything is ok"
}

getLightingSummary

Responses

Response samples

200

Content type

application/json

{"zones": [{"id": "string",
"name": "string",
"deviceId": 0,
"deviceType": "dimmer",
"zone": "string"
}
],
"zoneStatus": [{"id": "string",
"name": "string",
"lastUpdate": "2019-08-24T14:15:22Z",
"level": 0
}
]
}

Environment

temperatureSummary

Responses

Response samples

200

Content type

application/json

{"zones": [{"id": 0,
"name": "string",
"inputPosition": 0,
"outputPosition": 0,
"zone": "string"
}
],
"zoneStatus": [{"id": "string",
"name": "string",
"value": 0.1,
"units": "celsius",
"timestamp": "2019-08-24T14:15:22Z"
}
]
}

getForecast

path Parameters

days

required

integer <int32>

Responses

Response samples

200

Content type

application/json

{"city": {"id": 0,
"name": "string",
"lat": 0.1,
"lon": 0.1,
"country": "string"
},
"values": [{"date": "2019-08-24T14:15:22Z",
"pressure": 0.1,
"humidity": 0,
"windSpeed": 0.1,
"clouds": 0,
"temperature": {"low": 0.1,
"high": 0.1,
"morning": 0.1,
"day": 0.1,
"evening": 0.1,
"night": 0.1
},
"weather": {"summary": "string",
"description": "string",
"icon": "string"
}
}
]
}

getZoneTemperature

path Parameters

zoneId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"value": 0.1,
"units": "celsius",
"timestamp": "2019-08-24T14:15:22Z"
}

getHeaterState

gets the state of the heater

path Parameters

zoneId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"state": "string"
}

setHeaterState

turns the heater on or off

path Parameters

zoneId required	string
state required	string Enum: "false" "true"

Responses

Response samples

200

Content type

application/json

{"code": 0,
"message": "everything is ok"
}

Zones

getZones

Responses

Response samples

200

Content type

application/json

["string"
]

quietZone

path Parameters

zoneId

required

string

Enum: "basement" "first-floor" "second-floor"