commands and responses template

This commit is contained in:
Emanuele Trabattoni
2025-07-12 13:45:19 +02:00
parent ef7b9506b6
commit e4d28b55cb
2 changed files with 224 additions and 0 deletions

101
docs/commands.json Normal file
View File

@@ -0,0 +1,101 @@
[
{
"cmd": "setHPlimit",
"params": {
"level": [
"UNLIMITED",
"P1",
"P2",
"P3",
"P4"
]
}
},
{
"cmd": "setHeating",
"params": {
"pump": [
"ON",
"OFF"
],
"ground": [
"ON",
"OFF"
],
"first": [
"ON",
"OFF"
]
}
},
{
"cmd": "getHPpower",
"params": null
},
{
"cmd": "getHPlimit",
"params": null
},
{
"cmd": "getInputStatus",
"params": null
},
{
"cmd": "getOutputStatus",
"params": null
},
{
"cmd": "getTemperatures",
"params": null
},
{
"cmd": "getWaterInfo",
"params": null
},
{
"cmd": "getTankLevel",
"params": null
},
{
"cmd": "getRainInfo",
"params": null
},
{
"cmd": "setIrrigation",
"params": {
"zone": [
"Ricircolo",
"1",
"2",
"3",
"Rubinetti"
],
"timeOn": 120,
"timePause": 2
}
},
{
"cmd": "getIrrigation",
"params": null
},
{
"cmd": "setCronJob",
"params": {
"name": "nomedeljob",
"timeStr": "* * * 10,45 5 *",
"action": "qua ci va un dizionario come se arrivasse da mqtt, cosi li interpreto alla stessa maniera"
}
},
{
"cmd": "getCronJob",
"params": {
"name": "nomedeljob"
}
},
{
"cmd": "delCronJob",
"params": {
"name": "nomedeljob"
}
}
]

123
docs/response.json Normal file
View File

@@ -0,0 +1,123 @@
[
{
"cmd": "POLL",
"values": {
"number": 1234,
"date": "20250810-123512"
}
},
{
"cmd": "getHPpower",
"values": {
"power": 3200,
"current": 16,
"energy": 12341234
}
},
{
"cmd": "getHPlimit",
"values": {
"level": [
"UNLIMITED",
"P1",
"P2",
"P3",
"P4"
]
}
},
{
"cmd": "getInputStatus",
"values": {
"rain": [
"ON",
"OFF"
],
"waterPressure": [
"ON",
"OFF"
]
}
},
{
"cmd": "getOutputStatus",
"values": {
"pump": [
"ON",
"OFF"
],
"ground": [
"ON",
"OFF"
],
"first": [
"ON",
"OFF"
]
}
},
{
"cmd": "getTemperatures",
"values": {
"solar": 1234,
"acs": 1234,
"heating": 1234
}
},
{
"cmd": "getWaterInfo",
"values": {
"flow": 1234,
"consumption": 1234,
"temperature": 1234
}
},
{
"cmd": "getTankLevel",
"values": {
"level": 10
}
},
{
"cmd": "getRainInfo",
"values": {
"rain": [
"ON",
"OFF"
]
}
},
{
"cmd": "getIrrigation",
"values": {
"Ricircolo": [
"ON",
"OFF"
],
"1": [
"ON",
"OFF"
],
"2": [
"ON",
"OFF"
],
"3": [
"ON",
"OFF"
],
"Rubinetti": [
"ON",
"OFF"
]
}
},
{
"cmd": "getCronJob",
"values": {
"name": "nomedeljob",
"timeStr": "* * * 10,45 5 *",
"action": "dizionario che dice cosa deve fare come e' salvato nel micro"
}
}
]