Documentación de Alexa-API

icono de alexaapi

Instalación del plugin Alexa-API

Instalar el Plugin desde el Mercado

installationalexaapi1

installationalexaapi3

Nota sobre las versiones:

Usted tiene la opción entre la versión Estable o versión beta. Muchas características nuevas siempre están más presentes en la Beta que en la Estable, pero están en prueba. Si eres un gamer y curioso, puedes instalar la versión Beta. Nota: No es necesario instalar Jeedom en Beta (esto no se recomienda para el caso) para instalar el plugin Beta. Puede cambiar de una versión Beta a una versión estable con bastante facilidad y viceversa, simplemente reinstale sobre la otra versión.

installationalexaapi4

Activar el plugin

installationalexaapi5

Recarga de dependencias

installationalexaapi6

Generar manualmente la cookie de Amazon

installationalexaapi7

Inicia sesión en la ventana emergente de Amazon

installationalexaapi8

Cierre la ventana tan pronto como se cree la cookie de Amazon.

Lanza el Daemon si no se lanza por sí mismo

installationalexaapi9

Lanzamiento del SCAN

installationalexaapi10

Los dispositivos aparecen, entran en un dispositivo y en Órdenes lanzar una Hablar para probar. Alexa habla en menos de 5 minutos!!

Actualizar o cambiar la versión

¿Qué hacer? Dado que el plugin y su API están vivos (Amazon no ha documentado la API y le permite cambiar sus protocolos con el tiempo), las actualizaciones permiten realizar correcciones en los enlaces entre el plugin y el servidor de Amazon.

Tres soluciones para tener una instalación operativa:

  • Eliminar todos los dispositivos de Amazon y sus pedidos y recrearlos
  • Actualización de fuerza de todos los comandos
  • Inicie un SCAN que detecte nuevos equipos o comandos

La elección entre estas tres soluciones depende de la cantidad de escenarios que haya desarrollado con el complemento Alexa-API. De hecho, la primera solución elimina todos los dispositivos y todos los comandos, por lo que los eliminará en sus escenarios. La segunda solución es más respetuosa con sus escenarios porque actualizará sus pedidos sin eliminarlos y, por lo tanto, sus escenarios estarán intactos, pero si no funciona, tendrá que usar la solución 1.

Solución 1: Retire todo el equipo y sus controles y vuelva a crearlos

Este es el modo más importante limpiar y el más optimizado Desde que te vas con una instalación como nuevos dispositivos y sus comandos.

Para hacer esto, tienes que usar el botón Buttonalexaapi1

Atención, esta función elimina todos los equipos y sus comandos, por lo que pierde todos los enlaces en sus escenarios.

Solución 2: Actualización de fuerza de todos los comandos

Este es el modo más importante simple y libre de riesgo ya que su equipo y sus pedidos no se eliminan. Por lo tanto, este forzamiento no afecta sus escenarios.

Para hacer esto, tienes que usar el botón Buttonalexaapi2

Si no desea iniciar la actualización forzando todos las Órdenes de todos equipo, puede lanzarlo en un solo equipo (y por lo tanto en todos sus pedidos). Para ello, vaya al equipo en cuestión y haga clic en:

Buttonalexaapi3

Solución 3: El SCAN

Buttonalexaapi4

Finalmente, tenga en cuenta que el escaneo se puede iniciar en cualquier momento, no afecta el equipo ya detectado o los comandos existentes, pero recrea todos los nuevo Dispositivos o dispositivos eliminado. También recrea todo el noticias órdenes o pedidos suprimido.

Pantallas de gestión

Captura de pantalla 2019 10 27 Alexaapi Jeedom

Escanear

Permite iniciar automáticamente la detección de todos sus dispositivos, puede iniciarlo cuando lo desee, nunca elimina ningún dispositivo o comando, sin riesgo.

Configuración

Este es todo el motor de parametrización. Si algo no parece lo suficientemente intuitivo, háganoslo saber, lo documentaremos o lo simplificaremos.

Salud

Da indicaciones sobre la salud de su equipo

