ZiPulses

Compteur d'impulsions communiquant en ZigBee 3.0.
Le ZiPulses est disponible en boutique :
Boutique LiXee

Sommaire

• Description
• Fonctionnement
  • Appairage
  • le capteur est appairé
• Boitier
• PCB
• Installation
  • Alimentation
  • Impulsions
• Voyant lumineux
• MAJ non OTA
• Clusters
  • Clusters list
  • Basic Cluster
  • PowerConfiguration Cluster
  • TemperatureMeasurement Cluster
  • SimpleMetering Cluster
  • Tableau unité
• Intégrations
  • Jeedom
  • Domoticz
  • HomeAssistant
  • Eedomus
• Changelog

Description

L'appareil ZiPulses permet de récupérer les impulsions d'un compteur pour créer un index et le transmettre à un coordinateur Zigbee.
ZiPulses est un capteur Zigbee de type "ZED" (Zigbee End Device). Il ne peut donc pas router les informations des autres capteurs et nécessite des périodes d'endormissement afin de préserver sa consommation d'énergie.

ZiPulses peut être alimenté de deux façons:

• avec une pile CR2450 (3V)
• avec une alimentation externe de 5V à 12V

Fonctionnement

Appairage

Si le produit n'est associé à aucun réseau zigbee

• ZiPulses se mettra en mode appairage dès la mise sous tension. (la Led clignote 3 sec)
• ZiPulses se mettra en mode appairage à chaque appuie sur le bouton "Link". (la Led clignote 3 sec)

Si le produit est déjà associé à un réseau zigbee

• ZiPulses fera un "rejoin" à chaque mise sous tension.
• Pour sortir d'un réseau, il faut rester appuyer sur le bouton "Link" pendant 10 sec. Il se remettra automatiquement en mode appairage. (la Led clignote 3 sec)

Le capteur est appairé

Juste après l'appairage ou Rejoin

• Le capteur ZiPulses reste éveillé environ 10 secondes afin que le coordinateur zigbee puisse faire un bind sur les clusters : 0x0001, 0x0402, 0x0702 ou interroger le capteur

ZiPulses n'est pas sollicité

• Le capteur va se réveiller et s'endormir toutes les 60 secondes
• Le capteur envoie toutes les 2 heures, la tension de batterie, la temperature et le dernier index
• (A partir de v8.0) le capteur envoie la tension de batterie, la temperature et le dernier index toutes les minutes uniquement s'il y a eu des impulsions.

ZiPulses reçoit des impulsions

• (avant la v8.0) Le capteur est reveillé. Il incrémente l'index, sauvegarde en mémoire et l'envoie au coordinateur
• (à partir de la v8.0) Le capteur est reveillé. Il incrémente l'index et sauvegarde en mémoire.

Appuie sur le bouton

• (avant la v8.0) le capteur est réveillé et retente une connexion si déconnecté
• (à partir de la v8.0) le capteur est réveillé, tente une connexion si déconnecté et envoie les infos du capteur si connecté.

⚠️ Pour que des requêtes manuelles du coordinateur vers le ZiPulses soit prises en compte, il est indispensable d'appuyer sur le bouton "Link" (1 seule fois) juste après le lancement de la requête ZigBee (afin de le réveiller). Cette technique est notamment indispensable pour modifier le coefficient multiplicateur de l'index et/ou l'unité de mesure par exemple.

Boitier

Photos

Exemple de schema montage

PCB

Les PCB ci-dessous ne sont pas forcément contractuels. Ils peuvent légèrement être modifiés en fonction des évolutions mais les fonctions seront similaires

Face 1

Magenta : MCU zigbee
Bleu : régulateur 3.3V
Jaune : Connecteur antenne externe

Face 2

Installation

Alimentation

Comme vu plus haut, il existe 2 modes d'alimentation qui ne peuvent fonctionner en même temps.

Alimentation externe

Par défaut, l'appareil est en mode alimentation externe. Tout d'abord, il faut vérifier que le Switch alimentation (visible ici) est bien positionné sur REG (comme régulateur)
Ensuite, il faut brancher sur les connecteurs d'alimentation noté VIN et GND, les fils d'alimentation.
⚠️ La tension aux bornes doit être comprise entre 5 et 12 VDC.

⚠️ A partir de la version 2 (v0.7 sur PCB), il est possible d'utiliser les bornes pour brancher des piles (pas de surconsommations lié au régulateur)

