Alexa-API 文档

Alexaapi 图标

安装 Alexa-API 插件

从市场安装插件

安装 Alexaapi1

安装 Alexaapi3

关于版本的说明：

你可以在版本之间做出选择。 稳定 型 或版本 Beta 版 版. 许多新功能在Beta上总是比在Stable上更多，但它们正在测试中。 如果你是一个玩家和好奇，你可以安装Beta版本。 注： 您不需要在 Beta 中安装 Jeedom（不建议这样做）来安装 Beta 插件。 您可以轻松地从Beta版本切换到稳定版本，反之亦然，只需重新安装其他版本即可。

安装 Alexaapi4

激活 插件

安装 Alexaapi5

重新加载依赖项

安装 Alexaapi6

手动生成 Amazon Cookie

安装 Alexaapi7

登录到亚马逊的弹出窗口

安装 Alexaapi8

创建 Amazon Cookie 后立即关闭窗口。

启动守护神，如果它自己不启动

安装 Alexaapi9

启动 SCAN

安装 Alexaapi10

设备出现，进入设备并进入 订单 订单 启动 a 说话 说话 测试.. Alexa在不到5分钟的时间内发言！

更新或更改版本

该怎么办？ 由于插件及其API是活的（亚马逊没有记录API，并允许它随着时间的推移更改其协议），因此更新可以在插件和亚马逊服务器之间的链接中进行更正。

具有操作性安装的三种解决方案：

  • 删除所有亚马逊设备及其订单并重新创建它们
  • 部队更新所有指挥部
  • 启动可检测新设备或命令的 SCAN

这三个解决方案之间的选择取决于您使用Alexa-API插件开发的场景数量。 事实上，第一个解决方案删除了所有设备和所有命令，因此它会在您的场景中删除它们。 第二个解决方案更尊重您的场景，因为它会在不删除的情况下更新您的订单，因此您的场景将完好无损，但如果它不起作用，您将不得不使用解决方案1。

解决方案1： 删除所有设备及其控制，并重新创建它们。

这是最重要的模式。 清洁 清洁 和最 优化 优化 因为你离开一个安装像新设备和他们的命令。

要做到这一点，你必须使用按钮。 Buttonalexaapi1 的

注意 注意, 此功能将删除所有设备及其命令，因此您会丢失场景中的所有链接。

解决方案2： 部队更新所有指挥部

这是最重要的模式。 简单 简单 以及 无风险 风险 因为您的设备及其订单不会被删除。 因此，这种强迫不会影响您的场景。

要做到这一点，你必须使用按钮。 Buttonalexaapi2 的

如果您不想启动更新强制 全部 的 命令 全部 设备，您可以在单个设备上（因此根据所有订单）启动它。 要做到这一点，请转到有关设备并点击：

Buttonalexaapi3 的

解决方案3： SCAN 的

Buttonalexaapi4 的

最后，请注意，扫描可以随时启动，它不会影响已经检测到的设备或现有的命令，但它会重新创建所有命令。 新 的 设备 或 设备 删除 删除. 它也重现了所有 新闻 新闻 新闻 订单或 订单 订单 删除了。

管理屏幕

截图 2019 10 27 Alexapi Jeedom

扫描 扫描

允许自动启动所有设备的检测，您可以随时启动它，它永远不会删除任何设备或命令，没有风险。

配置 配置

这是整个参数化引擎。 如果某些东西看起来不够直观，请告诉我们，我们会记录它或使其更简单。

健康 健康

显示您的设备健康状况

例行 程 例行

列出保存在 Amazon 帐户上的例程，并允许您手动运行它们

提醒/提醒

提供您的警报或提醒的列表，允许您删除它们。 手动停用不再工作。

历史 》

这是您的亚马逊设备活动的全部历史，如果有必要，可以表明成功。

请求 者 信息

保留给知情用户，它允许质疑亚马逊服务器

请求 者 行动

为高度精明的用户保留，它允许您向亚马逊服务器启动原始请求

瓷砖 的

迄今为止，每台设备可以生成3块瓷砖。

  • 设备的主要瓦片及其与您的交互，您的发言命令，警报/提醒，体积和启动例程的能力
  • 多媒体播放器瓷砖
  • 当前播放列表的瓷砖

