pyNetatmoHue

This repository contains the module 'pyNetatmoHue.py' (Python code) that allows you to continuously automatically adjust the colours of your Hue lights according to the measured PPM levels by your Netatmo weather station.

This is useful when you want to easily monitor the PPM level in your room so you known when you need to ventilate your room (additionally).

You can specify a Netatmo Station and Module to measure the PPM level, a Hue light that will colour as the PPM level changes and a motion sensor (optional) that checks if anybody is present in the room, if not, that light will not change colour.

Target Audience

This repository is intended for (Python) Developers who would like to use this code, or ideally, would like to contribute.

References

A slightly more elaborate description of this solution is also available on Medium: https://medium.com/@steve.depeijper/easy-at-a-glance-awareness-of-room-ventilation-levels-b8fa1e63ff1a

Installation

Install via PIP with:

sudo pip install pyNetatmoHue

Use in Python like this:

import pyNetatmoHue as pNH

NH2 = pNH.NetatmoHue(
    _CLIENT_ID="xx",
    _CLIENT_SECRET="xxx",
    _USERNAME="[email protected]",
    _PASSWORD="xx%xx*",
    scope=(
        "read_station read_camera access_camera write_camera read_presence "
        "access_presence write_presence read_thermostat write_thermostat"
    ),
    _BASE_URL="https://api.netatmo.com/",
    _IP="192.168.2.7",
    _SETTINGS={
        "portaal": {
            "station": "_ (Keuken)",
            "module": "Portaal",
            "lights": [8],
            "sensor": 16,
        },
        "werkkamer": {
            "station": "_ (Pepijn)",
            "module": "Werkkamer",
            "lights": [6],
            "sensor": 160,
        },
        "keuken": {"station": "_ (Keuken)", "lights": [3, 4]},
    },
)

NH2.start()

API Credentials

Netatmo API credentials can be created via https://dev.netatmo.com/apps/. Register an APP to get a ClientID and Client Secret.

Configuration

When you intitiate a class instance a number of parameter values are required. The following parameters are required to obtain the CO2 levels:

• _CLIENT_ID
• _CLIENT_SECRET
• _USERNAME
• _PASSWORD
• scope
• _BASE_URL

You also need to specify the IP address of your HUE bridge. This is done using the parameter _IP. You can find you IP address by using your HUE app and going to 'Settings' -> 'Hue Bridges' -> 'Information Icon'.

Settings

The settings parameter consists of a nested dictionary with the rooms that each have a station or optionally also a module to retrevieve the CO2 level. The light(s) that need to be coloured in that room are specified (in a list). Finally, optionally, you can specify a motion sensor that checks for presence in the room.

To obtain the light and sensor identifiers, I recommend the app 'all 4 hue'. In this app you can select a light or sensor and then choose 'show internal identifier'.

Initial use

When you start instance the first time, using instance_name.start(), you will be prompted to push the button on your bridge. Every 10 seconds a retry is attempted to connect to the bridge. So within 10 seconds after pushing the button a connection is attempted. When you push the button on the bridge a username is released by the bridge. This username is stored in a json file.

Defaults

The current version of this module works with a number of fixed values:

The function getHue assumes a range PPM range of 400 - 900.

The function getHue sets the colour by changing the amount of red for PPM values of 400 to 800.

The function getHue sets the colour by changing the amount of green and blue for PPM values of 800 to 900.

Therefore, purple is good, blue is not so good and green is bad.

Contribution

The TODO.md file contains the todo items / roadmap. We are looking for contributors! Please share your thoughts in the discussion tab.