Netatmo Binding - vpjuslin/openhab GitHub Wiki
The Netatmo binding integrates the Netatmo Personal Weather Station into openHAB. Its different modules allow you to measure temperature, humidity, air pressure, carbon dioxide concentration in the air, as well as the ambient noise level.
See http://www.netatmo.com/ for details on their product.
-
Create an application at http://dev.netatmo.com/dev/createapp
-
Retrieve a refresh token from Netatmo API, using e.g. curl:
curl -d "grant_type=password&client_id=123456789012345678901234&client_secret=ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHI&[email protected]&password=example" "http://api.netatmo.net/oauth2/token"
- Add client id, client secret and refresh token to openhab.cfg
netatmo:refresh=300000
netatmo:clientid=123456789012345678901234
netatmo:clientsecret=ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHI
netatmo:refreshtoken=ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABCDE
The IDs for the modules can be extracted from the developer documentation on the netatmo site. First login with your user. Then some examples of the documentation contain the real results of your weather station. Get the IDs of your devices (indoor, outdoor, rain gauge) here:
https://dev.netatmo.com/doc/methods/devicelist
main_device is the ID of the "main device", the indoor sensor.
The other modules you can recognize by "module_name" and then note the "_id" which you need later.
Another way to get the IDs is to calculate them:
You have to calculate the ID for the outside module as follows: (it cannot be read from the app) if the first serial character is "h": start with "02", if the first serial character is "i": start with "03",
append ":00:00:",
split the rest into three parts of two characters and append with a colon as delimeter.
For example your serial number "h00bcdc" should end up as "02:00:00:00:bc:dc".
Example item for the indoor sensor:
Number Netatmo_Indoor_CO2 "Carbon dioxide [%d ppm]" {netatmo="00:00:00:00:00:00#Co2"}
Supported are:
- Temperature
- Humidity
- Co2
- Pressure
- Noise
- WifiStatus
- Altitude
- Latitude
- Longitude
- TimeStamp
Example item for the outdoor sensor (first id is the main module, second id is the outdoor module):
Number Netatmo_Outdoor_Temperature "Outdoor temperature [%.1f °C]" {netatmo="00:00:00:00:00:00#00:00:00:00:00:00#Temperature"}
Supported are for the outdoor modules:
- Temperature
- Humidity
- RfStatus
- BatteryVP
- TimeStamp
The rain gauge supports Rain: (What a surprise!)
Number Netatmo_Rain_Gauge "Rain [%.1f mm]" {netatmo="00:00:00:00:00:00#00:00:00:00:00:00#Rain"}
Example item configration:
Number Netatmo_Indoor_Temperature "Indoor Temperature [%.2f C]" (Netatmo) {netatmo="00:00:00:00:00:00#Temperature"}
Number Netatmo_Indoor_Humidity "Indoor Humidity [%d]" (Netatmo) {netatmo="00:00:00:00:00:00#Humidity"}
Number Netatmo_Indoor_CO2 "Indoor Carbon dioxide [%d ppm]" (Netatmo) {netatmo="00:00:00:00:00:00#Co2"}
Number Netatmo_Indoor_Pressure "Indoor Pressure [%.2f mbar]" (Netatmo) {netatmo="00:00:00:00:00:00#Pressure"}
Number Netatmo_Indoor_Noise "Indoor Noise [%d db]" (Netatmo) {netatmo="00:00:00:00:00:00#Noise"}
Number Netatmo_Indoor_wifi "Indoor Wifi status [%d / 4]" (Netatmo) {netatmo="00:00:00:00:00:00#Wifistatus"}
Number Netatmo_Indoor_altitude "Indoor Altitude [%d]" (Netatmo) {netatmo="00:00:00:00:00:00#Altitude"}
Number Netatmo_Indoor_latitude "Indoor Latitude [%d]" (Netatmo) {netatmo="00:00:00:00:00:00#Latitude"}
Number Netatmo_Indoor_longitude "Indoor Longitude [%d]" (Netatmo) {netatmo="00:00:00:00:00:00#Longitude"}
Number Netatmo_Outdoor_Temperature "Outdoor Temperature [%.2f C]" (Netatmo) {netatmo="00:00:00:00:00:00#02:00:00:00:00:00#Temperature"}
Number Netatmo_Outdoor_Humidity "Outdoor Humidity [%.2f P]" (Netatmo) {netatmo="00:00:00:00:00:00#02:00:00:00:00:00#Humidity"}
Number Netatmo_Outdoor_Rfstatus "Outdoor RF status [%d / 5]" (Netatmo) {netatmo="00:00:00:00:00:00#02:00:00:00:00:00#Rfstatus"}
Number Netatmo_Outdoor_Batteryvp "Outdoor battery status [%d]" (Netatmo) {netatmo="00:00:00:00:00:00#02:00:00:00:00:00#Batteryvp"}
Number Netatmo_Rain_Gauge "Rain [%d mm]" (Netatmo) {netatmo="00:00:00:00:00:00#05:00:00:00:00:00#Rain"}
Number Netatmo_Rain_Rfstatus "Rain RF Status [%d / 5]" (Netatmo) {netatmo="00:00:00:00:00:00#05:00:00:00:00:00#Rfstatus"}
Number Netatmo_Rain_Batteryvp "Rain battery status [%d]" (Netatmo) {netatmo="00:00:00:00:00:00#05:00:00:00:00:00#Batteryvp"}
Example rule to send a mail if carbon dioxide reaches a certain threshold:
var boolean co2HighWarning = false
var boolean co2VeryHighWarning = false
rule "Monitor carbon dioxide level"
when
Item Netatmo_Indoor_CO2 changed
then
if(Netatmo_Indoor_CO2.state > 1000) {
if(co2HighWarning == false) {
sendMail("[email protected]",
"High carbon dioxide level!",
"Carbon dioxide level is " + Netatmo_Indoor_CO2.state + " ppm.")
co2HighWarning = true
}
} else if(Netatmo_Indoor_CO2.state > 2000) {
if(co2VeryHighWarning == false) {
sendMail("[email protected]",
"Very high carbon dioxide level!",
"Carbon dioxide level is " + Netatmo_Indoor_CO2.state + " ppm.")
co2VeryHighWarning = true
}
} else {
co2HighWarning = false
co2VeryHighWarning = false
}
end
Example rule to send notifications if the module battery level is low:
rule "Monitor Netatmo battery levels"
when
Time cron "00 10 * * * ?" or
System started
then
if( Netatmo_Outdoor_Batteryvp.state < 20) {
logInfo("NetatmoBatteryAlerts","Netatmo Outdoor Sensor Battery is low: " + Netatmo_Outdoor_Batteryvp.state + " Sending alert!")
var String mailSubject = "Netatmo Outdoor Sensor Battery is low: " + Netatmo_Outdoor_Batteryvp.state + "!"
sendMail("<MAIL>", mailSubject, mailSubject);
}
if( Netatmo_Rain_Batteryvp.state < 20) {
logInfo("NetatmoBatteryAlerts","Netatmo Rain Battery is low: " + Netatmo_Rain_Batteryvp.state + " Sending alert!")
var String mailSubject = "Netatmo Rain Gauge Battery is low: " + Netatmo_Rain_Batteryvp.state + "!"
sendMail("<MAIL>", mailSubject, mailSubject);
}
end
javax.net.ssl.SSLHandshakeException:
sun.security.validator.ValidatorException:
PKIX path building failed:
sun.security.provider.certpath.SunCertPathBuilderException:
unable to find valid certification path to requested target
can be solved by installing the StartCom CA Certificate into the local JDK like this:
-
Download the certificate from https://www.startssl.com/certs/ca.pem
-
Then import it into the keystore (the password is "changeit")
$JAVA_HOME/bin/keytool -import -keystore $JAVA_HOME/jre/lib/security/cacerts -alias StartCom-Root-CA -file ca.pem
source: http://jinahya.wordpress.com/2013/04/28/installing-the-startcom-ca-certifcate-into-the-local-jdk/
alternative approach if above solution does not work:
sudo keytool -delete -alias StartCom-Root-CA -keystore $JAVA_HOME/jre/lib/security/cacerts -storepass changeit
download the certificate from https://api.netatmo.net to $JAVA_HOME/jre/lib/security/ and save it as api.netatmo.net.crt
sudo $JAVA_HOME/bin/keytool -import -keystore $JAVA_HOME/jre/lib/security/cacerts -alias StartCom-Root-CA -file api.netatmo.net.crt
If you want to evaluate this binding but have not got a Netatmo station yourself yet, you can add the Netatmo office in Paris to your account:
http://www.netatmo.com/en-US/addguest/index/TIQ3797dtfOmgpqUcct3/70:ee:50:00:02:20
The following icons are used by original Netatmo web app:
http://my.netatmo.com/img/my/app/module_int.png
http://my.netatmo.com/img/my/app/module_ext.png
http://my.netatmo.com/img/my/app/module_rain.png
http://my.netatmo.com/img/my/app/battery_verylow.png
http://my.netatmo.com/img/my/app/battery_low.png
http://my.netatmo.com/img/my/app/battery_medium.png
http://my.netatmo.com/img/my/app/battery_high.png
http://my.netatmo.com/img/my/app/battery_full.png
http://my.netatmo.com/img/my/app/signal_verylow.png
http://my.netatmo.com/img/my/app/signal_low.png
http://my.netatmo.com/img/my/app/signal_medium.png
http://my.netatmo.com/img/my/app/signal_high.png
http://my.netatmo.com/img/my/app/signal_full.png
http://my.netatmo.com/img/my/app/wifi_low.png
http://my.netatmo.com/img/my/app/wifi_medium.png