-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
128 lines (127 loc) · 4.79 KB
/
index.html
1
<!DOCTYPE html><html> <head> <meta charset="utf-8" /> <style> * { font-family: verdana, arial; text-align: justify; } h1 { text-align: center; background-color: silver; } .plugin { color: blue; } em, .plugin, strong { font-style: italic; } .under { text-decoration: underline; } </style> <!-- <link rel="stylesheet" href="style.css" /> --> <title>Documentation du Plugin FindRemote pour SARAH</title> </head> <body> <header> <h1>Documentation du Plugin <span class ="plugin">FindRemote</span> pour SARAH</h1> </header> <br> auteur : Phi Bri<br> date : 08/11/2014<br> version : 1.0<br> <br> <br> <nav> <ul> <li><a href="#conf">CONFIGURATION</a></li> <li><a href="#desc">DESCRIPTEUR DES COMMANDES</a></li> <li><a href="#news">NEWS IN THIS VERSION</a></li> <li><a href="#todo">TODO ET RESTRICTIONS</a></li> <li><a href="#rem">REMERCIEMENTS</a></li> </ul> </nav> <br> <section> <article> <h1 id="conf">1. CONFIGURATION</h1><br> <br> Ce plugin permet à SARAH de trouver et d'annoncer les objects connectés sur votre réseau local. Toutefois, ces objets devront êtres compatibles upnp.<br> <br> On peut rechercher les objets suivants plusieurs critéres, notament :<br> <ul> <li><span class="under"> Suivant le nom de l'objet :</span></li><br> <ul> <li> Paramètre = <strong>friendlyName</strong></li> </ul> <br> <li><span class="under"> Suivant le constructeur de l'objet :</span></li><br> <ul> <li> Paramètre = <strong>manufacturer</strong></li> </ul> <br> <li><span class="under"> Suivant le modèle :</span></li><br> <ul> <li> Paramètre = <strong>modelName</strong></li> </ul> <br> <li><span class="under"> Suivant la description :</span></li><br> <ul> <li> Paramètre = <strong>modelDescription</strong></li> </ul> </ul> <em>(D'autres paramètres peuvent êtres utilisés... Mais attention à la vocalisation par SARAH...).</em> <br> <br>Sachant que certains de ces paramètres peuvent ne pas êtres présents, je vous conseille de rester sur <strong>friendlyname</strong>, qui est assez "vocalisable". <br> <br> Ce paramètre doit être stockée dans le fichier <strong>FindRemote.prop</strong> situé dans le répertoire du plugin.<br> <br> Pour cela, 2 manières de faire : <ul> <li> Renseigner directement l'élément "search" dans le fichier (déconseillé...).</li> <li> Via l'interface web de <strong>SARAH</strong> en cliquant sur la "tuile" <span class ="plugin">FindRemote</span> (préférable...).</li> </ul> Sachant que si vous n'aurez pas à vous soucier de la "casse" (qui varie suivant les objets), il vous faudra impérativement respecter l'orthographe... <br> <h1 id="desc">2. DESCRIPTEUR DES COMMANDES</h1><br> <br> La configuration des requètes vocales passe par le fichier externe : <strong>FindRemote.xml</strong>, ce fichier est aisément modifiable par vos soins pour en changer le vocabulaire des phrases "clés" utilisées par <strong>SARAH.</strong><br> <br> D'une façon générale, ce fichier permet de déclarer les actions à demander sans avoir à manipuler le code javascript.<br> <br> <span class="under">Exemples de commandes vocales :</span><br> <ul> <li><em>SARAH, liste moi les objets connectés.</em><br> </li><br> <li><em>SARAH, scanne le réseau.</em><br> </li><br> <li><em>SARAH quels sont les objets ?</em><br> </li> </ul> Dans tous les cas, ces commandes n'entrainent qu'une seule et même action de SARAH... Elle vous donnera le nombre, la liste et les 2 derniers digits de l'adresse IP locale de l'objet connecté. <h1 id="news">3. NEWS IN THIS VERSION</h1><br> <ul> <li>Utilisation du fichier <strong>FindConnected.js</strong> utilisé en tant que "librairie"... Il sera, par ailleurs, ré-utilisé pour trouver automatiquement l'ip des mes autres plugins (sans passer par le fichier .prop). </li> </ul> <h1 id="todo">4. TODO ET RESTRICTIONS</h1><br> <ul> <li>Rien pour l'instant !</li> </ul> <h1 id="rem">5. REMERCIEMENTS</h1><br> <br> A Jean-Philippe ENCAUSSE -> Pour <strong>SARAH</strong> (sans qui rien ne serait arrivé !)<br> A la communauté de <strong>SARAH</strong><br> </article> </section></body></html>