MIYO is an intelligent, radio-based irrigation system for gardens of any size. The starter kit consists of a cube, a sensor and a valve. The Cube is the brain of your MIYO system. It maintains a wireless connection to the sensor and valve and coordinates the irrigation. It takes into account your individual specifications, weather forecasts and optional messages from the smart home. The sensor transmits humidity values, temperature and brightness to the Cube. The valve is opened automatically by the Cube or manually via the mobile app, depending on the garden settings. The sensor and valve are powered by solar energy and therefore do not require batteries. The MIYO system optimizes the watering of your plants, saving water and ensuring healthy soil and plants.
What are you looking for?
FAQ - all information about our MIYO products
General
Which devices does MIYO consist of and how does it work?
For whom is the MIYO irrigation system suitable?
For every hobby and professional gardener who wants to water their garden smartly and in a resource-saving way. Because MIYO takes into account soil moisture, weather forecasts and individual settings, plants and soil are always optimally supplied with water and there is no overwatering. This reduces water consumption by up to 50%. Soil and plants become healthier. Due to solar charging and the resulting elimination of the need to change batteries, huge amounts of battery waste are saved over the years.
For young and old, MIYO is child's play to install, user-friendly to operate and an eye-catcher in any garden.
Likewise, technology- and innovation-loving trendsetters get their money's worth and can finally bring the smart home into the garden. Via the smart app, they can call up and change essential parameters of their garden at any time and from anywhere, or directly control the irrigation.
What is the difference between MIYO and an irrigation computer?
The MIYO irrigation logic is not structured like a timer, but is 100% oriented to the needs of the plants. MIYO waters only when it is necessary and not when the time has come. It thus saves up to 50% water. This is good for your plants and it avoids damage to the soil from overwatering. Via the cloud you have access to your garden irrigation anytime and anywhere.
Why can't I set fixed time cycles?
MIYO is not a timed system, but irrigates when soil moisture falls below the set point, no rain is expected, and an allowable window of time for irrigation has been reached.
Take, for example, the area "hedge". Since there might be a bead hose here, watering could be done at any time of day. So the setting is 0-24 on all days. The second range of values you define consists of the moisture upper and lower limits. So which moisture is too dry, which is wet enough.
The vegetable bed, on the other hand, may only be watered from 4:00 am to 6:00 am to avoid direct heat from the sun during watering. So here you set from 04:00 - 06:00.
MIYO checks the parameters every 15 seconds. If MIYO now determines that watering is necessary and also permitted, the first watering cycle starts. After 10-15 minutes, this is interrupted, after another 15 minutes, a control measurement takes place and if necessary (because it is still too dry), the next cycle starts.
This happens with the hedge sometime during the day, with the vegetable patch only within the allowed time. If you want a timed area (for example, after lawn replanting), you disable the sensor in the app and set the watering time. Then the valve will follow the time settings.
What other advantages does MIYO offer?
MIYO does without batteries! Sensors and valves are solar powered, which is sustainable and saves you the hassle of changing batteries.
With MIYO there is no over-irrigation and no watering during or before rainfall. This significantly reduces water consumption and is a benefit to the soil and plants.Thanks to a special radio standard, the sensors, valves and the cube communicate up to a range of 300 meters in the open field and you can set up MIYO in gardens of any size. So you don't need an internet connection to the farthest corner of your garden!
You can also limit MIYO exclusively to your home WLAN. The Cube then receives weather data and updates from the cloud, but no personal data is transferred from the Cube to the cloud.
In addition, all data is stored locally on the cube. Thus, except for the installation, no internet connection is necessary and your garden is well taken care of even in case of an internet failure. The Cube only needs to be connected to the cloud if global access via app is desired.
Without long operating instructions, MIYO is installed and set up in a few minutes. The operation of the app is also uncomplicated, so don't be afraid of technology!
The valves are watered staggered, so as not to have a problem with the water pressure. However, if desired, an irrigation area can also be excluded from this.
Is MIYO also suitable for balcony and terrace irrigation?
Yes of course, as soon as there is a water connection, MIYO is ready for use. Since the sensor and valve are solar powered, they must be placed outdoors. Indoors, the solar charge is not sufficient.
Can I also use MIYO indoors?
No, MIYO is not designed for that. Indoors, the solar power generation of the devices is not enough for smooth operation.
What does "irrigation area" mean?
Different areas in a garden (e.g.: shade lawn, sun lawn, flowers, raised bed, hedge, etc.) require different amounts of water and need to be watered at different times. This means that you must be divided into separate watering areas, as the watering settings such as soil moisture limits or times of day in MIYO are made per watering area.
At least one valve is required for each watering area, but the Cube could manage more than 200. The number of valves depends on the fact that all plants of the irrigation area can be supplied with water.
A maximum of one sensor can be used per watering area. This should be located at a point in the watering area that is representative of the soil moisture.
How many sensors and valves do I need for my garden and how big can my garden be?
With a Cube you can divide your garden into several watering areas. At least one valve is required for each watering area and a maximum of one sensor can be used per watering area. In total, more than 200 devices can be connected to a Cube.
It does not matter whether the garden is 50m² or 1,000m². The decisive factor is the number of irrigation pipes and sufficiently strong water pressure.
Installation: App, Cube, Sensors and Valves
How do I put MIYO into operation and where can I find a digital operating manual?
- To ensure sufficient solar charging of the devices, the devices should charge at least 2 hours land in the sun. If the devices are very heavily discharged, a whole day may also be necessary.
- Plug in the cube (USB and Ethernet): As soon as the Cube is supplied with power, one LED lights up, after approx. 1 minute all 3 LEDs light up. The middle LED signals that the Cube application is running normally and the wireless network has started. The 3rd LED signals a successful connection to the MIYO Cloud via the Internet. If the third LED does not light up, please check the Internet connection.
- Download and register MIYO app on cell phone.
- Press white "Pairing" button on the Cube, continue setup of the Garden on the cell phone. Scan QR code on the bottom of the Cube and follow the instructions.
- Connect the devices: hold the magnet on the top of the housing from the side for 3 seconds until the green LED on the device flashes. Start the search in the APP.
Good luck! You can find more detailed information under Downloads.
Can I do the installation myself and how long does it take?
Yes, the commissioning is very easy and done in a short time. The app and operating instructions guide you through the individual steps.
What do I need the app for?
For commissioning the MIYO irrigation system, setting the optimal irrigation and as a dashboard to all Smart Garden activities anywhere in the world. After the initial setup, MIYO works without an app.
Where is the best place to install the Cube?
Install the Cube where you have an Internet and power connection, usually near your Internet router. To achieve a high range of the wireless system, a place near your garden makes the most sense. In any case, the wireless signal should not be obstructed by thick concrete walls.
In any case, place the Cube inside the building.
With which router can I use MIYO?
Any commercially available router with Internet access is suitable for this purpose.
How do I add more sensors and valves?
In the settings of a watering area in the app you will find "Sensors&Valves". When you have activated the device (sensor or valve) with the magnet for 3 seconds and the LED flashes, click on "Search". The sensor or valve will then appear in the list.
Why can't I put the sensor or valve into teach-in mode?
In teach-in mode, the cube and the device are connected.
Please check that you have held the magnet in the correct place: on the right side of the top edge of the solar cell of the valve/sensor, as shown in the Quick Start Guide.
Hold the magnet at this position for 3 seconds and then remove it again. If the contact lasts longer than 10 seconds, the connection/configuration will be deleted again.
If you have done everything correctly, the LED on the device will start flashing.
If this is not the case, the battery of the device is possibly empty. Place the device in the sun for 4 hours to charge the battery. Charging does not work through a window pane.
How is it ensured that my sensors and valves communicate exclusively with my Cube?
Once your MIYO has been programmed, the devices are clearly assigned to your cube. Therefore, there is no danger of confusing devices.
How can I distinguish between several installed sensors and valves?
Each device has a unique address and is therefore uniquely identifiable.
When you click on the lamp icon in the "Create watering area" section in the app during installation (or in the settings of any watering area you have set up), the LED will light up on the corresponding sensor or valve. Be patient - this can be delayed up to 30 seconds.
You can also store a name for each watering area as well as a picture showing the sensor and valve.
What do the lights on the cube stand for?
The first light (from the left) indicates the power supply.
The second light informs whether the MIYO application is running on the cube and the cube has established its radio network to sensors and valves.
The third light indicates whether the Cube is connected to the MIYO Cloud via the Internet connection. If you deactivate the cloud connection in the garden settings of your app, this third light goes out.
What does the white button on the back of the Cube do?
The button has several functions.
- When pressed briefly, it activates the teach-in
- When pressed for 5 seconds, the cube restarts
- If it is pressed for 20 seconds, the cube settings are reset
Where does it make most sense to install the sensor?
Select as bright a location as possible in the area to be irrigated. The location should not be in a depression and should reflect the conditions (soil moisture, temperature and brightness) of the area to be irrigated. Make sure that the solar surface of the sensor is not covered with leaves and receives sufficient light.
Why do I have to uncover a small hole for the sensor and can't I just push it into the ground?
The electronic component for measuring soil moisture is located on the lower neck of the sensor and is sensitive.
Our experience shows that the turf or soil conditions (e.g. clay soil) can be a severe obstacle and could damage the sensor.
It is even more important that the sensor measuring surface does not lie against a root or a stone or is not affected by a small cavity with air or water for optimal measurement. You can prevent all this by digging a small hole.
Simply dig out the hole with a small shovel or loosen the soil accordingly with your hands (see quick guide). Please compact the soil carefully again afterwards so that the sensor surface has optimal contact with the soil.
Do I need a second account for a second Cube?
Each account can be assigned several cubes in the app (garden management), e.g. one cube for the balcony and another cube for the allotment garden.
Why do I suddenly get an error message when logging into the app?
When you register, we will send you an email. This contains a link to confirm your email address. For the first 48 hours after registration, you can use the MIYO app without confirmation.
After these 48 hours the account will be locked if the mail address has not been confirmed. If you want us to send you the mail with the confirmation link again, please send a mail to service@miyo.garden.
Why does my sensor show such low humidity values?
When placing the sensor, it is very important that the earth is in contact with the measuring surface and that no air is trapped. If your sensor shows 0% over a longer period of time, or never rises above e.g. 30%, then please check whether the earth has been pressed well against the measuring surface. If necessary, reposition the sensor.
Why does my sensor show an unusually/unreal high temperature in direct sunlight?
The displayed temperature often seems very high, but this can be easily explained:
Normally thermometers measure air temperature in the shade, at least 1.5 meters above the ground and are protected from wind & rain. However, our sensor is located on the ground and is exposed to direct sunlight and weather. Also, the ground stores and reflects a lot of heat and the sun additionally heats the housing. The measured values are therefore not incorrect, and provide MIYO with important information for the optimal watering of your plants.
running operation
Where can I get hoses, sprinklers and fittings and what is compatible with MIYO?
Hoses, sprinklers and fittings are available in our webshop. These are branded products from renowned partners, which are perfectly matched to MIYO.
If you already have accessories, they are compatible with our standardized connectors.
Why does the irrigation stop after a few minutes and start again after a short time?
As long-time irrigation specialists, we have found that it is best to irrigate at intervals. This gives the water time to percolate and disperse, and reduces the influence of varying soil conditions.
Once the water has completely penetrated the various soil layers after a few minutes, the soil moisture is measured again. Based on the moisture that has actually reached the roots, irrigation is repeated as needed until the desired moisture level is reached.
Why doesn't MIYO water even though the soil of my plants is very dry and it doesn't rain?
One cause may be that the local weather forecast has reported rain in a timely manner.
Likewise, watering is not triggered if the outside temperature is below 4° C or the sun is shining too strongly. This prevents freezing or burning, which is harmful to the plants. It is also possible that automatic watering has been deactivated because the battery has not been sufficiently charged in the past 14 days. Also make sure that you have not mistakenly selected "Pause watering" in the watering settings per area or that an incorrect moisture floor is set.
After the first successful installation, the automatic watering is deactivated for safety reasons until the battery of the valve has been charged for 60 minutes. During this time, however, you can start watering manually by clicking "Water now".
Why do I have to set watering times when MIYO waters on demand?
Correct, MIYO is more than just a normal watering computer. Nevertheless, it is necessary to define periods of time when watering is basically allowed, even if MIYO then decides individually about watering within the defined periods.
This way you define at the same time when not to water. A frequently used scenario is, for example, to allow grass watering only in the morning on Sundays, because you are often in the garden in the afternoon and of course do not want to get wet. You can program each day of the week individually.
Why do I need the "Water Now" function in the app?
There are several scenarios for this.
The most common reason is as simple as it is ingenious: for example, you have friends visiting your garden on a beautiful summer's day for a barbecue or the neighbour is curiously looking over the fence. In both cases, you naturally want to proudly show off your MIYO intelligent garden watering system. Since you don't want to wait for the next regular watering, you can trigger the watering with the touch of a button in the app. This will start within the next 15 seconds. We affectionately call this scenario the show-off feature. Your viewers will be thrilled!
It is also possible that on a hot day you check the work of MIYO and discover that the watering limits you set were too low and the soil of your beloved plants is too dry. Then you can correct this immediately and start watering using the "Water now" function.
Where can I see how often and how much MIYO has irrigated?
In the app you will find the "Statistics" function for each watering area.
I want to water several watering areas with different programs. What do I need to do?
Mount a multiway distributor directly on the water tap. Now you can switch several valves after the multiway distributor.
Place a sensor in each watering area. Make sure that the interconnected valves and sensors are correctly assigned. You can also find out how to avoid confusing the devices here in the FAQ.
Are the sensors and valves frost-proof and can they remain in the garden over the winter?
No, all mobile devices (sensor and valve) must be dismantled over the winter, i.e. from an outside temperature of 4°C, and winterised indoors. As soon as the sensor measures a temperature of 4°C, you will receive a warning in the app that it will soon be time to winterise. At a temperature of 0°C, you will receive an error message that the sensors and valves must now be dismantled.
How can I winterize MIYO and start it up again in the spring?
Deactivation before winter:
Give your sensors and valves plenty of sun in advance so that the battery is well charged in winter mode. Alternatively, it is always possible to charge the devices in winter mode in the sun.
1. water supply for the garden Turn off garden, drain if necessary and winterize.
Disassemble the valve.
3. winter mode in the app for each watering area activate. ! This opens the valve opened.
4. carefully pull the sensor out of the pull out.
Store the valve and sensor in a dry store at 0 °C to 50 °C.
6. disconnect cube from power supply if necessary power supply - all settings remain stored locally stored locally.
Spring activation
1. reconnect the cube if necessary (see Installation).
2. exit winter mode in the app.
3. end winter mode on valve and sensor. To do this, place magnet the upper edge of the solar cell of the sensor or the valve for 1 second. of the valve.
4. turn on the water supply for the garden.
We have also written a blog post about it.
Will the battery last during the winter months or do I need to recharge in between?
When you winterize MIYO, you should activate the winter mode in the settings of each watering area. This will put the units into a power saving mode where the batteries will last several months without recharging. This assumes that the devices are fully charged when put into winter mode.
In case of doubt, it is always possible and also reasonable to charge the devices in the sun as long as the temperature remains above 4° C.
For charging, it makes no difference whether the devices are in active mode or winter mode.
In which languages is the MIYO app available?
The app is currently available in German, English, French and Dutch. The language of the app depends on the system settings of the smartphone.
Product details for app, cube, sensor and valve
How often does the Cube receive sensor readings?
Cube and sensor are in direct radio contact and communicate several times per minute.
Why do the sensors and valves only communicate with the Cube via radio and not via WiFi or Bluetooth?
We have deliberately decided not to equip the sensors and valves with WiFi receivers. In order to be able to achieve a higher range and to save you the purchase and installation of a WLAN repeater for the garden.
We also do not consider a connection via Bluetooth to be effective, as the range is often insufficient and the connection is not reliable.
Where can I find technical details about MIYO?
The technical data of all devices can be found in the technical information under Downloads.
What is the function of the Cube?
The Cube is placed in the house and combines the plant data from the sensor with the current weather forecast and your personal settings. Optionally, it also takes into account messages from your smart home.
Thus, it is the brain of the system and decides for one or more irrigation areas whether, when and how to irrigate ideally. Only one Cube is required per irrigation system. It can be used to manage more than 200 valves and sensors. The Cube is the only device that can connect to the Internet and the cloud via an Ethernet connector.
Where does the Cube get my location data to take into account the local weather forecast?
When creating a garden in the app, you will be asked for the location of the garden. this location will be used for weather forecasting.
What and how does the sensor measure?
The sensor measures the soil moisture at a depth of 10 cm. It also measures light intensity and air temperature. The soil moisture is measured at the end of the sensor neck via a sensor measuring surface.
What does lx mean?
lx is the symbol for the SI unit of illuminance (lux).
How much light do the batteries of the sensors and valves need?
The solar cell must not be covered.
To fully charge the battery once, you need about 40 hours of sunlight. On average, about one hour of direct sunlight per day is enough to maintain the charge of the fully charged batteries.
How do I notice that the batteries of my sensors or valves are not charged enough?
You will receive a warning from your app if the solar cell has not been exposed to sunlight for 7 days or has not been sufficiently charged in the last 7 days. If the battery should become empty, you will receive an error message.
Are the costs one-time or are there ongoing costs?
The costs for the hardware are one-time costs. You can download the app free of charge. There are no costs within your own WLAN, for control at home. If you have connected MIYO to the Internet, however, costs may be incurred by your mobile phone/Internet provider.
What does the bar display in the app settings for sensors and valves mean?
The bars indicate the radio strength of a sensor/valve to the cube. The further the distance, the fewer bars are displayed. There is no display of the battery charge status.
Can I also connect brass fittings to the valve?
Since the connections on the valve are made of plastic, we also recommend using plastic fittings. Fittings made of brass basically work, but the connection may be looser and therefore more sensitive than with plastic fittings. You can find suitable fittings from our partners in our webshop.
Customer service and assistance in case of malfunction
Where can I find information about customer service?
We have compiled all the information under Service for you.
Why is my sensor or valve not accessible?
This can have several reasons:
The battery of the device is empty.
In this case, you should have already received warnings and error messages (alarms). Place the device in the sun for at least 4 hours to charge the battery. Charging does not work through a window pane.
A missing radio link.
Make sure that the cube is not shielded by objects. If the connection breaks off frequently, turn the sensor/valve 90° to the left or right as a first step.
If that doesn't work either, reduce the distance between the devices by placing the Cube in a different location in the house. When choosing the location, make sure that the Cube has to overcome as few walls and other obstacles as possible as the crow flies towards the garden.
Please also see the FAQ"Where does it make most sense to install the Cube?"
What effects does a router/internet failure at the Cube have for the MIYO system?
MIYO continues to operate completely self-sufficiently and supplies your garden.
You just can't access the app.
What are the effects of a power failure at the Cube for the MIYO system?
Unfortunately, MIYO cannot work without power. As soon as the power supply is ensured again, MIYO starts fully automatically. With a powerbank you can bridge a system failure for some time.
If the Cube is no longer accessible for the valves, the emergency program on the valves takes effect and the watering is automatically stopped.
Your watering settings will of course be preserved in any case, as they are stored locally.
Why doesn't the Cube establish a cloud connection?
Make sure you have connected the LAN cable first and the power cable second to the Cube.
Check that the LAN cable is securely connected at both ends and that your router has an Internet connection.
One light on my cube is not lit, what does that mean?
The LED on the left side lights up when the cube is turned on. If this LED is off, make sure that the charging cable is plugged in.
The middle LED represents the wireless connection of the cube. If it is not lit, the devices are not communicating with each other and your MIYO system is no longer working. In this case, restart the cube by pressing the white button on the back of the cube for 5 seconds.
The right LED with the cloud symbol stands for the internet connection. If this is not on, no weather forecasts will be retrieved. You will also not have a connection to your app unless you are on the same network as your phone. To fix this problem, make sure your router has an internet connection and the network cable is properly connected. Then check if the LEDs on the network jack of the Cube are lit. If the LEDs are not lit, restart the Cube by pressing the white button on the back of the Cube for 5 seconds and wait a few seconds until the LEDs are solid.
Why is my valve dripping?
If your valve is leaking, first make sure that it is properly connected to the water connection. This is indicated by the valve clicking twice. Make sure that the connection of the valve is tightened or tighten it if necessary.
Why won't my irrigation start? Why is the "Start Watering" button greyed out?
If the irrigation does not start, it may be that your devices are updating or have not been charged for the minimum 2 hours.
You can track the status of your devices in the app in the respective area. You can find the number of charged hours per day in the settings for sensors and valves and then at the respective info symbol of the devices.
Software updates, privacy and security
How and when do the devices make updates?
Das Cube Update überprüft jeden Tag um Mitternacht ob es ein Update gibt und startet Download und Installation automatisch. Zusätzlich kannst Du manuell jederzeit die Update Funktion in der App starten. Die Updates dauern für gewöhnlich < 30 Minuten.
The firmware of valves and sensors is automatically updated according to availability.
If a valve or a sensor is not accessible after an update, this can have several reasons:
- The Cube does not have the latest firmware version
You can now wait for the midnight update of the Cube or start it in the app via the garden management. - The Cube has not started properly (not all 3 LEDs are lit)
Restart the Cube by pressing the button for 5 seconds. - Valve or sensor were not charged enough before the update and the battery became empty during the update. Position the devices in the sun to charge them.
How is MIYO updated and what do I have to consider?
This works automatically.
The only requirement is that the Cube is connected to the Internet. Even if you value a system that is independent of the cloud and the Internet and do not have a WiFi connection connected in continuous operation, we recommend that you connect the Cube to the Internet at least once a year for one day to enable scheduled software updates.
Once the Cube is updated, it passes the updates to the sensors and valves.
During an update, your MIYO will continue to function normally.
What (personal) data is stored?
You can find information about this in the privacy policy, which is available in the App Stores and also here on the website.
Is the data sent from MIYO to a cloud?
If you don't want to use a cloud service that stores your data, you can limit MIYO to your home WLAN only. The Cube will then receive weather data and updates from the cloud, but no personal data will be transferred from the Cube to the cloud.
Nevertheless, you can always activate the cloud to use the MIYO app and online services such as IFTTT outside of your home Wi-Fi.
Is there a theft protection?
Since each device has a unique serial number, we can track where the stolen device is installed and act accordingly. Therefore, please report any theft to our service hotline immediately.
You'll also get an alert in the app when the Cube fails to reach the sensors or valves.
Does the tap need to be open all the time and is this safe?
Yes, the water tap on which the valve is mounted must be open all the time. The regulation via opening and closing is done by a proven solenoid valve. In the logic of the cube and the valve, corresponding safety features are stored to prevent water damage. Faults and problems are reported to you immediately via the app.
To prevent leakage, we recommend using only the fittings supplied.
CUBE API documentation
Websocket
General
WEBSOCKET REQUEST
Port: 3810
Format: json
ws://*IP*:3810
Note upper and lower case
NOTIFICATIONS
The cube sends notifications via the websocket. A notification contains the id -1 and the value "notification" with information about the changes made.
Example:
{
"id": -1,
"notification": "Device.stateChanged",
"params": {
"deviceId": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"type": "rssi",
"value": -41
}
}Link.all - returns a new apiKey
Returns a new apiKey if access to the cube is allowed. Pressing the button on the cube or the API method System.allowlink allows one-time access for 15 minutes.
INQUIRY
Example:
{
"id": 1,
"method": "Link.all"
}Parameters:
| id | The Cube sends back this ID | Integer | not required |
| method | Type of request | String | Necessary |
ANSWER
{
"apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"id": 1,
"status": "success"
}System.update - Schedules the next update
Schedule the next update, does not start immediately.
INQUIRY
Example:
{
"id": 1,
"method": "System.update"
}Parameters:
| id | The Cube sends back this ID | Integer | not required |
| method | Type of request | String | Necessary |
ANSWER
{
"id": 1,
"status": "success"
}Device.all - Information about all devices
Provides information about all devices.
INQUIRY
Example:
{
"id": 1,
"apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"method": "Device.all",
"params": {
"typeIds": [
"valve"
]
}
}Parameters:
| id | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
| typeIds | Device type Filter (several possible) | [valve/moistureOutdoor] | not required |
ANSWER
{
"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 a device
Provides information about a device.
INQUIRY
Example:
{
"id": 1,
"apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"method": "Device.status",
"params": {
"deviceId": "{abcd1234-ab12-ab12-ab12-abcdef123456}"
}
}Parameters:
| id | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
| deviceId | ID of the device | String | Necessary |
ANSWER
{
"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 - unassigned devices
Returns all devices that are not assigned to a range.
INQUIRY
Example:
{
"id": 1,
"apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"method": "Device.free",
"params": {
"typeIds": [
"valve"
]
}
}Parameters:
| id | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
| typeIds | Device type Filter (several possible) | [valve/moistureOutdoor] | not required |
ANSWER
{
"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 the cube.
INQUIRY
Example:
{
"id": 1,
"apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"method": "Device.remove",
"params": {
"deviceId": "{abcd1234-ab12-ab12-ab12-abcdef123456}"
}
}Parameters:
| id | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
| deviceId | ID of the device | String | Necessary |
ANSWER
{
"id": 1,
"status": "success"
}Device.teachin - teaches a device in
Connects the Cube to a device that has been activated with the magnet.
INQUIRY
Example:
{
"id": 1,
"apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"method": "Device.teachin"
}Parameters:
| id | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
ANSWER
{
"id": 1,
"status": "success"
}Device.highlight - Activate LED of a device
Activates the LED on the selected device.
INQUIRY
Example:
{
"id": 1,
"apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"method": "Device.highlight",
"params": {
"deviceId": "{abcd1234-ab12-ab12-ab12-abcdef123456}"
}
}Parameters:
| id | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
| deviceId | ID of the device | String | Necessary |
ANSWER
{
"id": 1,
"status": "success"
}Circuit.all - All areas
Provides information on all areas.
INQUIRY
Example:
{
"id": 1,
"apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"method": "Circuit.all"
}Parameters:
| id | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
ANSWER
{
"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 area
Provides information about an area, analogous to /all.
INQUIRY
Example:
{
"id": 1,
"apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"method": "Circuit.status",
"params": {
"circuitId": "{abcd1234-ab12-ab12-ab12-abcdef123456}"
}
}Parameters:
| id | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
| circuitId | ID of the area | String | Necessary |
ANSWER
{
"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 - All possible types
Provides all possible types for soil condition, irrigation equipment, plant type and location.
INQUIRY
Example:
{
"id": 1,
"apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"method": "Circuit.types"
}Parameters:
| id | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
ANSWER
{
"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 statistics
Returns the states of all devices within the last week or within the defined time periods.
INQUIRY
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 | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
| circuitId | ID of the area | String | Necessary |
| timeFilters | Filter by time | List of unix timestamps in the 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 | Sorting (ascending default) | [asc/desc] | not required |
ANSWER
{
"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 area.
INQUIRY
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 | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
| valves | List of valveIds for the range | List of valveIds | Necessary |
| sensorId | ID of the sensor for the range | String | Necessary |
| name | Name of the area | String | Necessary |
| borderTop | Upper moisture limit in percent | String | not required |
| borderBottom | Lower moisture limit in percent | String | not required |
| automaticMode | Automatic irrigation | Boolean | not required |
| considerMower | Consider external lawn mower | Boolean | not required |
| considerWeather | Consider external weather service - expertMode must be set to true | Boolean | not required |
| considerCharge | Consider charging time for the function of the devices expertMode must be set to true | Boolean | not required |
| irrigationType | Set irrigation type | [UpSprinkler/Sprinkler/Drip/Pants] | not required |
| plantType | Set plant type | [Grass/Hedge/Patch/Tree/Individual] | not required |
| soilType | Set soil type | [Loamy/Sandy/LoamySandy/Unknown] | not required |
| locationType | Set position | [Open/Covered/Glasshouse] | not required |
| valveStaggering | phasing in | Boolean | not required |
| day0 | Watering times for Monday | String | not required |
| day1 | Watering times for Tuesday | String | not required |
| day2 | Watering times for Wednesday | String | not required |
| day3 | Watering times for Thursday | String | not required |
| day4 | Watering times for Friday | String | not required |
| day5 | Watering times for Saturday | String | not required |
| day6 | Watering times for Sunday | String | not required |
ANSWER
{
"id": 1,
"status": "success"
}Circuit.edit - Edit area
Edits an area.
INQUIRY
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 | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
| circuitId | ID of the area | String | Necessary |
| valves | List of valveIds for the range | List of valveIds | not required |
| sensorId | ID of the sensor for the range | String | not required |
| name | Name of the area | String | not required |
| borderTop | Upper moisture limit in percent | String | not required |
| borderBottom | Lower moisture limit in percent | String | not required |
| automaticMode | Automatic irrigation | Boolean | not required |
| considerMower | Consider external lawn mower | Boolean | not required |
| considerWeather | Consider external weather service - expertMode must be set to true | Boolean | not required |
| considerCharge | Consider charging time for the function of the devices expertMode must be set to true | Boolean | not required |
| irrigationType | Set irrigation type | [UpSprinkler/Sprinkler/Drip/Pants] | not required |
| plantType | Set plant type | [Grass/Hedge/Patch/Tree/Individual] | not required |
| soilType | Set soil type | [Loamy/Sandy/LoamySandy/Unknown] | not required |
| locationType | Set position | [Open/Covered/Glasshouse] | not required |
| valveStaggering | phasing in | Boolean | not required |
| day0 | Watering times for Monday | String | not required |
| day1 | Watering times for Tuesday | String | not required |
| day2 | Watering times for Wednesday | String | not required |
| day3 | Watering times for Thursday | String | not required |
| day4 | Watering times for Friday | String | not required |
| day5 | Watering times for Saturday | String | not required |
| day6 | Watering times for Sunday | String | not required |
ANSWER
{
"id": 1,
"status": "success"
}Circuit.irrigation - Start/stop irrigation
Starts or stops a watering session, default for 10 minutes.
INQUIRY
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 | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
| circuitId | ID of the area | String | Necessary |
| mode | Start or stop | [start/stop] | Necessary |
| duration | Duration of irrigation in minutes | String | not required |
ANSWER
{
"id": 1,
"status": "success"
}Circuit.remove - Delete area
Deletes a range.
INQUIRY
Example:
{
"id": 1,
"apiKey": "{abcd1234-ab12-ab12-ab12-abcdef123456}",
"method": "Circuit.remove",
"params": {
"circuitId": "{abcd1234-ab12-ab12-ab12-abcdef123456}"
}
}Parameters:
| id | The Cube sends back this ID | Integer | not required |
| apiKey | API Key from Link.all | String | Necessary |
| method | Type of request | String | Necessary |
| circuitId | ID of the area | String | Necessary |