Rutinas

Muestra las rutinas guardadas en su cuenta de Amazon y le permite ejecutarlas manualmente

Recordatorios/Alarmas

Da una lista de sus alarmas o recordatorios, le permite eliminarlos. La desactivación manual ya no funciona.

Historia

Este es el historial completo de la actividad de su equipo Amazon, da la indicación de éxito si es necesario.

Información del solicitante

Reservado para usuarios informados, permite cuestionar el servidor de Amazon

Acción del solicitante

Reservado para usuarios altamente expertos, le permite lanzar solicitudes sin procesar al servidor de Amazon

Los azulejos

Hasta la fecha, cada pieza de equipo puede generar 3 azulejos.

  • El azulejo principal del equipo con sus interacciones con usted, sus órdenes de hablar, alarmas / recordatorios, volumen y la capacidad de lanzar rutinas
  • Baldosa de reproductor multimedia
  • El mosaico de la lista de reproducción actual

La baldosa del equipo principal

widget principal

A : Esta es la última interacción con usted, tenga en cuenta que puede recuperar esta información y utilizarla en un escenario.

B : Puede iniciar una rutina seleccionándola en la lista desplegable

C : El volumen, tenga en cuenta que se actualiza si cambia el volumen en el dispositivo. (El volumen de un grupo se impone a todos los dispositivos del grupo)

D/E/F : Esta es la siguiente alarma, alarma de música o recordatorio.

G : Es una forma que permite a Alexa hablar.

Baldosa de reproductor multimedia

widgetplayer

El mosaico de la lista de reproducción actual

widgetplaylist

Órdenes simples

Principio

Los comandos simples están preinstalados para detectar dispositivos, por lo que tiene comandos inmediatamente utilizables. Los comandos preinstalados se pueden usar como en los escenarios. Tenga en cuenta que todos los pedidos se pueden adaptar individualmente, de modo que los usuarios informados puedan crear sus pedidos y personalizarlos gracias a los posibles parámetros de cada pedido. Esta documentación presta poca atención a los comandos simples porque su uso se considera intuitivo, pero los comandos complejos se detallan en el siguiente capítulo.

Siguiente Alarma

Siguiente Alarma de música

El siguiente temporizador

Siguiente recordatorio

Estos 4 comandos INFO funcionan de la misma manera. Se actualizan automáticamente por el plugin (por MQTT y por CRON). El resultado se da en el siguiente formato: 2019-12-02 21:10:00. Si lo quieres en otro formato 2110 p. ej. Un tutorial explica cómo hacerlo.

Haz que Alexa hable en SSML

Amazon ha integrado SSML en su equipo y esto hace que la forma de hablar sea extremadamente natural. Puede personalizar aún más las oraciones proporcionando detalles sobre los descansos, así como el formato de audio de acrónimos, fechas, horas, abreviaturas de …, también puede elegir el idioma de lectura, una cita o una expresión en un idioma extranjero para que pueda leerse con el acento extranjero en un texto en su idioma original. A diferencia de los otros comandos para hacer hablar a Alexa, en este comando, se tomó la decisión de respetar escrupulosamente la sintaxis del protocolo SSML, incluidas las etiquetas. Por lo tanto, será necesario utilizar las etiquetas de apertura y cierre y ser riguroso en la forma en que se codifican estas oraciones.

Los ejemplos incluyen:

<speak> <voice name="Conchita"> <prosody rate="medium" pitch="high"> Yé me llama Conchita. yé fair lé menache partou dans la maichon.</prosody></voice> </speak>

o

<speak> Hola puedo leer <say-as interpret-as="characters">SSML</say-as>. Puedo pausar <break time="3s"/>. Un cardenal <say-as interpret-as="cardinal">10</say-as>. en ordinal <say-as interpret-as="ordinal">10</say-as>. o dígito <say-as interpret-as="caracteres">10</say-as>. </hablar>

o

<speak><amazon:effect name="whispered">Hola, soy un ghost</amazon:effect></speak>

Algunos enlaces interesantes:

