fbpx

Cube API Documentation

General

Websocket request

Port: 3810

Format: json

case-sensitive

ws://*IP*:3810

Notifications

The cube sends Notifications over the websocket. A notification contains the id -1 and the value « notification » with the info about the changes


Example:

{
  "id": -1,
  "notification": "Device.stateChanged",
  "params": {
    "deviceId": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
    "type": "rssi",
    "value": -41
  }
}

Link.all - Provides a new apiKey

Provides a new apiKey, if access is allowed. A button push on the Cube or the api method System.allowlink allows one request for 15 minutes.

Request

Example:

{
  "id": 1,
  "method": "Link.all"
}

Parameters:

id Cube sends this id back Integer not required
method type of request String required

Response

{
"apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"id": 1,
"status": "success"
}

System.update - Schedules the next update.

Schedules the next update. Won’t start immediately.

Request

Example:

{
  "id": 1,
  "method": "System.update"
}

Parameters:

id Cube sends this id back Integer not required
method type of request String required

Response

{
"id": 1,
"status": "success"
}

Device.all - Provides information about all devices.

Provides information about all devices.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Device.all",
  "params": {
    "typeIds": [
      "valve"
    ]
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
typeIds Device type filter (multiple possible) [valve/moistureOutdoor] not required

Response

{
  "id": 1,
  "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 one device

Provides information about one device.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Device.status",
  "params": {
    "deviceId": "{abcd1234-ab12-ab12-ab12-abcdef123456}"
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
deviceId ID of the device String required

Response

{
  "id": 1,
  "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 - Provides only unassigned devices

Provides only devices that are not assigned to an irrigation area.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Device.free",
  "params": {
    "typeIds": [
      "valve"
    ]
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
typeIds Device type filter (multiple possible) [valve/moistureOutdoor] not required

Response

{
  "id": 1,
  "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 Cube.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Device.remove",
  "params": {
    "deviceId": "{abcd1234-ab12-ab12-ab12-abcdef123456}"
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
deviceId ID of the device String required

Response

{
  "id": 1,
  "status": "success"
}

Device.teachin- Teaches a device

Connects to a device, that is activated with a magnet.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Device.teachin"
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required

Response

{
  "id": 1,
  "status": "success"
}

Device.highlight- Activate LED on device

Activates LED on the chosen device.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Device.highlight",
  "params": {
    "deviceId": "{abcd1234-ab12-ab12-ab12-abcdef123456}"
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
deviceId ID of the device String required

Response

{
  "id": 1,
  "status": "success"
}

Circuit.all - All irrigation areas

Provides information about all irrigation areas.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Circuit.all"
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required

Response

{
    "id": 1,
    "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 - One irrigation area

Provides information about one irrigation area, analog to /all.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Circuit.status",
  "params": {
    "circuitId": "{abcd1234-ab12-ab12-ab12-abcdef123456}"
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
circuitId ID of the circuit String required

Response

{
    "id": 1,
    "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 - Provides all possible types

Provides all possible types for soil composition, irrigation tools, plants and location.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Circuit.types"
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required

Response

{
    "id": 1,
    "params": {
        "irrigationType": {
            "Drip": 2,
            "Hose": 3,
            "Sprinkler": 1,
            "UpSprinkler": 0
        },
        "locationType": {
            "Covered": 1,
            "Glasshouse": 2,
            "Open": 0
        },
        "plantType": {
            "Gras": 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

Provides all device states for the last week or within set time.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Circuit.log",
  "params": {
    "circuitId": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
    "timeFilters": [
        {"startDate": 1566224417, "endDate": 1566224450},
        {"startDate": 1566204417, "endDate": 1566210000}
    ],
    "deviceIds": [
        "{abcd1234-ab12-ab12-ab12-abcdef123456}",
        "{wxyz9876-yz98-yz98-yz98-uvwxyz987654}"
    ],
    "stateTypeIds": [
        "chargingLess",
        "reachable"
    ],
    "sort": "desc"
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
circuitId ID of the circuit String required
timeFilters Filter statistics by timestamps List of unix timestamps in format: « startDate1,endDate1;startDate2,endDate2 » not required
deviceIds Filter by deviceIds List of deviceIds not required
stateTypeIds Filter by stateTypes List of stateTypes not required
sort Sort direction (ascending by default) [asc/desc] not required

Response

{
    "id": 1,
    "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 a circuit

Adds a new irrigation area. Set valves or sensorId to 0 for circuit without valve/sensor.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Circuit.add",
  "params": {
    "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:00"
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
valves List of valveIds in the circuit List of Strings required
sensorId ID of the sensor in the circuit String required
name Name of the circuit String required
borderTop Top moisture border in percent String not required
borderBottom Bottom moisture border in percent String not required
automaticMode Automatic irrigation on Boolean not required
considerMower Consider extern Mower for irrigation Boolean not required
considerWeather Consider the weather from extern weather service – expertMode has to be set to true Boolean not required
considerCharge Consider chargingduration for devices to work – expertMode has to be set to true Boolean not required
irrigationType Set irrigation Type [UpSprinkler/Sprinkler/Drip/Hose] not required
plantType Set plant Type [Gras/Hedge/Patch/Tree/Individual] not required
soilType Set soil Type [Loamy/Sandy/LoamySandy/Unknown] not required
locationType Set location Type [Open/Covered/Glasshouse] not required
valveStaggering Staggering On Boolean not required
day0 Irrigation times for Monday String not required
day1 Irrigation times for Tuesday String not required
day2 Irrigation times for Wednesday String not required
day3 Irrigation times for Thursday String not required
day4 Irrigation times for Friday String not required
day5 Irrigation times for Saturday String not required
day6 Irrigation times for Sunday String not required

Response

{
    "id": 1,
    "status": "success"
}

Circuit.edit - Edits a circuit

Edit an irrigation area. Set valves or sensorId to 0 for circuit without valve/sensor.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Circuit.edit",
  "params": {
    "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:00"
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
circuitId ID of the circuit String required
valves List of valveIds in the circuit List of Strings not required
sensorId ID of the sensor in the circuit String not required
name Name of the circuit String not required
borderTop Top moisture border in percent String not required
borderBottom Bottom moisture border in percent String not required
automaticMode Automatic irrigation on Boolean not required
considerMower Consider extern Mower for irrigation Boolean not required
considerWeather Consider the weather from extern weather service – expertMode has to be set to true Boolean not required
considerCharge Consider chargingduration for devices to work – expertMode has to be set to true Boolean not required
irrigationType Set irrigation Type [UpSprinkler/Sprinkler/Drip/Hose] not required
plantType Set plant Type [Gras/Hedge/Patch/Tree/Individual] not required
soilType Set soil Type [Loamy/Sandy/LoamySandy/Unknown] not required
locationType Set location Type [Open/Covered/Glasshouse] not required
valveStaggering Staggering On Boolean not required
day0 Irrigation times for Monday String not required
day1 Irrigation times for Tuesday String not required
day2 Irrigation times for Wednesday String not required
day3 Irrigation times for Thursday String not required
day4 Irrigation times for Friday String not required
day5 Irrigation times for Saturday String not required
day6 Irrigation times for Sunday String not required

Response

{
    "id": 1,
    "status": "success"
}

Circuit.irrigation - Start/Stop irrigation

Starts or stops an irrigation, default for 10 minutes.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Circuit.irrigation",
  "params": {
    "circuitId": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
    "mode": "start",
    "duration": 15
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
circuitId ID of the circuit String required
mode Start or stop [start/stop] required
duration Duration of the irrigation in minutes String not required

Response

{
    "id": 1,
    "status": "success"
}

Circuit.remove - Delete circuit

Deletes an irrigation area.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Circuit.remove",
  "params": {
    "circuitId": "{abcd1234-ab12-ab12-ab12-abcdef123456}"
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
circuitId ID of the circuit String required

Response

{
    "id": 1,
    "status": "success"
}

Circuit.winter - Activate/Deactivate wintermode

Activates or deactivates the wintermode.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Circuit.winter",
  "params": {
    "circuitId": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
    "winter": true
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
circuitId ID of the circuit String required
winter Wintermode on/off Boolean required

Response

{
    "id": 1,
    "status": "success"
}

Extern.status - Provides data of extern devices

Provides current data of extern devices « rain », « temperature », « wind » and « mower ».

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Extern.status",
  "params": {
    "circuitId": "{abcd1234-ab12-ab12-ab12-abcdef123456}"
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required

Response

{
    "id": 1,
    "params": {
        "mower": null,
        "rain": false,
        "temperature": 20,
        "wind":null
    },
    "status": "success"
}

Extern.rain - Informs MIYO about rain

Informs MIYO about rain. If set to true MIYO Cube considers raining, if set to false MIYO Cube only considers weather from cloud.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Extern.rain",
  "params": {
    "circuitId": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
    "rain": true
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
rain Set raining Boolean required

Response

{
    "id": 1,
    "status": "success"
}

Extern.wind - Defines wind force

Send wind force to miyo. The wind force limit for MIYO to stop irrigation is 40.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Extern.wind",
  "params": {
    "circuitId": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
    "wind": 20
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
wind Wind force Integer required

Response

{
    "id": 1,
    "status": "success"
}

Extern.temperature- Defines temperature

Send temperature in degree Celsius to miyo.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Extern.temperature",
  "params": {
    "circuitId": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
    "temperature": 20
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
temperature Temperature in degree Celsius Integer required

Response

{
    "id": 1,
    "status": "success"
}

Extern.mower - Set if mower is running

Defines if a mower is currently active or not. The value considerMower in /circuit/edit has to be set to true.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Extern.mower",
  "params": {
    "circuitId": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
    "running": true
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
running Mower running Boolean required

Response

{
    "id": 1,
    "status": "success"
}

Extern.block - Block circuit

Permits or prohibits the irrigation for a circuit for example during a party.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Extern.block",
  "params": {
    "circuitId": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
    "block": true
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
circuitId ID of the circuit to be blocked String required
block Blocking On/Off Boolean required

Response

{
    "id": 1,
    "status": "success"
}

System.status - Information about cube

Provides information about the cube.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "System.status"
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required

Response

{
    "id": 1,
    "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 current local time and timezone.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "System.time"
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required

Response

{
    "id": 1,
    "params": {
        "clock": {
            "timestamp":1566809253,
            "timezone":"CEST"
        },
        "timestamp": 1566809253,
        "timezone": "CEST"
    },
    "status": "success"
}

System.timezone - All timezones

Provides all timezones.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "System.timezone"
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required

Response

{
    "id": 1,
    "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+00:00",
            "UTC+01:00",
            "UTC+02:00",
            "UTC+03:00",
            "UTC+03:30",
            "UTC+04:00",
            "UTC+04:30",
            "UTC+05:00",
            "UTC+05:30",
            "UTC+05:45",
            "UTC+06:00",
            "UTC+06:30",
            "UTC+07:00",
            "UTC+08:00",
            "UTC+09:00",
            "UTC+09:30",
            "UTC+10:00",
            "UTC+11:00",
            "UTC+12:00",
            "UTC+13:00",
            "UTC+14: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 current weather.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "System.weather"
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required

Response

{
    "id": 1,
    "params": {
        "weather": {
            "description": "light intensity shower rain",
            "forecast": true,
            "icon": "09d",
            "temperature":24
        }
    },
    "status": "success"
}

System.reboot - Restart cube

Restarts the cube.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "System.reboot"
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required

Response

{
    "id": 1,
    "status": "success"
}

System.reset - Reset cube

Reset cube to factory settings.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "System.reset"
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required

Response

{
    "id": 1,
    "status": "success"
}

System.position - Set GPS Position

Sets the GPS Position of the cube (necessary for weather forecast).

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "System.position",
  "params": {
    "lat": 21.271656,
    "lon": -157.821612
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
lon Longitude String required
lat Latitude String required

Response

{
    "id": 1,
    "status": "success"
}

System.allowlink - Allow linking

Allows a new user to link with cube as pressing the button on the cube.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "System.allowlink"
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required

Response

{
    "id": 1,
    "status": "success"
}

System.cloud- Activate/deactivate cloud connection

Activates or deactivates the cloud connection.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "System.cloud",
  "params": {
    "allowed": true
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
allowed Cloud allowed Boolean required

Response

{
    "id": 1,
    "status": "success"
}

System.timezone - Set timezone

Sets the timezone of the cube.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "System.timezone",
  "params": {
    "timezone": "Atlantic/St_Helena"
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
timezone Timezone String required

Response

{
    "id": 1,
    "status": "success"
}

System.expertMode - Set expertMode

Activates or deactivates the expertmode that is required to change some additional settings.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "System.expertMode",
  "params": {
    "allowed": true
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
allowed expertMode allowed Boolean required

Response

{
    "id": 1,
    "status": "success"
}

Logging.entries - Provides a statistic

Provides all device states for the last week or within the set time.

Request

Example:

{
  "id": 1,
  "apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
  "method": "Logging.entries",
  "params": {
    "circuitIds": [
        "{abcd1234-ab12-ab12-ab12-abcdef123456}",
        "{wxyz9876-yz98-yz98-yz98-uvwxyz987654}"
    ],
    "timeFilters": [
        {"startDate": 1566224417, "endDate": 1566224450},
        {"startDate": 1566204417, "endDate": 1566210000}
    ],
    "deviceIds": [
        "{abcd1234-ab12-ab12-ab12-abcdef123456}",
        "{wxyz9876-yz98-yz98-yz98-uvwxyz987654}"
    ],
    "stateTypeIds": [
        "chargingLess",
        "reachable"
    ],
    "sort": "desc"
  }
}

Parameters:

id Cube sends this id back Integer not required
apiKey api key gotten from Link.all String required
method type of request String required
circuitIds Filter by circuits List of circuitIds not required
timeFilters Filter statistics by timestamps List of unix timestamps in format: « startDate1,endDate1;startDate2,endDate2 » not required
deviceIds Filter by deviceIds List of deviceIds not required
stateTypeIds Filter by stateTypes List of stateTypes not required
sort Sort direction (ascending by default) [asc/desc] not required

Response

{
    "id": 1,
    "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"
}

General

HTTP Request

This is the documentation for the MIYO Cube HTTP API. The API is accessible on

http://*IP*/api/*Method*

where *IP* is the IP address of your cube and *Method* the request you want to execute on the cube (see list below).

/link - Provides a new apiKey

Provides a new apiKey, if access is allowed. A button push on the Cube or the api method /system/allowlink allows one request for 15 minutes.

Request

Example:

http://192.168.1.0/api/device/link

Parameters:

Response

{
"apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"id": 0,
"status": "success"
}

/system/update - Schedules the next update.

Schedules the next update. Won’t start immediately.

Request

Example:

http://192.168.1.0/api/device/system/update

Parameters:

Response

{
"id": 0,
"status": "success"
}

/device/all - Provides information about all devices.

Provides information about all devices.

Request

Example:

http://192.168.1.0/api/device/all?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&typeIds=valve

Parameters:

apiKey api key gotten from /link String required
typeIds Device type filter (multiple possible) [valve/moistureOutdoor] not required

Response

{
  "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 one device

Provides information about one device.

Request

Example:

http://192.168.1.0/api/device/status?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&deviceId={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required
deviceId ID of the device String required

Response

{
  "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 - Provides only unassigned devices

Provides only devices that are not assigned to an irrigation area.

Request

Example:

http://192.168.1.0/api/device/free?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&typeIds=valve

Parameters:

apiKey api key gotten from /link String required
typeIds Device type filter (multiple possible) [valve/moistureOutdoor] not required

Response

{
  "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 Cube.

Request

Example:

http://192.168.1.0/api/device/remove?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&deviceId={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required
deviceId ID of the device String required

Response

{
  "id": 0,
  "status": "success"
}

/device/teachin- Teaches a device

Connects to a device, that is activated with a magnet.

Request

Example:

http://192.168.1.0/api/device/teachin?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required

Response

{
  "id": 0,
  "status": "success"
}

/device/highlight- Activate LED on device

Activates LED on the chosen device.

Request

Example:

http://192.168.1.0/api/device/highlight?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&deviceId={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required
deviceId ID of the device String required

Response

{
  "id": 0,
  "status": "success"
}

/circuit/all - All irrigation areas

Provides information about all irrigation areas.

Request

Example:

http://192.168.1.0/api/circuit/all?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required

Response

{
    "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 - One irrigation area

Provides information about one irrigation area, analog to /all.

Request

Example:

http://192.168.1.0/api/circuit/status?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&circuitId={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required
circuitId ID of the circuit String required

Response

{
    "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 - Provides all possible types

Provides all possible types for soil composition, irrigation tools, plants and location.

Request

Example:

http://192.168.1.0/api/circuit/types?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required

Response

{
    "id": 0,
    "params": {
        "irrigationType": {
            "Drip": 2,
            "Hose": 3,
            "Sprinkler": 1,
            "UpSprinkler": 0
        },
        "locationType": {
            "Covered": 1,
            "Glasshouse": 2,
            "Open": 0
        },
        "plantType": {
            "Gras": 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

Provides all device states for the last week or within set time.

Request

Example:

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=desc

Parameters:

apiKey api key gotten from /link String required
circuitId ID of the circuit String required
timeFilters Filter statistics by timestamps List of unix timestamps in format: « startDate1,endDate1;startDate2,endDate2 » not required
deviceIds Filter by deviceIds List of deviceIds not required
stateTypeIds Filter by stateTypes List of stateTypes not required
sort Sort direction (ascending by default) [asc/desc] not required

Response

{
    "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 a circuit

Adds a new irrigation area. Set valves or sensorId to 0 for circuit without valve/sensor.

Request

Example:

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:00

Parameters:

apiKey api key gotten from /link String required
valves List of valveIds in the circuit List of Strings required
sensorId ID of the sensor in the circuit String required
name Name of the circuit String required
borderTop Top moisture border in percent String not required
borderBottom Bottom moisture border in percent String not required
automaticMode Automatic irrigation on Boolean not required
considerMower Consider extern Mower for irrigation Boolean not required
considerWeather Consider the weather from extern weather service – expertMode has to be set to true Boolean not required
considerCharge Consider chargingduration for devices to work – expertMode has to be set to true Boolean not required
irrigationType Set irrigation Type [UpSprinkler/Sprinkler/Drip/Hose] not required
plantType Set plant Type [Gras/Hedge/Patch/Tree/Individual] not required
soilType Set soil Type [Loamy/Sandy/LoamySandy/Unknown] not required
locationType Set location Type [Open/Covered/Glasshouse] not required
valveStaggering Staggering On Boolean not required
day0 Irrigation times for Monday String not required
day1 Irrigation times for Tuesday String not required
day2 Irrigation times for Wednesday String not required
day3 Irrigation times for Thursday String not required
day4 Irrigation times for Friday String not required
day5 Irrigation times for Saturday String not required
day6 Irrigation times for Sunday String not required

Response

{
    "id": 0,
    "status": "success"
}

/circuit/edit - Edits a circuit

Edit an irrigation area. Set valves or sensorId to 0 for circuit without valve/sensor.

Request

Example:

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:00

Parameters:

apiKey api key gotten from /link String required
circuitId ID of the circuit String required
valves List of valveIds in the circuit List of Strings not required
sensorId ID of the sensor in the circuit String not required
name Name of the circuit String not required
borderTop Top moisture border in percent String not required
borderBottom Bottom moisture border in percent String not required
automaticMode Automatic irrigation on Boolean not required
considerMower Consider extern Mower for irrigation Boolean not required
considerWeather Consider the weather from extern weather service – expertMode has to be set to true Boolean not required
considerCharge Consider chargingduration for devices to work – expertMode has to be set to true Boolean not required
irrigationType Set irrigation Type [UpSprinkler/Sprinkler/Drip/Hose] not required
plantType Set plant Type [Gras/Hedge/Patch/Tree/Individual] not required
soilType Set soil Type [Loamy/Sandy/LoamySandy/Unknown] not required
locationType Set location Type [Open/Covered/Glasshouse] not required
valveStaggering Staggering On Boolean not required
day0 Irrigation times for Monday String not required
day1 Irrigation times for Tuesday String not required
day2 Irrigation times for Wednesday String not required
day3 Irrigation times for Thursday String not required
day4 Irrigation times for Friday String not required
day5 Irrigation times for Saturday String not required
day6 Irrigation times for Sunday String not required

Response

{
    "id": 0,
    "status": "success"
}

/circuit/irrigation - Start/Stop irrigation

Starts or stops an irrigation, default for 10 minutes.

Request

Example:

http://192.168.1.0/api/circuit/irrigation?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&circuitId={abcd1234-ab12-ab12-ab12-abcdef123456}&mode=start&duration=15

Parameters:

apiKey api key gotten from /link String required
circuitId ID of the circuit String required
mode Start or stop [start/stop] required
duration Duration of the irrigation in minutes String not required

Response

{
    "id": 0,
    "status": "success"
}

/circuit/remove - Delete circuit

Deletes an irrigation area.

Request

Example:

http://192.168.1.0/api/circuit/remove?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&circuitId={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required
circuitId ID of the circuit String required

Response

{
    "id": 0,
    "status": "success"
}

/circuit/winter - Activate/Deactivate wintermode

Activates or deactivates the wintermode.

Request

Example:

http://192.168.1.0/api/circuit/winter?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&circuitId={abcd1234-ab12-ab12-ab12-abcdef123456}&winter=true

Parameters:

apiKey api key gotten from /link String required
circuitId ID of the circuit String required
winter Wintermode on/off Boolean required

Response

{
    "id": 0,
    "status": "success"
}

/extern/status - Provides data of extern devices

Provides current data of extern devices « rain », « temperature », « wind » and « mower ».

Request

Example:

http://192.168.1.0/api/extern/status?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required

Response

{
    "id": 0,
    "params": {
        "mower": null,
        "rain": false,
        "temperature": 20,
        "wind":null
    },
    "status": "success"
}

/extern/rain - Informs MIYO about rain

Informs MIYO about rain. If set to true MIYO Cube considers raining, if set to false MIYO Cube only considers weather from cloud.

Request

Example:

http://192.168.1.0/api/extern/rain?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&rain=true

Parameters:

apiKey api key gotten from /link String required
rain Set raining Boolean required

Response

{
    "id": 0,
    "status": "success"
}

/extern/wind - Defines wind force

Send wind force to miyo. The wind force limit for MIYO to stop irrigation is 40.

Request

Example:

http://192.168.1.0/api/extern/wind?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&wind=20

Parameters:

apiKey api key gotten from /link String required
wind Wind force Integer required

Response

{
    "id": 0,
    "status": "success"
}

/extern/temperature- Defines temperature

Send temperature in degree Celsius to miyo.

Request

Example:

http://192.168.1.0/api/extern/temperature?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&temperature=20

Parameters:

apiKey api key gotten from /link String required
temperature Temperature in degree Celsius Integer required

Response

{
    "id": 0,
    "status": "success"
}

/extern/mower - Set if mower is running

Defines if a mower is currently active or not. The value considerMower in /circuit/edit has to be set to true.

Request

Example:

http://192.168.1.0/api/extern/mower?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&running=true

Parameters:

apiKey api key gotten from /link String required
running Mower running Boolean required

Response

{
    "id": 0,
    "status": "success"
}

/extern/block - Block circuit

Permits or prohibits the irrigation for a circuit for example during a party.

Request

Example:

http://192.168.1.0/api/extern/block?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&circuitId={abcd1234-ab12-ab12-ab12-abcdef123456}&block=true

Parameters:

apiKey api key gotten from /link String required
circuitId ID of the circuit to be blocked String required
block Blocking On/Off Boolean required

Response

{
    "id": 0,
    "status": "success"
}

/system/status - Information about cube

Provides information about the cube.

Request

Example:

http://192.168.1.0/api/system/status?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required

Response

{
    "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 current local time and timezone.

Request

Example:

http://192.168.1.0/api/system/time?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required

Response

{
    "id": 0,
    "params": {
        "clock": {
            "timestamp":1566809253,
            "timezone":"CEST"
        },
        "timestamp": 1566809253,
        "timezone": "CEST"
    },
    "status": "success"
}

/system/timezone - All timezones

Provides all timezones.

Request

Example:

http://192.168.1.0/api/system/timezone?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required

Response

{
    "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+00:00",
            "UTC+01:00",
            "UTC+02:00",
            "UTC+03:00",
            "UTC+03:30",
            "UTC+04:00",
            "UTC+04:30",
            "UTC+05:00",
            "UTC+05:30",
            "UTC+05:45",
            "UTC+06:00",
            "UTC+06:30",
            "UTC+07:00",
            "UTC+08:00",
            "UTC+09:00",
            "UTC+09:30",
            "UTC+10:00",
            "UTC+11:00",
            "UTC+12:00",
            "UTC+13:00",
            "UTC+14: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 current weather.

Request

Example:

http://192.168.1.0/api/system/weather?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required

Response

{
    "id": 0,
    "params": {
        "weather": {
            "description": "light intensity shower rain",
            "forecast": true,
            "icon": "09d",
            "temperature":24
        }
    },
    "status": "success"
}

/system/reboot - Restart cube

Restarts the cube.

Request

Example:

http://192.168.1.0/api/system/reboot?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required

Response

{
    "id": 0,
    "status": "success"
}

/system/reset - Reset cube

Reset cube to factory settings.

Request

Example:

http://192.168.1.0/api/system/reset?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required

Response

{
    "id": 0,
    "status": "success"
}

/system/position - Set GPS Position

Sets the GPS Position of the cube (necessary for weather forecast).

Request

Example:

http://192.168.1.0/api/system/position?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&lat=21.271656&lon=-157.821612

Parameters:

apiKey api key gotten from /link String required
lon Longitude String required
lat Latitude String required

Response

{
    "id": 0,
    "status": "success"
}

/system/allowlink - Allow linking

Allows a new user to link with cube as pressing the button on the cube.

Request

Example:

http://192.168.1.0/api/system/allowlink?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}

Parameters:

apiKey api key gotten from /link String required

Response

{
    "id": 0,
    "status": "success"
}

/system/cloud- Activate/deactivate cloud connection

Activates or deactivates the cloud connection.

Request

Example:

http://192.168.1.0/api/system/cloud?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&allowed=true

Parameters:

apiKey api key gotten from /link String required
allowed Cloud allowed Boolean required

Response

{
    "id": 0,
    "status": "success"
}

/system/timezone - Set timezone

Sets the timezone of the cube.

Request

Example:

http://192.168.1.0/api/system/timezone?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&timezone=Atlantic/St_Helena

Parameters:

apiKey api key gotten from /link String required
timezone Timezone String required

Response

{
    "id": 0,
    "status": "success"
}

/system/expertMode - Set expertMode

Activates or deactivates the expertmode that is required to change some additional settings.

Request

Example:

http://192.168.1.0/api/system/expertMode?apiKey={abcd1234-ab12-ab12-ab12-abcdef123456}&allowed=true

Parameters:

apiKey api key gotten from /link String required
allowed expertMode allowed Boolean required

Response

{
    "id": 0,
    "status": "success"
}

/logging/entries - Provides a statistic

Provides all device states for the last week or within the set time.

Request

Example:

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=desc

Parameters:

apiKey api key gotten from /link String required
circuitIds Filter by circuits List of circuitIds not required
timeFilters Filter statistics by timestamps List of unix timestamps in format: « startDate1,endDate1;startDate2,endDate2 » not required
deviceIds Filter by deviceIds List of deviceIds not required
stateTypeIds Filter by stateTypes List of stateTypes not required
sort Sort direction (ascending by default) [asc/desc] not required

Response

{
    "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"
}

Devices

sensorData and valveData

Type Description Datatype
valveInitialClose Valve should be closed Boolean
valveStatus Valve is open Boolean
openValve Valve should be opened Boolean
lastIrrigationStart Unix Timestamp of last irrigation start Integer
lastIrrigationEnd Unix Timestamp of last irrigation end Integer
lastIrrigationDuration Duration of last irrigation Integer
rssi Signal Strength of device Integer
reachable Device is reachable by cube Boolean
solarVoltage Solar voltage of device Integer
sunWithinWeek currently always true Boolean
lowPower Device has low power Boolean
otauPossible Installation of update is possible Boolean
otauProgress Progress of update Integer
otauStatus Update status of device String
winterMode Winter mode activated Boolean
chargingDurationDay Charging duration per day within last week Integer
charging Device is charging Boolean
chargingLess Device is not charging enough Boolean
lastResetTime Time of last reset of the device Integer
lastResetType Type of last reset of the device String
moisture Moisture of sensor in % Integer
brightness Brightness of sensor in lux Integer
temperature Temperature of sensor (close to ground) in °C Integer
frequency Frequency of the moisture sensor Integer
irrigationNecessary Irrigation necessary (soil very dry) Boolean
irrigationPossible Irrigation possible (soil dry) Boolean
temperatureOffset Temperature offset of Sensor Integer

Statetypes

Type Description Datatype
channel Radio Channel of the Sensor Integer
deviceTypeId Type of device String
firmware Firmware version String
id Unique id of the device String
ipv6 Ipv6 address of the device String
lastUpdate Unix timestamp of last update String
stateTypes List of all stateTypes with values List of stateTypes