openapi: 3.0.0
servers:
# Added by API Auto Mocking Plugin
- description: Local HTTP API
url: http://{APIUrl}
variables:
APIUrl:
default: "192.168.1.100"
description: Base Url to API
##########
## Info ##
##########
info:
version: "2.0.0"
title: Heatit WiFi7
description: The API documentation for WiFi7 relay mode.
contact:
name: Heatit Support
url: https://heatit.com/contact
email: post@heatit.com
termsOfService: https://heatit.com/terms-of-use-private
externalDocs:
description: Heatit's documents page
url: http://documents.heatit.com
##########
## Tags ##
##########
tags:
- name: "Status"
description: Get data from the device.
- name: "Parameters"
description: Change parameters on the device
- name: "BlueFusion"
description: Get data and change parameters on BlueFusion connected devices.
- name: "DirectLink"
description: Set and delete DirectLinks between devices.
- name: "Reset"
description: Reset settings, kwh or entire device to factory defaults
###########
## Paths ##
###########
paths:
/api/status:
get:
tags:
- Status
summary: Gets status of the device.
description: Returns all information about the device.
responses:
"200":
description: Get the information from the device.
content:
application/json:
schema:
$ref: "#/components/schemas/deviceInfo"
/api/parameters:
post:
tags:
- Parameters
summary: Change parameters on the device.
description: Change parameters on the device. At least one parameter is required.
parameters:
- $ref: "#/components/parameters/disableButtons"
- $ref: "#/components/parameters/sensorMode"
- $ref: "#/components/parameters/deviceRestoreState"
- $ref: "#/components/parameters/automaticTurnOff"
- $ref: "#/components/parameters/automaticTurnOn"
- $ref: "#/components/parameters/turnOffDelayTime"
- $ref: "#/components/parameters/invertedOutput"
- $ref: "#/components/parameters/alwaysOn"
- $ref: "#/components/parameters/internalSensorCalibration"
- $ref: "#/components/parameters/floorSensorCalibration"
- $ref: "#/components/parameters/externalSensorCalibration"
- $ref: "#/components/parameters/displayInformation"
- $ref: "#/components/parameters/activeDisplayBrightness"
- $ref: "#/components/parameters/standbyDisplayBrightness"
- $ref: "#/components/parameters/actionAfterError"
- $ref: "#/components/parameters/sizeOfLoad"
- $ref: "#/components/parameters/onOff"
responses:
"200":
description: Successful
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/disableButtons"
- $ref: "#/components/schemas/sensorMode"
- $ref: "#/components/schemas/deviceRestoreState"
- $ref: "#/components/schemas/automaticTurnOff"
- $ref: "#/components/schemas/automaticTurnOn"
- $ref: "#/components/schemas/turnOffDelayTime"
- $ref: "#/components/schemas/invertedOutput"
- $ref: "#/components/schemas/alwaysOn"
- $ref: "#/components/schemas/internalSensorCalibration"
- $ref: "#/components/schemas/floorSensorCalibration"
- $ref: "#/components/schemas/externalSensorCalibration"
- $ref: "#/components/schemas/displayInformation"
- $ref: "#/components/schemas/activeDisplayBrightness"
- $ref: "#/components/schemas/standbyDisplayBrightness"
- $ref: "#/components/schemas/actionAfterError"
- $ref: "#/components/schemas/sizeOfLoad"
- $ref: "#/components/schemas/onOff"
examples:
Disable buttons:
value:
status: Success
disableButtons: 1
Sensor mode:
value:
status: Success
sensorMode: 1
Device restore state:
value:
status: Success
deviceRestoreState: 0
Automatic turn off:
value:
status: Success
automaticTurnOff: 0
Automatic turn on:
value:
status: Success
automaticTurnOn: 0
Turn off delay time:
value:
status: Success
turnOffDelayTime: 0
Inverted output:
value:
status: Success
invertedOutput: false
Always on:
value:
status: Success
alwaysOn: false
Internal sensor calibration:
value:
status: Success
internalSensorCalibration: 0.0
Floor sensor calibration:
value:
status: Success
floorSensorCalibration: 0.0
External sensor calibration:
value:
status: Success
externalSensorCalibration: 0.0
Display information:
value:
status: Success
displayInformation: 0
Active display brightness:
value:
status: Success
activeDisplayBrightness: 0
Standby display brightness:
value:
status: Success
standbyDisplayBrightness: 0
Action after error:
value:
status: Success
actionAfterError: 0
Size of load:
value:
status: Success
sizeOfLoad: 0
On/Off:
value:
status: Success
onOff: 0
Multiple parameters at the same time:
value:
status: Success
disableButtons: 1
sensorMode: 1
deviceRestoreState: 0
automaticTurnOff: 0
automaticTurnOn: 0
turnOffDelayTime: 0
invertedOutput: false
alwaysOn: false
internalSensorCalibration: 0.0
floorSensorCalibration: 0.0
externalSensorCalibration: 0.0
displayInformation: 0
activeDisplayBrightness: 0
standbyDisplayBrightness: 0
actionAfterError: 0
sizeOfLoad: 0
onOff: 0
"400":
description: Failed
content:
application/json:
schema:
type: object
properties:
status:
type: string
reason:
type: string
examples:
Failed:
value:
status: failed
reason: out of range.
Failed2:
value:
status: failed
reason: invalid data.
"422":
description: Validation Error - At least one parameter needs to be changed
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: failed
reason:
type: string
example: You need to change at least one parameter.
example:
status: failed
reason: You need to change at least one parameter.
/api/reset/factory:
delete:
tags:
- Reset
summary: Reset the device to factory default.
description: Reset to factory defaults.
parameters:
- name: reset
description: Resets the device to factory defaults. This will reset network settings or remove the device from the app.
in: query
required: false
schema:
type: string
enum:
- Reset
responses:
"200":
description: Successful
content:
application/json:
schema:
type: object
properties:
reset:
$ref: "#/components/schemas/ResetInfo/properties/statusSuccess"
"400":
description: Failed
content:
application/json:
schema:
type: object
properties:
reset:
$ref: "#/components/schemas/ResetInfo/properties/statusFailed"
/api/reset/settings:
delete:
tags:
- Reset
summary: Reset settings to factory default.
description: Reset settings to factory defaults.
parameters:
- name: reset
description: Resets all settings to factory defaults. This will not reset network settings or remove the device from the app.
in: query
required: false
schema:
type: string
enum:
- Reset
responses:
"200":
description: Successful
content:
application/json:
schema:
type: object
properties:
reset:
$ref: "#/components/schemas/ResetInfo/properties/statusSuccess"
"400":
description: Failed
content:
application/json:
schema:
type: object
properties:
reset:
$ref: "#/components/schemas/ResetInfo/properties/statusFailed"
/api/reset/kwh:
delete:
tags:
- Reset
summary: Reset Kwh to 0.
description: Reset Kwh to zero.
parameters:
- name: reset
description: Resets the Kwh counter to 0.
in: query
required: false
schema:
type: string
enum:
- Reset
responses:
"200":
description: Successful
content:
application/json:
schema:
type: object
properties:
reset:
$ref: "#/components/schemas/ResetInfo/properties/statusSuccess"
"400":
description: Failed
content:
application/json:
schema:
type: object
properties:
reset:
$ref: "#/components/schemas/ResetInfo/properties/statusFailed"
/api/bluefusion/devices:
get:
tags:
- BlueFusion
summary: Get list of devices connected via BlueFusion
description: returns list of devices connected via BlueFusion
responses:
"200":
description: All devices connected via BlueFusion
content:
application/json:
schema:
$ref: "#/components/schemas/Devices"
"400":
description: Failed
content:
application/json:
schema:
type: object
properties:
reset:
$ref: "#/components/schemas/ResetInfo/properties/statusFailed"
/api/bluefusion/{id}/status:
get:
tags:
- BlueFusion
summary: Get information from the BlueFusion device
description: Returns all information about the BlueFusion device. See the documentation for each device for response schema.
responses:
"200":
description: All the devices
content:
application/json:
examples:
BLE-Temp3:
value:
id: sdf87g4bnfc87a523rbsdf4
name: BLE-Temp3 hall
room: hall
state: false
temperature: 22.2
parameters:
disableButton: 2
minimumTemperatureLimit: 8.5
maximumTemperatureLimit: 35.5
calibration: -2.5
regulationMode: false
temperatureControlHysteresis: 0.5
temperatureDisplay: false
activeDisplayBrightness: 10
directLink:
relayControl: []
masterThermostat: []
model: Heatit BLE-Temp3
firmware: 1.2.2
/api/bluefusion/{id}/parameters:
post:
tags:
- BlueFusion
summary: Adjust parameters on a BlueFusion device.
description: Adjust parameters on a BlueFusion connected device. See the documentation for each device for available parameters.
responses:
"200":
description: Successful
content:
application/json:
examples:
Disable Buttons:
value:
status: success
disableButton: 0
Minimum temperature limit (MIN):
value:
status: success
minimumTemperature: 8.5
Maximum temperature limit (MAX):
value:
status: success
maximumTemperature: 35.5
Sensor calibration (CAR):
value:
status: success
sensorCalibration: -1.0
Regulation mode (REG):
value:
status: success
regulationMode: false
Temperature control hysteresis:
value:
status: success
temperatureControlHysteresis: 0.5
Temperature display:
value:
status: success
temperatureDisplay: true
Active Display Brightness:
value:
status: success
activeDisplayBrightness: 10
Multiple parameters at the same time:
value:
status: success
disableButton: true
minimumTemperature: 5.0
maximumTemperature: 40.0
sensorCalibration: -1.2
regulationMode: false
temperatureControlHysteresis: 0.5
temperatureDisplay: true
activeDisplayBrightness: 10
standbyDisplayBrightness: 5
actionAfterError: 0
sizeOfLoad: 0
"400":
description: Failed
content:
application/json:
schema:
type: object
properties:
status:
type: string
reason:
type: string
examples:
Failed:
value:
status: failed
reason: out of range.
Failed2:
value:
status: failed
reason: invalid data.
"422":
description: Validation Error - At least one parameter needs to be changed
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: failed
reason:
type: string
example: You need to change at least one parameter.
example:
status: failed
reason: You need to change at least one parameter.
/api/bluefusion/{id}/reset/factory:
delete:
tags:
- BlueFusion
summary: Reset the BlueFusion device to factory default.
description: Reset the BlueFusion device to factory defaults. This will reset network settings or remove the device from the app.
parameters:
- name: reset
description: Reset the BlueFusion device to factory defaults.
in: query
required: false
schema:
type: string
enum:
- Reset
responses:
"200":
description: Successful
content:
application/json:
schema:
oneOf:
- type: object
properties:
status:
type: string
description: Status of the connection
- type: object
properties:
status:
type: string
description: Status of the connection
reason:
type: string
description: Reason for the connection
examples:
Success:
value:
status: success
Failed:
value:
status: failed
reason: no response from device
/api/bluefusion/{id}/reset/settings:
delete:
tags:
- BlueFusion
summary: Reset settings on a BlueFusion device to factory default.
description: Reset settings on a BlueFusion device to factory defaults. This will not reset network settings or remove the device from the app.
parameters:
- name: resetSettings
description: Resets all settings to factory defaults. This will not reset network settings or remove the device from the app.
in: query
required: false
schema:
type: string
enum:
- Reset
responses:
"200":
description: Successful
content:
application/json:
schema:
oneOf:
- type: object
properties:
status:
type: string
description: Status of the connection
- type: object
properties:
status:
type: string
description: Status of the connection
reason:
type: string
description: Reason for the connection
examples:
Success:
value:
status: success
Failed:
value:
status: failed
reason: no response from device
/api/bluefusion/{id}/reset/kwh:
delete:
tags:
- BlueFusion
summary: Reset the kWh counter on a BlueFusion device to 0.
description: Reset the kWh counter on a BlueFusion device to 0.
parameters:
- name: resetKwh
description: Resets the Kwh counter to 0.
in: query
required: false
schema:
type: string
enum:
- Reset
responses:
"200":
description: Successful
content:
application/json:
schema:
oneOf:
- type: object
properties:
status:
type: string
description: Status of the connection
- type: object
properties:
status:
type: string
description: Status of the connection
reason:
type: string
examples:
Success:
value:
status: success
Failed:
value:
status: failed
reason: no response from device
/api/directlink:
get:
tags:
- DirectLink
summary: Get current DirectLink connections
description: Returns list of all DirectLink connections
responses:
"200":
description: Successful
content:
application/json:
schema:
type: object
properties:
relayControl:
type: array
items:
type: object
properties:
id:
type: string
description: Unique id of the connected device
name:
type: string
description: Name of the connected device
macAddress:
type: string
description: MAC address of the connected device
examples:
Success:
value:
relayControl:
- id: "df4g8b7n2gh9a1c4r4sd2f7"
name: "Relay living room"
macAddress: "AA:BB:CC:DD:EE:FF"
- id: "jdu98sh234234234234234234"
name: "Relay kitchen"
macAddress: "11:22:33:44:55:66"
Empty:
value:
relayControl: []
post:
tags:
- DirectLink
summary: Set a DirectLink connection
description: Set a DirectLink. Requires IP address of the device to connect to.
parameters:
- name: directLink
description: Choose which function you want to DirectLink
in: query
required: true
schema:
type: string
enum:
- relayControl
- recv
- name: nodeId
description: Node ID of the device to connect to
in: query
required: true
schema:
type: string
example: "8AQycyKLaaiEEQRrm7KkEb"
responses:
"201":
description: Successful
content:
application/json:
schema:
oneOf:
- type: object
properties:
status:
type: string
description: Status of the connection
nodeId:
type: string
description: Node ID of the connected device
- type: object
properties:
status:
type: string
description: Status of the connection
reason:
type: string
description: Reason for the connection
examples:
Success:
value:
status: success
nodeId: "8AQycyKLaaiEEQRrm7KkEb"
"422":
description: Failed
content:
application/json:
schema:
oneOf:
- type: object
properties:
status:
type: string
description: Status of the connection
nodeId:
type: string
description: Node ID of the connected device
- type: object
properties:
status:
type: string
description: Status of the connection
reason:
type: string
description: Reason for the connection
examples:
Failed:
value:
status: failed
reason: no response from device
Incompatible:
value:
status: failed
reason: This DirectLink is not supported on the receiving device.
delete:
tags:
- DirectLink
summary: Delete a DirectLink connection
description: Removes a DirectLink connection.
parameters:
- name: directLink
description: Choose which DirectLink function you want to remove from.
in: query
required: true
schema:
type: string
enum:
- relayControl
- name: nodeId
description: Node ID of the device to connect to
in: query
required: true
schema:
type: string
example: "8AQycyKLaaiEEQRrm7KkEb"
responses:
"200":
description: Successful
content:
application/json:
schema:
oneOf:
- type: object
properties:
status:
type: string
description: Status of the connection
nodeId:
type: string
description: Node ID of the connected device
- type: object
properties:
status:
type: string
description: Status of the connection
reason:
type: string
description: Reason for the connection
examples:
Success:
value:
status: success
nodeId: "8AQycyKLaaiEEQRrm7KkEb"
"422":
description: Successful
content:
application/json:
schema:
oneOf:
- type: object
properties:
status:
type: string
description: Status of the connection
nodeId:
type: string
description: Node ID of the connected device
- type: object
properties:
status:
type: string
description: Status of the connection
reason:
type: string
description: Reason for the connection
examples:
Failed:
value:
status: failed
reason: no response from device
################
## Components ##
################
components:
parameters:
disableButtons:
name: disableButtons
description: >
Disable buttons, must be enabled through the parameter, or turned back on locally by holding the center and right button for 30 seconds until the display shows "UNLK".
**0** = Buttons are disabled.
**1** = Buttons are not disabled. (Default)
**2** = Lock menu, buttons will function as normal, but the menu cannot be accessed.
in: query
required: false
schema:
$ref: "#/components/schemas/disableButtons"
example: 1
sensorMode:
name: sensorMode
description: >
Choose which sensor mode the device should operate with.
**0** = Floor sensor (F)
**1** = Internal sensor (A) (Default)
**2** = Internal sensor & floor sensor limitation (AF)
**3** = External sensor (A2)
**4** = External sensor & floor sensor limitation (A2F)
**5** = Power regulator mode (PWER)
**6** = External wireless sensor
**7** = Relay mode
in: query
required: false
schema:
$ref: "#/components/schemas/sensorMode"
example: 1
deviceRestoreState:
name: deviceRestoreState
description: >
Relay state when restoring from a power-loss.
**0** = Restore previous state. (Default)
**1** = Turn ON
**2** = Turn OFF
in: query
required: false
schema:
$ref: "#/components/schemas/deviceRestoreState"
example: 0
automaticTurnOff:
name: automaticTurnOff
description: >
Time to turn OFF device after being turned ON
**0** = Automatic OFF disabled. (Default)
**1** - **86400** = Automatically turn OFF after specified time.
in: query
required: false
schema:
$ref: "#/components/schemas/automaticTurnOff"
example: 0
automaticTurnOn:
name: automaticTurnOn
description: >
Time to turn ON device after being turned OFF
**0** = Automatic ON disabled. (Default)
**1** - **86400** = Automatically turn ON after specified time.
in: query
required: false
schema:
$ref: "#/components/schemas/automaticTurnOn"
example: 0
turnOffDelayTime:
name: turnOffDelayTime
description: >
The time it takes before the device turns off after turning it off.
Minimum: **0** = Disabled (Default)
Maximum: **1** - **60** = 1 to 60 seconds
in: query
required: false
schema:
$ref: "#/components/schemas/turnOffDelayTime"
example: 0
invertedOutput:
name: invertedOutput
description: >
Decides if the device output should be inverted
**0** = **false** = Standard operation (Default)
**1** = **true** = Inverted operation
in: query
required: false
schema:
$ref: "#/components/schemas/invertedOutput"
example: false
alwaysOn:
name: alwaysOn
description: >
Always on mode
**0** = **false** = always on disabled (Default)
**1** = **true** = always on enabled
in: query
required: false
schema:
$ref: "#/components/schemas/alwaysOn"
example: false
internalSensorCalibration:
name: internalSensorCalibration
description: >
Manually calibrate sensor A ±6°C
Minimum: **-6.0** = -6.0°C
Default: **0.0** = 0.0°C
Maximum: **6.0** = +6.0°C
in: query
required: false
schema:
$ref: "#/components/schemas/internalSensorCalibration"
example: -2.3
floorSensorCalibration:
name: floorSensorCalibration
description: >
Manually calibrate sensor F ±6°C.
Minimum: **-6.0** = -6.0°C
Default: **0.0** = 0.0°C
Maximum: **6.0** = +6.0°C
in: query
required: false
schema:
$ref: "#/components/schemas/floorSensorCalibration"
example: -2.3
externalSensorCalibration:
name: externalSensorCalibration
description: >
Manually calibrate sensor A2 ±6°C.
Minimum: **-6.0** = -6.0°C
Default: **0.0** = 0.0°C
Maximum: **6.0** = +6.0°C
in: query
required: false
schema:
$ref: "#/components/schemas/externalSensorCalibration"
example: -2.3
displayInformation:
name: displayInformation
description: >
Select what is displayed on the display during standby state
**0** = Relay state (Default)
**1** = Current consumption
**2** = Total consumption
**3** = Internal temperature
**4** = External temperature
**5** = Floor temperature
in: query
required: false
schema:
$ref: "#/components/schemas/displayInformation"
example: 0
activeDisplayBrightness:
name: activeDisplayBrightness
description: >
Configure the brightness of the display during active state
**10** - **100** = 10% - 100% (Default)
in: query
required: false
schema:
$ref: "#/components/schemas/activeDisplayBrightness"
example: 100
standbyDisplayBrightness:
name: standbyDisplayBrightness
description: >
Configure the brightness of the display during standby state
**0** - **100** = 0% - 100%
Default: **50** = 50%
in: query
required: false
schema:
$ref: "#/components/schemas/standbyDisplayBrightness"
example: 50
actionAfterError:
name: actionAfterError
description: >
Decide how the device should react when the overload / overheating features has turned OFF relay
**0** = Device will turn off and show an error in the display. (Default)
**10 - 65535** = Device will attempt to turn on again after an error based on the delay specified. Will display error if off.
in: query
required: false
schema:
$ref: "#/components/schemas/actionAfterError"
example: 300
sizeOfLoad:
name: sizeOfLoad
description: >
Allows the user to decide the power consumption of the connected load in 100W increments
**0** = Uses power metering values. (Default)
**100** - **9900** = 100W - 9900W = Allows the user to set the size of the load, used when connected to a contactor.
in: query
required: false
schema:
$ref: "#/components/schemas/sizeOfLoad"
example: 0
onOff:
name: onOff
description: >
Turn the relay on or off.
**0** = **false** = Relay off. (Default)
**1** = **true** = Relay on.
in: query
required: false
schema:
$ref: "#/components/schemas/onOff"
example: 0
#################
## SCHEMAS ##
#################
schemas:
disableButtons:
type: integer
pattern: '^(?:0|1|2)$'
description: >
Disable buttons, must be enabled through the parameter, or turned back on locally by holding the center and right button for 30 seconds until the display shows "UNLK".
**0** = Buttons are disabled.
**1** = Buttons are not disabled. (Default)
**2** = Lock menu, buttons will function as normal, but the menu cannot be accessed.
enum:
- 0
- 1
- 2
default: 1
sensorMode:
type: integer
pattern: '^(?:0|1|2|3|4|5|6|7)$'
description: >
Choose which sensor mode the device should operate with.
**0** = Floor sensor (F)
**1** = Internal sensor (A) (Default)
**2** = Internal sensor & floor sensor limitation (AF)
**3** = External sensor (A2)
**4** = External sensor & floor sensor limitation (A2F)
**5** = Power regulator mode (PWER)
**6** = External wireless sensor
**7** = Relay mode (RELA)
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
default: 1
deviceRestoreState:
type: integer
pattern: '^(?:0|1|2)$'
description: >
Relay state when restoring from a power-loss.
**0** = Restore previous state. (Default)
**1** = Turn ON
**2** = Turn OFF
enum:
- 0
- 1
- 2
default: 0
automaticTurnOff:
type: integer
pattern: '^\d{1,5}$'
description: >
Time to turn OFF device after being turned ON
**0** = Automatic OFF disabled. (Default)
**1** - **86400** = Automatically turn OFF after specified time.
minimum: 0
maximum: 86400
default: 0
automaticTurnOn:
type: integer
pattern: '^\d{1,5}$'
description: >
Time to turn ON device after being turned OFF
**0** = Automatic ON disabled. (Default)
**1** - **86400** = Automatically turn ON after specified time.
minimum: 0
maximum: 86400
default: 0
turnOffDelayTime:
type: integer
pattern: '^\d{1,2}$'
description: >
The time it takes before the device turns off after turning it off.
Minimum: **0** = Disabled (Default)
Maximum: **1** - **60** = 1 to 60 seconds
default: 0
minimum: 0
maximum: 60
invertedOutput:
type: boolean
pattern: '^(?:0|1|true|false)$'
description: >
Decides if the device output should be inverted
**0** = **false** = Standard operation (Default)
**1** = **true** = Inverted operation
enum:
- 0
- 1
- false
- true
default: 0
alwaysOn:
type: boolean
pattern: '^(?:0|1|true|false)$'
description: >
Always on mode
**0** = **false** = always on disabled (Default)
**1** = **true** = always on enabled
enum:
- 0
- 1
- false
- true
default: 0
internalSensorCalibration:
type: number
format: float
pattern: '^-?\d{1}\.\d{1}$'
description: >
Manually calibrate sensor A ±6°C
Minimum: **-6.0** = -6.0°C
Default: **0.0** = 0.0°C
Maximum: **6.0** = +6.0°C
multipleOf: 0.1
minimum: -6.0
maximum: 6.0
default: 0.0
floorSensorCalibration:
type: number
format: float
pattern: '^-?\d{1}\.\d{1}$'
description: >
Manually calibrate sensor F ±6°C.
Minimum: **-6.0** = -6.0°C
Default: **0.0** = 0.0°C
Maximum: **6.0** = +6.0°C
multipleOf: 0.1
minimum: -6.0
maximum: 6.0
default: 0.0
externalSensorCalibration:
type: number
format: float
pattern: '^-?\d{1}\.\d{1}$'
description: >
Manually calibrate sensor A2 ±6°C.
Minimum: **-6.0** = -6.0°C
Default: **0.0** = 0.0°C
Maximum: **6.0** = +6.0°C
multipleOf: 0.1
minimum: -6.0
maximum: 6.0
default: 0.0
displayInformation:
type: integer
pattern: '^(?:0|1|2|3|4|5)$'
description: >
Select what is displayed on the display during standby state
**0** = Relay state (Default)
**1** = Current consumption
**2** = Total consumption
**3** = Internal temperature
**4** = External temperature
**5** = Floor temperature
enum:
- 0
- 1
- 2
- 3
- 4
- 5
default: 0
activeDisplayBrightness:
type: integer
pattern: '^(?:10|20|30|40|50|60|70|80|90|100)$'
description: >
Configure the brightness of the display during active state
**10** - **100** = 10% - 100% (Default)
enum:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 100
default: 100
standbyDisplayBrightness:
type: integer
pattern: '^(?:0|10|20|30|40|50|60|70|80|90|100)$'
description: >
Configure the brightness of the display during standby state
**0** - **100** = 0% - 100%
Default: **50** = 50%
enum:
- 0
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 100
default: 50
actionAfterError:
type: integer
pattern: '^\d{1,5}$'
description: >
Decide how the device should react when the overload / overheating features has turned OFF relay
**0** = Device will turn off and show an error in the display. (Default)
**10 - 65535** = Device will attempt to turn on again after an error based on the delay specified. Will display error if off.
minimum: 0
maximum: 65535
default: 0
example: 0
sizeOfLoad:
type: integer
pattern: '^\d{1,4}$'
description: >
Allows the user to decide the power consumption of the connected load in 100W increments
**0** = Uses power metering values. (Default)
**100** - **9900** = 100W - 9900W = Allows the user to set the size of the load, used when connected to a contactor.
multipleOf: 100
minimum: 0
maximum: 9900
default: 0
onOff:
type: boolean
pattern: '^(?:0|1|true|false)$'
description: >
Turn the relay on or off.
**0** = **false** = Relay off. (Default)
**1** = **true** = Relay on.
enum:
- 0
- 1
- false
- true
default: false
#################
## Device Info ##
#################
deviceInfo:
type: object
properties:
id:
type: string
description: Unique id for each device.
example: dfkfj38f652900jd
name:
type: string
description: Device name from the MyHeatit app.
example: Thermostat hall
room:
type: string
description: The room the device is linked to in the MyHeatit app.
example: hall
state:
type: string
description: Current heating state of the thermostat.
**Open** = relay is open.
**Closed** = relay is closed.
enum:
- Open
- Closed
example: Open
currentPower:
type: integer
pattern: '^\d{1,4}$'
description: Current power draw of the device in watt.
example: 150
totalConsumption:
type: number
format: float
pattern: '^\d+\.\d{2}$'
description: Total consumption in kWh
example: 624.24
internalTemperature:
type: number
format: float
pattern: '^-?\d{1,3}\.\d{1}$'
description: Current measurement from the internal temperature sensor.
example: 20.2
floorTemperature:
type: number
format: float
pattern: '^-?\d{1,3}\.\d{1}$'
description: Current measurement from the floor temperature sensor.
example: 21.2
externalTemperature:
type: number
format: float
pattern: '^-?\d{1,3}\.\d{1}$'
description: Current measurement from the external temperature sensor.
example: 22.2
parameters:
type: object
properties:
disableButtons:
$ref: '#/components/schemas/disableButtons'
sensorMode:
$ref: '#/components/schemas/sensorMode'
deviceRestoreState:
$ref: '#/components/schemas/deviceRestoreState'
automaticTurnOff:
$ref: '#/components/schemas/automaticTurnOff'
automaticTurnOn:
$ref: '#/components/schemas/automaticTurnOn'
turnOffDelayTime:
$ref: '#/components/schemas/turnOffDelayTime'
invertedOutput:
$ref: '#/components/schemas/invertedOutput'
alwaysOn:
$ref: '#/components/schemas/alwaysOn'
internalSensorCalibration:
$ref: '#/components/schemas/internalSensorCalibration'
floorSensorCalibration:
$ref: '#/components/schemas/floorSensorCalibration'
externalSensorCalibration:
$ref: '#/components/schemas/externalSensorCalibration'
displayInformation:
$ref: '#/components/schemas/displayInformation'
activeDisplayBrightness:
$ref: '#/components/schemas/activeDisplayBrightness'
standbyDisplayBrightness:
$ref: '#/components/schemas/standbyDisplayBrightness'
actionAfterError:
$ref: '#/components/schemas/actionAfterError'
sizeOfLoad:
$ref: '#/components/schemas/sizeOfLoad'
onOff:
$ref: '#/components/schemas/onOff'
blueFusion:
type: object
description: >
Devices connected with BlueFusion to this device.
properties:
link:
type: array
items:
type: object
properties:
id:
description: Unique id for each device
format: id
name:
type: string
description: Device name used in the MyHeatit app.
device:
type: string
description: What type of product the device is.
example:
- id: df4g8b7n2gh9a1c4r4sd2f7
name: Relay living room
device: Heatit WiFi7
- id: 6f7g8s5a4h9j2k3l1m0n5b2
name: Relay kitchen
device: Heatit WiFi7
directLink:
type: object
properties:
relayControl:
type: array
items:
type: string
onOff:
type: array
items:
type: string
network:
type: object
properties:
SSID:
type: string
description: SSID of the connected wifi network
example: "Home WiFi"
mac:
type: string
description: Mac address of the device
example: "aa:bb:cc:11:22:33"
ipAddress:
type: string
description: IP address of the device on the local network.
example: "192.168.1.10"
wifiSignalStrength:
type: string
description: Wifi signal strength
example: "65dBm"
status:
type: string
description: Status of the connection.
example: "ok"
model:
type: string
description: Model of the device.
example: "Heatit WiFi7"
firmware:
type: string
description: Current firmware version of the device.
example: "1.2"
ResetInfo:
type: object
properties:
statusSuccess:
type: string
enum:
- success
example: success
statusFailed:
type: string
enum:
- failed
example: failed
Devices:
type: array
items:
type: object
properties:
id:
description: Unique id for each device
type: string
format: id
example: sdf87g4bnfc87a523rbsdf4
name:
type: string
description: Device name used in the MyHeatit app.
example: BLE-Temp3 hall
device:
type: string
description: What type of product the device is.
example: BLE-Temp3
example:
- id: df4g8b7n2gh9a1c4r4sd2f7
name: Thermostat living room
device: Heatit BLE-Temp3
- id: 6f7g8s5a4h9j2k3l1m0n5b2
name: Thermostat kitchen
device: Heatit BLE-Temp3
- id: 9d8c7a6b5f4g1h2i3j4k5l6
name: Thermostat bedroom
device: Heatit BLE-Temp3