主要设备的瓷砖

主部件

A 个 : 这是与您的最后一次互动，请注意，您可以检索此信息并在场景中使用。

B : 您可以通过从下拉列表中选择它来启动它

C : 卷，请注意，如果您更改设备上的卷，它会更新。 （一个组的体积被强加于组中的所有设备）

D/E/F : 这是下一个警报，音乐警报或提醒。

G : 这是一种允许Alexa说话的形式。

多媒体播放器瓷砖

widgetplayer 游戏

当前播放列表的瓷砖

部件 播放 列表

简单命令

原则 原则

简单的命令预装来检测设备，因此您可以立即使用命令。 预安装的命令可以像在场景中一样使用。 请注意，所有订单都可以单独调整，以便知情的用户能够根据每个订单的可能参数创建订单并个性化。 这个文档很少关注简单的命令，因为它们的使用被认为是直观的，但是在下一章中详细介绍了复杂的命令。

下一个 警报

下 音乐 警报

下 计时 器

下一 条 提醒

这4个INFO命令以同样的方式工作。 它们由插件（由MQTT和CRON）自动更新。 结果以以下格式给出： 2019-12-02 21:10:00. 如果你想用另一种格式 2110 例如 一个教程解释了如何做到这一点。

让Alexa在SSML中说话

亚马逊已经将SSML集成到其设备中，这使得说话方式非常自然。 您可以通过提供休息时间的详细信息以及首字母缩略词，日期，时间，......缩写的音频格式来进一步个性化句子，您还可以选择阅读的语言，报价或外语表达式，以便您可以在原始语言的文本中用外国口音阅读。 不像其他命令让Alexa说话，在这个命令上，选择严格尊重SSML协议的语法，包括标签。 因此，有必要使用开头和关闭标签，并严格执行这些句子的编码方式。

例子包括：

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

或

<speak> Hello 我可以读 <say-as-as="characters">SSML</say-as>。 我可以暂停<break time="3s"/>。 在序数 <say-as 解释-as="cardinal">10</say-as>.. in or digit <say-as-as="characters">>10</say-as>. 或数字<say-as-as="字符">10</say-as>。 </speak>

或

<speak><amazon:effect name="whispered">Hello, I'm a ghost</amazon:effect></speak>

一些有趣的链接：

启动广告（在所有设备上）

到目前为止，我们还不知道如何在Alexa智能手机应用程序中使用"广告"命令，但我们可以使用"Speak to Alexa"命令做同样的事情。 因此，要宣布"因子已经过去了，有必要（在一种情况下）做出：

  • 订单 次序 与 Alexa 交谈
  • ， 放 留言 信 在 Message Alexa宣布邮递员已经通过

复杂订单

原则 原则

简单命令（上一段）预装以检测设备，因此您可以立即使用命令。 复杂的命令可供经验丰富的用户访问，它们的使用要困难得多，但它们更强大。 注意，简单的命令是可以定制的。 他们将成为复杂的订单。 要做到这一点，请使用按钮（控制面板下方）：

添加命令按钮

您可以使用预安装的命令来复制语法，并使用下面的文档来找出所有可能的选项。 如果您想要另一个功能，另一种格式或找不到您的快乐，请联系插件创建团队，始终为您提供解决方案。

注： : 如此 命令 。 添加一个动作命令 要么处于活动状态，请在插件配置中选中此框：

截图 2019 12 14 Alexa API Jeedom

闹钟？When=#当 时#&recurring=#反复 发生#&sound=#声音 声音#

此命令允许您向创建命令的设备添加警报。

以下是选项：

  • When=yyyy-mm-DD HH24:mi:SS

示例： 2019-12-31 21:36:00

请注意，警报不同于提醒，必须处于24小时时段（4月31/12的警报是不可能的，不像提醒）。 因此，如果没有再现被编程（通过递归参数），只有时间被考虑在内，亚马逊会忽略这一天。

  • Recurring=#反复 发生#

此参数的编程在场景中要容易得多，因为下拉列表允许您轻松选择重现。 但这可以在具有以下编码的操作命令中手动完成：

