Esquema da característica OpenClose para casas inteligentes

action.devices.traits.OpenClose: essa característica pertence a dispositivos com suporte para abertura e fechamento e, em alguns casos, abertura e fechamento parcial ou potencialmente em mais de uma direção.

ATRIBUTOS do dispositivo

Dispositivos com essa característica podem informar os seguintes atributos como parte da operação SYNC. Para saber mais sobre como processar intents SYNC, consulte Fulfillment de intent.

Atributos Tipo Descrição
discreteOnlyOpenClose Booleano

Padrão: false.

Quando definido como verdadeiro, isso indica que o dispositivo precisa estar totalmente aberto ou totalmente fechado (ou seja, não oferece suporte a valores entre 0% e 100%).

openDirection Array

Lista de direções compatíveis nas quais o dispositivo pode abrir ou fechar. Inclua este atributo se o dispositivo permitir abrir e fechar em mais de uma direção.

[item, ...] String

Direção suportada.

Os valores suportados são:

UP
DOWN
LEFT
RIGHT
IN
OUT
commandOnlyOpenClose Booleano

Padrão: false.

Indica se o dispositivo é compatível com o uso de comunicação unidirecional (verdadeiro) ou bidirecional (falso). Defina esse atributo como verdadeiro se o dispositivo não puder responder a uma intent QUERY ou estado de relatório para essa característica.

queryOnlyOpenClose Booleano

Padrão: false.

Indica se o dispositivo só pode ser consultado para fornecer informações de estado e não pode ser controlado. Os sensores que só podem informar o estado aberto precisam definir esse campo como "true".

Exemplos

Dispositivo simples que permite abrir e fechar.

{
  "discreteOnlyOpenClose": true
}

Dispositivo de cima para baixo de baixo para cima. Pode ser aberto em qualquer direção.

{
  "openDirection": [
    "UP",
    "DOWN"
  ]
}

Dispositivo somente comando.

{
  "commandOnlyOpenClose": false
}

STATES do dispositivo

Entidades com essa característica podem informar os estados a seguir como parte da operação QUERY. Para saber mais sobre como processar intents QUERY, consulte Fulfillment de intent.

O payload contém uma das seguintes opções:

Abertura/fechamento em direção única

Estados Tipo Descrição
openPercent Número

Obrigatório.

Indica a porcentagem que um dispositivo está aberto, em que 0 é fechado e 100 está totalmente aberto.

targetOpenPercent Número

Nível que indica a porcentagem de abertura do dispositivo para onde o dispositivo vai ou está se movendo como resultado de uma mudança contínua de posição.

Várias direções de abertura/fechamento

Estados Tipo Descrição
openState Array

Obrigatório.

Lista de estados para cada direção aberta compatível.

[item, ...] Object

Estado atual para a direção aberta fornecida.

openPercent Número

Obrigatório.

Indica a porcentagem que um dispositivo está aberto, em que 0 é fechado e 100 está totalmente aberto.

targetOpenPercent Número

Nível que indica a porcentagem de abertura do dispositivo para onde o dispositivo vai ou está se movendo como resultado de uma mudança contínua de posição.

openDirection String

Obrigatório.

Direção em que o dispositivo é aberto.

Os valores suportados são:

UP
DOWN
LEFT
RIGHT
IN
OUT

Exemplos

Dispositivo simples que permite abrir e fechar.

{
  "openPercent": 100
}

Dispositivo simples que abre e fecha no momento em uma nova posição.

{
  "openPercent": 50,
  "targetOpenPercent": 100
}

Abra o dispositivo em 30% na direção para baixo e 50% na direção para cima.

{
  "openState": [
    {
      "openPercent": 30,
      "openDirection": "DOWN"
    },
    {
      "openPercent": 50,
      "openDirection": "UP"
    }
  ]
}

Abra o dispositivo em 30% na direção para baixo e 50% na direção para cima. Atualmente, movendo-se para 80% na direção para cima.

{
  "openState": [
    {
      "openPercent": 30,
      "openDirection": "DOWN"
    },
    {
      "openPercent": 50,
      "targetOpenPercent": 80,
      "openDirection": "UP"
    }
  ]
}

