Skip to content

Commit

Permalink
Mise à jour documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ticed35 committed Mar 12, 2018
1 parent 45b45de commit b8d16f3
Show file tree
Hide file tree
Showing 13 changed files with 284 additions and 267 deletions.
12 changes: 12 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,23 @@ sass:
sass_dir: assets/css
style: compressed
markdown: kramdown
permalink: /404.html
kramdown:
input: GFM
hard_wrap: false
highlighter: rouge
gems:
- jekyll-paginate
- jekyll-seo-tag
exclude:
- vendor
plugins:
- jekyll-seo-tag
title: "Documentation Plugin-Teleinfo"
description: "Ceci est la documentation du plugin téléinfo"
author: "ticed35"
image: https://avatars2.githubusercontent.com/u/13416516?s=200&v=4
social:
name: ticed35
links:
- https://github.com/ticed35
4 changes: 2 additions & 2 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,11 +133,11 @@
var i = 1, j = 1;
$('h1, h2', $('#div_content')).each(function(){
if($(this)[0].tagName.toLowerCase() == 'h1'){
$('#'+$(this).attr('id')).text(i + ') ' + $(this).text());
$('#'+$(this).attr('id')).text($(this).text());
i++;
}
if($(this)[0].tagName.toLowerCase() == 'h2'){
$('#'+$(this).attr('id')).text( (i-1) + '.' + j + ') ' + $(this).text());
$('#'+$(this).attr('id')).text($(this).text());
j++;
}else{
j = 1;
Expand Down
46 changes: 46 additions & 0 deletions docs/fr_FR/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
API
===
Le plugin téléinfo met à disposition une api afin de mettre à jour les données depuis d'autres systèmes.
Il s'agit d'une URL d'appel de type GET.
Pour y accéder ces informations sont obligatoires :

URL = http://#IP_JEEDOM#:#PORT_JEEDOM#/jeedom/plugins/teleinfo/core/php/jeeTeleinfo.php?api=#VOTRE_API_JEEDOM#&ADCO=#IDENTIFIANT_DU_COMPTEUR#

#IP_JEEDOM# correspond à l'adresse ip de votre Jeedom
#PORT_JEEDOM# correspond au port d'accès à votre Jeedom
#VOTRE_API_JEEDOM# est la clé API disponible depuis le menu Général / Administration / Configuration

![teleinfo8](../images/teleinformation_api_menu1.png)

#IDENTIFIANT_DU_COMPTEUR# correspond à l'ADCO de celui-ci. Cette information est obligatoirement transmise par le compteur lorsque vous recevez une trame.

Attention le /jeedom peux être différent si vous êtes sur une installation DIY ou OEM. En règle générale il faut l'ajouter.

A cette url d'appel vous pouvez ajouter les différentes valeurs suivant le format : &#NOM_DE_LA_VALEUR#=#VALEUR#

Par exemple pour l'index d'un abonnement BASE EDF équivalent à 123456789 :

*&BASE=123456789*

L'URL sera donc surchargée de toutes information utile.

Par exemple :

IP_JEEDOM : 192.168.1.15
PORT_JEEDOM : 80
VOTRE_API_JEEDOM : zertyuiolkjhgfdsxc
IDENTIFIANT_DU_COMPTEUR : 0095123657
Index BASE : 123456789

Donnera l'URL : http://192.168.1.15:80/jeedom/plugins/teleinfo/core/php/jeeTeleinfo.php?api=zertyuiolkjhgfdsxc&ADCO=0095123657*&BASE=123456789*

Il est possible d'envoyer toutes les informations transmises par les compteurs suivant les étiquettes définie par la norme.
Quelques unes (Les plus connues) :

* BASE
* HPHP
* HPHC
* PTEC
* PAPP
* IINST
* ADPS
20 changes: 20 additions & 0 deletions docs/fr_FR/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Architecture
===
Pour récupérer la Téléinformation il faut se connecter sur les bornes I1 et I2 du compteur :

![teleinfo1](../images/teleinfo_compteur.png)

![teleinfo2](../images/teleinfo_archi.png)

Cas d'utilisation de 2 compteurs
===

## Utilisation du modem Cartelectronic 2 Compteurs
Dans le cas d'utilisation du modem Cartelectronic 2 Compteurs et le branchement de 2 compteurs électrique il est nécessaire d'activer le mode 2 compteurs.

![teleinfo3](../images/teleinformation_2compteurs.png)

## Utilisation d'un second compteur pour de la production électrique
Dans ce cas il faut activer le mode production du plugin :

![teleinfo31](../images/teleinformation_production.png)
6 changes: 6 additions & 0 deletions docs/fr_FR/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Bug
===

En cas de bug avéré du plugin il est possible d'ouvrir une issue :

[https://github.com/Jeedom-Plugins-Extra/plugin-teleinfo/issues](https://github.com/Jeedom-Plugins-Extra/plugin-teleinfo/issues)
10 changes: 9 additions & 1 deletion docs/fr_FR/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,15 @@ Change log
- Noms des variables et fonctions
- Compatibilité Linky

2.6.1 [![Stable](https://img.shields.io/badge/version-stable-brightgreen.svg?longCache=true&style=flat-square)](https://github.com/Jeedom-Plugins-Extra/plugin-teleinfo/releases)
2.6.3 [![Stable](https://img.shields.io/badge/version-stable-brightgreen.svg?longCache=true&style=flat-square)](https://github.com/Jeedom-Plugins-Extra/plugin-teleinfo/releases)
=====
- Lancement du démon pour la partie production

2.6.2
=====
- Etat du démon pour le mode 2 compteurs

2.6.1
=====
- Revue de certains designs
- Ajout de la fonction compteur de production
Expand Down
41 changes: 41 additions & 0 deletions docs/fr_FR/commandes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Les commandes
===

Les commandes (Ajouter une donnée) correspondent aux données envoyées par le modem.

Celles-ci peuvent êtres les suivantes :

- Index (Base / Heures Pleines / Heures Creuses)
- Index (Heures Normales / Heures de pointe mobile / Heures Pleines Bleu / Heures Creuses Bleu / Heures Pleine Blanc / Heures Creuses Blanc / Heures Pleines Rouge / Heures Creuses Rouge)
- Tranche tarifaire
- Type d'abonnement
- Puissance instantanée
- Intensité instantanée (Pour triphasé également)
- Alerte dépassement (Pour triphasé également)
- Intensité souscrite
- Préavis EJP (30 minutes avant)
- Couleur EJP lendemain.

Les statistiques
===

Afin d'obtenir des informations sur une durée plus longue des statistiques ont étés ajoutées.
Ces statistiques correspondent aux informations suivantes :
- Consommation du jour en cours
- Consommation d'hier
- Consommation du mois en cours
- Consommation du mois précédent
- Tendance journalière de la consommation (Pour être informé si l'on consomme plus ou moins par rapport au jour précédent à la même heure)
- Puissance apparente : Certains compteurs ne renvoie pas l'information PAPP. Pour cela un calcul à été implémenté afin d'obtenir une moyenne de consommation en W toutes les minutes.

Les unités
===

- Les index : Watt-heure
- Tranche tarifaire : Chaîne de caractères.
- Puissance apparente instantanée : Volt-Ampère.
- Les intensités : Ampère.
- Les alertes dépassement : Ampère
- Type d'abonnement : Chaîne de caractères.
- Le préavis EJP et la couleur du lendemn : Chaîne de caractères.
- La conso moyenne sur la dernière minute : Watt
21 changes: 21 additions & 0 deletions docs/fr_FR/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Configuration
===
Le plugin offre la possibilité de créer automatiquement les commandes réceptionnées. Pour cela démarrez le daemon, attendez que les premières trames arrivent puis rendez vous sur Plugin / Protocoles Domotiques / Téléinfo.
Vous devriez voir apparaitre un objet avec un ID.

>Il est possible de désactiver la création automatique des nouveaux compteurs.
>
>![teleinfo51](../images/teleinformation_blocage.png)
Cliquez sur l'objet et sélectionnez "Création automatique des commandes" en haut à droite, enfin sauvegardez. A partir de ce moment toutes les commandes reçu et non reconnu seront ajoutée automatiquement.

![teleinfo52](../images/teleinformation_objet.png)

![teleinfo52](../images/teleinformation_commandes_auto.png)

Vous pouvez également créer votre appareil manuellement :
- Créez votre nouvel appareil en cliquant sur Ajouter
- Ajoutez les commandes que vous souhaitez récupérer en cliquant sur le bouton vert "Commande"
- Vous pouvez également afficher des statistiques de consommation (Aujourd'hui / Hier / Mois en cours / Mois dernier) en cliquant sur le bouton "Ajouter une statistique"
- Renseignez le nom affiché dans Jeedom, le Sous-Type en fonction de l'information qui sera récupérée, la donnée à récupérer et enfin les paramètres associés.
- Cliquez sur sauvegarder.
89 changes: 89 additions & 0 deletions docs/fr_FR/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
FAQ
===

>J'ai un modem Cartelectronic qui n'envoi aucune information
Plusieurs firmwares existent pour ce modem, seul le firmware linux est compatible avec Jeedom.
Pour le mettre à jour :

ATTENTION ! Je vous conseille de lire le forum en premier afin d'être sûr d'effectuer les bonnes actions. Je ne pourrais être tenu responsable des opérations effectuées.

Télécharger le programme et le firmware ici : [http://www.cartelectronic.fr/logiciels/Modif%20teleinfo%201TIC.zip](http://www.cartelectronic.fr/logiciels/Modif%20teleinfo%201TIC.zip)
(Pour le modem 1 compteur : [http://www.cartelectronic.fr/blog/?p=1125](http://www.cartelectronic.fr/blog/?p=1125))

- Installer le logiciel FT PROG
- exécuter FT PROG
- faire un scan (loupe) pour rechercher les modules USB
- une fois le module trouvé aller dans FILE -> OPEN TEMPLATE et sélectionner le fichier : Interface USB 1 TIC SF.xml
- cliquer sur le module détecté avec le bouton droit et sélectionner appliquer template
- cliquer sur le module détecté avec le bouton droit et sélectionner programmer
- A la fin le modem peux être débranché.

>Un second équipement c'est créé lors de la mise à jour
Un nouvel équipement peut apparaitre lorsque vous montez d'une version et que l'ancienne ne contenait pas l'ADCO du compteur.
Pour récupérer l'ancien équipement :
- Copier l'ADCO du nouvel objet dans celui de l'ancien.
- Sauvegarder l'ancien.
- Supprimer le nouveau.

>Success - No result has been sent s'affiche lorsque je clique sur Tester
Cela indique que la donnée n'a pas été reçu par le plugin.
Deux cas sont possible :
- La donnée n'existe pas sur votre abonnement.
- La donnée n'as pas encore eu le temps de remonter.

Dans tous les cas il est nécessaire d'attendre 24h après l'installation du plugin pour être sûr des données qui sont reçu.

>Les statistiques restent à zero
Il est nécessaire que l'historisation des index soit activée afin de que les statistiques se calcule.
Il est possible de forcer le calcul en relancant les 2 tâches suivantes depuis le moteur de tâche :
- CalculateTodayStats
- CalculateOtherStats

>J'ai une installation DIY et je ne récupère aucune information
Il est nécessaire dans certains cas de supprimer certaines lignes du fichier /boot/cmdline.txt

Supprimer :

console=ttyAMA0,115200 kgdboc=ttyAMA0,115200

et commenter la ligne suivante dans le fichier /etc/inittab

#T0:23:respawn:/sbin/getty -L ttyAMA0 115200 vt100

Depuis la version jessie le fichier inittab n'est plus présent. Il faut utiliser ces lignes de commandes :

sudo systemctl stop [email protected]
sudo systemctl disable [email protected]


>Comment récupérer les statistiques du plugin
Suivant l'architecture choisie les logs du plugin peuvent êtres séparés.

En mode local tous les logs se trouvent sur l'interface log de Jeedom (En mode expert : Général / Administration / Logs ; cf doc jeedom

[Accès doc](https://jeedom.fr/doc/documentation/core/fr_FR/doc-core-log.html)

En mode satellite :
- Sur le maitre : Les logs de récupération / traitement des données. Les calculs des statistiques
- Sur l'esclave : Les logs de lancement du daemon.

>Mon panel n'affiche pas les informations
Dans un premier temps cliquer sur le bouton vérifier en haut à droite du panel afin de connaître l'état des données.
Dans le cas ou une données est NOK aller sur l'objet téléinfo puis le re sauvegarder.

>Mes statistiques ne se mettent pas à jour / sont erronés
Afin que les statistiques soient calcullés il est nécessaire que les index soient historisés. Vérifier la bonne configuration de ceux-ci.
Le lissage des historiques Jeedom peut induire des valeurs statistiques erronées. Pour supprimer le lissage pour chaque index :

- Cliquer sur la petite roue à côté du bouton Tester (En mode expert)
- Aller sur l'onglet Configuration Avancée
- Dans la zone historique choisir Aucun pour le mode de lissage.
- Enregistrer
Loading

0 comments on commit b8d16f3

Please sign in to comment.