TA652FC-W MQTT API
Tip
This section applies to both
TA652FC-W
andTA652FH-W
.Unless otherwise specified, all specifications applicable to TA652FC-W are also applicable to TA652FH-W.
Overview
TA652FC-W & TA652FH-W MQTT API
is an implementation of ThingsBoard MQTT Device API (MQTT is a lightweight publish/subscribe messaging protocol).
Features
MQTT protocol:
Support MQTT over TCP
NOT support MQTT over SSL with mbedtls, MQTT over Websocket, MQTT over Websocket Secure
Base on ThingsBoard MQTT Device API:
Support telemetry upload API
Support client-side & shared attributes, and attributes API:
Request attribute values from the server
Publish attribute update to the server
Subscribe to attribute updates from the server
Support PRC API:
Server-side RPC: one-way and two-way
Client-side RPC: one-way and two-way
Support Claiming devices API
Support Firmware API
NOT support Device provisioning API
MQTT Special
Currently support
mqtt
schemesCurrently NOT support
mqtts
,ws
,wss
schemesMQTT over TCP samples:
mqtt://mqtt.eclipse.org
: MQTT over TCP, default port 1883:mqtt://mqtt.eclipse.org:1884
: MQTT over TCP, port 1884:
Flow Chart
Tip
The range of values for message fields is referred to in the following sections, see Telemetry (Time-series data), Shared attributes, Client-side attributes and Server-side RPC.
TELE.01 Time-series Data Upload
- Chart:
- Message:
// Message Type: Telemetry upload (MQTT, PUBLISH) // Topic: v1/devices/me/telemetry // Payload - TA652FC-W: {"roomTemp":26.2,"changeOverTemp":26.3} // Payload - TA652FH-W: {"roomTemp":26.2,"floorTemp":26.3}
See roomTemp, changeOverTemp (only for TA652FC-W), floorTemp (only for TA652FH-W).
See uploadFreq.
See uploadThreshold.
CTRL.01 Control Mode
- Chart:
- Message 1:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"controlMode":"On"}
- Message 2:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteSetControlMode","params":"Off"}
See controlMode and remoteSetControlMode.
CTRL.02 Fan Mode & Fan Status (only for TA652FC-W)
- Chart:
- Message 1:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload - TA652FC-W: {"fanMode":"Auto"}
- Message 2:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload - TA652FC-W: {"fanStatus":"Low"}
- Message 3:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload - TA652FC-W: {"method":"remoteSetFanMode","params":"Med"}
See fanMode (only for TA652FC-W), fanStatus (only for TA652FC-W) and remoteSetFanMode (only for TA652FC-W).
CTRL.03 Set Point & Override Status
- Chart:
- Message 1:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"spValue":27.5}
- Message 2:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"overrideStatus":false}
- Message 3:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteSetSpValue","params":34}
- Example 4:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteSetOverrideStatus","params":{}}
See spValue, overrideStatus, remoteSetSpValue and remoteSetOverrideStatus .
PRG.01 Program Mode & Program Status
- Chart:
- Message 1:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"prgMode":"Every-day"}
- Message 2:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"prgNextEnable":true}
- Message 3:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"prgNextCtrlMode":"On"} //{"prgNextCtrlMode":"Off"}
- Message 4:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"prgNextSetpoint":24.5}
- Message 5:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"prgNextDaysTime":"Wed, 06:00 PM"}
- Message 6:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteSetPrgMode","params":"Sun_mon-fri_sat"}
See prgMode, prgNextEnable, prgNextCtrlMode, prgNextSetpoint, prgNextDaysTime and remoteSetPrgMode.
PRG.02 Program Setpoint & Time
- Chart:
- Message 1:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"prgSpTime00":"10:00"}
- Message 2:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"prgCtrlMode00":"On"} //{"prgCtrlMode27":"Off"}
- Message 3:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"prgSpValue00":27.5}
- Message 4:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteSetPrgSpTime27","params":"23:00"}
- Message 5:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteSetPrgCtrlMode27","params":"Off"} //{"method":"remoteSetPrgCtrlMode00","params":"On"}
- Message 6:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteSetPrgSpValue14","params":21.5}
See prgSpTimeXX, prgCtrlModeXX, prgSpValueXX, remoteSetPrgSpTimeXX, remoteSetPrgCtrlModeXX and remoteSetPrgSpValueXX.
SET.01 Upload Device Attributes when the device is started
- Chart:
- Message 1:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"model":"TA652FC-W-TB","mac":"24:0A:C4:2C:EB:C8", "wifiFWVersion":"1.5.4.0","mcuFWVersion":"1.4.4.1", "wifiRSSIMin":0,"wifiRssiMax":255,"wifiRssiStep":1, "uploadFreqMin":2,"uploadFreqMax":2592000,"uploadFreqStep":1, "syncTimeFreqMin":1800,"syncTimeFreqMax":2592000,"syncTimeFreqStep":1}
- Message 2:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"supportCtrlModeInSchedule":"Yes", "currentTempUnit":"°C", "envirTempMin":0,"envirTempMax":50,"envirTempStep":0.1, "spValueMin":5,"spValueMax":40,"spValueStep":0.5, "internalOffsetMin":-5,"internalOffsetMax":5,"internalOffsetStep":0.5, "uploadThresholdMin":0.2,"uploadThresholdMax":5,"uploadThresholdStep":0.1}
- Message 3 - TA652FC-W:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload - TA652FC-W: {"switchingDiffHeatingMin":1,"switchingDiffHeatingMax":4,"switchingDiffHeatingStep":0.5, "switchingDiffCoolingMin":1,"switchingDiffCoolingMax":4,"switchingDiffCoolingStep":0.5, "changeOverTempHeatingMin":27,"changeOverTempHeatingMax":40,"changeOverTempHeatingStep":0.5, "changeOverTempCoolingMin":10,"changeOverTempCoolingMax":25,"changeOverTempCoolingStep":0.5}
- Message 3 - TA652FH-W:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload - TA652FH-W: {"floorTempLimitedMin":20,"floorTempLimitedMax":40,"floorTempLimitedStep":0.5, "switchingDiffHeatingMin":1,"switchingDiffHeatingMax":4,"switchingDiffHeatingStep":0.5, "switchingDiffCoolingMin":1,"switchingDiffCoolingMax":4,"switchingDiffCoolingStep":0.5}
See model, mac, wifiFWVersion, mcuFWVersion, wifiRSSIMin, wifiRssiMax, wifiRssiStep, uploadFreqMin, uploadFreqMax, uploadFreqStep, syncTimeFreqMin, syncTimeFreqMax and syncTimeFreqStep.
See supportCtrlModeInSchedule, currentTempUnit, envirTempMin, envirTempMax, envirTempStep, spValueMin, spValueMax, spValueStep, internalOffsetMin, internalOffsetMax and internalOffsetStep, uploadThresholdMin, uploadThresholdMax and uploadThresholdStep.
See floorTempLimitedMin (only for TA652FH-W), floorTempLimitedMax (only for TA652FH-W), floorTempLimitedStep (only for TA652FH-W), switchingDiffHeatingMin, switchingDiffHeatingMax, switchingDiffHeatingStep, switchingDiffCoolingMin, switchingDiffCoolingMax, switchingDiffCoolingStep, changeOverTempHeatingMin (only for TA652FC-W), changeOverTempHeatingMax (only for TA652FC-W), changeOverTempHeatingStep (only for TA652FC-W), changeOverTempCoolingMin (only for TA652FC-W), changeOverTempCoolingMax (only for TA652FC-W) and changeOverTempCoolingStep (only for TA652FC-W).
SET.02 Settings
- Chart:
- Message 1a:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"tempUnit":"°C"}
- Message 1b:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteSetTempUnit","params":"°F"}
- Message 2a:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"timeFormat":"12hours"}
- Message 2b:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteSetTimeFormat","params":"24hours"}
- Message 3a:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"method":"remoteSetInternalOffset","params":-3.5}
- Message 3b:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"internalOffset":-3.5}
- Message 4a:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"switchingDiffHeating":3.5}
- Message 4b:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteSetSwitchingDiffHeating","params":3.5}
- Message 5a:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"switchingDiffCooling":2.5}
- Message 5b:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteSetSwitchingDiffCooling","params":2.5}
- Message 6a - TA652FH-W:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload - TA652FH-W: {"systemMode":"Cool"}
- Message 6b - TA652FH-W:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload - TA652FH-W: {"method":"remoteSetSystemMode","params":"Heat"}
- Message 7a - TA652FH-W:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload - TA652FH-W: {"sensorMode":"Internal"}
- Message 7b - TA652FH-W:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload - TA652FH-W: {"method":"remoteSetSensorMode","params":"External"}
- Message 8a - TA652FH-W:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload - TA652FH-W: {"floorTempLimited":29.5}
- Message 8b - TA652FH-W:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload - TA652FH-W: {"method":"remoteSetFloorTempLimited","params":29.5}
- Message 9a - TA652FH-W:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload - TA652FH-W: {"adaptiveControl":false}
- Message 9b - TA652FH-W:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload - TA652FH-W: {"method":"remoteSetAdaptiveControl","params":true}
- Message 10a - TA652FC-W:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload - TA652FC-W: {"forceVent":true}
- Message 10b - TA652FC-W:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload - TA652FC-W: {"method":"remoteSetForceVent","params":false}
- Message 11a - TA652FC-W:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload - TA652FC-W: {"changeOverMode":"Heat"}
- Message 11b - TA652FC-W:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload - TA652FC-W: {"method":"remoteSetChangeOverMode","params":"Auto"}
- Message 12a - TA652FC-W:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload - TA652FC-W: {"changeOverTempHeating":27}
- Message 12b - TA652FC-W:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload - TA652FC-W: {"method":"remoteSetChangeOverTempHeating","params":27}
- Message 13a - TA652FC-W:
// Message Type: publish client-side attributes update to the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload - TA652FC-W: {"changeOverTempCooling":11.5}
- Message 13b - TA652FC-W:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload - TA652FC-W: {"method":"remoteSetChangeOverTempCooling","params":10}
See tempUnit and remoteSetTempUnit, timeFormat and remoteSetTimeFormat, internalOffset and remoteSetInternalOffset, switchingDiffHeating and remoteSetSwitchingDiffHeating, switchingDiffCooling and remoteSetSwitchingDiffCooling.
See systemMode and remoteSetSystemMode, sensorMode and remoteSetSensorMode, floorTempLimited and remoteSetFloorTempLimited, adaptiveControl and remoteSetAdaptiveControl.(only for TA652FH-W)
See forceVent and remoteSetForceVent, changeOverMode and remoteSetChangeOverMode, changeOverTempHeating and remoteSetChangeOverTempHeating, changeOverTempCooling and remoteSetChangeOverTempCooling.(only for TA652FC-W)
ADM.01 Request all remote parameters when the device is started
- Chart:
- Message 1:
// Message Type: request attribute values from the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes/request/$request_id // Payload: {"sharedKeys":"uploadFreq,uploadThreshold,syncTimeFreq,timezone,timeNTPServer"}
- Message 2:
// Message Type: receive response (MQTT, PUBLISH) // Topic: v1/devices/me/attributes/response/$request_id // Payload: {"shared":{"uploadFreq":300,"uploadThreshold":1.5,"syncTimeFreq":86400, "timezone":480,"timeNTPServer":"pool.ntp.org"}}
See uploadFreq, uploadThreshold, syncTimeFreq, timezone and timeNTPServer.
ADM.02 Timer Parameters & upload threshold
- Chart:
- Message 1:
// Message Type: receive attribute update from the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"uploadFreq":300}
- Message 2:
// Message Type: receive attribute update from the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"uploadThreshold":1.5}
- Message 3:
// Message Type: receive attribute update from the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"syncTimeFreq":86400}
See uploadFreq, uploadThreshold and syncTimeFreq.
ADM.03 Remote Sync Time
- Chart:
- Message 1:
// Message Type: receive attribute update from the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"timezone":480}
- Message 2:
// Message Type: receive attribute update from the server (MQTT, PUBLISH) // Topic: v1/devices/me/attributes // Payload: {"timeNTPServer":"pool.ntp.org"}
- Message 3:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteSyncTimeRequest","params":{}}
See timezone, timeNTPServer and remoteSyncTimeRequest.
ADM.04 FUOTA (firmware update over the air)
The flow is to download the firmware from your HTTP server. For the flow of downloading firmware from ThingsBoard server, please refer to Firmware API.
- Chart:
- Message 1a:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteWiFiFUOTA", "params":"http://192.168.1.106/TA652FC-W_WiFi.ino.bin"}
- Message 1b:
// Message Type: send response (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/response/$request_id // Payload: {"method":"remoteWiFiFUOTA","results":{"result":"success"}}
- Message 2a (NOT implemented):
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteMcuFUOTA", "params":"http://192.168.1.106/TA652FC-W_MCU.bin"}
- Message 2b (NOT implemented):
// Message Type: send response (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/response/$request_id // Payload: {"method":"remoteMcuFUOTA","results":{"result":"success"}}
See remoteWiFiFUOTA and remoteMcuFUOTA.
ADM.05 Remote Get Memeory Usage
- Chart:
- Message 1a:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteGetMemoryUsage"}
- Message 1b:
// Message Type: send response (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/response/$request_id // Payload: {"iram":162592,"spiram":4194252}
See remoteGetMemoryUsage.
ADM.06 Remote Reboot Device
- Chart:
- Message 1:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteRebootDevice","params":{}}
See remoteRebootDevice.
ADM.07 Remote Clear Wi-Fi Config
- Chart:
- Message 1:
// Message Type: receive server-side RPC request from the server (MQTT, PUBLISH) // Topic: v1/devices/me/rpc/request/$request_id // Payload: {"method":"remoteClearWiFiConfig","params":{}}
Claiming
Refer to Claiming API.
Firmware update with ThingsBoard Server
Refer to Firmware API.
Telemetry (Time-series data)
Tip
All of these telemetry (timeseries data) is uploaded every uploadFreq seconds.
If these telemetry (timeseries data) change exceeds uploadThreshold, upload immediately.
roomTemp
changeOverTemp
floorTemp
wifiRssi
Time-series |
Type |
Unit |
Min |
Max |
Step/Precision |
Value |
TA652 |
TA652 |
Memo |
---|---|---|---|---|---|---|---|---|---|
roomTemp |
float |
● |
● |
Room temperature |
|||||
changeOverTemp |
float |
● |
Change Over |
||||||
floorTemp |
float |
● |
Floor Temperatue |
||||||
wifiRssi (deprecated)* |
int |
● |
● |
Received Signal |
Tip
In order to reduce the load on ThingsBoard server, wifiRssi is no longer sent.
Client-side attributes
Client-side attribute (static/fixed)
model
mac
wifiFWVersion
mcuFWVersion
Client-side |
Type |
Unit |
Value |
TA652 |
TA652 |
Memo |
---|---|---|---|---|---|---|
model |
string |
“TA652FC-W-TB”, |
● |
● |
Product Model |
|
mac |
string |
eg: |
● |
● |
Mac Address |
|
wifiFWVersion |
string |
eg: |
● |
● |
WiFi Module |
|
mcuFWVersion |
string |
eg: |
● |
● |
Main MCU |
Client-side attribute (static/fixed, metadata)
wifiRssiMin
wifiRssiMax
wifiRssiStep
uploadFreqMin
uploadFreqMax
uploadFreqStep
syncTimeFreqMin
syncTimeFreqMax
syncTimeFreqStep
Client-side |
Type |
Unit |
Value |
TA652 |
TA652 |
Memo |
---|---|---|---|---|---|---|
wifiRssiMin |
int |
0 |
● |
● |
the minimum value |
|
wifiRssiMax |
int |
255 |
● |
● |
the maximum value |
|
wifiRssiStep |
int |
1 |
● |
● |
the step value |
|
uploadFreqMin |
int |
second |
2 |
● |
● |
the minimum value |
uploadFreqMax |
int |
second |
30*24*3600 (2592000) |
● |
● |
the maximum value |
uploadFreqStep |
int |
second |
1 |
● |
● |
the step value |
syncTimeFreqMin |
int |
second |
30*60 |
● |
● |
the minimum value |
syncTimeFreqMax |
int |
second |
30*24*3600 |
● |
● |
the maximum value |
syncTimeFreqStep |
int |
second |
1 |
● |
● |
the step value |
Client-side attribute (semi-static)
supportCtrlModeInSchedule
currentTempUnit
tempResolution
envirTempMin
envirTempMax
envirTempStep
spValueMin
spValueMax
spValueStep
internalOffsetMin
internalOffsetMax
internalOffsetStep
uploadThresholdMin
uploadThresholdMax
uploadThresholdStep
floorTempLimitedMin
floorTempLimitedMax
floorTempLimitedStep
switchingDiffHeatingMin
switchingDiffHeatingMax
switchingDiffHeatingStep
switchingDiffCoolingMin
switchingDiffCoolingMax
switchingDiffCoolingStep
changeOverTempHeatingMin
changeOverTempHeatingMax
changeOverTempHeatingStep
changeOverTempCoolingMin
changeOverTempCoolingMax
changeOverTempCoolingStep
Client-side |
Type |
Unit |
Value |
TA652 |
TA652 |
Memo |
---|---|---|---|---|---|---|
supportCtrlModeInSchedule |
string |
“Yes” / “No” |
● |
● |
Control On/Off |
|
currentTempUnit |
string |
“°C” / “°F” |
● |
● |
Centigrade, |
|
envirTempMin |
float |
0.0 (°C) / 32 (°F) |
● |
● |
the minimum value of |
|
envirTempMax |
float |
50.0 (°C) / 120 (°F) |
● |
● |
the maximum value of |
|
envirTempStep |
float |
0.1 (°C) / 0.5 (°F) |
● |
● |
the step value of |
|
spValueMin |
float |
5.0 (°C) / 40 (°F) |
● |
● |
the minimum value of |
|
spValueMax |
float |
40.0 (°C) / 104 (°F) |
● |
● |
the maximum value of |
|
spValueStep |
float |
0.5 (°C) / 1.0 (°F) |
● |
● |
the step value of |
|
internalOffsetMin |
float |
-5.0 (°C) / -10 (°F) |
● |
● |
the minimum value of |
|
internalOffsetMax |
float |
5.0 (°C) / 10 (°F) |
● |
● |
the maximum value of |
|
internalOffsetStep |
float |
0.1 (°C) / 0.5 (°F) |
● |
● |
the step value of |
|
uploadThresholdMin |
float |
0.2 (°C) / 32 (°F) |
● |
● |
the minimum value of |
|
uploadThresholdMax |
float |
5.0 (°C) / 41 (°F) |
● |
● |
the maximum value of |
|
uploadThresholdtep |
float |
0.1 (°C) / 0.5 (°F) |
● |
● |
the step value of |
|
floorTempLimitedMin |
float |
20.0 (°C) / 68 (°F) |
● |
the minimum value of |
||
floorTempLimitedMax |
float |
5.0 (°C) / 10 (°F) |
● |
the maximum value of |
||
floorTempLimitedStep |
float |
40.0 (°C) / 104 (°F) |
● |
the step value of |
||
switchingDiffHeatingMin |
float |
0.5 (°C) / 1 (°F) |
● |
● |
the minimum value of |
|
switchingDiffHeatingMax |
float |
4.0 (°C) / 8 (°F) |
● |
● |
the maximum value of |
|
switchingDiffHeatingStep |
float |
0.5 (°C) / 1 (°F) |
● |
● |
the step value of |
|
switchingDiffCoolingMin |
float |
0.5 (°C) / 1 (°F) |
● |
● |
the minimum value of |
|
switchingDiffCoolingMax |
float |
4.0 (°C) / 8 (°F) |
● |
● |
the maximum value of |
|
switchingDiffCoolingStep |
float |
0.5 (°C) / 1 (°F) |
● |
● |
the step value of |
|
changeOverTempHeatingMin |
float |
27.0 (°C) / 80 (°F) |
● |
the minimum value of |
||
changeOverTempHeatingMax |
float |
40.0 (°C) / 104 (°F) |
● |
the maximum value of |
||
changeOverTempHeatingStep |
float |
0.5 (°C) / 1 (°F) |
● |
the step value of |
||
changeOverTempCoolingMin |
float |
10.0 (°C) / 50 (°F) |
● |
the minimum value of |
||
changeOverTempCoolingMax |
float |
25.0 (°C) / 77 (°F) |
● |
the maximum value of |
||
changeOverTempCoolingStep |
float |
0.5 (°C) / 1 (°F) |
● |
the step value of |
Client-side attribute (application state)
fanStatus
overrideStatus
prgNextEnable
prgNextCtrlMode
prgNextDaysTime
prgNextSetpoint
Client-side |
Type |
Unit |
Value |
TA652 |
TA652 |
Memo |
---|---|---|---|---|---|---|
fanStatus |
string |
“Off”, |
● |
|||
overrideStatus |
bool |
true, |
● |
● |
see spValue |
|
prgNextEnable |
bool |
true, |
● |
● |
Next program |
|
prgNextCtrlMode |
string |
“On”, |
● |
● |
Next program |
|
prgNextDaysTime |
float |
● |
● |
Next program |
||
prgNextSetpoint |
float |
● |
● |
Next program |
Client-side attribute (change by server-side RPC, settings)
tempUnit
timeFormat
systemMode
sensorMode
internalOffset
floorTempLimited
switchingDiffHeating
switchingDiffCooling
adaptiveControl
forceVent
changeOverMode
changeOverTempHeating
changeOverTempCooling
Client-side |
Type |
Unit |
Min |
Max |
Step/ |
Value |
TA652 |
TA652 |
Memo |
---|---|---|---|---|---|---|---|---|---|
tempUnit |
string |
“°C” / “°F” |
● |
● |
Centigrade, Fahrenheit, see |
||||
timeFormat |
string |
“12hours”, |
● |
● |
|||||
systemMode |
string |
“Heat”, |
● |
||||||
sensorMode |
string |
“Internal”, |
● |
||||||
internalOffset |
float |
● |
● |
Internal Sensor |
|||||
floorTempLimited |
float |
● |
floor temperature limited |
||||||
switchingDiffHeating |
float |
● |
● |
Switching Differential Heating, see |
|||||
switchingDiffCooling |
float |
● |
● |
Switching Differential Cooling, see |
|||||
adaptiveControl |
bool |
true, |
● |
||||||
forceVent |
bool |
true, |
● |
Force Ventialation, see |
|||||
changeOverMode |
string |
“Heat”, |
● |
||||||
changeOverTempHeating |
float |
● |
Change Over Temp Heating, see |
||||||
changeOverTempCooling |
float |
● |
Change Over Temp Cooling, see |
Client-side attribute (change by server-side RPC, control & program)
controlMode
fanMode
spValue
prgMode
prgSpTimeXX
0 <= XX <= 27, prgSpTime00 ~ prgSpTime27
prgCtrlModeXX
0 <= XX <= 27, prgCtrlMode00 ~ prgCtrlMode27
prgSpValueXX
0 <= XX <= 27, prgSpValue00 ~ prgSpValue27
Client-side |
Type |
Unit |
Min |
Max |
Step/ |
Value |
TA652 |
TA652 |
Memo |
---|---|---|---|---|---|---|---|---|---|
controlMode |
string |
“Off”, |
● |
● |
|||||
fanMode |
string |
“Auto”, |
● |
see remoteSetFanMode |
|||||
spValue |
float |
● |
● |
see remoteSetSpValue, |
|||||
prgMode |
string |
“No-program”, |
● |
● |
see remoteSetPrgMode |
||||
prgSpTimeXX |
string |
“hh:mm”, |
● |
● |
|||||
prgCtrlModeXX |
string |
“On”, |
● |
● |
|||||
prgSpValueXX |
float |
● |
● |
Server-side RPC
Server-side RPC (remote change client-side attribute)
Tip
All of these server-side RPC are one-way, no response
Request format of these server-side RPC: {”method”:”remoteSetTempUnit”, “params”:”°F”}
params value see Client-side attribute (change by server-side RPC, settings) & Client-side attribute (change by server-side RPC, control & program)
remoteSetTempUnit
remoteSetTimeFormat
remoteSetSystemMode
remoteSetSensorMode
remoteSetInternalOffset
remoteSetFloorTempLimited
remoteSetSwitchingDiffHeating
remoteSetSwitchingDiffCooling
remoteSetAdaptiveControl
remoteSetForceVent
remoteSetChangeOverMode
remoteSetChangeOverTempHeating
remoteSetChangeOverTempCooling
remoteSetControlMode
remoteSetFanMode
remoteSetSpValue
remoteSetPrgMode
remoteSetPrgSpTimeXX
0 <= XX <= 27, remoteSetPrgSpTime00 ~ remoteSetPrgSpTime27
remoteSetPrgCtrlModeXX
0 <= XX <= 27, remoteSetPrgCtrlMode00 ~ remoteSetPrgCtrlMode27
remoteSetPrgSpValueXX
0 <= XX <= 27, remoteSetPrgSpValue00 ~ remoteSetPrgSpValue27
Server-side RPC |
params |
params |
TA652 |
TA652 |
Memo |
---|---|---|---|---|---|
remoteSetTempUnit |
string |
“°C” / “°F” |
● |
● |
|
remoteSetTimeFormat |
string |
“12hours” |
● |
● |
|
remoteSetSystemMode |
string |
“Heat” |
● |
||
remoteSetSensorMode |
string |
“Internal” |
● |
||
remoteSetInternalOffset |
float |
● |
● |
||
remoteSetFloorTempLimited |
float |
● |
|||
remoteSetSwitchingDiffHeating |
float |
● |
● |
||
remoteSetSwitchingDiffCooling |
float |
● |
● |
||
remoteSetAdaptiveControl |
bool |
true |
● |
||
remoteSetForceVent |
bool |
true |
● |
||
remoteSetChangeOverMode |
string |
“Heat” |
● |
||
remoteSetChangeOverTempHeating |
float |
● |
|||
remoteSetChangeOverTempCooling |
float |
● |
|||
remoteSetControlMode |
string |
“Off” |
● |
● |
|
remoteSetFanMode |
string |
“Auto” |
● |
||
remoteSetSpValue |
float |
● |
● |
||
remoteSetPrgMode |
string |
“No-program” |
● |
● |
|
remoteSetPrgSpTimeXX |
string |
“hh:mm”, |
● |
● |
remoteSetPrgSpTime00 ~ |
remoteSetPrgCtrlModeXX |
string |
“On” |
● |
● |
remoteSetPrgCtrlMode00 ~ |
remoteSetPrgSpValueXX |
float |
● |
● |
remoteSetPrgSpValue00 ~ |
Server-side RPC (remote control)
remoteSetOverrideStatus
remoteSyncTimeRequest
remoteClearWiFiConfig
remoteRebootDevice
remoteWiFiFUOTA
remoteMcuFUOTA
remoteGetMemoryUsage
Server-side RPC |
one-way | |
Request |
Response |
TA652 |
TA652 |
Memo |
---|---|---|---|---|---|---|
remoteSetOverrideStatus |
one-way |
{“method”:”remoteSetOverrideStatus”, |
● |
● |
Assign a prgSpValueXX to |
|
remoteSyncTimeRequest |
one-way |
{“method”:”remoteSyncTimeRequest”, |
● |
● |
||
remoteClearWiFiConfig |
one-way |
{“method”:”remoteClearWiFiConfig”, |
● |
● |
||
remoteRebootDevice |
one-way |
{“method”:”remoteRebootDevice”, |
● |
● |
||
remoteWiFiFUOTA |
two-way |
{“method”:”remoteWiFiFUOTA”, |
{“method”:”remoteWiFiFUOTA”, |
● |
● |
|
remoteMcuFUOTA |
two-way |
{“method”:”remoteMcuFUOTA”, |
{“method”:”remoteMcuFUOTA”, |
● |
● |
|
remoteGetMemoryUsage |
two-way |
{“method”:”remoteGetMemoryUsage”, |
{“method”:”remoteGetMemoryUsage”, |
● |
● |