P1D=每天
XXXX-WD=周日
XXXX-WE=周末
XXXX-WXX-1=每个星期一
XXXX-WXX-2=每个星期二
XXXX-WXX-3=每个星期三
XXXX-WXX-4=每个星期四
XXXX-WXX-5=每个星期五
XXXX-WXX-6=每个星期六
XXXX-WXX-7=每个星期日

  • 音响=#声音 声音#

这是警报的声音。 #声音 声音# 可以替换为：

_ 警报 _ 旋律 _ 01 简单提醒
_ 警报 _ 旋律 _ 01 简单定时器 Simple Timer
_ 警报 _ 旋律 _ 02 曲名 : A la Drift
_ 警报 _atonal _02 为 Metallic
_ 警报 _ 旋律 _ 05 为 Clarity
_ 警报 _ 重复 _04 关于 Comptoir
_ 警报 _ 旋律 _ 03 为 Focus
_ 警报 _ 旋律 _ 06 为 Glow
_ 警报 _ 重复 _ 01 床边桌子 Bedside Table
_ 警报 _ 旋律 _ 07 对于 Vif
_ 警报 _soothing _05 关于 Orca
_ 警报 _atonal _03 为 门廊 的 光
_ 警报 _ 失常 _ 02 饰 Pulsar
_ 警报 _ 音乐 _ 02 关于 Pluvieux
_ 警报 _ 警报 _ 03 曲名 : Square Waves

提醒 文本 @ info: whatsthis#留言 信#&When=#当 时

此命令允许您向创建命令的设备添加提醒。

以下是选项：

  • When=yyyy-mm-DD HH24:mi:SS

示例： 2019-12-31 21:36:00

  • 文本=#留言 信#

你有可能给你的回忆起一个标题。

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

注： 这个命令是隐藏的，它给出了info命令的结果： 下 警报 小时

此命令返回创建该命令的设备的下一个警报。 注意，这个命令是命令 行动 行动, 它必须连接到一个订单。 信息 信息 这将显示结果，看看下面的解释选项的描述。

以下是选项：

位置=x

  • 位 位 位 1 下一个警报
  • 2 对于下一个
  • 等等

缺省，如果未指定位置=1

状态=x

  • 位 位 位 在 上 只考虑主动报警
  • 位 位 位 关闭 只考虑不活动的警报
  • 位 位 位 全部 考虑所有警报

默认情况下，如果未指定状态=ON

格式=x

  • 位 位 位 小时 小时 以格式获得结果 HH:mm （警告，这个显示是危险的，如果你编程警报超过24小时，这是可能的重复）
  • 位 位 位 HHMM ， HHMM 以格式获得结果 HHMM ， HHMM
  • 位 位 位 完整 的 要有一个详细的显示 yyyy-MM-ddd'HH:mm:ss.SSS

默认情况下，如果未指定格式=hhmm

注： : 如果您需要另一种格式，请不要犹豫地问我，我会在下一个版本中添加它。

建立秩序 信息 信息 它将显示命令的结果 WhenNextAlarm 时

将为您提供 WhenNextAlarm 命令结果的 INFO 命令将在字段后立即自动创建。 订单 名称 信息 在列中 结果 在 将被填满。

解释ACTION命令和INFO命令之间的交互作用

  • 当您运行ACTION命令时，会查询 Amazon 服务器，并将结果分配给 INFO 命令。
  • 当您启动 INFO 命令时，Jeedom 会给你相应的 ACTION 命令的结果。

（所有这些都与虚拟插件的逻辑相同）

注： : 如果在不久的将来没有警报，服务器将回复『无』。

Whennextmusicalalarm？position=1&status=ON&format=hour

用作当nextalarm，但用于音乐警报器。

Musicalarmicentity？position=1&status=ON

作为thenextmusicalalarm，但提供信息 MusicEntity 》 MusicEntity 这与警报时将播放的内容相对应。

Whennextreminder？position=1&status=ON

注： 这个命令是隐藏的，它给出了info命令的结果： 下 提醒 时间

此命令给出下一个提醒，它的工作方式与 WhenNextAlarm 完全相同。

