doc update

guirem · Feb 11, 2020 · 0eaa3e7 · 0eaa3e7
1 parent 4d4412c
commit 0eaa3e7
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 45 deletions.
diff --git a/docs/en_US/index.md b/docs/en_US/index.md
@@ -61,41 +61,49 @@ In a few steps:
 Toble of Content
 =======================
 
-- [GoogleCast plugin (googlecast)](#googlecast-plugin--googlecast-)
+- [GoogleCast plugin (googlecast)](#googlecast-plugin-googlecast)
 - [Dashboard](#dashboard)
 - [Quick Start](#quick-start)
 - [Toble of Content](#toble-of-content)
 - [Plugin Configuration](#plugin-configuration)
-- [Configuration des équipements](#configuration-des--quipements)
-    + [Onglet Commandes](#onglet-commandes)
-    + [Afficheur Lecture en cours (widget)](#afficheur-lecture-en-cours--widget-)
-    + [TTS Widget for text entry and volume control](#tts-widget-for-text-entry-and-volume-control)
+- [Configuration des équipements](#configuration-des-%c3%a9quipements)
+    - [Onglet Commandes](#onglet-commandes)
+    - [Afficheur Lecture en cours (widget)](#afficheur-lecture-en-cours-widget)
+    - [TTS Widget for text entry and volume control](#tts-widget-for-text-entry-and-volume-control)
 - [Custom commands](#custom-commands)
-    + [Special applications](#special-applications)
-    + [Advanced commands](#advanced-commands)
+    - [Special applications](#special-applications)
+    - [Advanced commands](#advanced-commands)
       - [Syntax for raw commands](#syntax-for-raw-commands)
-      - [Possible parameters for *play_media* en mode *media* :](#possible-parameters-for--play-media--en-mode--media---)
-      - [Possible parameters for *load_url* en mode *web* :](#possible-parameters-for--load-url--en-mode--web---)
-      - [Possible parameters for *play_media* en mode *plex* :](#possible-parameters-for--play-media--en-mode--plex---)
-      - [Possible parameters for *tts* :](#possible-parameters-for--tts---)
-      - [Possible parameters for *notif* :](#possible-parameters-for--notif---)
+      - [Possible parameters for *play_media* en mode *media*](#possible-parameters-for-playmedia-en-mode-media)
+      - [Possible parameters for *load_url* en mode *web*](#possible-parameters-for-loadurl-en-mode-web)
+      - [Possible parameters for *play_media* en mode *plex*](#possible-parameters-for-playmedia-en-mode-plex)
+      - [Possible parameters for *tts*](#possible-parameters-for-tts)
+      - [Possible parameters for *notif*](#possible-parameters-for-notif)
       - [Command sequences](#command-sequences)
       - [Device advanced configuration](#device-advanced-configuration)
-        * [Retreive a configuration](#retreive-a-configuration)
-          + [available parameters for *getconfig* cmd :](#available-parameters-for--getconfig--cmd--)
-        * [Modify a configuration](#modify-a-configuration)
-          + [available parameters for *setconfig* cmd :](#available-parameters-for--setconfig--cmd--)
-        * [Pre-defined configuration commands](#pre-defined-configuration-commands)
-    + [Adding a command *action* of type *List*](#adding-a-command--action--of-type--list-)
-    + [Use in scenarios](#use-in-scenarios)
-      - [With dedicated command *Custom Cmd*](#with-dedicated-command--custom-cmd-)
+        - [Retreive a configuration](#retreive-a-configuration)
+          - [available parameters for *getconfig* cmd :](#available-parameters-for-getconfig-cmd)
+        - [Modify a configuration](#modify-a-configuration)
+          - [available parameters for *setconfig* cmd :](#available-parameters-for-setconfig-cmd)
+        - [Pre-defined configuration commands](#pre-defined-configuration-commands)
+    - [Adding a command *action* of type *List*](#adding-a-command-action-of-type-list)
+    - [Use in scenarios](#use-in-scenarios)
+      - [With dedicated command *Custom Cmd*](#with-dedicated-command-custom-cmd)
       - [With php bloc code](#with-php-bloc-code)
-    + [Use with interactions and IFTTT](#use-with-interactions-and-ifttt)
+    - [Use with interactions and IFTTT](#use-with-interactions-and-ifttt)
       - [Interactions](#interactions)
-      - [ask type reply](#-ask--type-reply)
+      - [*ask* type reply](#ask-type-reply)
       - [Custom CMD](#custom-cmd)
 - [Known limitations and bugs](#known-limitations-and-bugs)
 - [FAQ](#faq)
+      - [No detection during the scan](#no-detection-during-the-scan)
+      - [No commands seems to work](#no-commands-seems-to-work)
+      - [Some commands do not work](#some-commands-do-not-work)
+      - [Dependencies can't install properly](#dependencies-cant-install-properly)
+      - [Text To Speech (TTS) doen't work](#text-to-speech-tts-doent-work)
+      - [Broadcast Jeedom without authentication on a Google Cast](#broadcast-jeedom-without-authentication-on-a-google-cast)
+      - [Get an API Key for Google Cloud Text-to-Speech' API](#get-an-api-key-for-google-cloud-text-to-speech-api)
+      - [TTS 'Google Cloud Text-to-Speech' API key is not working anymore](#tts-google-cloud-text-to-speech-api-key-is-not-working-anymore)
 - [Changelog](#changelog)
 
 
@@ -284,7 +292,7 @@ ex TTS : cmd=tts|vol=100|value=Mon text a dire
 > **Notes**     
 > String length for commands are limited in Jeedom to 128 characters. Use scenarios (see below to override this limitation)
 
-#### Possible parameters for *play_media* en mode *media* :
+#### Possible parameters for *play_media* en mode *media*
 ```
 - value: str - seperated by ',' (see notes)
     * url: str - url of the media (mandatory).
@@ -319,7 +327,7 @@ ex long : app=media|cmd=play_media|value='http://contentlink','video/mp4',title:
 > - Il est nécessaire de remplacer le signe '=' dans les url par '%3D'
 > - Un média local situé dans le répertoire *<jeedom>/plugins/googlecast/localmedia/* peux être utilisé en appelant l'url *local://<nomdufichier>* (ex: local://bigben1.mp3)
 
-#### Possible parameters for *load_url* en mode *web* :
+#### Possible parameters for *load_url* en mode *web*
 ```
 - url: str - website url.
 - force: bool - force mode. To be used if default is not working. (optional, default False).
@@ -334,7 +342,7 @@ ex 3 : app=web|value='http://mywebsite/index.php?apikey%3Dmyapikey' (implicit lo
 > - Urls and strings are surrounded by single quotes ('). Other possible values are True/False/None and integer numeric values.
 > - It is necessary to replace the sign '=' dans les url par '%3D'
 
-#### Possible parameters for *play_media* en mode *plex* :
+#### Possible parameters for *play_media* en mode *plex*
 ```
 - value: str - search query. It will play the first element returned.
 - type: str - type of content. Example: 'video/audio' (optional, default=video).
@@ -359,7 +367,7 @@ ex using token with implicit play_media command call :
 > - Token value is displayed in logs (debug) when user & pass has been used the first time
 > - you can simulate result of search query (value) in main search field of Plex web UI
 
-#### Possible parameters for *tts* :
+#### Possible parameters for *tts*
 ```
 - value: str - text
 - lang: str - fr-FR/en-US or any compatible language (optional, default is configuration)
@@ -390,7 +398,7 @@ ex voice/ssml : cmd=tts|engine=gttsapi|voice=fr-FR-Standard-A|value=<speak>Etape
 > - By default, the plugin will try to resume previous app launched (will only work when previous application has been launched by the plugin).
 > - You can try to force resume to any application using 'forceapplaunch=1' but there is a good chance that it will not resume correctly.
 
-#### Possible parameters for *notif* :
+#### Possible parameters for *notif*
 ```
 - value: str - local media filename (located in '<jeedom>/plugins/googlecast/localmedia/' folder)
 - quit: 0/1 - quit app after notif action.

diff --git a/docs/fr_FR/index.md b/docs/fr_FR/index.md
@@ -2,7 +2,7 @@
 
 ![Logo plugin](../images/logoplugin.png "Logo plugin")
 
-Plugin pour commander les équipements compatibles Google Cast et Google Assistant.
+Ce plugin [Jeedom](https://www.jeedom.com) à pour objectif de gérer les équipements compatibles Google Cast et Google Assistant.
 
 **Fonctionnalités :**
 
@@ -74,12 +74,12 @@ En quelques étapes :
     - [Applications spéciales](#applications-sp%c3%a9ciales)
     - [Commandes avancées](#commandes-avanc%c3%a9es)
       - [Syntaxe des commandes brutes](#syntaxe-des-commandes-brutes)
-      - [Paramètres possibles pour _play_media_ en mode _media_ :](#param%c3%a8tres-possibles-pour-playmedia-en-mode-media)
-      - [Paramètres possibles pour _load_url_ en mode _web_ :](#param%c3%a8tres-possibles-pour-loadurl-en-mode-web)
-      - [Paramètres possibles pour _play_media_ en mode _plex_ :](#param%c3%a8tres-possibles-pour-playmedia-en-mode-plex)
-      - [Paramètres possibles pour _play_media_ en mode _spotify_ (experimental) :](#param%c3%a8tres-possibles-pour-playmedia-en-mode-spotify-experimental)
-      - [Paramètres possibles pour cmd _tts_ :](#param%c3%a8tres-possibles-pour-cmd-tts)
-      - [Paramètres possibles pour cmd _notif_ :](#param%c3%a8tres-possibles-pour-cmd-notif)
+      - [Paramètres possibles pour _play_media_ en mode _media_](#param%c3%a8tres-possibles-pour-playmedia-en-mode-media)
+      - [Paramètres possibles pour _load_url_ en mode _web_](#param%c3%a8tres-possibles-pour-loadurl-en-mode-web)
+      - [Paramètres possibles pour _play_media_ en mode _plex_](#param%c3%a8tres-possibles-pour-playmedia-en-mode-plex)
+      - [Paramètres possibles pour _play_media_ en mode _spotify_ (experimental)](#param%c3%a8tres-possibles-pour-playmedia-en-mode-spotify-experimental)
+      - [Paramètres possibles pour cmd _tts_](#param%c3%a8tres-possibles-pour-cmd-tts)
+      - [Paramètres possibles pour cmd _notif_](#param%c3%a8tres-possibles-pour-cmd-notif)
       - [Séquence de commandes](#s%c3%a9quence-de-commandes)
     - [Configuration des fonctionnalités Google Home/Assistant](#configuration-des-fonctionnalit%c3%a9s-google-homeassistant)
       - [Récupérer une configuration](#r%c3%a9cup%c3%a9rer-une-configuration)
@@ -254,6 +254,8 @@ paramètres CSS optionnels (via '_Paramètres optionnels widget_'):
 
 # Commandes personnalisées
 
+L'utilisation des commandes personnalisées se fait soit via l'interface utilisateur sur la page de gestion des commandes, soit via l'utilisation de la commande _Custom Cmd_ (ex: pour les scénarios)
+
 ### Applications spéciales
 
 - _Web_ : afficher une page web sur un Google Cast. Les paramètres disponibles sont l'url, forcer, et le délai de rechargement (ex: value='https://google.com',False,0 pour charger Google sans forcer (nécessaire pour certains sites) et sans rechargement)
@@ -265,7 +267,6 @@ paramètres CSS optionnels (via '_Paramètres optionnels widget_'):
 > **Notes**
 >
 > - Voir les boutons créés par défaut pour un exemple d'utilisation
-> - Youtube est non fonctionnel pour le moment
 
 ### Commandes avancées
 
@@ -325,7 +326,7 @@ ex storecmd and resume : app=web|cmd=load_url|vol=90|value='http://pictoplasma.s
 > **Notes**  
 > les chaînes de caractères pour les commandes sont limitées dans Jeedom à 128 caractères. Utiliser les scénarios (voir plus bas pour passer outre cette limitation) ou voir la FAQ pour optimiser la commande.
 
-#### Paramètres possibles pour _play_media_ en mode _media_ :
+#### Paramètres possibles pour _play_media_ en mode _media_
 
 ```
 - value: str - seperated by ',' (see notes)
@@ -362,7 +363,7 @@ ex long : app=media|cmd=play_media|value='http://contentlink','video/mp4',title:
 > - Il est nécessaire de remplacer le signe '=' dans les url par '%3D'
 > - Un média local situé dans le répertoire _<jeedom>/plugins/googlecast/localmedia/_ peut être utilisé en appelant l'url _local://<nomdufichier>_ (ex: local://bigben1.mp3)
 
-#### Paramètres possibles pour _load_url_ en mode _web_ :
+#### Paramètres possibles pour _load_url_ en mode _web_
 
 ```
 - value: str - seperated by ',' (see notes)
@@ -381,7 +382,7 @@ ex 3 : app=web|value='http://mywebsite/index.php?apikey%3Dmyapikey' (implicit lo
 > - Il est nécessaire de remplacer le signe '=' dans les url par '%3D'
 > - Pour la diffusion de flux caméra, la caméra doit pouvoir fournir le flux via http (rtsp n'est pas compatible google cast)
 
-#### Paramètres possibles pour _play_media_ en mode _plex_ :
+#### Paramètres possibles pour _play_media_ en mode _plex_
 
 ```
 - value: str - search query. It could be individual title, playlist or other type of content handled by Plex (it will play the first element returned).
@@ -408,7 +409,7 @@ ex using token with implicit play_media command call :
 > - Token value is displayed in logs (debug) when user & pass has been used the first time. Token is then persistent.
 > - you can simulate result of search query (value) in main search field of Plex web UI
 
-#### Paramètres possibles pour _play_media_ en mode _spotify_ (experimental) :
+#### Paramètres possibles pour _play_media_ en mode _spotify_ (experimental)
 
 !! Le plus dur est de récupérer un token valable !!  
 Pas de support sur cette fonctionnalité
@@ -426,7 +427,7 @@ ex using valid token :
 > - Token is too long to be passed through regular command. Use _CustomCmd_.
 > - For test, you can use a web token (open spotify in browser, log in and look for 'wp_access_token' value to use as token).
 
-#### Paramètres possibles pour cmd _tts_ :
+#### Paramètres possibles pour cmd _tts_
 
 ```
 - value: str - text
@@ -459,7 +460,7 @@ ex voice/ssml : cmd=tts|engine=gttsapi|voice=fr-CA-Standard-A|value=<speak>Etape
 > - By default, the plugin will try to resume previous app launched (will only work when previous application has been launched by the plugin).
 > - You can try to force resume to any application using 'forceapplaunch=1' but there is a good chance that it will not resume correctly.
 
-#### Paramètres possibles pour cmd _notif_ :
+#### Paramètres possibles pour cmd _notif_
 
 ```
 - value: str - local media filename (located in '<jeedom>/plugins/googlecast/localmedia/' folder)
@@ -505,7 +506,7 @@ Cela permet de récupérer (ou modifier) des informations tel que les alarmes, t
 
 La procédure de récupération des jetons est ici : https://gist.github.com/rithvikvibhu/1a0f4937af957ef6a78453e3be482c1f#the-token
 
-Ce jeton doit être saisi sur la page de configuration de chaque Gooogle Home.
+Ce jeton doit être saisi sur la page de configuration de chaque équipement Gooogle Home.
 
 #### Récupérer une configuration
 
@@ -649,10 +650,12 @@ Exemple : commande appelée 'radio_rtl'
 
 La commande nommée _Custom Cmd_ permet de lancer une commande brute à partir d'un scénario.
 
-Par exemple, pour lancer Google sur un Google Cast à partir d'un scénario, ajouter la commande avec la valeur souhaitée dans le champs 'message'.
+Dans le scénario, ajouter la commande _Custom Cmd_ et saisir la commande à envoyer tel que décrit dans la section [Commandes personnalisées](#commandes-personnalis%c3%a9es) dans le champs 'message'.
 
 ```
+Exemples : 
 app=web|cmd=load_url|value='https://google.com',True,10
+cmd=tts|vol=100|value=Mon text a dire
 ```
 
 ![Scenario](../images/scenario.png "Scenario")
@@ -796,7 +799,8 @@ Notes :
 
 # Limitations et bugs connus
 
-- Moteur PicoTTS ne gère pas les phrases accentuées (ils sont supprimés)
+- Moteur PicoTTS ne gère pas les phrases accentuées (ils sont supprimés);
+- L'accès à certaines fonctionnalité Google Assistant requière depuis fin 2019 un token d'authentification (voir [Configuration des fonctionnalités Google Home/Assistant](#configuration-des-fonctionnalit%c3%a9s-google-homeassistant));
 
 # FAQ
 
@@ -895,7 +899,7 @@ Suite à la mise à jour de janvier 2020, il est probable que l'API 'Google Clou
 
 #### Comment récupérer les alamers et timers d'un Google Home
 
-C'est possible mais il est nécessaire d'avoir un jeton d'authentification (https://gist.github.com/rithvikvibhu/1a0f4937af957ef6a78453e3be482c1f) configuré sur la page du googlecast. Voir la section de la doc dédiée.
+C'est possible mais il est nécessaire d'avoir un jeton d'authentification (https://gist.github.com/rithvikvibhu/1a0f4937af957ef6a78453e3be482c1f) configuré sur la page du googlecast. Voir la section de la doc [Configuration des fonctionnalités Google Home/Assistant](#configuration-des-fonctionnalit%c3%a9s-google-homeassistant).
 
 # Changelog