/voicify

To generate spoken notification

Primary LanguagePHPGNU General Public License v2.0GPL-2.0

Home Voicify

Donner de la voix à votre maison domotisée !

Origine du projet : GitHub/Nikya/Voicify

Présentation

Home Voicify est un système de génération de notification vocal variable pour les maisons domotisées.
(Il génére des textes qui doivent être envoyés à un systéme TTS externe)

Certaines actions de votre domotique méritent une notification vocale:

La porte du garage est restée ouverte !

Bon retour chez vous Monsieur, la température intérieure est de 22°

Armement de l'alarme, vous avez 2 minutes pour évacuer les lieux.

Pensez à sortir la poubelle du tri sélectif pour demain.

Variation des notifications

Le principal avantage de Home Voicify est que pour un même type de notification, il va générer des phrases qui varient : il évite la lassitude ou évite de s'habituer à une notification et donc à la longue un risque de ne plus y prêter attention.

Avec une notification qui serait "oublie fermer porte garage", il est possible de paramétrer des phrases différentes comme :

La porte du garage, est restée ouverte.

Un oublie de la porte du garage.

Qui voudrait bien fermer la porte du garage ?

Home Voicify gère l'injection de variables dans le texte de la notification, par exemple une température qui peut varier :

Bon retour chez vous Monsieur, la température intérieure est de 22°.

Fonctionnalités

Module type FEATURE

Plusieurs fonctionnalités exploitent ce concept de notification vocale variée :

  • voicekey : Pour un certain mot clé déclancheur, obtenir une notificaiton vacale variante.
  • speakingclock : Une horloge parlante qui annoncera l'heure toujours de façon différente.
  • breakingnews : Un journal quotidien personalisé (météo, agenda, ...)

Module type TTSENGINE

Compatible avec plusieurs systèmes de génération de synthèse vocale (TTS) :

Mise en service

Prerequis

  • Avoir un serveur Web PHP

Installer

Dans un répertoire web du serveur PHP :

Dossiers d'échanges

Créer à la racine du dossier voicify, 2 dossiers d'échanges : configuration et temporaire, puis leur donner des droits en lecture/écriture :

mkdir config
mkdir temp
sudo chmod 770 config
sudo chmod 770 temp

Initialiser

  1. Aller sur l'URL du serveur Web-PHP où est installé Home Voicify.
  2. Aller sur l'interface web de Home Voicify
  3. Puis comme demandé, executer le Setup
  4. Une fois le Setup accomplie, il ne reste plus qu'à utiliser ce système

Utiliser

Tester

Tester et jouer avec les fonctionalités du système grace au menu Play.

Chaque page play est constituée de 3 parties :

  • Read Me : Contient la documentation contextuel
  • Action : Contient les éléments d'intérations
  • Console : Affiche les résultats de l'intération :
    • URL : Contient l'URL d'API appelée par l'intération
    • Indicateur : La couleur indique le bon déroulement ou non de l'intérration
    • Output : Affiche un détail du bon déroulement ou non de l'intérration
    • Saying : Affiche le texte final envoyé au systéme de notification vocale

Liaison domotique

Chaque utilisation d'une fonctionalité génére une URL d'API dans la console.

Il suffit ensuite :

  1. de copier cette URL
  2. de la coller dans un composant de votre sytéme de domotique qui est capable d'appeler des URL externes.
  3. De programmer dans votre sytéme de domotique, un appel au moments opportun vers ce composant.

Edition des textes

Les textes utilisés suivent une syntaxe particulière nommée Textify : Voir la documentation en ligne pour exploiter au mieux cette syntaxe.

Releasing

  • Release : Détails et contenues des releases précédentes
  • ToDo : Nouveau contenues à venir
  • Contributing : Comment contribuer au projet
  • Licence : GNU GENERAL PUBLIC LICENSE

Remerciements