deleteallalarms 类型=alarm&status=all

此命令从创建命令的设备中删除所有提醒和/或警报。

以下是选项：

Type=x 类型

  • 位 位 位 报警 器 仅删除提醒@ info: whatsthis
  • 位 位 位 提醒 提醒 仅删除提醒
  • 位 位 位 全部 删除警报和提醒

默认情况下，如果未指定，type=alarm

状态=x

  • 位 位 位 在 上 仅删除活动警报和/或提醒
  • 位 位 位 关闭 仅删除非活动的警报和/或提醒
  • 位 位 位 全部 删除所有提醒和/或提醒

默认情况下，如果未指定状态=ON

注： : 为了使删除工作，Alexa必须连接！！

历史：maxRecordSize=50&recordType='VOICE_HISTORY'

任何新的测试顺序，将寻找历史。

  • maxRecordSize表示要上传的记录nb（插件上为50）
  • RecordType 可能是记录类型，VOICE _HISTORY 是默认值，没有其他可能的值是已知的。

命令？命令#指挥 部#

此命令向创建命令的设备发送命令。

使用此命令的两种方法：

  • 与一个场景

通过经历一个场景，你离开。 命令？命令#指挥 部# 作为操作命令，您将在场景中有一个下拉列表，下拉列表为您提供所有可能的命令。

  • 直接命令

在这种情况下，在设备命令的级别上，您将创建一个命令命令发送到Alexa。 您将使用以下语法： Command？command=play 发射A 玩 游戏 以及 Command？command=pause 使a 打破 依次下达命令： 暂停下一场fwd rwd shuffle 重复

注： : 亚马逊不存在停止，应使用PAUSE

广播电台=#选择#

此命令在创建命令的设备上启动无线电台。 为了更好地在仪表板中使用，此命令已简化。 我们现在可以选择所需的无线电，而不是通过心脏知道无线电的代码(s0000)。 因此，您必须首先在将阅读它的玩家的命令部分中『配置』您的无线电台。

截图 2019 11 08 Alexaapi Jeedom

默认情况下，配置了以下内容： s2960|Nostalgia;s6617θRTL;s6566…Europe1

只需遵循 idStation1|Name1;idStation2θName2

一旦您设置了电台，您可以在无线电小部件上选择它们：

电台 广播 机

车站：

要找到车站的ID，去现场 https://tunein.com/radio/home/. 你选择你的收音机，并有ID，点击共享，你将在链接中看到一些以s后面的数字开头的东西，它是ID。

请注意，插件能够为您提供正在播放的站的id， 该过程与TrackID相同， 看这里

在场景中使用无线电控制

要在场景中使用无线电命令，您必须是经验丰富的用户（在配置中），并知道如何创建新命令（在设备播放器中）：

截图 2019 11 08 Alexa API Jeedom

屏幕截图 2019 11 08 Alexa API Jeedom1

在这个新命令中，我们通过冻结station id（或使用变量）以非常简单的方式进行配置，例如：

截图 2019 11 08 Alexaapi Jeedom1

例行公事？ 例行公事#选择#

此命令启动指定的例程。

使用此命令的两种方法：

  • 与一个场景

通过经历一个场景，你离开。 例行公事？ 例行公事#选择# 作为操作命令，在场景中，在"常规ID"字段中指定例行标识符，请参阅下面的段落来查找该标识符。

  • 直接命令

在这种情况下，您将在设备命令级别创建一个操作命令。 您将使用以下语法： 例程？routine=xxxxx 启动ID为例程 XXXX 的

要查找常规 ID ：

您可以通过咨询插件的 Routines 屏幕（右侧最后一列）轻松找到 Routines ID。

Playmusictrack？trackId#选择#

此命令通过 trackID 号码启动 Amazon 音乐播放轨道的回放。 Trackids 在 Action 命令中配置 听音乐曲目 在您的设备设备中，这是一个下拉列表，具有以下语法：

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

所以你可以改变你的足迹和他们的名字。

截图 2019 11 03 Alexaapi Jeedom

一旦配置了命令，你所要做的就是使用将在仪表板和场景中提出的下拉列表。

