Netatmo Binding - sprehn/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&scope=read_station read_thermostat write_thermostat' 'https://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
Starting with 1.8, you can optionally set the unit system and/or pressure units. The unit systems options are either Metric (Celsius/meters/millimeters) or US (Fahrenheit/feet/inches) and is case insensitive. The temperature (Celsius or Fahrenheit), rain (millimeter or inches) and altitude (meters or feet) are affected by this parameter. If not specified, openHAB defaults to Metric.
netatmo:unitsystem=m
netatmo:unitsystem=us
The pressure unit is either mbar, inHg, or mmHg and is used for pressure, and is case insenstive. If not specified, openHAB defaults to mbar.
netatmo:pressureunit=mbar
netatmo:pressureunit=inHg
netatmo:pressureunit=mmHg
Prior to 1.8, openHAB returns values in Metric and mbar.
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 module:
Number Netatmo_Indoor_CO2 "Carbon dioxide [%d ppm]" {netatmo="00:00:00:00:00:00#Co2"}
Supported types for the indoor module:
- Temperature
- Humidity
- Co2
- Pressure
- Noise
- WifiStatus
- Altitude
- Latitude
- Longitude
- TimeStamp
- min_temp
- date_min_temp
- max_temp
- date_max_temp
- min_hum
- date_min_hum
- max_hum
- date_max_hum
- min_pressure
- date_min_pressure
- max_pressure
- date_max_pressure
- min_noise
- date_min_noise
- max_noise
- date_max_noise
- min_co2
- date_min_co2
- max_co2
- date_max_co2
Example item for the outdoor module (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 types for the outdoor module:
- Temperature
- Humidity
- RfStatus
- BatteryVP
- TimeStamp
- min_temp
- date_min_temp
- max_temp
- date_max_temp
- min_hum
- date_min_hum
- max_hum
- date_max_hum
Example item for the rain gauge (first id is the main module, second id is the rain module):
Number Netatmo_Rain_Current "Rain [%.1f mm]" {netatmo="00:00:00:00:00:00#00:00:00:00:00:00#Rain"}
Supported types for the rain guage:
- Rain
- Humidity
- sum_rain
- RfStatus
- BatteryVP
Example item for the wind module (first id is the main module, second id is the wind module):
Number Netatmo_Wind_Strength "Wind Strength [%.0f KPH]" {netatmo="00:00:00:00:00:00#00:00:00:00:00:00#WindStrength"}
Supported types for the wind module:
- WindStrength
- WindAngle
- GustStrength
- GustAngle
- date_max_gust
- RfStatus
- BatteryVP
Types WindStrength, WindAngle, GustStrength, GustAngle are for a specific time frame, and default to the latest measurement. Other possible time frames are:
- 30min
- 1hour
- 3hours
- 1day
- 1week
- 1month
The type date_max_gust is also for a specific time frame, and defaults to 1 day. It will only work with the ranges 1day, 1week, and 1month.
Example items with different time frames:
Number Netatmo_Wind_Strength_Current "Wind Strength [%.0f KPH]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#WindStrength"}
Number Netatmo_Wind_Wind_Angle_Current "Wind Angle [%d°]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#WindAngle"}
Number Netatmo_Wind_Gust_Strength_Current "Wind Strength [%.0f KPH]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#GustStrength"}
Number Netatmo_Wind_Gust_Angle_Current "Wind Angle [%d°]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#GustAngle"}
Number Netatmo_Wind_Strength_Today "Wind Strength [%.0f KPH]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#WindStrength,1day"}
Number Netatmo_Wind_Wind_Angle_Today "Wind Angle [%d°]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#WindAngle,1day"}
Number Netatmo_Wind_Gust_Strength_Today "Wind Strength [%.0f KPH]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#GustStrength,1day"}
Number Netatmo_Wind_Gust_Angle_Today "Wind Angle [%d°]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#GustAngle,1day"}
DateTime Netatmo_Wind_Max_Gust_Date_Today "Date Max Gust [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#date_max_gust"}
Number Netatmo_Wind_Strength_Month "Wind Strength [%.0f KPH]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#WindStrength,1month"}
Number Netatmo_Wind_Wind_Angle_Month "Wind Angle [%d°]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#WindAngle,1month"}
Number Netatmo_Wind_Gust_Strength_Month "Wind Strength [%.0f KPH]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#GustStrength,1month"}
Number Netatmo_Wind_Gust_Angle_Month "Wind Angle [%d°]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#GustAngle,1month"}
DateTime Netatmo_Wind_Max_Gust_Date_Month "Date Max Gust [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#date_max_gust,1month"}
###Min, Max and Sum Types (Since 1.8) Types that contain _min, _max, or _sum are for a specific time frame, with a default of 1 day. Possible time frames are:
- 30min
- 1hour
- 3hours
- 1day
- 1week
- 1month
The types that contain _date will only work with the ranges 1day, 1week, and 1month.
Example items with different time frames:
Number Netatmo_Indoor_Max_Temp_Today "Indoor Maximum Temperature Today [%.2f C]" (Netatmo) {netatmo="00:00:00:00:00:00#max_temp"}
Number Netatmo_Indoor_Max_Temp_This_Week "Indoor Maximum Temperature This Week [%.2f C]" (Netatmo) {netatmo="00:00:00:00:00:00#max_temp,1week"}
Number Netatmo_Indoor_Max_Temp_This_Month "Indoor Maximum Temperature This Month [%.2f C]" (Netatmo) {netatmo="00:00:00:00:00:00#max_temp,1month"}
Number Netatmo_Rain_Today "Rain Today [%.02f mm]" (Netatmo) {netatmo="00:00:00:00:00:00#05:00:00:00:00:be#sum_rain"}
Number Netatmo_Rain_Week "Rain This Week [%.02f mm]" (Netatmo) {netatmo="00:00:00:00:00:00#05:00:00:00:00:be#sum_rain,1week""}
Number Netatmo_Rain_Month "Rain This Month [%.02f mm]" (Netatmo) {netatmo="00:00:00:00:00:00#05:00:00:00:00:be#sum_rain,1month""}
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 [%f]" (Netatmo) {netatmo="00:00:00:00:00:00#Altitude"}
Number Netatmo_Indoor_latitude "Indoor Latitude [%.6f]" (Netatmo) {netatmo="00:00:00:00:00:00#Latitude"}
Number Netatmo_Indoor_longitude "Indoor Longitude [%.6f]" (Netatmo) {netatmo="00:00:00:00:00:00#Longitude"}
Number Netatmo_Indoor_Min_Temp "Indoor Minimum Temperature Today [%.2f C]" (Netatmo) {netatmo="00:00:00:00:00:00#min_temp"}
DateTime Netatmo_Indoor_Min_Temp_Date "Indoor Minimum Temperature Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#date_min_temp"}
Number Netatmo_Indoor_Max_Temp "Indoor Maximum Temperature Today [%.2f C]" (Netatmo) {netatmo="00:00:00:00:00:00#max_temp"}
DateTime Netatmo_Indoor_Max_Temp_Date "Indoor Maximum Temperature Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#date_max_temp"}
Number Netatmo_Indoor_Min_Hum "Indoor Minimum Humidity Today [%d %%]" (Netatmo) {netatmo="00:00:00:00:00:00#min_hum"}
DateTime Netatmo_Indoor_Min_Hum_Date "Indoor Minimum Humidity Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#date_min_hum"}
Number Netatmo_Indoor_Max_Hum "Indoor Maximum Humidity Today [%d %%]" (Netatmo) {netatmo="00:00:00:00:00:00#max_hum"}
DateTime Netatmo_Indoor_Max_Hum_Date "Indoor Maximum Humidity Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#date_max_hum"}
Number Netatmo_Indoor_Min_Press "Indoor Minimum Pressure Today [%.2f mbar]" (Netatmo) {netatmo="00:00:00:00:00:00#min_pressure"}
DateTime Netatmo_Indoor_Min_Temp_Press "Indoor Minimum Pressure Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#date_min_pressure"}
Number Netatmo_Indoor_Max_Press "Indoor Maximum Pressure Today [%.2f mbar]" (Netatmo) {netatmo="00:00:00:00:00:00#max_pressure"}
DateTime Netatmo_Indoor_Max_Temp_Press "Indoor Maximum Pressure Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#date_max_pressure"}
Number Netatmo_Indoor_Min_Noise "Indoor Minimum Noise Today [%d db]" (Netatmo) {netatmo="00:00:00:00:00:00#min_noise"}
DateTime Netatmo_Indoor_Min_Noise_Date "Indoor Minimum Noise Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#date_min_noise"}
Number Netatmo_Indoor_Max_Noise "Indoor Maximum Noise Today [%d db]" (Netatmo) {netatmo="00:00:00:00:00:00#max_noise"}
DateTime Netatmo_Indoor_Max_Noise_Date "Indoor Maximum Noise Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#date_max_noise"}
Number Netatmo_Indoor_Min_CO2 "Indoor Minimum Carbon Dioxide Today [%d ppm]" (Netatmo) {netatmo="00:00:00:00:00:00#min_co2"}
DateTime Netatmo_Indoor_Min_CO2_Date "Indoor Minimum Carbon Dioxide Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#date_min_co2"}
Number Netatmo_Indoor_Max_CO2 "Indoor Maxinum Carbon Dioxide Today [%d ppm]" (Netatmo) {netatmo="00:00:00:00:00:00#max_co2"}
DateTime Netatmo_Indoor_Max_CO2_Date "Indoor Maximum Carbon Dioxide Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#date_max_co2"}
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 %%]" (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_Outdoor_Min_Temp "Outdoor Mininum Temperature Today [%.2f C]" (Netatmo) {netatmo="00:00:00:00:00:00#02:00:00:00:00:00#min_temp"}
DateTime Netatmo_Outdoor_Min_Temp_Date "Outdoor Minimum Temperature Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#02:00:00:00:00:00#date_min_temp"}
Number Netatmo_Outdoor_Max_Temp "Outdoor Maximum Temperature Today [%.2f C]" (Netatmo) {netatmo="00:00:00:00:00:00#02:00:00:00:00:00#max_temp"}
DateTime Netatmo_Outdoor_Max_Temp_Date "Outdoor Maximum Temperature Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#02:00:00:00:00:00#date_max_temp"}
Number Netatmo_Outdoor_Min_Hum "Outdoor Mininum Humidity Today [%d %%]" (Netatmo) {netatmo="00:00:00:00:00:00#02:00:00:00:00:00#min_hum"}
DateTime Netatmo_Outdoor_Min_Hum_Date "Outdoor Minimum Humidity Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#02:00:00:00:00:00#date_min_hum"}
Number Netatmo_Outdoor_Max_Hum "Outdoor Maximum Humidity Today [%d %%]" (Netatmo) {netatmo="00:00:00:00:00:00#02:00:00:00:00:00#max_hum"}
DateTime Netatmo_Outdoor_Max_Hum_Date "Outdoor Maximum Humidity Today [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#02:00:00:00:00:00#date_max_hum"}
Number Netatmo_Rain_Current "Rain Current [%.02f mm]" (Netatmo) {netatmo="00:00:00:00:00:00#05:00:00:00:00:be#Rain"}
Number Netatmo_Rain_Today "Rain Today [%.02f mm]" (Netatmo) {netatmo="00:00:00:00:00:00#05:00:00:00:00:be#sum_rain"}
Number Netatmo_Rain_Rfstatus "Rain RF Status [%d / 5]" (Netatmo) {netatmo="00:00:00:00:00:00#05:00:00:00:00:be#Rfstatus"}
Number Netatmo_Rain_Batteryvp "Rain battery status [%d %%]" (Netatmo) {netatmo="00:00:00:00:00:00#05:00:00:00:00:be#Batteryvp"}
Number Netatmo_Wind_Strength "Wind Strength [%.0f KPH]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#WindStrength"}
Number Netatmo_Wind_Wind_Angle "Wind Angle [%d°]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#WindAngle"}
Number Netatmo_Wind_Gust_Strength "Wind Strength [%.0f KPH]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#GustStrength"}
Number Netatmo_Wind_Gust_Angle "Wind Angle [%d°]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#GustAngle"}
DateTime Netatmo_Wind_Max_Gust_Date "Date Max Gust [%1$tD %1$tr]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#date_max_gust"}
Number Netatmo_Wind_Rfstatus "Wind RF Status [%d / 5]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#Rfstatus"}
Number Netatmo_Wind_Batteryvp "Wind battery status [%d %%]" (Netatmo) {netatmo="00:00:00:00:00:00#06:00:00:00:00:de#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 (X.509 / PEM)
sudo $JAVA_HOME/bin/keytool -import -keystore $JAVA_HOME/jre/lib/security/cacerts -alias StartCom-Root-CA -file api.netatmo.net.crt
The password is "changeit".
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