README.md

Integration Ecole directe pour Home Assistant

• Installation
  • Installation via l'interface utilisateur via HACS
  • Installation manuelle
• Configuration
• Utilisation

Installation

Installation via l'interface utilisateur via HACS

1. Depuis HACS (Home Assistant Community Store), sélectionner Intégrations. Puis ouvrez le menu en haut à droite et utiliser l'option Dépôts personnalisés pour ajouter le dépôt de l'intégration.

2. Ajoutez l'adresse https://github.com/hacf-fr/hass-ecoledirecte avec pour catégorie Intégration, et faire AJOUTER. Le dépôt apparaît dans la liste.

3. La carte de ce nouveau dépôt va s'afficher, cliquez sur celle-ci puis Télécharger en bas à droite.

4. Laisser le choix de la dernière version et utiliser l'option Télécharger.

5. Il faut ensuite redémarrer Home Assistant.

Installation manuelle

Copier le répertoire ecole_directe de la dernière release dans le répertoire custom_components de votre répertoire config. Redémarrer Home Assistant

Configuration

Cliquer sur ce bouton:

Ou aller dans :
Paramètres > Appareils et services > Intégrations > Ajouter une intégration, et chercher "Ecole Directe"

Utiliser votre identifiant et mot de passe :

Le fichier qcm permet de sauvegarder les questions et respectives réponses pour la double authentification requise par Ecole Directe. Il est créé automatiquement dans le répertoire Config de Home Assistant. L'option "Envoi de notifications" permet d'envoyer une notification lorsqu'il y a une nouvelle question dans le fichier qcm. Il est aussi possible de créer une automatisation à partir de l'événement "ecole_directe_event" de type "new_qcm. Exemple:

alias: Ecole Directe - notification nouvelle question QCM
description: Notification en cas de nouvelle question QCM dans le fichier qcm
trigger:
  - platform: event
    event_type: ecole_directe_event
    event_data:
      type: new_qcm
action:
  - service: notify.persistent_notification
    data:
      message: >
        Nouvelle question : {{ trigger.event.data.question }} Il faut vérifier
        le fichier qcm
      title: Nouvelle question qcm Ecole Directe
mode: queued
max: 10

Utilisation

Cette intégration fournit plusieurs entités, toujours préfixées avec ecole_directe_PRENOM_NOM (où PRENOM et NOM sont remplacé). Les entités sont mises à jour toutes les 30 minutes.

Entité	Description
sensor.ecole_directe_PRENOM_NOM	informations basique de l'enfant
[...]_homework	devoirs
[...]_grades	notes
[...]_evaluations	evaluations
[...]_timetable_today	emploi du temps du jour
[...]_timetable_tomorrow	emploi du temps du lendemain
[...]_timetable_next_day	emploi du temps du jour ouvré suivant (ex: si on consulte le vendredi, il doit y avoir l'emploi du temps du lundi )
[...]_timetable_period	emploi du temps de la semaine en cours
[...]_timetable_period_1	emploi du temps de la semaine suivante
[...]_timetable_period_2	emploi du temps de la semaine suivante suivante :D
[...]_absences	absences
[...]_retards	retards
[...]_sanctions	sanctions
[...]_encouragements	encouragements

Il y a des événements qui sont déclenché sous certaines conditions. Ils peuvent être utiliser comme déclencheur dans des automatisations.

Evénement	Description
new_formulaires	nouveau formulaire
new_homework	nouveau devoir
new_grade	nouvelle note
new_absence	nouvelle absence
new_retard	nouveau retard
new_sanction	nouvelle sanction
new_encouragement	nouvel encouragement
new_qcm	nouveau qcm