Bibliothèque Python

Le paquet Python hamapi télécharge les données historiques (datalogs) de vos appareils. Il lit les lignes pour vous et donne une liste de valeurs pour chaque mesure. Vous pouvez l’utiliser librement (licence MIT).

Installation

pip install hamapi

Vous avez besoin de Python 3.6 ou plus récent. Le paquet installe aussi requests et brotli.

Exemple

import time
import hamapi

ham = hamapi.hamapi(api_key='YOUR_API_KEY')

end = int(time.time())
start = end - 7 * 86400

data = ham.get_datalog_data('e11:123', start, end, averaging_step=120)
print(list(data.keys()))
print(data['timestamp'][:5])

api_key : vous l’obtenez sur la page Compte de l’application. Voir l’API REST.
'e11:123' : le numéro de série de l’appareil. Vous avez besoin de la permission de lecture sur l’appareil.
start, end : temps Unix en secondes.
averaging_step : facultatif. Le paquet donne une valeur moyenne pour chaque pas de ce nombre de secondes. Avec 0 (la valeur par défaut), vous obtenez toutes les lignes.

Le résultat

get_datalog_data retourne un dictionnaire :

timestamp : l’heure de chaque valeur, en secondes Unix.
Une liste pour chaque mesure et chaque sortie de l’appareil. La clé est le code de la mesure (par exemple T). Les codes sont dans le Dictionnaire des mesures.

Toutes les listes ont la même longueur. Sans averaging_step, les listes ont un point de plus juste avant chaque changement. Ainsi, un graphique montre des paliers.

Autres fonctions

ham.get_user_devices() : les appareils de votre compte. Ce sont les mêmes données que get_user_devices.php.

Remarques

Le paquet garde les jours passés téléchargés dans le fichier .cached.db, dans le dossier actuel. Il ne télécharge pas ces jours une autre fois. Pour les télécharger de nouveau, supprimez le fichier.
Le paquet lit uniquement l’historique. Pour les données en direct, voir Données en direct (WebSocket).
Le paquet contient les définitions d’appareils de sa version. Pour les nouveaux types d’appareils, mettez-le à jour avec pip install -U hamapi.
Page du paquet : pypi.org/project/hamapi.

Voir aussi

Chat avec le support