Guia de conversor de casa inteligente
action.devices.types.SETTOP: as interações com o distribuidor de programação de vídeo multicanal (MVPD) e os conversores podem incluir o controle da reprodução de mídia.
Esse tipo indica que o dispositivo recebe o ícone do conversor e alguns relacionados sinônimos e aliases.
Recursos do dispositivo
Consulte a documentação de característica correspondente para detalhes da implementação, como atributos e estados aos quais seu serviço precisa oferecer suporte, e instruções para criar respostas EXECUTE e QUERY.
Características obrigatórias
Essas características e comandos são obrigatórios, se aplicáveis ao seu
dispositivo. Se seu dispositivo não for compatível com essas características, insira o código de erro de
functionNotSupported em uma resposta de QUERY ou EXECUTE. Consulte
Consulte o artigo Erros e exceções para mais informações.
| Características | Comandos |
|---|---|
action.devices.traits.AppSelector |
|
action.devices.traits.InputSelector |
|
action.devices.traits.MediaState |
|
action.devices.traits.OnOff |
|
action.devices.traits.TransportControl |
|
action.devices.traits.Volume |
|
Características recomendadas
Essas características são recomendadas, se aplicáveis ao seu dispositivo. No entanto, você pode misturar e combinar todas as características disponíveis para combinar melhor com suas a funcionalidade do produto.
Requisitos de qualidade
- Latência:precisa ser menor ou igual a 3.000 ms.
- Confiabilidade:precisa ser maior ou igual a 97%.
Exemplo de dispositivo: conversor simples
Esta seção contém exemplos de payloads de intents que representam um conversor com base no tipo de dispositivo e nas características acima. Se você adicionar ou remover características na sua implementação, modifique suas respostas de acordo com essas alterações.
Exemplo de resposta SYNC
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}
{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.SETTOP",
"traits": [
"action.devices.traits.OnOff",
"action.devices.traits.AppSelector",
"action.devices.traits.MediaState",
"action.devices.traits.Channel",
"action.devices.traits.TransportControl"
],
"name": {
"name": "Simple set-top box"
},
"willReportState": true,
"attributes": {
"transportControlSupportedCommands": [
"NEXT",
"PREVIOUS",
"PAUSE",
"STOP",
"RESUME",
"CAPTION_CONTROL"
],
"availableApplications": [
{
"key": "youtube",
"names": [
{
"name_synonym": [
"Youtube",
"Youtube_en"
],
"lang": "en"
}
]
}
],
"availableChannels": [
{
"key": "ktvu2",
"names": [
"Fox",
"KTVU"
],
"number": "2"
},
{
"key": "abc1",
"names": [
"ABC",
"ABC East"
],
"number": "702.4-11"
}
],
"supportActivityState": true,
"supportPlaybackState": true
},
"deviceInfo": {
"manufacturer": "smart-home-inc",
"model": "hs1234",
"hwVersion": "3.2",
"swVersion": "11.4"
}
}
]
}
}
Exemplo de resposta de QUERY
{
"requestId": "6894439706274654514",
"inputs": [
{
"intent": "action.devices.QUERY",
"payload": {
"devices": [
{
"id": "123"
}
]
}
}
]
}
{
"requestId": "6894439706274654514",
"payload": {
"devices": {
"123": {
"status": "SUCCESS",
"online": true,
"on": true,
"currentApplication": "youtube",
"activityState": "ACTIVE",
"playbackState": "PAUSED"
}
}
}
}
Exemplos de comandos EXECUTE
OnOff
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.OnOff
de referência.
{
"requestId": "6894439706274654528",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.OnOff",
"params": {
"on": true
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654528",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"on": true
}
}
]
}
}
appInstall
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.AppSelector
de referência.
{
"requestId": "6894439706274654522",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.appInstall",
"params": {
"newApplication": "youtube"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654522",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentApplication": "youtube"
}
}
]
}
}
appSearch
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.AppSelector
de referência.
{
"requestId": "6894439706274654524",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.appSearch",
"params": {
"newApplication": "youtube"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654524",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentApplication": "youtube"
}
}
]
}
}
appSelect
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.AppSelector
de referência.
{
"requestId": "6894439706274654526",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.appSelect",
"params": {
"newApplication": "youtube"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654526",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentApplication": "youtube"
}
}
]
}
}
selectChannel
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.Channel
de referência.
{
"requestId": "6894439706274654516",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.selectChannel",
"params": {
"channelCode": "ktvu2"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654516",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true
}
}
]
}
}
relativeChannel
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.Channel
de referência.
{
"requestId": "6894439706274654518",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.relativeChannel",
"params": {
"relativeChannelChange": 1
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654518",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true
}
}
]
}
}
returnChannel
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.Channel
de referência.
{
"requestId": "6894439706274654520",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.returnChannel"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654520",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true
}
}
]
}
}
mediaClosedCaptioningOff
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.TransportControl
de referência.
{
"requestId": "6894439706274654530",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaClosedCaptioningOff"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654530",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PLAYING"
}
}
]
}
}
mediaClosedCaptioningOn
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.TransportControl
de referência.
{
"requestId": "6894439706274654532",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaClosedCaptioningOn",
"params": {
"closedCaptioningLanguage": "en"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654532",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PLAYING"
}
}
]
}
}
mediaNext
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.TransportControl
de referência.
{
"requestId": "6894439706274654534",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaNext"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654534",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "FAST_FORWARDING"
}
}
]
}
}
mediaPause
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.TransportControl
de referência.
{
"requestId": "6894439706274654536",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaPause"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654536",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PAUSED"
}
}
]
}
}
mediaPrevious
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.TransportControl
de referência.
{
"requestId": "6894439706274654538",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaPrevious"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654538",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "REWINDING"
}
}
]
}
}
mediaResume
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.TransportControl
de referência.
{
"requestId": "6894439706274654540",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaResume"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654540",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PLAYING"
}
}
]
}
}
mediaStop
Para mais detalhes sobre os parâmetros de comando,
consulte a
action.devices.traits.TransportControl
de referência.
{
"requestId": "6894439706274654542",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaStop"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654542",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "STOPPED"
}
}
]
}
}