Alimentation sur pile

Tout d'abord, il faut vérifier que le Switch alimentation (visible ici) est bien positionné sur BAT (comme Battery)
Ensuite, il faut introduire une pile de type CR2450 dans l'emplacement en respectant la polarité. (+ en haut et - en bas)

Alimentation externe (custom) - pour la V0.5

Il y a une possibilité d'utiliser les plots de programmation pour alimenter le ZiPulses. Vous pouvez utiliser un autre support de pile branché sur le plot 3v3 et GND du port de programmation. Dans ce mode là, a position du switch REG/BAT n'a pas d'incidence.

Exemple de piles avec support :

• Soit 2 piles LR6 AA en série (env 1500mAh) support
• Soit 2 piles LR14 en série (env 8000mAh) support
• Soit 2 piles LR20 en série (env 16000 mAh) support
• Soit une pile CR123A (env 1500mAh) support
  Il y a surement d'autres techno/type de piles mais j'ai mis les plus usuelles / moins chères. Il faut juste respecter la tension de 3V à 3.6V MAX
  Bien entendu, les capacités dépendent des marques, de l'environnement et du type d'utilisation. Il est conseillé de prendre 70-80% de la vraie valeur.

Exemple de montage

Sachant que la pile CR2450 d'origine contient environ 500mAh, vous pouvez calculer (en fonction de vos utilisations) l'autonomie du ZiPulses avec vos nouvelles piles

⚠️ Avec la version 2 (v0.7 sur PCB), il est désormais possible d'utiliser ces supports avec les bornes classiques VIN et GND de l'appareil

Impulsions

Le ZiPulses est en mesure de détecter les impulsions (créneau bas) à partir de 20ms environ. (à partir de la V5.0) Le ZiPulses est en mesure de détecter les impulsions à partir de 20ms jusqu'à 500 ms environ. La fréquence des impulsions détectable doit être supérieure à 500ms (à partir de la V8.0)

Compteur GAZPAR

⚠️ Attention, le ZiPulses n'a pas le marquage ATEX. Pour des raisons de sécurité, il faut utiliser un connecteur JAE marqué compatible Gazpar. Il est aussi recommandé de placer le ZiPulses à l'extérieur du coffret où se trovue le compteur Gaz.

Compteur / débimètre eau

Avec sortie impulsion de type ILS (lamelles métallique)

Avec sortie impulsion (Transistor ou Mosfet)

Voyant lumineux

Voici les différentes possibilités :

La LED bleue est éteinte

• Le capteur est endormi ou non sollicité

La LED bleue s'allume puis s'éteint

• le capteur a reçu une impulsion
• le capteur est appairé et le bouton link a été actionné.

La LED bleue clignote

• le capteur n'est pas encore appairé

La LED bleue est allumé constamment

• le bouton "Link" est appuyé sans être relaché
• le capteur est planté et nécessite un reset

Mise à jour du Firmware (non OTA)

Tout d'abord, il faut dévisser le boitier afin de sortir la carte électronique. Ensuite, il faut brancher le module USB TTL (CP2102 dans l'exemple) sur le ZiPulses comme sur la photo.

Une fois que les branchements sont OK, il suffit d'insérer sur votre ordinateur la clef USB en maintenant le bouton Flash puis relacher. L'utilisation d'une rallonge USB peut se révéler plus pratique pour faire la mise à jour.

Sous Windows

