Skip to content

Latest commit

 

History

History
83 lines (49 loc) · 3.78 KB

README.md

File metadata and controls

83 lines (49 loc) · 3.78 KB
Raw

Flipr Python API REST Client

Client Python pour l'API Flipr. | Python client for Flipr API.

PyPi GitHub Release Python Version Black Read the docs Codecov Github Activity

You will find English README content in the section For English speaking users.

Vous trouverez le contenu francophone du README dans la section Pour les francophones.

Pour les francophones

Description

Flipr est un objet connecté que l'on met dans sa piscine pour mesurer en continu les valeurs chimiques de celle-ci. Ce package Python permet de gérer la communication avec l'API REST publique Flipr API.

Le client permet de :

  • Récupérer l'id de votre flipr.
  • Accéder à la mesure la plus récente de votre Flipr (données de température, ph, chlore et redox).

Pour utiliser le client, il vous faudra disposer de vos identifiants et mot de passe Flipr créés avec l'application mobile.

Ce package a été développé avec l'intention d'être utilisé par Home-Assistant mais il peut être utilisé dans d'autres contextes.

Installation

Pour utiliser le module Python flipr_api vous devez en premier installer le package en utilisant pip depuis PyPI:

   pip install flipr-api

Vous pouvez trouver un exemple d'usage en regardant le test d'intégration.

Vous pouvez également faire un test direct de l'API REST en suivant l'exemple testing_api.md.

Contribuer

Les contributions sont les bienvenues. Vous pouvez ouvrir une pull request.

For English speaking users

Description english

Flipr is a connect object that you put in your swimming pool in order to measure chemical values of it. This Python package allows to communicate with the public REST API Flipr API.

This client allows to :

  • Retrieve the id of your flipr
  • Get the latest measure of your Flipr (data of temperature, ph, chlorine and redox).

To use this client, it requires you have your login and password created with Flipr's mobile application.

This package has been developed to be used with Home-Assistant but it can be used in other contexts.

Installation english

To use the flipr_api Python module, you have to install this package first via pip from PyPI:

   pip install flipr-api

You will find an example ot usage in a Python program in the le test d'intégration.

You can test directly the flipr API following the given sample testing_api.md.

Contributing

Contributions are welcomed. You can open pull requests.

Credits

This project was inspired from the MeteoFranceAPI HACF project.