Skip to content

Latest commit

 

History

History
165 lines (116 loc) · 5.79 KB

README.md

File metadata and controls

165 lines (116 loc) · 5.79 KB
Raw

Netatmo PHP Widget

NO MORE SUPPORTED

The Netatmo API has changed in 2017. No more time to support this.

Requirements

You need a web server with PHP 5.4+

The gettext PHP extension is mandatory to localize the widget.

The Curl extension is mandatory too to access the Netatmo API.

Example

For ubuntu users, install the Curl extension :

sudo apt-get install php5-curl
sudo service apache2 restart

Installation

Just copy the project directory on your server and configure it.

Configuration

  1. Create a config.user.inc.php at the root directory.
  2. Put these lines : 
    <?php
$NAusername = "____EMAIL_ACCOUNT_HERE____";
$NApwd      = "____PASS_ACCOUNT_HERE____";
$NAconfig   = array(
    'client_id'     => '____API_CLIENT_ID_HERE____',
    'client_secret' => '____API_CLIENT_SECRET_HERE____',
);

define( 'NETATMO_DEVICE_DEFAULT_VALUES' , 'Humidity,CO2,Noise' );
define( 'NETATMO_MODULE_DEFAULT_VALUES' , 'Humidity,Rain,RainSum,sum_rain_1,sum_rain_24' );
  3. Change ____EMAIL_ACCOUNT_HERE____ by your netatmo email address
  4. Change ____PASS_ACCOUNT_HERE____ by your netatmo password
  5. To change ____API_CLIENT_ID_HERE____ and ____API_CLIENT_SECRET_HERE____, you need to create a netatmo app, it is really straightforward :
    1. Go to https://dev.netatmo.com
    2. Sign in with your netatmo email address and password
    3. Click on CREATE AN APP button on top
    4. Give a name to your application
    5. Fill the application description eg: Netatmo Application for my PHP Widget installed on my website
    6. Accept the terms of use
    7. Click on CREATE
    8. Now you can copy paste client id and client secret

You can configure the CSS by creating a css/style.user.css file, it will not be updated when you pull code from git.

Change log

  • 0.6

    • Support of anemometer
    • Add sv_SE language (thank to Janne Gustafsson)

  • 0.5.8

    • Force all http Netatmo API URL to https

  • 0.5.7

    • Add text_wo_rainsensor and r parameters in raw.php

  • 0.5.6

    • Prefix mac address class name with letter m, CSS class names beginning with a digit is not supported in browsers...
    • Add a check for people who do not configure the widget

  • 0.5.5

    • Add GET parameter a in raw.php
    • Add rain1 and rain24 values for GET messages in raw.php

  • 0.5.4

    • Add rain_sum_1 and rain_sum_24 values
    • Add index_combined.php file to display rain information in the first outside module instead of a new rain module

  • 0.5.3

    • change raw.php to return last 24h rain gauge informations
    • change raw.php to specify custom message
    • change raw.php to retrieve all weather stations informations with GET parameter a
    • add polish language (thanx to Karol Zak)

Upgrade notes

Upgrading to 0.6

To retrieve wind informations, please add WindStrength, WindAngle, GustStrength and GustAngle in constant NETATMO_MODULE_DEFAULT_VALUES in your configuration file like this :

define( 'NETATMO_DEVICE_DEFAULT_VALUES' , 'Humidity,CO2,Noise' );
define( 'NETATMO_MODULE_DEFAULT_VALUES' , 'Humidity,RainSum,sum_rain_1,sum_rain_24,WindStrength,WindAngle,GustStrength,GustAngle' );

Upgrading to 0.5

To retrieve rain informations, please add Rain, RainSum, RainSum in constant NETATMO_MODULE_DEFAULT_VALUES in your configuration file like this :

define( 'NETATMO_DEVICE_DEFAULT_VALUES' , 'Humidity,CO2,Noise' );
define( 'NETATMO_MODULE_DEFAULT_VALUES' , 'Humidity,Rain,RainSum' );

dump.php

You can dump all Netatmo informations by calling this script.

raw.php

If you only want to display text instead of a widget, you can call raw.php instead of index.php.

You can now specify 6 custom messages in the url when :

  • there is no anenometer and there is a rain gauge information (text_wi_rain)
  • there is no anenometer and no rain gauge information (text_wo_rain)
  • there is no anenometer and no rain gauge information for more than a count of seconds (text_wo_rainsensor and the count of seconds is defined by the r parameter. Default is 24h, ie 86400)
  • there is an anenometer and there is a rain gauge information (text_wi_rain_wi_wind)
  • there is an anenometer and no rain gauge information (text_wo_rain_wi_wind)
  • there is an anenometer and no rain gauge information for more than a count of seconds (text_wo_rainsensor_wi_wind and the count of seconds is defined by the r parameter. Default is 24h, ie 86400)

Here are the distinct available parameters :

Available parameters in your message are :

  • _device_name_
  • _name_
  • _human_date_
  • _human_hour_
  • _temp_
  • _humi_
  • _rain_ : seems to be the last rain measured
  • _rain1_ : amount of rain in last hour
  • _rain24_ : amount of rain today
  • _windangle_ : in °
  • _windstrength_ : in km/h
  • _gustangle_ : in °
  • _guststrength_ : in km/h

raw2.php

Just to show you how to retrieve informations from the PHP array to build your own script.