Alexa-API Documentation

alexaapi

 

Table des matières

Installation du Plugin Alexa-API

Mise à jour ou changement de version

Les écrans de gestion

Les tuiles (widgets)

Utilisation des commandes

Présentation du plugin

La présentation du plugin fait l'objet d'une page spéciale.

La TODOList et le ChangeLog font l'ojvet d'une page spéciale.

 

Installation du Plugin Alexa-API

Installer le Plugin depuis le Market

installationalexaapi1

 

installationalexaapi3

Note sur les versions :

Vous avez le choix entre la version Stable ou la version Beta.

Beaucoup de nouvelles fonctionnalités sont toujours plus présentes sur la Beta que sur la Stable mais elles sont en test.

Si vous êtes joueur et curieux, vous pouvez installer la version Béta.

Nota  Vous n'avez pas besoin d'installer Jeedom en Beta (c'est plutôt déconseillé d'ailleurs) pour installer le plugin en Béta.

Vous pouvez assez facilement passer d'une version Beta à une version Stable et réciproquement, il suffir de réinstaller par dessus l'autre version.

installationalexaapi4

 

Activer le Plugin

installationalexaapi5

 

Recharger les dépendances

installationalexaapi6

 

Générér manuellement le cookie Amazon

installationalexaapi7

 

S'identifier sur la pop-up d'Amazon

installationalexaapi8

Fermer la fênetre dès que le Cookie Amazon est créé.

 

Lancer le Daemon s'il ne se lance pas tout seul

installationalexaapi9

 

Lancer le SCAN

installationalexaapi10

 

Les devices apparaissent, aller dans un device et dans Commandes lancer un Speak pour tester

 Et voilà, Alexa parle en moins de 5 min !!

Mise à jour ou Changement de version (de Beta à Stable ou de Stable à Beta)

Que faire ?

