Hello fellow forum members and experts.
I hope that somebody can steer me in the right direction as to setting up an connection to an API provided by the sauna supplier HUUM.
There are several options available via the HS4 (latest firmware and QC software level) and / or possibly also the use of various logic blocks in the logic editor.
Within HS4 there are the IP/KNX telegrams (send/receive) and also Web pages / IP devices options and I am unsure which of these to use and setup.
The API from HUUM has been supplied with the following documentation. I need to both send variables and also receive responces from the API.
------------
GET - api.huum.eu/action/home/status - returns your current sauna status
POST - api.huum.eu/action/home/start - wants targetTemperature as a parameter, which must be a number between 40 and 110. startDate and endDate are optional parameters to send the start and end time for the sauna. If they are missing the sauna will be started instantly for the max heating time configured from the controller(default 3). If you are using a humidifier with our controller you can also set the value with the parameter humidity. The value should be between 0-10
POST - api.huum.eu/action/home/stop - turns off the sauna
GET - api.huum.eu/action/home/light - switches the light without any parameters, if the ?light=1 or ?light=0 is set then sets the light to the required state.
Basic authentication should be used and all requests must be over a https connection. The username and password are the same as in the app and the user must be connected to the sauna.
All requests return the current state of the sauna in JSON: ({"statusCode": 232, "door": true, "temperature": "23", "targetTemperature": "50", "startDate": 1507184846, "endDate": 1507184846, "duration": 0, "config": 2, "steamerError": 0, "paymentEndDate" : SOMEDATE, “humidity” : 4, “light” : 1})
statusCode: 230 - sauna offline, 231 - online and heating, 232 sauna online but not heating, 233 sauna is being used by another user and is locked, 400 sauna is put to emergency stop
door: true - the door is closed, false - the door is open and sauna can't be started
temperature: The current temperature of the sauna
targetTemperature: The temperature the sauna is trying to reach
startDate: heating start time in UNIX
endDate: heating end time
duration: time of the remaining heating period
config: 2 shows that the controller is configured to use a light system, 1 shows that the controller is configured to use a steamer system, 3 shows that the controller is configured to use both the light and steamer system .
steamerError: if 1 then the steamer is empty of water and needs to be refilled also no steamer start is allowed
light: 1 if light is turned on, 0 if off
humidity: 0-10 the value for the humidity setting
paymentEndDate: shows the date when the payment period is ending. Only relevant for GSM controllers with our SIM card.
maxHeatingTime: Shows the maximum heating time for the controller in h
-------------
Can anybody assist me in getting started? There are also a few developed Homebridge plug-ins that use the API.
Many thanks in beforehand.
Kind regards Rolf
I hope that somebody can steer me in the right direction as to setting up an connection to an API provided by the sauna supplier HUUM.
There are several options available via the HS4 (latest firmware and QC software level) and / or possibly also the use of various logic blocks in the logic editor.
Within HS4 there are the IP/KNX telegrams (send/receive) and also Web pages / IP devices options and I am unsure which of these to use and setup.
The API from HUUM has been supplied with the following documentation. I need to both send variables and also receive responces from the API.
------------
GET - api.huum.eu/action/home/status - returns your current sauna status
POST - api.huum.eu/action/home/start - wants targetTemperature as a parameter, which must be a number between 40 and 110. startDate and endDate are optional parameters to send the start and end time for the sauna. If they are missing the sauna will be started instantly for the max heating time configured from the controller(default 3). If you are using a humidifier with our controller you can also set the value with the parameter humidity. The value should be between 0-10
POST - api.huum.eu/action/home/stop - turns off the sauna
GET - api.huum.eu/action/home/light - switches the light without any parameters, if the ?light=1 or ?light=0 is set then sets the light to the required state.
Basic authentication should be used and all requests must be over a https connection. The username and password are the same as in the app and the user must be connected to the sauna.
All requests return the current state of the sauna in JSON: ({"statusCode": 232, "door": true, "temperature": "23", "targetTemperature": "50", "startDate": 1507184846, "endDate": 1507184846, "duration": 0, "config": 2, "steamerError": 0, "paymentEndDate" : SOMEDATE, “humidity” : 4, “light” : 1})
statusCode: 230 - sauna offline, 231 - online and heating, 232 sauna online but not heating, 233 sauna is being used by another user and is locked, 400 sauna is put to emergency stop
door: true - the door is closed, false - the door is open and sauna can't be started
temperature: The current temperature of the sauna
targetTemperature: The temperature the sauna is trying to reach
startDate: heating start time in UNIX
endDate: heating end time
duration: time of the remaining heating period
config: 2 shows that the controller is configured to use a light system, 1 shows that the controller is configured to use a steamer system, 3 shows that the controller is configured to use both the light and steamer system .
steamerError: if 1 then the steamer is empty of water and needs to be refilled also no steamer start is allowed
light: 1 if light is turned on, 0 if off
humidity: 0-10 the value for the humidity setting
paymentEndDate: shows the date when the payment period is ending. Only relevant for GSM controllers with our SIM card.
maxHeatingTime: Shows the maximum heating time for the controller in h
-------------
Can anybody assist me in getting started? There are also a few developed Homebridge plug-ins that use the API.
Many thanks in beforehand.
Kind regards Rolf