Adding www.saurclient.fr integration

forzewin · March 7, 2023, 4:45pm

Hello there,

Im posting here to find out if anyone would be interesting to create with my help a new integration for www.saurclient.fr

What is www.saurclient.fr ?

It is a website used by french customers that is used to see contract information for water supply, especially usefull because you can see you water consumption data, day by day.

see for yourself :

It would be awesome to have an integration on home assistant to integrate those data in HA.

I reversed engineered a little bit the website, and found out it is using an undocumented API endpoint.

it is fairly easy to use, you need one POST Request with the username/password to get an access token :

And then one GET Request to get the values :

I dont havethe knowledge and skills to create the integration but i can help by providing information and testing.

Is anyone interested for this ?

bend94 · June 26, 2024, 7:10pm

hi,
i am also at saur company
I can help a bit
but tell me how to pass login and password in postman ?
thx

epoxsv · October 15, 2024, 8:37am

Hi all
Somes news about this request ?
Could you share the postman request?
Thanks

0r1g1ne · October 26, 2024, 10:31am

Hello,
I can’t reproduce postman requests on api v2 (neither auth nor consumption).
Could you please share your requests?

magnor · November 11, 2024, 5:33pm

Found this online, but it seems to update on the wrong date (gives consumption of yesterday instead of today). Could not figure out how to fix this.

cekage · February 5, 2025, 6:33am

Hello,

I’ve developed an open-source integration for SAUR water consumption data in Home Assistant: Eye On Saur.
It correctly handles the one-day delay in SAUR’s data and provides:

The latest physical reading (with screenshot)
Meter information (with screenshot)
Full integration with the Home Assistant Energy dashboard

You can check it out here:

Library: Saur_fr_client
HA Integration: EyeOnSaur

What is displayed in Energy Panel view :

It’s still in beta, but it works well! Happy to get feedback and testers.

slOOgO · February 13, 2025, 8:03am

@cekage
Beau travail merci !!
J’ai testé de mon côté mais j’ai quelques questions

tu parles dans la doc d’activer l’accès aux données, j’ai beau chercher je ne trouve rien sur mon compte qui permet cela (site ou appli)
j’ai deux compteurs rattachés à mon compte, est ce que ton intégration permet cette gestion, quand j’ai installé l’intégration je n’ai vu aucune option pour choisir le contrat
j’ai une erreur dans mon dashboard energy : Entity unavailable The state of these configured entities are currently not available: * sensor.compteur_saur (unknown)
mais peut être cela est du au fait que j’ai deux contrats rattaché à mon compte ?

Merci d’avance pour tes éclaircissements !

cekage · February 14, 2025, 12:57am

Merci pour ton retour @slOOgO

La documentation erronée

Ma documentation n’est pas claire, je vais l’amender. Tu n’as rien à activer de ton côté.

Ton compteur d’eau doit être équipé du module installé par l’équipe technique de la SAUR.
Voici ce que j’ai chez moi :
La SAUR doit avoir activé la collecte. Chez moi le compteur a été installé en mars, Et les premières données collectées en juin. Peut-être un délai de déploiement sur le bassin, peut-être un lien avec certains riverains qui questionnaient la puissance de transmission de données.
La SAUR doit avoir activé l’interface (cf 1ere image du post de @forzewin)

Multi Compteur

Pour l’instant l’application ne gère qu’un contrat. Très précisément, elle ne gère que LE contrat par défaut qu’elle trouve dans la valeur de “defaultSectionId” du JSON d’authentification (cf. 2ᵉ image du post de @forzewin).
Je ne sais pas à quoi peut ressembler le JSON lorsqu’il y a deux contrats. Mais je peux y réfléchir avec un modèle.

DashBoard

C’est un casse-tête pour moi, ta question est double

Entity unavailable

Le sensor doit être “None” pour éviter le mécanisme normal d’HomeAssistant de surveillance d’un sensor pour affichage dans l’historique et dans les statistiques. Ce n’est pas intuitif, mais c’est le meilleur compromis.
J’ai ajouté une mention sur le temps réel et je vais améliorer le message du dernier relevé.

state_class: total_increasing
Date Dernier Relevé Physique: “1970-01-01 00:00:00”
Volume Dernier Relevé Physique: null
Date d’installation: “2024-xx-xxT00:00:00”
Note Importante: SAUR ne fournit pas de données en temps réel
unit_of_measurement: m³
device_class: water
friendly_name: Compteur SAUR 5000xxxxxxxx

sensor.compteur_saur (unknown)

Je suis surpris du “unknow”, ça veut dire que l’intégration n’a pas pu récupérer ton index de compteur. L’intégration aurait dû traiter l’erreur et t’informer de ce problème.

Je suis désolé de la faible qualité d’expérience que tu as eue avec cette intégration.

slOOgO · February 16, 2025, 9:23am

@cekage

Je vois merci de ton retour complet!
J’irai vérifier mais je pense que c’est bien ce type de compteur que j’ai