COMANDOS do dispositivo

Dispositivos com essa característica podem responder aos seguintes comandos como parte da operação EXECUTE. Para saber mais sobre como processar intents EXECUTE, consulte Fulfillment de intent.

action.devices.commands.OpenClose

Define o estado de abertura/fechamento do dispositivo.

Parâmetros

Parâmetros Tipo Descrição
openPercent Número

Obrigatório.

Indica a porcentagem que um dispositivo está aberto, em que 0 é fechado e 100 está totalmente aberto.

openDirection String

Ordem de abertura. Presente somente se o dispositivo for compatível com várias direções, conforme indicado pelo atributo openDirection, e se uma direção for especificada pelo usuário.

Os valores suportados são:

UP
DOWN
LEFT
RIGHT
IN
OUT
followUpToken String

Token fornecido pelo Google para resposta de acompanhamento.

Exemplos

Abra o dispositivo.

{
  "command": "action.devices.commands.OpenClose",
  "params": {
    "openPercent": 100,
    "followUpToken": "123"
  }
}

Abra o dispositivo 50% para baixo.

{
  "command": "action.devices.commands.OpenClose",
  "params": {
    "openPercent": 50,
    "openDirection": "DOWN",
    "followUpToken": "456"
  }
}

Ocorreu um erro ao definir o estado de abertura/fechamento do dispositivo.

Os valores suportados são:

lockedState
deviceJammingDetected

Respostas

Dispositivos com essa característica podem retornar o payload a seguir de resposta de acompanhamento como parte da operação EXECUTE. Para saber mais sobre como implementar respostas de acompanhamento, consulte Notificações para ações de casa inteligente.

O payload contém uma das seguintes opções:

Concluído

Campos Tipo Descrição
followUpToken String

Obrigatório.

Token fornecido na solicitação original para EXECUTAR.

status String

Obrigatório.

Resultado da solicitação.

Os valores suportados são:

SUCCESS
openPercent Número

Obrigatório.

Indica a porcentagem de que um dispositivo está aberto, em que 0 é fechado e 100 está totalmente aberto.

Com falha

Campos Tipo Descrição
followUpToken String

Obrigatório.

Token fornecido na solicitação original para EXECUTAR.

status String

Obrigatório.

Resultado da solicitação.

Os valores suportados são:

FAILURE
errorCode String

Obrigatório.

O valor pode ser qualquer código de erro para essa característica, por exemplo, lockedState.

Exemplos

Abra o portão da garagem. (resposta de acompanhamento para o caso de sucesso)

{
  "OpenClose": {
    "priority": 0,
    "followUpResponse": {
      "openPercent": 100,
      "status": "SUCCESS",
      "followUpToken": "1234"
    }
  }
}

Abra o portão da garagem. (resposta de acompanhamento para o caso de falha)

{
  "OpenClose": {
    "priority": 0,
    "followUpResponse": {
      "errorCode": "lockedState",
      "status": "FAILURE",
      "followUpToken": "1234"
    }
  }
}

action.devices.commands.OpenCloseRelative

Ajusta o estado de abertura/fechamento do dispositivo em relação ao estado atual. Esse comando só estará disponível se commandOnlyOpenClose estiver definido como false.

Esse comando requer os seguintes atributos:
{
  "commandOnlyOpenClose": false
}

Parâmetros

Parâmetros Tipo Descrição
openRelativePercent Número

Obrigatório.

A porcentagem exata de mudança do estado aberto/fechado. Comandos relativos ambíguos serão convertidos em um parâmetro de porcentagem exato (por exemplo, "Abrir as cortinas um pouco mais" vs. "Abrir as cortinas em 5%").

openDirection String

Ordem de abertura. Presente somente se o dispositivo for compatível com várias direções, conforme indicado pelo atributo openDirection, e se uma direção for especificada pelo usuário.

Os valores suportados são:

UP
DOWN
LEFT
RIGHT
IN
OUT

Exemplos

Abrir o dispositivo um pouco mais

