Homeassistant Airparif integration

Create Airparif previsions sensors in Homeassistant

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Acknowledgements

About The Project

This project provides an unofficial Homeassistant integration for Airparif data.

This integration retrieves the data from the official Airparif API and requires an official API key obtainable from Airparif on this page.

Getting Started

To get up and running follow these simple steps.

Prerequisites

You need to know the INSEE code for the cities you want to integrate.

Note that the INSEE code is different from the city postal code.

It can be found on the INSEE website or with a quick Google search.

For instance, Paris' first arrondissement INSEE code is 75101.

Installation

1. Copy the custom_components/airparif folder into your custom_components folder.

2. Add the following configuration in your configuration file:

sensor:
  - platform: airparif
    token: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    locations:
      - 75101
      - 75102

4. Restart your Homeassistant instance.

Usage

A sensor is created for each location defined in the configuration.

For now, the integration provides pollution indexes for the current and the next day:

today:
  date: '2021-08-22'
  pm_2_5: Bon
  pm_10: Bon
  ozone: Moyen
  nitrogen_dioxide: Bon
  sulfur_dioxide: Bon
  aqi: Moyen
tomorrow:
  date: '2021-08-23'
  pm_2_5: Bon
  pm_10: Bon
  ozone: Moyen
  nitrogen_dioxide: Bon
  sulfur_dioxide: Bon
  aqi: Moyen
friendly_name: Airparif 75101
icon: mdi:cloud

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

This repository is based on:

• The official WAQI integration
• The custom_component/integration_blueprint project