Inicie un anuncio (en todos los dispositivos)

Hasta la fecha, todavía no sabemos cómo utilizar el comando «Publicidad» en la aplicación para teléfonos inteligentes de Alexa, pero podemos hacer lo mismo con el comando «Habla con Alexa». Así, para hacer un anuncio "El factor ha pasado, es necesario hacer (en un escenario):

  • Orden Habla con Alexa
  • Poner el mensaje en Mensaje Alexa anuncia que el cartero ha pasado

Órdenes complejas

Principio

Los comandos simples (párrafo anterior) están preinstalados para detectar dispositivos, por lo que tiene comandos inmediatamente utilizables. Los comandos complejos son accesibles para usuarios experimentados y su uso es mucho más difícil, pero son mucho más poderosos. Tenga en cuenta que los comandos simples se pueden personalizar. Se convertirán en órdenes complejas. Para ello, utilice el botón (debajo del panel de control):

Añadir botón de acción de comando

Puede usar comandos preinstalados para copiar la sintaxis y usar la documentación a continuación para descubrir todas las opciones posibles. Si quieres otra función, otro formato o no encuentras tu felicidad, contacta con el equipo de creación del plugin, siempre habrá una solución para ti.

Nota: : Para que el comando " Agregar un comando de acción activa, marque esta casilla en la configuración del plugin:

Captura de pantalla 2019 12 14 Alexa API Jeedom

alarma?cuando=#cuando#&recurring=#recurrente#&sound=#sonido#

Este comando le permite agregar una alarma al dispositivo en el que se crea el comando.

Estas son las opciones:

  • cuando=AAAA-MM-DD HH24:MI:SS

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

Tenga en cuenta que las alarmas son diferentes de los recordatorios y deben estar en un espacio de 24 horas (una alarma para el 31/12 en abril no es posible, a diferencia de los recordatorios). Por lo tanto, si no se programa ninguna recurrencia (por el parámetro recurrente), solo se tiene en cuenta el tiempo, Amazon ignora el día.

  • recurrente =#recurrente#

La programación de este parámetro es mucho más fácil por un escenario ya que una lista desplegable le permite elegir fácilmente la recurrencia. Pero esto se puede hacer manualmente en un comando de acción con la siguiente codificación:

P1D=Todos los días
XXXX-WD=días laborables
XXXX-WE=Fines de semana
XXXX-WXX-1=Todos los lunes
XXXX-WXX-2=Todos los martes
XXXX-WXX-3=Todos los miércoles
XXXX-WXX-4=Todos los jueves
XXXX-WXX-5=Todos los viernes
XXXX-WXX-6=Todos los sábados
XXXX-WXX-7=Todos los domingos

  • sonido=#sonido#

Este es el sonido de la alarma. #sonido# podrá sustituirse por el texto siguiente:

_alerts _melodic _01 para la alarma simple
_alerts _melodic _01 para el temporizador simple
_alerts _melodic _02 por A la Drift
_alerts _atonal _02 para Metallic
_alerts _melodic _05 para la claridad
_alerts _repetitivo _04 para Comptoir
_alerts _melódico _03 para Focus
_alerts _melódico _06 para Glow
_alerts _repetitivo _01 para la mesita de noche
_alerts _melodic _07 para Vif
_alerts _soothing _05 para Orca
_alerts _atonal _03 para la luz del porche
_alerts _rhythmic _02 para Pulsar
_alerts _musical _02 para Pluvieux
_alerts _alarming _03 para olas cuadradas

recordatorio?texto=#mensaje#&cuando=#cuando

Este comando le permite agregar un recordatorio al dispositivo en el que se crea el comando.

Estas son las opciones:

  • cuando=AAAA-MM-DD HH24:MI:SS

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

  • texto=#mensaje#

Usted tiene la posibilidad de dar un título a su retiro.

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

Nota: Este comando está oculto, da el resultado en el comando info: Próxima hora de alarma