{
  "command": "action.devices.commands.OpenCloseRelative",
  "params": {
    "openRelativePercent": 5
  }
}

Fechar o dispositivo 10% mais

{
  "command": "action.devices.commands.OpenCloseRelative",
  "params": {
    "openRelativePercent": -10
  }
}

Abra o dispositivo 50% mais, para baixo.

{
  "command": "action.devices.commands.OpenCloseRelative",
  "params": {
    "openRelativePercent": 50,
    "openDirection": "DOWN"
  }
}

Ocorreu um erro ao definir o estado de abertura/fechamento do dispositivo.

Os valores suportados são:

lockedState
deviceJammingDetected

Exemplos de declarações

de-DE

  • Bitte öffne die Jalousien auf 30%
  • Fensterläden um 25 % schliessen
  • Ist die Jalousie zu?
  • Mach den Rollladen zu
  • Mach die Rollos auf
  • schließe die Rollläden ein bisschen mehr
  • Öffne die Jalousien um 25%

en-US

  • Are the blinds in the kitchen open
  • Close the blinds 25% in my room
  • Close the door more
  • Just close the front door
  • open the blinds in my room
  • open the blinds to 25%
  • open the door by 25%

es-ES

  • abre la ventana del salón
  • cerrar persianas del dormitorio un 20%
  • cierra la cortina del salón
  • cierra mucho más la ventana
  • está abierta la puerta
  • quiero que subas la persiana al 25%
  • sube un 20% las persianas

fr-FR

  • baisse les stores de 10%
  • est-ce que la porte d'entrée est ouverte
  • ferme les stores
  • ferme un peu les stores
  • ouvre les stores
  • ouvre les stores de la chambre de 25%
  • ouvre les stores à 25%

hi-IN

  • कृपया 25% पर्दे को खुला रखो
  • क्या मैंने सामने वाला दरवाजा खुला छोड दिया?
  • पर्दे को 25% बंद करोगे
  • पर्दे खोलो
  • ब्लाइंड 25% खुले पर सेट कर दीजिए
  • ब्लाइंड को थोड़ा और बंद कर दिजिए
  • ब्लाइंड बंद करें

it-IT

  • abbassa un po' di più le tapparelle
  • apri la serranda
  • apri la tapparella al 30%
  • apri le serrande del 30%
  • chiudi le serrande
  • chiudi le tende del 25%
  • è aperta la porta d'ingresso

ja-JP

  • 25% ブラインド を開けて
  • 25% ブラインド を閉めてください
  • 25% ブラインド 開けて
  • ブラインド 閉めて
  • ブラインド 開けて
  • 少し ブラインド を閉じて
  • 玄関のドア は開いてますか

ko-KR

  • 살짝만 닫아 줘
  • 블라인드 25% 열어 줘
  • 블라인드 25% 까지 열어 줘
  • 블라인드 30프로 닫아
  • 블라인드 닫아 줘
  • 블라인드 열어 줘
  • 안방 문 열렸어

nl-NL

  • doe de gordijnen 25% open
  • doe de jaloezieën voor 25% dicht
  • doe het raam ietsje meer dicht
  • is de voordeur open
  • open de gordijnen
  • sluit het gordijn
  • zet de luxaflex voor 50% open

pt-BR

  • Abrir janela 50%
  • As cortinas estão abertas?
  • Fecha a persiana toda
  • Fechar a janela 10%
  • a cortina do quarto está aberta?
  • abra a persiana até 30%
  • abre as cortinas
  • abre as cortinas a 50%
  • abrir as cortinas
  • abrir as cortinas na sala em 30%
  • fecha a persiana por favor
  • fecha um bocado a janela
  • fechar as cortinas em 25%
  • fechar um pouco mais as cortinas

sv-SE

  • Dra upp persiennerna
  • Dra upp persiennerna till 25%
  • stäng persiennen i mitt rum 25%
  • stäng persiennerna
  • är ytterdörren öppen?
  • öppna persiennerna med 25%

ERROS no dispositivo

Veja a lista completa de erros e exceções.