Concernant l’erreur je serai tenté de dire que cela est lié au multi contrat
Dans l’interface Saur on voit bien qu’il y’a un seul ‘Domicile’ avec 2 contrats rattachés

Je n’ai pas de grande expérience en dev, mais quand je regarde les logs de ton intégration je serai tenté de dire que l’intégration récupère un contrat mais qui ne correspond pas à un de mes deux contrats
Le soucis c’est que sur un de mes contrats j’ai une conso à 0, donc compliqué de comprendre si les valeurs retournées dans mon dashboard sont réelles sur mon contrat à 0, ou si c’est 0 car rien ne remonte
Ce qui est surprenant c’est qu’il me renseigne une valeur sur le mois de Février à 132 mais qui ne correspond à rien que ce soit sur mon contrat 1 ou 2

J’aurai bien apporté ma pierre à l’édifice en regardant le JSON de mon interface via une analyse Postman des infos remontées, mais je n’ai quasi aucune compétence en GET/POST pour faire un feedback utile
La seule chose que je constate via une simple inspection de la page web de compte est que j’ai deux ID différents en fonction des tableaux conso que je consulte sur l’URL, ID qui sont constants après connexion déconnexion sur saur.fr :
https://apib2c.azure.saurclient.fr/admin/users/coa…/xxxxxxxx
ID eux mêmes différents de l’ID retourné par ton intégration : sur la partie ‘friendly_name: Compteur SAUR xxxxxxxx’

lapuff · February 16, 2025, 9:37am

Bonjour,

Super boulot, merci beaucoup, c’est exactement ce que je cherche !

Malheureusement, je n’ai pas réussi à installer l’intégration.

Je l’ai installée via HACS et j’ai cette erreur dans mes journaux :

Unable to install package saur_client==0.2.9: × No solution found when resolving dependencies: ╰─▶ Because there is no version of saur-client==0.2.9 and you require saur-client==0.2.9, we can conclude that your requirements are unsatisfiable.

Je suis sous Home Assistant 2025.2.4.

Avez-vous une idée d’où pourrait venir le problème ?

Merci !

cekage · February 16, 2025, 10:22pm

@slOOgO ton retour m’a vraiment intrigué. J’ai essayé mon intégration avec un compte saur professionnel : Multi-contrat, multi-site, multi-compteurs.

Bonne nouvelle : j’ai obtenu les mêmes dysfonctionnements que toi.
Mauvaise nouvelle : ce n’est ni la même logique, ni la même volumétrie. Je dois tout revoir.

Rien de bloquant, juste des petites surprises à intégrer au fur et à mesure et de la mise à l’échelle. Je suis un peu anxieux pour les requêtes SQL du calcul de l’ancre

cekage · February 16, 2025, 10:33pm

@lapuff Merci pour ton retour.

Le problème vient de ma finesse légendaire.

J’ai publié trop vite, j’ai donc supprimé la version 0.2.9 du repo pypi pour reupload mais pypi verrouille.

Je te propose de modifier à la main le manifest.json

Aujourd’hui le fichier ressemble à ça :

{
	"domain": "eyeonsaur",
	"name": "EyeOnSaur",
	"codeowners": [
		"@cekage"
	],
	"config_flow": true,
	"documentation": "https://github.com/cekage/eyeonsaur-ha/blob/c6480ba64cd73d0ea3106389f98c564b16e98a0a/README.md",
	"integration_type": "device",
	"iot_class": "cloud_polling",
	"issue_tracker": "https://github.com/cekage/eyeonsaur-ha/issues",
	"loggers": [
		"eyeonsaur"
	],
	"quality_scale": "bronze",
	"requirements": ["saur_client==0.2.9"],
	"single_config_entry": true,
	"version": "1.1.8"
}

Je te propose de passer à l’une des versions encore publiées

"requirements": ["saur_client==0.3.1"],

ou

"requirements": ["saur_client==0.3.0"],

Il faut ensuite relancer HomeAssistant, je te conseille de relancer le système hôte.

slOOgO · February 17, 2025, 7:35am

@cekage ok je vois! aussi quelle idée d’avoir plusieurs contrats !
Je reste en suivi de l’intégration si jamais un jour avec le temps tu ajoutes ca!
En tout cas merci pour les retours et le boulot pour ton intégration !!

cekage · February 28, 2025, 7:54pm

Publication de la version 1.1.12 : cette mise à jour introduit la gestion du multi-site et du multi-compteur.

Si tout se passe bien, les informations que j’ai utilisées pour différencier les contrats et les compteurs devraient correspondre à celles que tu retrouves sur ta facture .

slOOgO · March 1, 2025, 7:56am

alors la !
J’ai envie de dire bravo !
Je te confirme ! Tout s’est très bien passé !
Tout remonte nickel : numéro de contrat ainsi que mes 2 compteurs !!
Merci pour ton intégration et ses évolutions !!
Bref l’intégration de référence HA pour Saur on peut le dire