Este comando devuelve la siguiente alarma del dispositivo en el que se crea el comando. Atención, este comando es un comando ACCIÓN, debe estar conectado a un pedido INFO que mostrará el resultado, mire la explicación debajo de la descripción de las opciones.

Estas son las opciones:

posición=x

  • Colocación 1 para la próxima alarma
  • 2 para la próxima
  • y así sucesivamente

Predeterminado, posición=1 si no se especifica

status=x

  • Colocación ON tener en cuenta únicamente las alarmas activas
  • Colocación OFF tener en cuenta únicamente las alarmas inactivas
  • Colocación TODOS tener en cuenta todas las alarmas

De forma predeterminada, status=ON si no se especifica

formato=x

  • Colocación hora para tener un resultado en formato HH:MM (Advertencia, esta pantalla es peligrosa en caso de programar alarmas más allá de las 24 horas, esto es posible con repeticiones)
  • Colocación hhmm para tener un resultado en formato HHMM
  • Colocación lleno para tener una visualización detallada aaaa-MM-dd’T’HH:mm:ss.SSS

Por defecto, format=hhmm si no se especifica

Nota: : Si necesitas otro formato, no dudes en preguntarme, lo añadiré en la próxima versión.

Creación de la orden INFO que mostrará el resultado del comando cuandoSiguienteAlarma

El comando INFO que le dará el resultado del comando WhenNextAlarm se creará automáticamente tan pronto como el campo Información del nombre del pedido en la columna Resultado en se llenará.

Explicación de la interacción entre el comando ACTION y el comando INFO

  • Cuando ejecuta el comando ACTION, se consulta el servidor de Amazon y el resultado se asigna al comando INFO
  • Cuando inicies el comando INFO, Jeedom te dará el resultado del comando ACTION correspondiente.

(Todo esto está diseñado en la misma lógica que el plugin Virtual)

Nota: : Si no hay alarma en un futuro próximo, el servidor responderá «ninguna».

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

Funciona como whennextalarm pero para alarmas de música.

musicalalarmmusicentity?position=1&status=ON

Funciona como whennextmusicalalarm pero proporciona información MusicEntity Esto corresponde a lo que se reproducirá en el momento de la alarma.

whennextreminder?position=1&status=ON

Nota: Este comando está oculto, da el resultado en el comando info: Siguiente Hora del Recordatorio

Este comando le da el siguiente recordatorio, funciona exactamente como WhenNextAlarm.

deleteallalarms?type=alarm&status=all

Este comando elimina todos los recordatorios y/o alarmas del dispositivo en el que se crea el comando.

Estas son las opciones:

tipo=x

  • Colocación alarma para eliminar solo las alarmas
  • Colocación recordatorio para eliminar solo los recordatorios
  • Colocación todos para eliminar alarmas y recordatorios

Por defecto, type=alarm si no se especifica

status=x

  • Colocación ON para eliminar solo alarmas y/o recordatorios activos
  • Colocación OFF para eliminar solo alarmas y/o recordatorios inactivos
  • Colocación TODOS para eliminar todas las alarmas y/o recordatorios

De forma predeterminada, status=ON si no se especifica

Nota: : Para que la eliminación funcione, ¡¡el Alexa debe estar conectado!!

history?maxRecordSize=50&recordType=’VOICE_HISTORY’

Cualquier nuevo orden en prueba que busque la historia.

  • maxRecordSize indica el registro nb que se cargará (50 en el plugin)
  • recordType es probablemente el tipo de registro, VOICE _HISTORY es el valor predeterminado, no se conocen otros valores posibles.

comando?comando=#comando#

Este comando envía un comando al dispositivo en el que se crea el comando.

Dos maneras de usar este comando:

  • Con un escenario

Al pasar por un escenario, te vas comando?comando=#comando# como un comando de acción y tendrá una lista desplegable en el escenario, la lista desplegable le ofrece todos los comandos posibles.

  • Con orden directa

En este caso, es al nivel de los comandos del dispositivo que creará un comando acción por comando para enviar a Alexa. Utilizarás la siguiente sintaxis: comando?command=play para poner en marcha una jugar y comando?command=pausa para hacer una romper y así sucesivamente con los pedidos: pause play siguiente prev fwd rwd shuffle repetición