Le plugin et son API étant vivants (Amazon n'ayant pas documenté l'API se permet de modifier au fil de l'eau ses protocoles), les mises à jour permettent d'apporter des corrections dans les liens entre le plugin et le serveur Amazon.

Deux solutions pour avoir une installation opérationnelle :

  • Supprimer tous les équipements Amazon et leurs commandes et les recréer
  • Forcer la mise à jour de toutes les commandes
  • Lancer un SCAN qui détecte les nouveaux équipements ou les nouvelles commandes

Le choix entre ces deux solutions dépend du nombre de scénarios que vous avez développé grâce au Plugin Alexa-API. En effet, la première solution supprime tous les devices et toutes les commandes, elle supprimera donc celles ci dans vos scénarios. La seconde solution est plus respectueuse de vos scénarios car elle mettra à jour vos commandes sans les supprimer et donc vos scénarios seront intacts.

Solution 1 : Supprimer tous les équipements et leurs commandes et les recréer

C'est le mode le plus propre et le plus optimisé puisque vous repartez avec une installation comme neuve des devices et de leurs commandes.

Pour se faire, il faut utiliser le bouton boutonalexaapi1

Attention, cette fonction supprime tous les équipements et leurs commandes, vous perdez donc tous les liens dans vos scénarios.

Solution 2 : Forcer la mise à jour de toutes les commandes

C'est le mode le plus simple et sans risque puisque vos équipements et leurs commandes ne sont pas supprimés. Ce forçage n'impacte donc pas vos scénarios.

Pour se faire, il faut utiliser le bouton boutonalexaapi2

Si vous ne souhaitez pas lancer le foçage de mise à jour sur toutes les commandes de tous les équipements, vous pouvez le lancer sur un seul équipement (et donc sur toutes ses commandes). Pour cela, rendez vous sur l'équipement concerné et cliquez sur :

boutonalexaapi3

Le SCAN

boutonalexaapi4

Notez enfin que le scan peut être lancé à tout moment, il n'impacte pas les équipements déja détectés ni les commandes existantes, par contre, il recrée tous les nouveaux devices ou les devices supprimés. Il recrée également toutes les nouvelles commandes ou les commandes supprimées.

 

Les écrans de gestion

Screenshot 2019 10 27 Alexaapi Jeedom

Scan

Permet de lancer automatiquement la détection de tous vos devices, vous pouvez le lancer quand vous le souhaiter, il ne supprime jamais de device ou de commande, pas de risque.

 

Configuration

C'est tout le moteur de paramètrage. si quelque chose ne semble pas assez intuitif, merci de nous le signaler, nous le documenterons ou le rendrons plus simple.

Santé

Donne des indications sur la santé de vos équipements

Routines

Donne la liste des routines enregistrées sur votre compte Amazon et permet de les lancer manuellement

Rappels/Alarmes

Donne la liste de vos alarmes ou rappels, permet de les supprimer. La désactivation manuelle ne fonctionne pour l'instant plus.

Historique

C'est tout l'historique de l'activité de vos équipements Amazon, donne l'indication de succès le cas échéant.

Requêteur Info

Réservé aux utilisateurs avertis, il permet de questionner le serveur Amazon

Requêteur Action

Réservé aux utilisateurs très avertis, il permet de lancer des requêtes brutes au serveur Amazon

 

Les tuiles

A ce jour, chaque équipement peut générer 3 tuiles.

  • La tuile principale de l'équipement avec ses intéractions avec vous, vos ordres de speak, les alarmes/rappels, le volume et la possibilité de lancer les routines
  • La tuile du player multimédia
  • La tuile de la playlist en cours

La tuile de l'équipement principal

widgetprincipal

A : C'est la dernière intéraction avec vous, notez que vous pouvez récupérer cette information et l'utiliser dans un scénario.

B : Vous pouvez lancer une routine en la sélectionnant dans la liste déroulante

C : Le volume, notez qu'il se met à jour si vous modifiez le volume sur l'appareil. (Le volume d'un groupe est imposé à tous les devices du groupe)

D/E/F : C'est la prochaine alarme, alarme musicale ou rappel.

G : C'est un formulaire qui permet de faire parler Alexa.

La tuile du player multimédia

widgetplayer

La tuile de la playlist en cours

widgetplaylist

 

Commandes (Info et Action) du plugin :

Principe

Les commandes sont préinstallées à la détection des devices, vous disposez ainsi de commandes immédiatement utilisables.

Les commandes préinstallées peuvent être utilisées en l'état dans des scénarios.

Sachez que toutes les commandes peuvent faire l'objet d'une adaptation personnelle, les utilisateurs avertis pourront créer leurs commandes et les personnliser grace aux paramètres possibles de chaque commande (décrits plus loin).

Pour cela, utilisez le bouton (sous le tableau des commandes) :  

boutonajoutercommandeaction

Vous pouvez vous aider des commandes préinstallées pour en copier la syntaxe et utilisez la documentation ci dessous pour connaitre toutes les options possibles. Si vous souhaitez une autre fonction, un autre format ou que vous ne trouvez pas votre bonheur, contacter l'équipe de crétion du plugin, il y aura toujours une solution pour vous.

 

alarm?when=#when#&recurring=#recurring#&sound=#sound#

Cette commande d'ajouter une alarme au device dans lequel est créée la commande.

Voici les options :

  • when=YYYY-MM-DD HH24:MI:SS

exemple : 2019-12-31 21:36:00

Notez que les alarmes sont différentes des rappels et doivent être dans un créneau de 24h (une alarme pour le 31/12 au moins d'avril est impossible contratirement aux Rappels)

Ainsi, si aucune récurrence n'est programmée (par le paramètre reccuring), seule l'heure est prise en compte, le jour est ignoré par Amazon.

  • recurring=#recurring#

La programmation de ce paramètre est bien plus aisé par un scnéario puisqu'une liste déroulante vous permet de facilement choisir la récurrence. Mais cela peut être fait manuellement dans une commande action avec le codage suivant :

P1D=Tous les jours
XXXX-WD=En semaine
XXXX-WE=Week-ends
XXXX-WXX-1=Chaque lundi
XXXX-WXX-2=Chaque mardi
XXXX-WXX-3=Chaque mercredi
XXXX-WXX-4=Chaque jeudi
XXXX-WXX-5=Chaque vendredi
XXXX-WXX-6=Chaque samedi
XXXX-WXX-7=Chaque dimanche

  • sound=#sound#

Il s'agit du son de l'alarme, #sound# peut être remplacé par :

system_alerts_melodic_01 pour Alarme simple
system_alerts_melodic_01 pour Timer simple
system_alerts_melodic_02 pour A la dérive
system_alerts_atonal_02 pour Métallique
system_alerts_melodic_05 pour Clarté
system_alerts_repetitive_04 pour Comptoir
system_alerts_melodic_03 pour Focus
system_alerts_melodic_06 pour Lueur
system_alerts_repetitive_01 pour Table de chevet
system_alerts_melodic_07 pour Vif
system_alerts_soothing_05 pour Orque
system_alerts_atonal_03 pour Lumière du porche
system_alerts_rhythmic_02 pour Pulsar
system_alerts_musical_02 pour Pluvieux
system_alerts_alarming_03 pour Ondes carrées

reminder?text=#message#&when=#when

Cette commande d'ajouter un rappel au device dans lequel est créée la commande.

Voici les options :

  • when=YYYY-MM-DD HH24:MI:SS

exemple : 2019-12-31 21:36:00

  • text=#message#

Vous avez la possibilité de donner un titre à votre rappel.

whennextalarm?position=1&status=ON&format=hour

Nota : Cette commande est masquée, c'est elle qui donne le résultat dans la commande info : Next Alarm Hour

Cette commande permet de renvoyer la prochaine alarme du device dans lequel est créée la commande.

Attention, cette commande est une commande ACTION, elle doit être reliée à une commande INFO qui affichera le résultat, regardez l'explication en dessous de la description des options.

Voici les options :

position=x

  • Mettre 1 pour la prochaine alarme
  • 2 pour la suivant
  • et ainsi de suite

Par défaut, position=1 si non spécifié

status=x

  • Mettre ON pour prendre en compte uniquement  les alarmes actives
  • Mettre OFF pour prendre en compte uniquement les alarmes inactives
  • Mettre ALL pour prendre en compte toutes les alarmes

Par défaut, status=ON si non spécifié

format=x

  • Mettre hour pour avoir un résultat au format HH:MM (Attention, cet affichage est dangereux dans le cas où vous programmez des alarmes au dela de 24h, cela est possible avec les répétitions)
  • Mettre hhmm pour avoir un résultat au format HHMM
  • Mettre full pour avoir un affichage détaillé yyyy-MM-dd'T'HH:mm:ss.SSS

Par défaut, format=hhmm si non spécifié

Nota : Si vous avez besoin d'un autre format, n'hésitez pas à me le demandez, je l'ajouterai dans la prochaine version.

Création de la commande INFO qui affichera le résultat de la commande whenNextAlarm

La commande INFO qui vous donnera le résultat de le la commande WhenNextAlarm sera créée automatiquement dès que le champ Nom de la commande Info se trouvant dans la colonne Résultat dans sera rempli.

Explication de l'intéraction entre la commande ACTION et la commande INFO

  • Quand vous lancez la commande ACTION, le serveur Amazon est interrogé et la résultat est affecté à la commande INFO
  • Quand vous lancez la commande INFO, Jeedom vous donnera donc le résultat de la commande ACTION correspondante

(Tout cela est conçu dans la même logique que le plugin Virtual)

Nota : S'il n'y aura pas d'alarme prochaine, le serveur répond "none".

whennextmusicalalarm?position=1&status=ON&format=hour

Fonctionne comme whennextalarm mais pour les alarmes musicales.

musicalalarmmusicentity?position=1&status=ON

Fonctionne comme whennextmusicalalarm mais fournit l'information MusicEntity qui correspond à ce qui va être joué à l'heure de l'alarme.

whennextreminder?position=1&status=ON

Nota : Cette commande est masquée, c'est elle qui donne le résultat dans la commande info : Next Reminder Hour

Cette commande donne le prochain rappel, elle fonctionne exactement comme WhenNextAlarm.

deleteallalarms?type=alarm&status=all

Cette commande supprime tous les rappels et/ou alarmes du device dans lequel est créée la commande.

Voici les options :

type=x

  • Mettre alarm pour ne supprimer que les alarmes
  • Mettre reminder pour ne supprimer que les rappels
  • Mettre all pour supprimer les alarmes et les rappels

Par défaut, type=alarm si non spécifié

status=x

  • Mettre ON pour ne supprimer que les alarmes et/ou rappels actifs
  • Mettre OFF pour ne supprimer que les alarmes et/ou rappels inactifs
  • Mettre ALL pour supprimer toutes les alarmes et/ou rappels

Par défaut, status=ON si non spécifié

Nota : Pour que la suppression fonctionne, il faut que l'Alexa soit connecté !!

command?command=#command#

Cette commande envoie une commande au device dans lequel est créée la commande.

Deux manières d'utiliser cette commande :

  • Avec un scénario

En passant par un scénario, vous laissez command?command=#command# comme commande action et vous aurez une liste déroulante dans le scénario, la liste déroulante vous propose toutes les commandes possibles.

  • Avec une commande directe

Dans ce cas, c'est au niveau des commandes du device que vous allez créer une commande action par commande à envoyer à Alexa.

Vous utiliserez ainsi la synthaxe suivante : command?command=play pour lancer un play et command?command=pause pour faire une pause et ainsi de suite avec les commandes : pause play next prev fwd rwd shuffle repeat

radio?station=#select#

Cette commande lance une station de radio sur le device dans lequel est créée la commande.

Pour une meilleure utilisation en Dashboard, cette commande a été simplifiée. On peut maintenant sélectionner la radio souhaitée plutôt que de copnnaitre par coeur le code (s0000) de la radio.

Ainsi, il faut dans un premier temps "configurer" ses stations de radio dans la partie commandes du player qui va la lire.

Screenshot 2019 11 08 Alexaapi Jeedom

Par défaut, sont configurés : s2960|Nostalgie;s6617|RTL;s6566|Europe1

Il suffit de respecter le format idStation1|Nomstation1;idStation2|Nomstation2

Une fois vos stations configurez,vous pourrez les choisir sur le widget de la radio :

radios

Les stations :

Pour trouver les id des stations, allez sur le site https://tunein.com/radio/home/

Vous choisissez votre radio, et pour avoir l'id, cliquez sur partager, vous verrez dans le lien quelque chose qui commence par un s suivi de chiffres, c'est l'id.

Notez que le plugin est capable de vous donner l'id de la station en cours de lecture, la procédure est identique à TrackID, regardez ici

Utilisation d'une commande radio dans un scénario

Pour utiliser une commande radio dans un scénario, il faut être un utilisateur expérimenté (dans la config) et savoir créer une nouvelle commande (dans le device player) :

Screenshot 2019 11 08 Alexa API Jeedom

Screenshot 2019 11 08 Alexa API Jeedom1

Sur cette nouvelle commande, on configure de manière très simple en figeant l'id de la station (ou en utilisant une variable), par exemple :

Screenshot 2019 11 08 Alexaapi Jeedom1

 

routine?routine=#select#

Cette commande lance la routine spécifiée.

Deux manières d'utiliser cette commande :

  • Avec un scénario

En passant par un scénario, vous laissez routine?routine=#select# comme commande action et dans le scénario, dans le champ "ID routine", spéficiez l'identifiant de la routine, cf. paragraphe ci dessous pour trouver cet identifiant.

  • Avec une commande directe

Dans ce cas, c'est au niveau des commandes du device que vous allez créer une commande action.

Vous utiliserez ainsi la synthaxe suivante : routine?routine=xxxxx pour lancer la routine dont l'ID est xxxx

Pour trouver l'ID Routine :

Vous pouvez trouver facilement l'ID des routines en consultant l'écran "Routines" du plugin, dernière colonne de droite.

playmusictrack?trackId=#select#

Cette commande lance la lecture de la piste de lecture Amazon music par son numéro de trackID.

Les trackID se configurent dans la commande action Ecouter une piste musicale dans votre equipement device, il s'agit d'une liste déroulante, donc avec la synthaxe suivante :

53bfa26d-f24c-4b13-97a8-8c3debdf06f0|Piste1;7b12ee4f-5a69-4390-ad07-00618f32f110|Piste2

Vous pouvez donc modifier vos pistes et leurs noms.

Screenshot 2019 11 03 Alexaapi Jeedom

Une fois la commande configurée, vous n'aurez plus qu'à utiliser la liste déroulante qui sera proposée, autant sur le Dashboard que dans les scénarios

Comment trouver le trackID d'une piste Amazon-Music ?

Le plugine Alexa-API est capable de vous donner le trackID de la piste qui est en cours de lecture.

Pour cela, suivez ces étapes :

  • Allez dans les commandes de l'équipement que vous utilisez et cochez la case Afficher de la commande Amazon Music Id

amazonmusicidtrack

  • Une note de musique va apparaitre sur le Dashboard, sur la tuile de votre équipement, c'est ici qu'apparaitra l'ID
  • Lancez la musique et relevez l'information ainsi affichée

amazonmusicidtrack2

  • Vous gardez ou pas l'information sur votre dashboard, pour la supprimer, décochez Afficher de la commande Amazon Music ID

Notez que cela fonctionne également pour trouver l'ID d'une station de musique lançable avec radio?station=#select#

Il a été constaté par contre que pour certaines playlist, l'ID ne remontait pas. Pour être certain de l'avoir, lancer uniquement la piste que vous souhaitez (et non dans une playlist).


Imprimer   E-mail