forked from openhab/openhab1-addons
-
Notifications
You must be signed in to change notification settings - Fork 0
Koubachi Binding
pallemannen edited this page Aug 7, 2015
·
10 revisions
Documentation of the Koubachi binding bundle
The Koubachi Services help everybody without a green thumb to be a perfect gardener. All plants can be registered on their really nice website (or through iPhone/iPad App) to tell you when and how to care for your plants. Furthermore they offer a dedicated hardware, the WIFI Plant Sensor. This wireless device measures vital parameters and determines the vitality of your plants.
Koubachis' slogan "give your plants a voice" becomes reality with this binding. It queries all relevant data through Koubachi's webservice and pushes it into openHAB.
For installation of the binding, please see Wiki page Bindings.
Before using the Koubachi services one has to register free of charge at Koubachi-Labs website for API access. Once the account is created the credentials and personal appKey can be obtained from the portal. Both values have to be specified in openhab.cfg.
The following config parameters have to be set for using Koubachi binding:
- (optional) koubachi:refresh - The refresh interval in milliseconds. Defaults to 900000ms (which equals to 15 minutes)
- (optional) koubachi:deviceurl - The Koubachi API URL of the device list. Defaults to '
https://api.koubachi.com/v2/user/smart_devices?user_credentials=%1$s&app_key=%2$s' - (optional) koubachi:planturl - The Koubachi API URL of the plant list. Defaults to '
https://api.koubachi.com/v2/plants?user_credentials=%1$s&app_key=%2$s' - koubachi:credentials - The single access token configured obtained from http://labs.koubachi.com
- koubachi:appkey - The personal appKey obtained from http://labs.koubachi.com
################################ Koubachi Binding #####################################
# The single access token obtained from http://labs.koubachi.com
koubachi:credentials=fMWNa6uR-KJtoidLe11k
# The personal appKey obtained from http://labs.koubachi.com
koubachi:appkey=KLABPLQP365CNQRIG0HY2DEX
In order to bind an item to a Koubachi resource query you need to provide configuration settings. The easiest way to do this is to add some binding information in your item file (in the folder configurations/items`). The syntax for the Koubachi binding configuration string is as follows:
koubachi="<device | plant>:<resourceId>:<propertyName>"
You can also bind to the action types in the Koubachi API using the keyword "action" and then the action type.
koubachi="plant:<resourceId>:action:<actionType>"
What actions can actually be performed on a specific plant depends on the type of Koubachi device used.
Here are some examples for valid binding configuration strings:
device:00066680190e:virtualBatteryLevel
device:00066680190e:nextTransmission
plant:129892:vdmMistLevel
plant:129892:vdmWaterInstruction
plant:129892:action:mist.performed
- virtualBatteryLevel (Number)
- ssid (String)
- hardwareProductType (String)
- lastTransmission (!DateTime)
- nextTransmission (!DateTime)
- associatedSince (!DateTime)
- recentSoilmoistureReadingValue (String)
- recentSoilmoistureReadingTime (!DateTime)
- recentTemperatureReadingValue (String)
- recentTemperatureReadingTime (!DateTime)
- recentLightReadingValue (String)
- recentLightReadingTime (!DateTime)
- name (String)
- location (String)
- lastFertilizerAt (!DateTime)
- nextFertilizerAt (!DateTime)
- lastMistAt (!DateTime)
- nextMistAt (!DateTime)
- lastWaterAt (!DateTime)
- nextWaterAt (!DateTime)
- vdmWaterInstruction (String)
- vdmWaterLevel (Number)
- vdmMistInstruction (String)
- vdmMistLevel (Number)
- vdmFertilizerInstruction (String)
- vdmFertilizerLevel (Number)
- vdmTemperatureHint (String)
- vdmTemperatureInstruction (String)
- vdmTemperatureLevel (Number)
- vdmLightHint (String)
- vdmLightInstruction (String)
- vdmLightLevel (Number)
- calibration.watered (Switch)
- calibration.is_dry (Switch)
- calibration.is_not_dry (Switch)
- calibration.restarted (Switch)
- water.performed (Switch)
- mist.skipped (Switch)
- mist.performed (Switch)
- fertilize.skipped (Switch)
- fertilize.performed (Switch)
- put_into_light.performed (Switch)
- put_into_shade.performed (Switch)
- heat_plant.performed (Switch)
- cool_plant.performed (Switch)
As a result, your lines in the items file might look like as follows:
DateTime Device_00066680190e_AssociatedSince "Assoc. since [%1$td.%1$tm.%1$tY %1$tT]" <grass> (Device_00066680190e) { koubachi="device:00066680190e:associatedSince" }
String Device_00066680190e_Soilmoisture "Soilmoisture [%s]" <grass> (Device_00066680190e) { koubachi="device:00066680190e:recentSoilmoistureReadingValue" }
String Device_00066680190e_Temperature "Temperature [%s]" <grass> (Device_00066680190e) { koubachi="device:00066680190e:recentTemperatureReadingValue" }
String Hortensie_Name "Name [%s]" <grass> (Hortensie) { koubachi="plant:129892:name" }
Number Hortensie_Mist_Level "Mist Level [%.2f]" <grass> (Hortensie) { koubachi="plant:129892:vdmMistLevel" }
Number Hortensie_Water_Level "Water Level [%.2f]" <grass> (Hortensie) { koubachi="plant:129892:vdmWaterLevel" }
Switch Hortensie_Fertilized "Fertilization done" <grass> (Hortensie) { koubachi="plant:129892:action:fertilize.performed" }
To remind you to give your plant water use the following rule. First need the water level Item and some block Item to don't spam your self.
Items
String plant1_Water_Level "Water Level [%s]" <grass> (gPL) { koubachi="device:00066672ef98:recentSoilmoistureReadingValue" }
Switch plantbswitch90 (gPL)
Switch plantbswitch80 (gPL)
Switch plantbswitch70 (gPL)
Switch plantbswitch60 (gPL)
Switch plantbswitch50 (gPL)
Switch plantbswitch40 (gPL)
Switch plantbswitch30 (gPL)
Following this two rules
Rules
rule "water level"
when
Item plant1_Water_Level received update
then
var level = plant1_Water_Level.state
if (plant1_Water_Level.state.toString.matches("9. %") && plantbswitch90.state == OFF{
sendMail("[email protected]", "Zamioculcas_zamiifolia", "I am well!My water level is " + level, "http://192.168.177.138/flower1.jpg")
sendCommand(plantbswitch90, ON)
sendCommand(plantbswitch80, OFF)
sendCommand(plantbswitch70, OFF)
sendCommand(plantbswitch60, OFF)
sendCommand(plantbswitch50, OFF)
sendCommand(plantbswitch40, OFF)
sendCommand(plantbswitch30, OFF)
}
if (plant1_Water_Level.state.toString.matches("8. %") && plantbswitch80.state == OFF ){
sendMail("[email protected]", "Zamioculcas_zamiifolia", "I am still well! My water level is " + level ,"http://192.168.177.138/flower1.jpg")
sendCommand(plantbswitch80, ON)
sendCommand(plantbswitch90, OFF)
}
if (plant1_Water_Level.state.toString.matches("7. %") && plantbswitch70.state == OFF ){
sendMail("[email protected]", "Zamioculcas_zamiifolia", "I am still well!My water level is " + level ,"http://192.168.177.138/flower1.jpg")
sendCommand(plantbswitch70, ON)
}
if (plant1_Water_Level.state.toString.matches("6. %") && plantbswitch60.state == OFF ){
sendMail("[email protected]", "Zamioculcas_zamiifolia", "I am still well!My water level is " + level ,"http://192.168.177.138/flower1.jpg")
sendCommand(plantbswitch60, ON)
}
if (plant1_Water_Level.state.toString.matches("5. %") && plantbswitch50.state == OFF ){
sendMail("[email protected]", "Zamioculcas_zamiifolia", "Next I need water!My water level is " + level ,"http://192.168.177.138/flower1.jpg")
sendCommand(plantbswitch50, ON)
}
if (plant1_Water_Level.state.toString.matches("4. %") && plantbswitch40.state == OFF ){
sendMail("[email protected]", "Zamioculcas_zamiifolia", "I need water! Please give me water. My water level is" + level ,"http://192.168.177.138/flower1.jpg")
sendCommand(plantbswitch40, ON)
}
if (plant1_Water_Level.state.toString.matches("3. %") && plantbswitch30.state == OFF ){
sendMail("[email protected]", "Zamioculcas_zamiifolia", "I realy need water! Please give me water ore i will di. My water level is " + level ,"http://192.168.177.138/flower1.jpg")
sendCommand(plantbswitch30, ON)
}
end
rule "set switch to off at start"
when
System started
then
sendCommand(plantbswitch90, OFF)
sendCommand(plantbswitch80, OFF)
sendCommand(plantbswitch70, OFF)
sendCommand(plantbswitch60, OFF)
sendCommand(plantbswitch50, OFF)
sendCommand(plantbswitch40, OFF)
sendCommand(plantbswitch30, OFF)
end
###Linux / OS X
###Windows
- Cosm Persistence
- db4o Persistence
- Exec Persistence
- InfluxDB Persistence
- JDBC Persistence
- JPA Persistence
- Logging Persistence
- mapdb Persistence
- MongoDB Persistence
- MQTT Persistence
- my.openHAB Persistence
- MySQL Persistence
- rrd4j Persistence
- Sen.Se Persistence
- SiteWhere Persistence
- AlarmDecoder Binding
- Anel Binding
- Arduino SmartHome Souliss Binding
- Asterisk Binding
- Astro Binding
- Autelis Pool Control Binding
- BenQ Projector Binding
- Bluetooth Binding
- Bticino Binding
- CalDAV Binding
- Comfo Air Binding
- Config Admin Binding
- CUL Binding
- CUL Intertechno Binding
- CUPS Binding
- DAIKIN Binding
- Davis Binding
- Denon Binding
- digitalSTROM Binding
- DMX512 Binding
- DSC Alarm Binding
- DSMR Binding
- eBUS Binding
- Ecobee Binding
- EDS OWSever Binding
- eKey Binding
- Energenie Binding
- EnOcean Binding
- Enphase Energy Binding
- Epson Projector Binding
- Exec Binding
- Freebox Binding
- Freeswitch Binding
- Frontier Silicon Radio Binding
- Fritz AHA Binding
- Fritz!Box Binding
- FS20 Binding
- Global Cache IR Binding
- GPIO Binding
- HAI/Leviton OmniLink Binding
- HDAnywhere Binding
- Heatmiser Binding
- Homematic / Homegear Binding
- HTTP Binding
- IEC 62056-21 Binding
- IHC / ELKO Binding
- ImperiHome Binding
- Insteon Hub Binding
- Insteon PLM Binding
- IPX800 Binding
- IRtrans Binding
- jointSPACE-Binding
- KNX Binding
- Koubachi Binding
- LCN Binding
- LightwaveRF Binding
- Leviton/HAI Omnilink Binding
- Lg TV Binding
- Logitech Harmony Hub
- MailControl Binding
- MAX!Cube-Binding
- MAX! CUL Binding
- MiLight Binding
- MiOS Binding
- Modbus TCP Binding
- MPD Binding
- MQTT Binding
- MQTTitude binding
- Neohub Binding
- Nest Binding
- Netatmo Binding
- Network Health Binding
- Network UPS Tools Binding
- Nibe Heatpump Binding
- Nikobus Binding
- Novelan/Luxtronic Heatpump Binding
- NTP Binding
- One-Wire Binding
- Onkyo AV Receiver Binding
- Open Energy Monitor Binding
- OpenPaths presence detection binding
- OpenSprinkler Binding
- OSGi Configuration Admin Binding
- Panasonic TV Bindung
- panStamp Binding
- Philips Hue Binding
- Piface Binding
- pilight Binding
- Pioneer-AVR-Binding
- Plex Binding
- Plugwise Binding
- PLCBus Binding
- Primare Binding
- Pulseaudio Binding
- RFXCOM Binding
- RWE Smarthome Binding
- Sager WeatherCaster Binding
- Samsung AC Binding
- Samsung TV Binding
- Serial Binding
- Sallegra Binding
- Satel Alarm Binding
- Sinthesi Sapp Binding
- Snmp Binding
- Somfy URTSI II Binding
- Sonos Binding
- Squeezebox Binding
- Swegon ventilation Binding
- System Info Binding
- TA CMI Binding
- TCP/UDP Binding
- Tellstick Binding
- TinkerForge Binding
- Tivo Binding
- VDR Binding
- Velleman-K8055-Binding
- Wago Binding
- Wake-on-LAN Binding
- Waterkotte EcoTouch Heatpump Binding
- Weather Binding
- Wemo Binding
- Withings Binding
- XBMC Binding
- xPL Binding
- Yamahareceiver Binding
- Zibase Binding
- Z-Wave Binding
- Asterisk
- Google Calendar
- Linux Media Players
- ROS Robot Operating System
- Telldus Tellstick
- Zoneminder
- Wink Hub (rooted)
- Wink Monitoring
- Transformations
- XSLT
- JSON
- REST-API
- Security
- Service Discovery
- Voice Control
- BritishGasHive-Using-Ruby
- Dropbox Bundle
A good source of inspiration and tips from users gathered over the years. Be aware that things may have changed since they were written and some examples might not work correctly.
Please update the wiki if you do come across any out of date information.
- Comfo Air Binding
- Ecobee Examples
- Nest Examples
- Rollershutter Bindings
- Squeezebox
- WAC Binding
- WebSolarLog
- Alarm Clock
- Convert Farenheit to Celcius
- The mother of all lighting rules
- Reusable Rules via Functions
- Combining different Items
- Items, Rules and more Examples of a SmartHome
- Google Map
- Controlling openHAB with Android
- Usecase examples
- B-Control Manager
- Spell checking for foreign languages
- Flic via Tasker
- Chromecast via castnow