Nota: : STOP no existe en Amazon, se debe usar PAUSE

estación de radio=#seleccionar#

Este comando inicia una estación de radio en el dispositivo en el que se crea el comando. Para un mejor uso en Dashboard, este comando se ha simplificado. Ahora podemos seleccionar la radio deseada en lugar de conocer de memoria el código (s0000) de la radio. Por lo tanto, primero debe "configurar" sus estaciones de radio en la parte de comandos del jugador que lo leerá.

Captura de pantalla 2019 11 08 Alexaapi Jeedom

De forma predeterminada, se configuran las siguientes opciones: 2960|Nostalgia;s6617|RTL;s6566|Europe1

Simplemente sigue el formato idStation1|Name1;idStation2|Name2

Una vez que haya configurado sus estaciones, puede elegirlas en el widget de radio:

radios

Estaciones:

Para encontrar el ID de las estaciones, vaya al sitio https://tunein.com/radio/home/. Usted elige su radio, y para tener el id, haga clic en compartir, verá en el enlace algo que comienza con un s seguido de números, es el id.

Tenga en cuenta que el plugin es capaz de darle el id de la estación que se está reproduciendo, el procedimiento es idéntico al TrackID, Mira aquí

Uso de un radiocontrol en un escenario

Para usar un comando de radio en un escenario, debe ser un usuario experimentado (en la configuración) y saber cómo crear un nuevo comando (en el reproductor de dispositivos):

Captura de pantalla 2019 11 08 Alexa API Jeedom

Captura de pantalla 2019 11 08 Alexa API Jeedom1

En este nuevo comando, configuramos de una manera muy sencilla congelando el id de la estación (o usando una variable), por ejemplo:

Captura de pantalla 2019 11 08 Alexaapi Jeedom1

rutina=#seleccionar#

Este comando inicia la rutina especificada.

Dos maneras de usar este comando:

  • Con un escenario

Al pasar por un escenario, te vas rutina=#seleccionar# como comando de acción y, en el escenario, en el campo «ID de rutina», especifique el identificador de rutina; véase el apartado siguiente para encontrar dicho identificador.

  • Con orden directa

En este caso, creará un comando de acción a nivel de los comandos del dispositivo. Utilizarás la siguiente sintaxis: rutina?rutina=xxxxx para iniciar la rutina cuyo ID es xxxx

Para encontrar el ID de rutina:

Puede encontrar fácilmente el identificador de rutinas consultando la pantalla de rutinas del plugin, última columna a la derecha.

playmusictrack?trackId=#seleccionar#

Este comando inicia la reproducción de la pista de reproducción de música de Amazon por su número de trackID. Los TrackIDs se configuran en el comando action Escuchar una pista musical en el equipo de su dispositivo, esta es una lista desplegable, con la siguiente sintaxis:

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

Para que puedas cambiar tus huellas y sus nombres.

Captura de pantalla 2019 11 03 Alexaapi Jeedom

Una vez configurado el comando, todo lo que tienes que hacer es utilizar la lista desplegable que se propondrá, tanto en el Dashboard como en los escenarios.

¿Cómo encontrar el trackID de una pista de Amazon-Music?

El plugin Alexa-API es capaz de darle el trackID de la pista que se está reproduciendo. Para ello, sigue estos pasos:

  • Vaya a los controles del equipo que está utilizando y marque la casilla Mostrar de la orden ID de Amazon Music

amazonmusicidtrack

  • Aparecerá una nota musical en el panel de control, en el azulejo de su equipo, aquí es donde aparecerá el ID
  • Inicie la música y grabe la información mostrada

amazonmusicidtrack2

  • Guarda o no la información en su panel de control, para eliminarla, desmarque Mostrar de la orden ID de música de Amazon

Tenga en cuenta que también funciona para encontrar el ID de una estación de música que se puede iniciar con estación de radio=#seleccionar#