如何找到 Amazon-Music Track 的 trackID？

Alexa-API插件能够为您提供正在播放的轨道的trackID。 为此，请遵循以下步骤：

  • 转到您正在使用的设备的控件并检查框。 显示 显示 命令 亚马逊 音乐 Id

亚马逊 音乐 道

  • 音乐音符将显示在仪表板上，在设备的瓷砖上，这是ID将出现的地方。
  • 启动音乐并录制显示的信息

亚马逊musicidtrack2

  • 您保留或不保存在仪表板上的信息，删除它，取消检查。 显示 显示 命令 亚马逊 音乐 ID

注意，它还可以找到可以启动的音乐电台的ID。 广播电台=#选择#

然而，发现对于一些播放列表，ID没有上升。 为了确保你有它，只启动你想要的曲目（而不是播放列表）。

其他特点

编辑播放器图标

播放器瓷砖图像是音乐提供商服务器发送的图像。 这些图片是链接 临时 临时 所以你可以得到空的图像。 这导致：

瓷砖 瓷砖

为了避免这种情况，玩家已经进行了修改，如果没有图像，则显示玩家的缩略图，该缩略图给出：

Tile2 的

如果你想更改图像，只需替换文件即可。 logourl.png 可以在以下方面找到：

插件/alexaamazonmusic/core/config （例如为其他玩家更改amazonmusic）

使用 Tags for Interjections and Sounds

对于"让Alexa说话"的功能，但它也适用于其他使Alexa说话的方法，它设置了两个新奇之处。 图书馆里的声音和声音。

  • FR Interjections 描述 在这里, 其他国家也有自己的页面。
  • 图书馆的声音被描述 在这里

为了更容易发送命令，Alexa-API设计了一个标签系统。

亚马逊图书馆的声音

例如，而不是发送

<audio src=> soundbank://soundlibrary/animals/amzn_sfx_lion_roar_01"/>

我们可以简单地添加

#动物/amzn_sfx_lion_roar_01#

扔掉狮子的咆哮。 许多其他声音在 亚马逊 声音 图书.

插 插 件

在类似于图书馆声音的原理上，插话要放在标签之间。 #

示例：

文本和插入序列

小心，与可能淹没在句子中的声音不同，插入必须在单独的句子中，所以这个例子不会起作用：

为了考虑到插句，必须将其放在一个单独的句子中，因此添加一点：

卷 滑动 器

在2021年4月的版本中，音量滑块已经完全修改。 的 Widget 诺多姆 · 诺多姆 （非常感谢他）已经被重新塑造并集成到小部件中。 小部件看起来像：

（ 使用 ） Alexaapi/Volume_legacy（英语：Alexaapi/Volume_legacy） 现在有了这个widget），它变成了：

（现为Alexaapi/Volume）

足迹与每个人的个性化设计兼容是相同的。

自定义 widget

widget是完全可定制的，只需使用widget变量 努斯莱德， 一个Doc是可用的所有 可选参数.

默认情况下，发送的参数是：

  • 显示值 = "0.20,40,60,80,100"
  • 步骤=10
  • 宽度=200
  • 身高=50
  • 处理大小=15
  • 光标LeftPos =50
  • CursorTopPos = 88
  • 默认情况下未设置的顶部参数，cf略低一点。

要自定义 widget，您可以将参数添加为 可选的 Widget 设置 "Volume" 动作命令，例如：

返回到以前的 Widget

如果你想保留旧的widget，不要惊慌，它仍然在插件中。 选择 Volume_legacy

改进的widget布局

可以使用一个顶部参数来设置部件的顶部间距, 规定如下就足够了：

删除扬声器徽标

如果从之前版本的插件中继承的小型扬声器徽标表示声音，则会打扰您：

不要惊慌，它很容易删除它，去你的设备，然后在命令中，点击这个小标志在左边，它会消失并保存。 他不再在这里了。 （如果出现"Volume"，请在Widget选项中取消"显示名称"）

信息 穆特

新的信息到达Alexa设备小部件。 这就是信息 静音 静音 当Alexa被告知： Alexa 剪掉声音.

发表 回复