HTTP API Documentation
🢓
General
🢓
This is the documentation for the MIYO Cube HTTP API. The API is accessible at http://*IP*/api/*Methode*
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| *IP* | IP address of the Cube | ||
| *Method* | Query to be executed |
Beispiel
http://192.168.1.0/api/link
/link - Provides a new apiKey
🢓
Provides a new apiKey if access to the Cube is allowed. Pressing the button on the Cube or the API method System.allowlink allows one-time access for 15 minutes.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
Beispiel
http://192.168.1.0/api/linkAntwort
{"apiKey":"{abcd1234-ab12-ab12-ab12-abcdef123456}","id":0,"status":"success"}
/system/update - Plans the next update
🢓
Schedule the next update, does not start immediately.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
Beispiel
http://192.168.1.0/api/system/updateAntwort
{"id":0,"status":"success"}
/device/all - Information about all devices
🢓
Provides information about all devices.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| typeIds | Device type filter (multiple possible) | [valve/moistureOutdoor] | not necessary |
Beispiel
http://192.168.1.0/api/device/all?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&typeIds=valveAntwort
{"id":0,"params":{"{abcd1234-ab12-ab12-ab12-abcdef123456};1":{"channel":1,"deviceTypeId":"moistureOutdoor","firmware":"1.34.0","id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","ipv6":"fe80::211:7d00:30:abcd%zmd0","lastUpdate":0,"stateTypes":{"0":{"type":"moisture","value":0},"1":{"type":"brightness","value":0},"2":{"type":"temperature","value":0},"3":{"type":"frequency","value":0},"4":{"type":"irrigationNecessary","value":false},"5":{"type":"irrigationPossible","value":false},"6":{"type":"temperatureOffset","value":0},"7":{"type":"rssi","value":-200},"8":{"type":"reachable","value":false},"9":{"type":"solarVoltage","value":0},"10":{"type":"sunWithinWeek","value":true},"11":{"type":"lowPower","value":false},"12":{"type":"otauPossible","value":false},"13":{"type":"otauProgress","value":0},"14":{"type":"otauStatus","value":""},"15":{"type":"winterMode","value":false},"16":{"type":"chargingDurationDay","value":0},"17":{"type":"charging","value":false},"18":{"type":"chargingLess","value":false},"19":{"type":"lastResetTime","value":0},"20":{"type":"lastResetType","value":-1}}},"{abcd1234-ab12-ab12-ab12-abcdef123456};1":{"channel":1,"deviceTypeId":"moistureOutdoor","firmware":"1.34.0","id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","ipv6":"fe80::211:7d00:30:abcd%zmd0","lastUpdate":0,"stateTypes":{"0":{"type":"moisture","value":0},"1":{"type":"brightness","value":0},"2":{"type":"temperature","value":0},"3":{"type":"frequency","value":0},"4":{"type":"irrigationNecessary","value":false},"5":{"type":"irrigationPossible","value":false},"6":{"type":"temperatureOffset","value":0},"7":{"type":"rssi","value":-200},"8":{"type":"reachable","value":false},"9":{"type":"solarVoltage","value":0},"10":{"type":"sunWithinWeek","value":true},"11":{"type":"lowPower","value":false},"12":{"type":"otauPossible","value":false},"13":{"type":"otauProgress","value":0},"14":{"type":"otauStatus","value":""},"15":{"type":"winterMode","value":false},"16":{"type":"chargingDurationDay","value":0},"17":{"type":"charging","value":false},"18":{"type":"chargingLess","value":false},"19":{"type":"lastResetTime","value":0},"20":{"type":"lastResetType","value":-1}}},"{abcd1234-ab12-ab12-ab12-abcdef123456};1":{"channel":1,"deviceTypeId":"moistureOutdoor","firmware":"1.34.0","id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","ipv6":"fe80::211:7d00:30:abcd%zmd0","lastUpdate":0,"stateTypes":{"0":{"type":"moisture","value":0},"1":{"type":"brightness","value":0},"2":{"type":"temperature","value":0},"3":{"type":"frequency","value":0},"4":{"type":"irrigationNecessary","value":false},"5":{"type":"irrigationPossible","value":false},"6":{"type":"temperatureOffset","value":0},"7":{"type":"rssi","value":-200},"8":{"type":"reachable","value":false},"9":{"type":"solarVoltage","value":0},"10":{"type":"sunWithinWeek","value":true},"11":{"type":"lowPower","value":false},"12":{"type":"otauPossible","value":false},"13":{"type":"otauProgress","value":0},"14":{"type":"otauStatus","value":""},"15":{"type":"winterMode","value":false},"16":{"type":"chargingDurationDay","value":0},"17":{"type":"charging","value":false},"18":{"type":"chargingLess","value":false},"19":{"type":"lastResetTime","value":0},"20":{"type":"lastResetType","value":-1}}}},"status":"success"}
/device/status - Information about a device
🢓
Provides information about a device.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| deviceId | Device ID | String | necessary |
Beispiel
http://192.168.1.0/api/device/status?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&deviceId={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{
"id": 0,
"params": {
"device": {
"channel": 1,
"deviceTypeId": "moistureOutdoor",
"firmware": "1.34.0",
"id": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"ipv6": "fe80::211:7d00:30:abcd%zmd0",
"lastUpdate": 0,
"stateTypes": {
"0": {
"type": "moisture",
"value": 0
},
"1": {
"type": "brightness",
"value": 0
},
"2": {
"type": "temperature",
"value": 0
},
"3": {
"type": "frequency",
"value": 0
},
"4": {
"type": "irrigationNecessary",
"value": false
},
"5": {
"type": "irrigationPossible",
"value": false
},
"6": {
"type": "temperatureOffset",
"value": 0
},
"7": {
"type": "rssi",
"value": -200
},
"8": {
"type": "reachable",
"value": false
},
"9": {
"type": "solarVoltage",
"value": 0
},
"10": {
"type": "sunWithinWeek",
"value": true
},
"11": {
"type": "lowPower",
"value": false
},
"12": {
"type": "otauPossible",
"value": false
},
"13": {
"type": "otauProgress",
"value": 0
},
"14": {
"type": "otauStatus",
"value": ""
},
"15": {
"type": "winterMode",
"value": false
},
"16": {
"type": "chargingDurationDay",
"value": 0
},
"17": {
"type": "charging",
"value": false
},
"18": {
"type": "chargingLess",
"value": false
},
"19": {
"type": "lastResetTime",
"value": 0
},
"20": {
"type": "lastResetType",
"value": -1
}
}
},
"status": "success"
}
/device/free - Unassigned devices
🢓
Delivers all devices that are not assigned to any area.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| typeIds | Device type filter (multiple possible) | [valve/moistureOutdoor] | not necessary |
Beispiel
http://192.168.1.0/api/device/free?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&typeIds=valveAntwort
{"id":0,"params":{"{abcd1234-ab12-ab12-ab12-abcdef123456};1":{"channel":1,"deviceTypeId":"moistureOutdoor","firmware":"1.34.0","id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","ipv6":"fe80::211:7d00:30:abcd%zmd0","lastUpdate":0,"stateTypes":{"0":{"type":"moisture","value":0},"1":{"type":"brightness","value":0},"2":{"type":"temperature","value":0},"3":{"type":"frequency","value":0},"4":{"type":"irrigationNecessary","value":false},"5":{"type":"irrigationPossible","value":false},"6":{"type":"temperatureOffset","value":0},"7":{"type":"rssi","value":-200},"8":{"type":"reachable","value":false},"9":{"type":"solarVoltage","value":0},"10":{"type":"sunWithinWeek","value":true},"11":{"type":"lowPower","value":false},"12":{"type":"otauPossible","value":false},"13":{"type":"otauProgress","value":0},"14":{"type":"otauStatus","value":""},"15":{"type":"winterMode","value":false},"16":{"type":"chargingDurationDay","value":0},"17":{"type":"charging","value":false},"18":{"type":"chargingLess","value":false},"19":{"type":"lastResetTime","value":0},"20":{"type":"lastResetType","value":-1}}},"{abcd1234-ab12-ab12-ab12-abcdef123456};1":{"channel":1,"deviceTypeId":"moistureOutdoor","firmware":"1.34.0","id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","ipv6":"fe80::211:7d00:30:abcd%zmd0","lastUpdate":0,"stateTypes":{"0":{"type":"moisture","value":0},"1":{"type":"brightness","value":0},"2":{"type":"temperature","value":0},"3":{"type":"frequency","value":0},"4":{"type":"irrigationNecessary","value":false},"5":{"type":"irrigationPossible","value":false},"6":{"type":"temperatureOffset","value":0},"7":{"type":"rssi","value":-200},"8":{"type":"reachable","value":false},"9":{"type":"solarVoltage","value":0},"10":{"type":"sunWithinWeek","value":true},"11":{"type":"lowPower","value":false},"12":{"type":"otauPossible","value":false},"13":{"type":"otauProgress","value":0},"14":{"type":"otauStatus","value":""},"15":{"type":"winterMode","value":false},"16":{"type":"chargingDurationDay","value":0},"17":{"type":"charging","value":false},"18":{"type":"chargingLess","value":false},"19":{"type":"lastResetTime","value":0},"20":{"type":"lastResetType","value":-1}}},"{abcd1234-ab12-ab12-ab12-abcdef123456};1":{"channel":1,"deviceTypeId":"moistureOutdoor","firmware":"1.34.0","id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","ipv6":"fe80::211:7d00:30:abcd%zmd0","lastUpdate":0,"stateTypes":{"0":{"type":"moisture","value":0},"1":{"type":"brightness","value":0},"2":{"type":"temperature","value":0},"3":{"type":"frequency","value":0},"4":{"type":"irrigationNecessary","value":false},"5":{"type":"irrigationPossible","value":false},"6":{"type":"temperatureOffset","value":0},"7":{"type":"rssi","value":-200},"8":{"type":"reachable","value":false},"9":{"type":"solarVoltage","value":0},"10":{"type":"sunWithinWeek","value":true},"11":{"type":"lowPower","value":false},"12":{"type":"otauPossible","value":false},"13":{"type":"otauProgress","value":0},"14":{"type":"otauStatus","value":""},"15":{"type":"winterMode","value":false},"16":{"type":"chargingDurationDay","value":0},"17":{"type":"charging","value":false},"18":{"type":"chargingLess","value":false},"19":{"type":"lastResetTime","value":0},"20":{"type":"lastResetType","value":-1}}}},"status":"success"}
/device/remove - Deletes a device
🢓
Deletes a device from the Cube.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| deviceId | Device ID | String | necessary |
Beispiel
http://192.168.1.0/api/device/remove?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&deviceId={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"status":"success"}
/device/teachin - Teaches a device
🢓
Connects the Cube with a device that was activated with the magnet.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | required |
Beispiel
http://192.168.1.0/api/device/teachin?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"status":"success"}
/device/highlight - Activate LED of a device
🢓
Activates the LED on the selected device.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| deviceId | Device ID | String | necessary |
Beispiel
http://192.168.1.0/api/device/highlight?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&deviceId={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"status":"success"}
/circuit/all - All areas
🢓
Provides information about all areas.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | required |
Beispiel
http://192.168.1.0/api/circuit/all?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"params":{"circuits":{"{abcd1234-ab12-ab12-ab12-abcdef123456}":{"id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","name":"garden","params":{"automaticMode":false,"borderBottom":"40","borderTop":"60","considerMower":false,"day0":"10:50-10:59;23:50-23:59","day1":"","day2":"","day3":"16:50-20:50","day4":"","day5":"","day6":"","irrigationDelayForecast":true,"irrigationType":0,"locationType":0,"plantType":1,"soilType":0,"temperatureOffset":0,"valveStaggering":true},"sensor":"{abcd1234-ab12-ab12-ab12-abcdef123456}","sensorData":{"channel":100,"deviceTypeId":"moistureOutdoor","firmware":"","id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","ipv6":"fe80::211:7d00:30:abcd%zmd0","lastUpdate":1563290254,"stateTypes":{"0":{"type":"moisture","value":100},"1":{"type":"brightness","value":0},"2":{"type":"temperature","value":0},"3":{"type":"frequency","value":0},"4":{"type":"irrigationNecessary","value":false},"5":{"type":"irrigationPossible","value":false},"6":{"type":"temperatureOffset","value":0},"7":{"type":"rssi","value":-200},"8":{"type":"reachable","value":false},"9":{"type":"solarVoltage","value":0},"10":{"type":"sunWithinWeek","value":true},"11":{"type":"lowPower","value":false},"12":{"type":"otauPossible","value":false},"13":{"type":"otauProgress","value":0},"14":{"type":"otauStatus","value":""},"15":{"type":"winterMode","value":false},"16":{"type":"chargingDurationDay","value":0},"17":{"type":"charging","value":false},"18":{"type":"chargingLess","value":false},"19":{"type":"lastResetTime","value":0},"20":{"type":"lastResetType","value":-1}}},"stateTypes":{"0":{"type":"irrigation","value":false},"1":{"type":"automaticMode","value":false},"2":{"type":"externBlock","value":false},"3":{"type":"winterMode","value":false},"4":{"type":"irrigationNextStart","value":1563461400},"5":{"type":"irrigationNextEnd","value":1563475800},"6":{"type":"valveStaggeringIndex","value":0}},"valves":{}},"{abcd1234-ab12-ab12-ab12-abcdef123456}":{"id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","name":"Flowers","params":{"automaticMode":false,"borderBottom":"40","borderTop":"60","considerMower":false,"day0":"","day1":"09:35-11:32","day2":"","day3":"","day4":"","day5":"","day6":"","irrigationDelayForecast":false,"irrigationType":0,"locationType":2,"plantType":0,"soilType":1,"temperatureOffset":0,"valveStaggering":true},"sensor":"{abcd1234-ab12-ab12-ab12-abcdef123456}","sensorData":{"channel":100,"deviceTypeId":"moistureOutdoor","firmware":"","id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","ipv6":"fe80::211:7d00:30:abcd%zmd0","lastUpdate":1563290254,"stateTypes":{"0":{"type":"moisture","value":100},"1":{"type":"brightness","value":0},"2":{"type":"temperature","value":0},"3":{"type":"frequency","value":0},"4":{"type":"irrigationNecessary","value":false},"5":{"type":"irrigationPossible","value":false},"6":{"type":"temperatureOffset","value":0},"7":{"type":"rssi","value":-200},"8":{"type":"reachable","value":false},"9":{"type":"solarVoltage","value":0},"10":{"type":"sunWithinWeek","value":true},"11":{"type":"lowPower","value":false},"12":{"type":"otauPossible","value":false},"13":{"type":"otauProgress","value":0},"14":{"type":"otauStatus","value":""},"15":{"type":"winterMode","value":false},"16":{"type":"chargingDurationDay","value":0},"17":{"type":"charging","value":false},"18":{"type":"chargingLess","value":false},"19":{"type":"lastResetTime","value":0},"20":{"type":"lastResetType","value":-1}}},"sensorValve":{"channel":1,"valve":"{abcd1234-ab12-ab12-ab12-abcdef123456}"},"stateTypes":{"0":{"type":"irrigation","value":false},"1":{"type":"automaticMode","value":false},"2":{"type":"externBlock","value":false},"3":{"type":"winterMode","value":false},"4":{"type":"irrigationNextStart","value":1563867300},"5":{"type":"irrigationNextEnd","value":1563874320},"6":{"type":"valveStaggeringIndex","value":0}},"valves":{"0":{"channel":1,"valve":"{abcd1234-ab12-ab12-ab12-abcdef123456}","valveData":{"channel":100,"deviceTypeId":"valve","firmware":"1.51.0","id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","ipv6":"fe80::211:7d00:30:abcd%zmd0","lastUpdate":1563352577,"stateTypes":{"0":{"type":"valveInitialClose","value":false},"1":{"type":"valveStatus","value":false},"2":{"type":"openValve","value":false},"3":{"type":"lastIrrigationStart","value":0},"4":{"type":"lastIrrigationEnd","value":1563290494},"5":{"type":"lastIrrigationDuration","value":1563290494},"6":{"type":"rssi","value":-35},"7":{"type":"reachable","value":true},"8":{"type":"solarVoltage","value":"0.84"},"9":{"type":"sunWithinWeek","value":true},"10":{"type":"lowPower","value":false},"11":{"type":"otauPossible","value":false},"12":{"type":"otauProgress","value":0},"13":{"type":"otauStatus","value":""},"14":{"type":"winterMode","value":false},"15":{"type":"chargingDurationDay","value":0},"16":{"type":"charging","value":false},"17":{"type":"chargingLess","value":false},"18":{"type":"lastResetTime","value":0},"19":{"type":"lastResetType","value":-1}}}}}}}},"status":"success"}
/circuit/status - An area
🢓
Provides information about an area, similar to /all .
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| circuitId | ID of the area | String | necessary |
Beispiel
http://192.168.1.0/api/circuit/status?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&circuitId={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"params":{"circuit":{"id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","name":"Flowers","params":{"automaticMode":false,"borderBottom":"40","borderTop":"60","considerMower":false,"day0":"","day1":"09:35-11:32","day2":"","day3":"","day4":"","day5":"","day6":"","irrigationDelayForecast":false,"irrigationType":0,"locationType":2,"plantType":0,"soilType":1,"temperatureOffset":0,"valveStaggering":true},"sensor":"{abcd1234-ab12-ab12-ab12-abcdef123456}","sensorData":{"channel":100,"deviceTypeId":"moistureOutdoor","firmware":"","id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","ipv6":"fe80::211:7d00:30:abcd%zmd0","lastUpdate":1563290254,"stateTypes":{"0":{"type":"moisture","value":100},"1":{"type":"brightness","value":0},"2":{"type":"temperature","value":0},"3":{"type":"frequency","value":0},"4":{"type":"irrigationNecessary","value":false},"5":{"type":"irrigationPossible","value":false},"6":{"type":"temperatureOffset","value":0},"7":{"type":"rssi","value":-200},"8":{"type":"reachable","value":false},"9":{"type":"solarVoltage","value":0},"10":{"type":"sunWithinWeek","value":true},"11":{"type":"lowPower","value":false},"12":{"type":"otauPossible","value":false},"13":{"type":"otauProgress","value":0},"14":{"type":"otauStatus","value":""},"15":{"type":"winterMode","value":false},"16":{"type":"chargingDurationDay","value":0},"17":{"type":"charging","value":false},"18":{"type":"chargingLess","value":false},"19":{"type":"lastResetTime","value":0},"20":{"type":"lastResetType","value":-1}}},"sensorValve":{"channel":1,"valve":"{abcd1234-ab12-ab12-ab12-abcdef123456}"},"stateTypes":{"0":{"type":"irrigation","value":false},"1":{"type":"automaticMode","value":false},"2":{"type":"externBlock","value":false},"3":{"type":"winterMode","value":false},"4":{"type":"irrigationNextStart","value":1563867300},"5":{"type":"irrigationNextEnd","value":1563874320},"6":{"type":"valveStaggeringIndex","value":0}},"valves":{"0":{"channel":1,"valve":"{abcd1234-ab12-ab12-ab12-abcdef123456}","valveData":{"channel":100,"deviceTypeId":"valve","firmware":"1.51.0","id":"{abcd1234-ab12-ab12-ab12-abcdef123456}","ipv6":"fe80::211:7d00:30:abcd%zmd0","lastUpdate":1563352577,"stateTypes":{"0":{"type":"valveInitialClose","value":false},"1":{"type":"valveStatus","value":false},"2":{"type":"openValve","value":false},"3":{"type":"lastIrrigationStart","value":0},"4":{"type":"lastIrrigationEnd","value":1563290494},"5":{"type":"lastIrrigationDuration","value":1563290494},"6":{"type":"rssi","value":-35},"7":{"type":"reachable","value":true},"8":{"type":"solarVoltage","value":"0.84"},"9":{"type":"sunWithinWeek","value":true},"10":{"type":"lowPower","value":false},"11":{"type":"otauPossible","value":false},"12":{"type":"otauProgress","value":0},"13":{"type":"otauStatus","value":""},"14":{"type":"winterMode","value":false},"15":{"type":"chargingDurationDay","value":0},"16":{"type":"charging","value":false},"17":{"type":"chargingLess","value":false},"18":{"type":"lastResetTime","value":0},"19":{"type":"lastResetType","value":-1}}}}}}},"status":"success"}
/circuit/types - All possible types
🢓
Supplies all possible types for soil condition, irrigation devices, plant type, and location.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | required |
Beispiel
http://192.168.1.0/api/circuit/types?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"params":{"irrigationType":{"Drip":2,"Hose":3,"Sprinkler":1,"UpSprinkler":0},"locationType":{"Covered":1,"Glasshouse":2,"Open":0},"plantType":{"Grass":0,"Hedge":1,"Individual":4,"Patch":2,"Tree":3},"soilType":{"Loamy":0,"LoamySandy":2,"Sandy":1,"Unknown":3}},"status":"success"}
/circuit/log - Provides a statistic
🢓
Delivers the states of all devices within the last week or in the defined time periods.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key of /link | String | necessary |
| circuitId | ID of the area | String | necessary |
| timeFilters | Filter by time points | List of unix timestamps in format: "startDate1,endDate1;startDate2,endDate2" | not necessary |
| deviceIds | Filter by deviceIds | List of deviceIds | not necessary |
| stateTypeIds | Filter by stateTypes | List of stateTypes | not necessary |
| sort | Sorting ([asc/desc] default ascending) | [asc/desc] | not necessary |
Beispiel
http://192.168.1.0/api/circuit/log?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&circuitId={abcd1234-ab12-ab12-ab12-abcdef123456}&timeFilters=1566224417,1566224450;1566204417,1566210000&deviceIds={abcd1234-ab12-ab12-ab12-abcdef123456},{wxyz9876-yz98-yz98-yz98-uvwxyz987654}&stateTypeIds=chargingLess,reachable&sort=descAntwort
{"id":0,"params":{"history":[{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1562871030000,"value":"1563180600"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1562871030000,"value":"1563181140"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563181170000,"value":"1563227400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563181170000,"value":"1563227940"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563227970000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563227970000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"chargingLess","timestamp":1563235377000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563235410000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563235410000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"reachable","timestamp":1563237180000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"chargingLess","timestamp":1563290255000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563290262000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563290262000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"reachable","timestamp":1563292080000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"chargingLess","timestamp":1563434285000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563434292000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563434293000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"reachable","timestamp":1563436140000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"chargingLess","timestamp":1563448660000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563448675000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563448675000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"chargingLess","timestamp":1563448684000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"chargingLess","timestamp":1563448685000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563448690000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563448690000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563448690000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563448690000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"reachable","timestamp":1563450540000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"reachable","timestamp":1563455520000,"value":"false"}]},"status":"success"}
/circuit/add - Adds an area
🢓
Adds a new area. For an area without Sensor/Valve, set valves or sensorId to 0.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key of /link | String | necessary |
| valves | List of valveIds for the area | List of valveIds | necessary |
| sensorId | ID of the sensor for the area | String | necessary |
| name | Name of the area | String | necessary |
| borderTop | Upper moisture limit in percent | String | not necessary |
| borderBottom | Lower moisture limit in percent | String | not necessary |
| automaticMode | Automatic irrigation | Boolean | not necessary |
| considerMower | Consider external lawn mower | Boolean | not necessary |
| considerWeather | Consider external weather service – expertMode must be set to true | Boolean | not required |
| considerCharge | Consider loading time for device function expertMode must be set to true | Boolean | not required |
| irrigationType | Set irrigation type | [UpSprinkler/Sprinkler/Drip/Hose] | not necessary |
| plantType | Set plant type | [Gras/Hedge/Patch/Tree/Individual] | not necessary |
| soilType | Set soil type | [Loamy/Sandy/LoamySandy/Unknown] | not necessary |
| locationType | Set position | [Open/Covered/Glasshouse] | not necessary |
| valveStaggering | Enable staggering | Boolean | not necessary |
| day0 | Irrigation times for Monday | String | not necessary |
| day1 | Irrigation times for Tuesday | String | not necessary |
| day2 | Irrigation times for Wednesday | String | not necessary |
| day3 | Irrigation times for Thursday | String | not necessary |
| day4 | Irrigation times for Friday | String | not necessary |
| day5 | Irrigation times for Saturday | String | not necessary |
| day6 | Irrigation times for Sunday | String | not necessary |
Beispiel
http://192.168.1.0/api/circuit/add?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&valves={abcd1234-ab12-ab12-ab12-abcdef123456},{wxyz9876-yz98-yz98-yz98-uvwxyz987654}&sensorId=0&name=Flowers&borderTop=70&borderBottom=30&automaticMode=true&considerMower=false&irrigationType=UpSprinkler&plantType=Gras&soilType=Loamy&locationType=Open&valveStaggering=true&day0=10:50-10:59;23:50-23:55&day3=12:50-13:00&day4=08:00-10:00Antwort
{"id":0,"status":"success"}
/circuit/edit - Edit area
🢓
Adds a new area. For an area without Sensor/Valve, set valves or sensorId to 0.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key of /link | String | required |
| circuitId | ID of the area | String | required |
| valves | List of valveIds for the area | List of valveIds | not necessary |
| sensorId | ID of the sensor for the area | String | not necessary |
| name | Name of the area | String | not necessary |
| borderTop | Upper moisture limit in percent | String | not necessary |
| borderBottom | Lower moisture limit in percent | String | not necessary |
| automaticMode | Automatic irrigation | Boolean | not necessary |
| considerMower | Consider external lawn mower | Boolean | not necessary |
| considerWeather | Consider external weather service – expertMode must be set to true | Boolean | not required |
| considerCharge | Consider loading time for device function expertMode must be set to true | Boolean | not required |
| irrigationType | Set irrigation type | [UpSprinkler/Sprinkler/Drip/Hose] | not necessary |
| plantType | Set plant type | [Gras/Hedge/Patch/Tree/Individual] | not necessary |
| soilType | Set soil type | [Loamy/Sandy/LoamySandy/Unknown] | not necessary |
| locationType | Set position | [Open/Covered/Glasshouse] | not necessary |
| valveStaggering | Enable staggering | Boolean | not necessary |
| day0 | Irrigation times for Monday | String | not necessary |
| day1 | Irrigation times for Tuesday | String | not necessary |
| day2 | Irrigation times for Wednesday | String | not necessary |
| day3 | Irrigation times for Thursday | String | not necessary |
| day4 | Irrigation times for Friday | String | not necessary |
| day5 | Irrigation times for Saturday | String | not necessary |
| day6 | Irrigation times for Sunday | String | not necessary |
Beispiel
http://192.168.1.0/api/circuit/edit?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&circuitId={abcd1234-ab12-ab12-ab12-abcdef123456}&valves={abcd1234-ab12-ab12-ab12-abcdef123456},{wxyz9876-yz98-yz98-yz98-uvwxyz987654}&sensorId=0&name=Flowers&borderTop=70&borderBottom=30&automaticMode=true&considerMower=false&irrigationType=UpSprinkler&plantType=Gras&soilType=Loamy&locationType=Open&valveStaggering=true&day0=10:50-10:59;23:50-23:55&day3=12:50-13:00&day4=08:00-10:00Antwort
{"id":0,"status":"success"}
/circuit/irrigation - Start/stop irrigation
🢓
Starts or stops an irrigation, default for 10 minutes.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| circuitId | ID of the area | String | necessary |
| mode | Start or stopp | [start/stop] | necessary |
| duration | Duration of irrigation in minutes | String | not necessary |
Beispiel
http://192.168.1.0/api/circuit/irrigation?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&circuitId={abcd1234-ab12-ab12-ab12-abcdef123456}&mode=start&duration=15Antwort
{"id":0,"status":"success"}
/circuit/remove - Delete area
🢓
Deletes an area.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| circuitId | ID of the area | String | necessary |
Beispiel
http://192.168.1.0/api/circuit/remove?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&circuitId={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"status":"success"}
/circuit/winter - Activate/deactivate winter mode
🢓
Activates or deactivates the winter mode.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| circuitId | ID of the area | String | necessary |
| winter | Winter mode on/off | Boolean | necessary |
Beispiel
http://192.168.1.0/api/circuit/winter?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&circuitId={abcd1234-ab12-ab12-ab12-abcdef123456}&winter=trueAntwort
{"id":0,"status":"success"}
/extern/status - Data from external devices
🢓
Currently provides data from the external devices "rain", "temperature", "wind" and "mower".
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | required |
Beispiel
http://192.168.1.0/api/extern/status?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"params":{"mower":null,"rain":false,"temperature":20,"wind":null},"status":"success"}
/extern/rain - Informs MIYO about rain
🢓
Informs MIYO about rain. If the value is set to true, the Cube takes rain weather into account; if it is set to false, it considers the weather from the Cloud.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| rain | Set rain | Boolean | necessary |
Beispiel
http://192.168.1.0/api/extern/rain?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&rain=trueAntwort
{"id":0,"status":"success"}
/extern/wind - Sends the wind speed
🢓
Sends the wind speed. The limit for the wind speed to stop the irrigation is 40.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| wind | Wind speed | Integer | necessary |
Beispiel
http://192.168.1.0/api/extern/wind?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&wind=20Antwort
{"id":0,"status":"success"}
/extern/temperature - Sends the temperature
🢓
Sends the temperature in degrees Celsius.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| temperature | Temperature in degrees Celsius | Integer | necessary |
Beispiel
http://192.168.1.0/api/extern/temperature?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&temperature=20Antwort
{"id":0,"status":"success"}
/extern/mower - Sends that a lawn mower is running
🢓
Sends whether a lawn mower is currently running/not running. The value considerMower in /circuit/edit must be set to true.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| running | Lawn mower is running | Boolean | necessary |
Beispiel
http://192.168.1.0/api/extern/mower?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&running=trueAntwort
{"id":0,"status":"success"}
/extern/block - Block area
🢓
Allows or prohibits irrigation for an area, e.g. during a party.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| circuitId | ID of the area to be blocked | String | necessary |
| block | Block on/off | Boolean | necessary |
Beispiel
http://192.168.1.0/api/extern/block?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&circuitId={abcd1234-ab12-ab12-ab12-abcdef123456}&block=trueAntwort
{"id":0,"status":"success"}
/system/status - Information about the Cube
🢓
Provides information about the Cube.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | required |
Beispiel
http://192.168.1.0/api/system/status?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"params":{"cloudAllowed":true,"expertMode":true,"lat":"21.271656","linkMode":false,"lon":"-157.821612","updateStatus":0,"uuid":"{abcd1234-ab12-ab12-ab12-abcdef123456}","version":"1.3.5"},"status":"success"}
/system/time - Current time
🢓
Provides the current local time and time zone.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | required |
Beispiel
http://192.168.1.0/api/system/time?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"params":{"clock":{"timestamp":1566809253,"timezone":"CEST"},"timestamp":1566809253,"timezone":"CEST"},"status":"success"}
/system/timezone - All time zones
🢓
Delivers all time zones.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | required |
Beispiel
http://192.168.1.0/api/system/timezone?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"params":{"timezones":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Inuvik","America/Iqaluit","America/Jamaica","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Chita","Asia/Choibalsan","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kathmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Riyadh","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Wake","Pacific/Wallis","UTC","UTC\u002B00:00","UTC\u002B01:00","UTC\u002B02:00","UTC\u002B03:00","UTC\u002B03:30","UTC\u002B04:00","UTC\u002B04:30","UTC\u002B05:00","UTC\u002B05:30","UTC\u002B05:45","UTC\u002B06:00","UTC\u002B06:30","UTC\u002B07:00","UTC\u002B08:00","UTC\u002B09:00","UTC\u002B09:30","UTC\u002B10:00","UTC\u002B11:00","UTC\u002B12:00","UTC\u002B13:00","UTC\u002B14:00","UTC-00:00","UTC-01:00","UTC-02:00","UTC-03:00","UTC-03:30","UTC-04:00","UTC-04:30","UTC-05:00","UTC-06:00","UTC-07:00","UTC-08:00","UTC-09:00","UTC-10:00","UTC-11:00","UTC-12:00","UTC-13:00","UTC-14:00"]},"status":"success"}
/system/weather - Current Weather
🢓
Provides the current weather.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | required |
Beispiel
http://192.168.1.0/api/system/weather?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"params":{"weather":{"description":"light intensity shower rain","forecast":true,"icon":"09d","temperature":24}},"status":"success"}
/system/reboot - Cube Restart
🢓
Restart the Cube.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | required |
Beispiel
http://192.168.1.0/api/system/reboot?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"status":"success"}
/system/reset - Reset cube
🢓
Cube is reset to factory settings.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | required |
Beispiel
http://192.168.1.0/api/system/reset?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"status":"success"}
/system/position - Set GPS position
🢓
Sets the GPS position of the Cube (needed for the weather forecast).
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| lon | Longitude | String | necessary |
| lat | Latitude | String | necessary |
Beispiel
http://192.168.1.0/api/system/position?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&lat=21.271656&lon=-157.821612Antwort
{"id":0,"status":"success"}
/system/allowlink - Allow linking
🢓
Allows a new user to connect to the Cube, as when pressing the Cube button.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | required |
Beispiel
http://192.168.1.0/api/system/allowlink?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}Antwort
{"id":0,"status":"success"}
/system/cloud - Enable/disable cloud connection
🢓
Enables or disables the cloud connection.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| allowed | Cloud allowed | Boolean | necessary |
Beispiel
http://192.168.1.0/api/system/cloud?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&allowed=trueAntwort
{"id":0,"status":"success"}
/system/timezone - Set timezone
🢓
Sets the timezone of the Cube.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| timezone | Timezone | String | necessary |
Beispiel
http://192.168.1.0/api/system/timezone?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&timezone=Atlantic/St_HelenaAntwort
{"id":0,"status":"success"}
/system/expertMode - set expertMode
🢓
Activates or deactivates the expertMode, which is required for certain additional settings.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| allowed | expertMode on | Boolean | required |
Beispiel
http://192.168.1.0/api/system/expertMode?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&allowed=trueAntwort
{"id":0,"status":"success"}
/logging/entries - Provides a statistic
🢓
Delivers the states of all devices within the last week or in the defined time periods.
Parameter
| Name | Beschreibung | Typ | Erforderlich |
|---|---|---|---|
| apiKey | API Key from /link | String | necessary |
| circuitIds | Filter by circuits | List of circuitIds | not necessary |
| timeFilters | Filter by time points | List of unix timestamps in the format: "startDate1,endDate1;startDate2,endDate2" | not necessary |
| deviceIds | Filter by deviceIds | List of deviceIds | not necessary |
| stateTypeIds | Filter by stateTypes | List of stateTypes | not necessary |
| sort | Sorting ([asc/desc] default ascending) | [asc/desc] | not necessary |
Beispiel
http://192.168.1.0/api/circuit/log?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&circuitIds={abcd1234-ab12-ab12-ab12-abcdef123456},{wxyz9876-yz98-yz98-yz98-uvwxyz987654}&timeFilters=1566224417,1566224450;1566204417,1566210000&deviceIds={abcd1234-ab12-ab12-ab12-abcdef123456},{wxyz9876-yz98-yz98-yz98-uvwxyz987654}&stateTypeIds=chargingLess,reachable&sort=descAntwort
{"id":0,"params":{"history":[{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1562871030000,"value":"1563180600"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1562871030000,"value":"1563181140"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563181170000,"value":"1563227400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563181170000,"value":"1563227940"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563227970000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563227970000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"chargingLess","timestamp":1563235377000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563235410000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563235410000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"reachable","timestamp":1563237180000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"chargingLess","timestamp":1563290255000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563290262000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563290262000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"reachable","timestamp":1563292080000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"chargingLess","timestamp":1563434285000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563434292000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563434293000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"reachable","timestamp":1563436140000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"chargingLess","timestamp":1563448660000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563448675000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563448675000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"chargingLess","timestamp":1563448684000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"chargingLess","timestamp":1563448685000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563448690000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563448690000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextStart","timestamp":1563448690000,"value":"1563461400"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"irrigationNextEnd","timestamp":1563448690000,"value":"1563475800"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"reachable","timestamp":1563450540000,"value":"false"},{"circuitId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","deviceId":"{abcd1234-ab12-ab12-ab12-abcdef123456}","source":"LoggingSourceState","stateTypeId":"reachable","timestamp":1563455520000,"value":"false"}]},"status":"success"}