Sin embargo, se encontró que para algunas listas de reproducción, la identificación no subió. Para asegurarte de que lo tienes, inicia solo la pista que quieras (no una lista de reproducción).

Otras características

Editar el icono del reproductor

Las imágenes de fichas de reproductor son imágenes enviadas por los servidores de los proveedores de música. Estas imágenes son enlaces temporario y así puedes terminar con imágenes vacías. Esto se traduce en:

azulejo

Para evitar esto, los jugadores han sido modificados y si no hay imagen, se muestra la miniatura del jugador, que da:

azulejos2

Si desea cambiar la imagen, simplemente reemplace el archivo logourl.png que puede encontrarse en:

plugins/alexaamazonmusic/core/config (por ejemplo, cambio de amazonmusic para otros jugadores)

Uso de etiquetas para interjecciones y sonidos

Para la función "Hacer que Alexa hable", pero también funciona para los otros métodos para hacer que Alexa hable, se establecen dos novedades. Interyecciones y sonidos de la biblioteca.

  • Se describen las interjecciones FR aquí, los otros países también tienen su página.
  • Se describen los sonidos de la biblioteca aquí

Para facilitar el envío de comandos, Alexa-API ha diseñado un sistema de etiquetas.

Los sonidos de la biblioteca amazónica

Por ejemplo, en lugar de enviar

<audio src= »soundbank://soundlibrary/animals/amzn_sfx_lion_roar_01″/>

podemos simplemente añadir

#animales/amzn_sfx_lion_roar_01#

Lanza el rugido de un león. Muchos otros sonidos están en Biblioteca de sonido de Amazon.

Interyecciones

En un principio similar a los sonidos de la biblioteca, las interjecciones deben ponerse entre etiquetas. #

Ejemplo:

Secuencia de texto e interjección

Tenga cuidado, a diferencia de los sonidos que se pueden ahogar en oraciones, las interjecciones deben estar en oraciones separadas, por lo que este ejemplo no funcionará:

Para que la interjección se tenga en cuenta, debe incluirse en una oración separada, así que añádase un punto:

Deslizador de volumen

En la versión de abril de 2021, el control deslizante de volumen se ha revisado por completo. El Widget de Noodom (un agradecimiento muy grande a él) ha sido refundido e integrado en los widgets. El widget se veía como:

(Utilizar Alexaapi/Volume_legacy ahora para tener este widget) y se convierte en:

(Corresponde ahora a Alexaapi/Volume)

La huella es la misma para ser compatible con los diseños personalizados de cada individuo.

Personalizar el widget

El widget es totalmente personalizable, solo tiene que utilizar las variables del widget NooSlider, un documento está disponible con todos Parámetros opcionales.

Por defecto, los parámetros enviados son:

  • displayValues = "0,20,40,60,80,100"
  • escalón = 10
  • anchura = 200
  • altura = 50
  • handleSize =15
  • cursorLeftPos =50
  • cursorTopPos = 88
  • parámetro superior no establecido por defecto, cf un poco más bajo.

Para personalizar su widget, puede agregar el parámetro como Ajustes de widget opcionales el comando de acción «Volumen», por ejemplo:

Volver al Widget anterior

Si quieres conservar el widget antiguo, no entres en pánico, sigue en el plugin. Seleccione Volume _legacy 😉

Mejora del diseño del widget

Un parámetro superior está disponible para establecer elEspaciado superior del widget, basta con especificarlo como sigue:

Eliminar el logotipo del altavoz

Si el pequeño logotipo del altavoz que indica el sonido, heredado de la versión anterior del plugin, le molesta:

No se asuste, es fácil eliminarlo, vaya a su equipo, luego en comandos, haga clic en este pequeño logotipo en cuestión a la izquierda, desaparecerá y guardará. Ya no está aquí. (Si aparece "Volumen", desmarque "Mostrar nombre" en las opciones del widget)

Silencio de la información

Llega nueva información en el widget de equipo de Alexa. Esta es la información Silencio que aparece cuando le dicen a Alexa: Alexa corta el sonido.