Skip to main content

Python3 API for the Netatmo Weather Station

Project description

netatmo.py

Build Status pyi pyi

Python 3 API to retrieve data from the Netatmo connected weather station.

The library implements the authentication, the token refresh and the both weather station methods Getstationdata and Getmeasure.

Although Netatmo provides samples written in Python, this library provides - I hope! - more high level methods to access the data.

Installation

The easiest way to install the library is using pip:

pip3 install netatmo

You can also download or clone the GitHub repository and install the module:

cd /path/to/repo
python3 setup.py install

Finally, you may get the netatmo.py source file and use it in your projects.

Requirements

  • Python 3 (sorry if you live in legacy)
  • The requests module (should be included in any decent Python distribution)
  • A valid Netatmo account with at least one weather station
  • A client_id / client_secret pair from Netatmo developper program (see Create your app)

Command-line usage

Help

netatmo -h
netatmo <command> -h

where <command> can be one of these keywords: config, fetch, list, test, dump.

Credentials

The library reads the username/password and client id/secret from a .rc file. By default, it is ~/.netatmorc. It could be edited by hand, or written by the library with the config command.

netatmo config -u user@mail -p password -i client_id -s client_secret -d 70:ee:50:xx:xx:xx

Without any option, config only prints the current configuration.

$ netatmo config
Read config
username: user@mail
password: password
client_id: 1234567890abcdef12345678
client_secret: ABCdefg123456hijklmn7890pqrs
default_station: 70:ee:50:xx:xx:xx

Display the authorized stations

netatmo list

Fetch data into CSV files

netatmo fetch

This command will write two CSV files, netatmo_station.csv and netatmo_module.csv. The most recent measures are appended to these files depending on the last timestamps.

Other commands and options

test tests the connection. On success, exit code is zero. On failure, non zero, like any shell command.

dump displays more data from the weather station.

Each option -v increases the verbosity. The option -c can be use to use an alternate configuration file.

Both -v and -c have to be placed before the command.

Usage as a Python module

#! /usr/bin/env python3

import netatmo

# fetch data using ~/.netatmorc credentials
netatmo.fetch()

# credentials as parameters
ws = netatmo.WeatherStation( {
        'client_id': '1234567890abcdef12345678',
        'client_secret': 'ABCdefg123456hijklmn7890pqrs',
        'username': 'user@mail',
        'password': 'password',
        'default_station': '70:ee:50:XX:XX:XX' } )
ws.get_data()
print(ws.devices)

License and warranty

None and none.

It is NOT an official software from Netatmo and it is not endorsed or supported by this company.

This library has been written as a personal work. Feel free to improve or adapt it to your own needs.

Notes

Other Netatmo devices

This library has been tested only with the weather station and its interior module. I don't know if it works well with the windgauge or the pluviometer. Other devices are unsupported, but their methods could be easily added. See Netatmo Connect APIs.

Installation on a Synology NAS

Synology provides a Python 3 package that lacks the requests module. Here is an simple download method, without git, pip or setup.py:

curl -sL https://api.github.com/repos/kennethreitz/requests/tarball/v2.20.0 | tar -xzf - --strip-components=1 --wildcards '*/requests'

Alternately, you can use Anaconda as Python3 distribution.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for netatmo, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size netatmo-1.0.0-py3.5.egg (10.3 kB) File type Egg Python version 3.5 Upload date Hashes View hashes
Filename, size netatmo-1.0.0-py3.6.egg (10.3 kB) File type Egg Python version 3.6 Upload date Hashes View hashes
Filename, size netatmo-1.0.0-py3.7.egg (10.3 kB) File type Egg Python version 3.7 Upload date Hashes View hashes
Filename, size netatmo-1.0.0-py3.8.egg (10.3 kB) File type Egg Python version 3.8 Upload date Hashes View hashes
Filename, size netatmo-1.0.0-py3-none-any.whl (11.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size netatmo-1.0.0.tar.gz (10.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page