Collaboration Hilo avec la communauté OSS - Intégration HA

[nlz242]

Bonjour collaborateurs à l'intégration Hilo pour Home Assistant,

Je m'appelle Carl Quirion, je suis développeur backend pour l'application mobile Hilo. Nous avons commencé un forum de réflexion pour définir comment nous allons pouvoir collaborer avec la communauté sur les initiatives open source, notamment l'intégration Hilo pour Home Assistant.

Nous aimerions avoir votre avis sur la manière dont vous préféreriez que notre entreprise apporte son aide. Veuillez nous faire part de vos suggestions, idées et priorités quant à la contribution que vous aimeriez voir de notre part. Votre perspective en tant que membres de la communauté du logiciel libre est importante pour nous, et nous souhaitons aller dans une direction alignée avec votre communauté.

Nous sommes ouverts à toutes les suggestions, que ce soit dans les domaines du développement, des tests, de la documentation, de la localisation ou de toute autre initiative que vous jugez importante. Votre expertise et vos idées nous guideront dans notre démarche pour apporter une contribution pertinente à ce projet.

Notre objectif n'est pas de prendre le contrôle du projet, mais plutôt de vous soutenir et de vous guider sous forme de documentation, de discussion et de code pour le faire évoluer dans la bonne direction.

N'hésitez pas à nous donner d'autres idées de collaboration pour mieux répondre à vos besoins spécifiques. Nous croyons en la puissance de la collaboration entre les entreprises et les communautés de logiciels libres pour favoriser l'innovation et le progrès technologique.

Nous sommes impatients d'entendre vos retours et de commencer à travailler ensemble pour faire avancer cette initiative.

Cordialement, Carl Quirion

[valleedelisle]

Personnellement, je salue la collaboration de l'équipe d'ingénieurs d'Hilo qui nous aide "behind the scene" depuis bien longtemps.

Fedora tip

Pour le premier item de ma wishlist, je crois que ça pourrait être pratique pour tout le monde (pas just pour la communauté home-assistant) d'avoir de la doc sur les APIs, avec des exemples, etc. Ensuite, comme dit le proverbe, plus on est de fou, plus on rit. Hilo pourrait s'inspirer des idées qui ont été développés par la communauté pour les intégrer des trucs à son app et les offrir à Monsieur et Madame Tout-le-monde.

Le deuxième item de ma wishlist serait d'offrir des comptes de développeur dans un environment de test ou de qualification, avec des fake-devices.

Le troisième item de ma wishlist serait qu'on puisse avoir accès à des journaux sur les actions qui ont été porté (ex: iPhone de David - App Hilo - Éteint lumière cuisine)

Je suis conscient que c'est un investissement de ressources et de temps, surtout au début mais ça aiderait tout le monde à bien échanger avec vous. Si vous réussissez tout ça, vous méritez mon Fédora :-)

Cheers,

DVD

[ic-dev21]

Super initiative, je vous salue bien bas.

Est-ce que prioriser les commandes du LAN pour ensuite updater le cloud serait une possibilité pour réduire la latence?

[nlz242]

Malheuresement, ce n'est pas dans les cartes. On travail fort pour diminuer la latence / augmenter la capacité de nos systemes.
Sans trop rentrer dans le technique, il n'y a pas de communication App -> Passerelle présentement, c'est toujours App -> Cloud -> Passerelle. Ça serait un gros chantier faire autrement.

[nlz242]

Bonjour!

Tout d’abord j'aimerais vous remercier pour les commentaires et suggestions apportées.
Nous prendrons actions sur certaines de celles-ci, certaines nécessites plus de réflexions ainsi que l'implications de différents départements.

Pour la documentation, la plupart de nos services ont de la documentation OpenAPI (Swagger) existante, celle-ci est privé et est divisée par services.
Un effort doit être fait pour regrouper la documentation des différents services, puis pour publier la documentation pour l'API tel qu'accessible via api.hiloenergie.com.
Nous devons aussi déterminer sous quel format nous la publierons (Swagger interactif, ReDoc, simple fichier de spec OpenAPI (swagger.json), autre...).

En ce qui a trait à l'accès à un environnement de dev ainsi que des outils de monitoring/debug, nous discutons présentement d'alternatives pour arriver à offrir l'accès à certaines de ces outils en respectant nos standards de sécurité.

J'en profite pour vous mentionner que deux chantiers tirent à leur fin (ou ont récemment été déploiés en production) et aurons un impact sur l'intégration Hilo pour Home Assistant.

