stas-dovgodko / viessmann-api
Requires
- php: ^7.0
- ext-curl: *
- ext-json: *
- lusitanian/oauth: v0.8.11
- phpunit/phpunit: ^7.3.2
- psr/link: ^1.0
- tomphp/siren: v0.1.0
Requires (Dev)
- roave/better-reflection: dev-master
README
Suppression de la dépendance sur php 7.1 et fix de GetAvailableFeatures https://github.com/thetrueavatar/Viessmann-Api/releases/tag/1.3.4
Version 1.3.3
Ajout d'un import DateTime manquant créant une erreur lors du traitement du message de ban de Viessmann: https://github.com/thetrueavatar/Viessmann-Api/releases/tag/1.3.3
Version 1.3.2
Attention, cette version nécessite php et php-curl 7.1 pour supporter l'utilisation du "?". Translated documentation can be found here:
Ajout d'une cache et refactoring pour réduire la charge sur le serveur Viessmann https://github.com/thetrueavatar/Viessmann-Api/releases/tag/1.3.2 Il est désormais possible de définir dans le credentials.properties son installationId(3ème ligne) et son gatewayid(4ème ligne) ce qui réduit le nombre de requêtes nécessaire. Ces valeurs peuvent être obtenues en appelant les méthodes getGatewayId and getInstallationId avec juste le user/pwd dans credentials.properties. Cela réduira le nombre de requête à 3 dont 2 pour l'authentification qui ne comptent pas dans le quota. La cache est utilisée pour tout appelle sur l'objet ViessmannApi. Le code suivant ne fait donc qu'un seul appel au total:
<?php
include __DIR__ . '/bootstrap.php';
$viessmannApi->getOutsideTemperature());
$viessmannApi->getBoilerTemperature());
$viessmannApi->getSlope());
$viessmannApi->getShift());
Comme déjà expliqué Viessmann limite désormais le nombre de requête sur son service:
- 120 calls for a time window of 10 minutes
- 1450 calls for a time window of 24 hours
If you wish to contribute or thanks me /Si souhaitez me soutenir ou me remercier:
News FR
Une nouvelle version utilisant une cache et évitant un nombre trop important d'appel est disponible en snapshot. Cette version a été développé à l'aveulge(mon compte est bloqué) mais fonctionne en test local. Faites-moi le plus de retour possible ! Attention, la cache fonctionne à condition que vous fassiez tout vos appels sur le même objet viessmannApi. Exemple:
$viessmannApi->getOutsideTemperature());
$viessmannApi->getBoilerTemperature());
$viessmannApi->getSlope());
$viessmannApi->getShift());
General info
Translated documentation can be found here:
Implémentation d'une interface pour récupérer les données exposées par le service Viessmann.
Ce service accessible via autorisation OAUTH2 expose les données via l'approche HATEOAS implémentée par Siren dont la spécification est définie ici:
https://github.com/kevinswiber/siren
Le but de l'api est de cacher ces aspects techniques poru exposer directement les données.
Je suis novice en php(JAVAEE Dev) donc il se peut que je ne connaisse pas les conventions/habitudes php. Tout conseil/remarque est apprécié et n'hésitez pas à contribuer !
Je précise aussi que je partage mon dev perso mais ne souhaite pas faire un support intensif (pas le temps). Je ne donne donc pas de garantie sur la résolution de tel ou tel bug en terme de délais de résolution. De toute façon, cmme on dit dans l'open-source "Please contribute" ;-)
Pour voir les explications sur l'utilisation voir wiki: https://github.com/thetrueavatar/Viessmann-Api/wiki/French ou le code de example/Main.php
Voici la doc des méthodes de l'api Viessmann API:
Une fonctionnalité manque ? N'hésitez pas à l'ajouter vous-même ! Je suis en train de construire un petit guide pour le faire: How to add new feature by yourself: