Relés
Os relés nas antenas de tags veiculares são responsáveis por acionar mecanismos físicos, como cancelas e portões, após uma leitura válida de tag. Esta seção permite o envio de comandos para abertura simples, abertura vinculada a dispositivos e alternância (toggle) do estado do relé. Os comandos podem ser feitos tanto por instância ativa quanto por ID de dispositivo.
1. Atualizar Abertura do Relé (por Instância)
Descrição:
Envia um comando direto de abertura do relé da antena via instância ativa. Esse comando é utilizado para realizar testes ou liberar passagem manualmente.
POST /api/v1/vehicleAntennas/instances/{id}/relays
Quando Usar:
Para testes durante a instalação.
Para liberações manuais sem uso de tag.
relay
int
Relé a ser acionado. Valores possíveis:
• 1 - Relé 1
• 2 - Relé 2
• 3 - Ambos os relés
seconds
int
Tempo de acionamento do relé. Valores possíveis:
• 0 - Tempo padrão configurado no equipamento
• 1-254 - Tempo em segundos
• 255 - Modo Toggle (Liga/Desliga)
Atualizar abertura do relé da antena de tag veicular por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a atualização ocorrer com sucesso
Quando ocorrer erro
2. Acionar o relé da antena conectada em modo simplificado (por Instância)
Descrição:
Este endpoint envia um comando para a antena disparar o relé usando uma configuração simplificada, ideal para testes, acionamentos manuais ou processos automatizados com baixa complexidade.
POST /api/v1/vehicleAntennas/instances/{id}/relays/easy
Quando Usar:
Para abrir uma cancela ou porta remotamente, via API
Em testes de integração com o hardware controlado pela antena
Para acionamentos de curta duração com configuração pré-definida
relay1
boolean
Relé a ser acionado. Valores possíveis: • relay1: true/false
relay2
boolean
Relé a ser acionado. Valores possíveis: • relay2: true/false
timeSeconds
int
Tempo de acionamento do relé. Valores possíveis:
• 0 - Tempo padrão configurado no equipamento
• 1-254 - Tempo em segundos
• 255 - Modo Toggle (Liga/Desliga)
Atualizar abertura do relé (simplificado) da antena de tag veicular por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a atualização ocorrer com sucesso
Quando ocorrer erro
3. Atualizar Abertura do Relé (por ID)
Descrição:
Envia um comando de abertura utilizando o ID da antena cadastrada, sem necessidade de conexão ativa.
POST /api/v1/vehicleAntennas/{id}/relays
Quando Usar:
Em comandos remotos feitos por sistemas externos.
Quando o dispositivo não está conectado diretamente.
relay
int
Relé a ser acionado. Valores possíveis:
• 1 - Relé 1
• 2 - Relé 2
• 3 - Ambos os relés
seconds
int
Tempo de acionamento do relé. Valores possíveis:
• 0 - Tempo padrão configurado no equipamento
• 1-254 - Tempo em segundos
• 255 - Modo Toggle (Liga/Desliga)
Atualizar abertura do relé da antena de tag veicular
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da antena de tag veicular
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a atualização ocorrer com sucesso
Quando ocorrer erro
4. Acionar o relé da antena de forma simplificada (por ID)
Descrição:
Este endpoint envia um comando padronizado para a antena identificada por ID acionar seu relé, utilizando o modo "Easy", que não exige configuração de parâmetros avançados.
POST /api/v1/vehicleAntennas/{id}/relays/easy
Quando Usar:
Para acionar relé de uma antena remota identificada por ID, sem depender de conexão direta
Em sistemas automatizados, quando se quer apenas um disparo rápido do relé
Para testes simples de acionamento em antenas registradas
relay1
boolean
Relé a ser acionado. Valores possíveis: • relay1: true/false
relay2
boolean
Relé a ser acionado. Valores possíveis: • relay2: true/false
timeSeconds
int
Tempo de acionamento do relé. Valores possíveis:
• 0 - Tempo padrão configurado no equipamento
• 1-254 - Tempo em segundos
• 255 - Modo Toggle (Liga/Desliga)
Atualizar abertura do relé (simplificado) da antena de tag veicular
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da antena de tag veicular
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a atualização ocorrer com sucesso
Quando ocorrer erro
Atualizado