• Télécharger et installer (si nécessaire) les pilotes du module USB TTL ici
• Télécharger et installer l'outil de flashage.
• Télécharger le firmware souhaité : (https://github.com/fairecasoimeme/ZiPulses/releases)
• Ouvrir une console
• Aller dans le répertoire de l'outil de flash
• Lancer la commande suivante :

Sans remise à zéro (Conserve les appareils déjà appairés):
DK6Programmer -s COMXX -P 500000 -Y -p <NOM_DU_FIRMWARE.bin>

Avec remise à zéro (Efface toutes les données (appairages compris)):
DK6Programmer -s COMXX -P 500000 -e FLASH -Y -p <NOM_DU_FIRMWARE.bin>

Sous Linux x86_64

• Télécharger et extraire l'outil de flashage :

  wget https://zigate.fr/wp-content/uploads/2021/05/x86_64.tar
  tar -xvf x86_64.tar
  

• Installer les dépendances de l'outil de flashage :

  sudo apt-get update
  sudo apt-get install libncurses5 libusb-1.0-0 libftdi1 libudev1
  

• Télécharger le firmware souhaité : (https://github.com/fairecasoimeme/ZiPulses/releases)

• Lancer une des commandes suivantes (on suppose que le module USB TTL est /dev/ttyUSB0) :

  Sans remise à zéro (Conserve les appareils déjà appairés) :
  DK6Programmer -s /dev/ttyUSB0 -P 115200 -Y -p <NOM_DU_FIRMWARE.bin>
  Avec remise à zéro (Efface toutes les données (appairages compris)) :
  DK6Programmer -s /dev/ttyUSB0 -P 115200 -e FLASH -Y -p <NOM_DU_FIRMWARE.bin>

Clusters

Clusters List

Basic Cluster (0x0000)

PowerConfiguration Cluster (0x0001)

Temperature Measurement (0x0402)

La temperature n'est pas précise mais elle peut être utile pour prévenir du gel. (surtout pour les compteurs d'eau) La valeur est en centième de degré.

Simple Metering (0x0702)

Tableau d'unité de mesure

Intégrations

Jeedom

Compatible avec le plugin zigbee.

Domoticz

Compatible avec le plugin Zigbeefordomoticz en version 7.1.003 (et ultérieures)

• Device de type compteur (permettant de choisir le type et donc l'unité, mais aussi l'offset, le diviseur,...)
• Remonte également un device température et un device tension de la pile/alim externe, mis à jour toutes les deux heures (indiquera donc 0°C et 0V pendant les deux premières heures)

Home-assistant

ZHA

Nativement compatible avec ZHA.

⚠️ Pour changer les coefficients multiplicateurs / diviseurs et l'unité de mesure il faut suivre la procédure suivante :

1- Sélectionner l'appareil puis lancer l'outil de gestion de l'appareil.

2- Sélectionner le cluster "Metering" et l'attribut correspondant à "Multiplier", "Divisor" ou "unit_of_measure"

3- Inscrire la valeur souhaitée et appuyer sur "Ecrire l'attribut".
4- Enfin, Appuyer sur le bouton "Link" du ZiPulses pour réveiller l'appareil pour l'enregistrement.

Z2M

Nativement compatible depuis la version 1.30.3-1

⚠️ Pour changer les coefficients multiplicateurs / diviseurs et l'unité de mesure il faut suivre la procédure suivante :

1- Dans l'onglet "Expose", sélectionner le bon coefficient et dans l'instant, appuyer sur le bouton "link" du ZiPulses.
2- Vérifier que le coefficient a bien été enregistré en changeant d'onglet ou en rafraichissant la page.
3- Si le coefficient a bien été validé, il faut aller dans l'ongle "A propos" puis cliquer sur le logo jaune de reconfiguration.

4- Une fois validé, vous devez voir apparaître "configuring" en vert en haut à droite.
5- Il faut ensuite appuyer sur le bouton "Link" du ZiPulses et vous devriez voir "successfully configured"

Si rien n'apparait, redémarrer zigbee2mqtt et refaire la procédure

Normalement, le nouveau coefficient doit s'appliquer correctement.

EEdomus

Documentation

Changelog

Version 0008

• Fix Pulses detection
  • detect pulses between 30ms and 500ms
  • detect pulses every 500ms
• change send packet delay to save energy
  • Send packets every 60 sec if new pulses exists.
  • don't send packet every pulses anymore
• Send datas when button is pressed (only if paired)
• Send datas on main task
• Enhance rejoin procedure

Version 0007

• Fix Rejoin failure issue
• Fix sleep process
• Increase max simultaneaous ack. Less packet resending

Version 0006

• Add battery percentage remaining attribute / reporting (cluster : 0x0001 / attribute : 0x0021)
• Fix consumption leak when led is ON in sleeping mode
• Fix consumption leak when impulsion is locked (need to unsold hardware pullup)
• Fix voltage accuracy
• Fix temperature accuracy
• Disable debug console

Version 0005

• Fix debounce pulses to 20ms

Version 0004

• Change debounce (on pulses) management. Useful for some counters
• Send report earlier (on press instead of release)

Version 0003

• Add divisor coefficient to counter

Version 0002

• Add watchdog for software timer too long
• Add stopwaketimer
• Optimisze cleaning before sleep
• Fix debouncing button
• Fix manufacturer name length
• Delete OTA Config

Version 0001 (Initial version)