1. Refonte de l'authentification
   Vous l'avez peut-être remarqué, l'authentification dans l'App Hilo se fait maintenant via un flow OpenID Connect de type Authorization Code with PKCE.
   C'est à dire que l'application ne contient plus le formulaire de connexion, celui-ci est fourni par la plateforme d'authentification et un échange de code d'authorization se fait entre l'app et la plateforme d'authentification, une fois l'utilisateur connecté.
   Le flow précédent n'a pas été désactivé, car nous ne voulions pas impacter négativement l'intégration Hilo pour HA. Cependant ce flow sera retiré dans les mois à venir, et bien que nous ne soyons pas en mesure et nous souhaitons vous accompagner pour que vous puissiez adapter l'intégration HA. Notre date initiale visée pour le retrait est septembre 2023, mais nous pourrons ajuster un peu pour permettre à l'intégration HA de continuer de fonctionner.
   Nous avons fait une petite preuve de concept d'authentification en utilisant ce flow, via une intégration Home Assistant, afin de valider la faisabilité d'utiliser ce type de flow. Le code de cette preuve de concept, une fois mis au propre et documenté, pourra être partagé avec la communauté.

2. Ajout des informations de passerelle dans SignalR
   Afin d'éliminer le plus de "polling" possible et permettre à l'App Hilo d'être plus réactive, plusieurs informations sont envoyées via à la connexion websocket effectuée par l'App Hilo (SignalR). L'intégration Hilo pour Home Assistant utilisait déjà un des deux types de messages pour obtenir les changements effectués aux différents périphériques, mais les informations de passerelle elle-même, tel que son status Connecté/Déconnecté, était obtenu par un appel à l'api via le endpoint Gateway/Info.
   Nous avons créé une branche de l'intégration où nous avons implémenté l'usage du nouveau message SignalR. Nous sommes en déploiement progressif pour cette fonctionnalité, qui est lié à d'autres améliorations au niveau de la mise à jour de l'état des périphériques.
   Une fois la fonctionnalité activée pour l'ensemble des utilisateurs, nous produirons une Pull Request vers le repo officiel de l'intégration.

Nous avons intégré ces éléments dans notre planification et devrions commencer le travail rapidement (pour Q3). Nous serons en contact avec vous pour vous partager les éléments mentionnés et pour répondre à vos questions.

[Extarys]

Salut @nlz242 , j'ai vraiment fait un saut quand j'ai vu qu'une compagnie "for profit" s'intéressait à la communauté, ses utilisateurs et à HA. C'est tellement rare, je n'en reviens toujours pas.

J'espère que le nouveau flow d'authentification sera disponible pour HA avant le retrait de la méthode actuelle, car je viens tout juste de souscrire à Hilo justement parce que ce module existe pour HA :)

Merci de votre transparence et votre belle communication. Vous avez le cœur à la bonne place, comme on dit !

EDIT: Je tiens à dire aussi que la politique de confidentialité était assez simple à lire et était rempli de gros bon sens, une autre chose très rare en tech ! (Voir le Privacy not included sur les voitures que Mozilla vient de sortir, un très bel exemple haha)

[julienld]

@nlz242 : Question comme ça... Avez-vous pensé simplement développer et supporter une intégration HA par Hilo plutôt que de mettre de l'effort sur rendre publique votre API avec tout ce que cela comporte? Avoir un API publique et documenté est un effort non négligeable (plus difficile à faire évoluer puisqu'il ne peut plus y avoir de breaking changes, requiert des versions de méthodes, un système de déprécation des anciennes versions de méthodes, etc.).

Maintenant, j'imagine que vous n'êtes pas une boite de développement Python... alors ce n'est probablement pas parfait comme solution.... mais peut-être pourriez-vous utiliser un middleware comme MQTT?

[nlz242]

@nlz242 : Question comme ça... Avez-vous pensé simplement développer et supporter une intégration HA par Hilo plutôt que de mettre de l'effort sur rendre publique votre API avec tout ce que cela comporte? Avoir un API publique et documenté est un effort non négligeable (plus difficile à faire évoluer puisqu'il ne peut plus y avoir de breaking changes, requiert des versions de méthodes, un système de déprécation des anciennes versions de méthodes, etc.).

On y a pensé. Les deux approches ont leurs pour et leurs contres... l'API documenté a l'avantage d'etre utilisable par plus de gens que seulement HA, par exemple des gens qui font des automatisations via IFTTT, etc...
Les challenges mentionnées, on vie déjà avec plusieurs de ceux-ci car nos versions "minimum" de l'application sont toujours plusieurs versions en arriere, on ne peut pas se permettre de forcer une MAJ de l'app Hilo à chaque fois qu'il y'a des modifications à l'API.

C'est un sujet de discussion constant et encore en vie, à l'interne. Est-ce qu'on pourrait changer d'idée et faire une intégration officielle ? Ce n'est pas impossible, mais ce n'est pas dans le plans.

Comme toute entreprise de tech, on a un gros backlog et ajouter un produit, comme une version officielle d'intégration HA, c'est quand même un serieux effort de developpement. La version developpé par la communauté (David et cie) fonctionne quand-même assez bien, c'est un autre argument pour la documentation. Si on peut encourager la collaboration et aider à rendre la communautée plus vivante, tout le monde y gagne.