Descoberta e Conexão
Esta seção agrupa os comandos responsáveis por localizar automaticamente as antenas veiculares na rede local e estabelecer conexões com esses dispositivos. Esses comandos são fundamentais durante o processo de instalação, configuração inicial ou manutenção, permitindo que o sistema identifique, autentique e se conecte corretamente às antenas disponíveis na rede.
1. Localizar Antenas na Rede
Descrição:
Permite localizar antenas de tags veiculares na rede local utilizando o protocolo UDP. Esse comando é útil para descobrir dispositivos na rede, retornando informações como endereço IP, modelo, versão do firmware, endereço MAC e portas.
POST /api/v1/vehicleAntennas/discoveries: Localiza antenas de tags veiculares na rede local. Esse método é ideal para a configuração inicial ou para verificar a presença de dispositivos na rede.
Quando Usar:
Durante a configuração inicial do sistema.
Para verificar a presença de antenas na rede.
Localizar a antena de tag veicular na rede local via UDP
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Endereço IP para qual a antena deverá responder
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a localização ocorrer com sucesso
Quando ocorrer erro
2. Conectar a antena de tag veicular (por Instância)
Descrição:
Permite estabelecer uma conexão com uma antena de tag veicular especificando o endereço IP e a porta. Após a conexão, a antena estará pronta para interagir com os demais endpoints do sistema.
POST /api/v1/vehicleAntennas/connections: Estabelece uma conexão com uma antena sem que ela esteja previamente cadastrada no sistema.
Quando Usar:
Após localizar a antena na rede.
Para garantir que a antena esteja pronta para receber comandos subsequentes.
Conectar a 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"
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a conexão ocorrer com sucesso
Quando ocorrer erro
3. Reiniciar a antena de tag veicular (por Instância)
Descrição:
Reinicia a antena com base em uma instância de conexão específica.
POST /api/v1/vehicleAntennas/instances/{id}/restarts
Quando Usar:
Recomendado quando há múltiplas conexões possíveis e a reinicialização deve ser direcionada a uma instância específica de uso da antena.
Reiniciar a 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 ocorrer com sucesso
Quando ocorrer erro
4. Desconectar Antena (por Instância)
Descrição:
Encerra a conexão com uma antena específica, com base no identificador da instância ativa da conexão.
POST
/api/v1/vehicleAntennas/instances/{id}/disconnections
Quando Usar:
Quando é necessário interromper a comunicação com uma antena conectada por meio de sua instância de conexão (por exemplo, para reconfigurações ou substituições).
Desconectar a 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 ocorrer com sucesso
Quando ocorrer erro
5. Conectar a antena de tag veicular (por ID)
Descrição:
Estabelece uma conexão com uma antena já cadastrada no sistema, utilizando o seu id. Após a conexão, a antena estará pronta para receber comandos e interagir com os demais módulos.
POST /api/v1/vehicleAntennas/{id}/connections: Conecta-se à antena identificada peloid.
Quando Usar:
Após o cadastro da antena.
Para inicializar a comunicação com o dispositivo.
Antes de executar comandos como envio de programação, leitura de dados ou eventos.
Conectar a antena de tag veicular por id
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 conexão ocorrer com sucesso
Quando ocorrer erro
6. Reiniciar a antena de tag veicular (por ID)
Descrição:
Reinicia a antena de tag veicular informada pelo ID cadastrado.
POST /api/v1/vehicleAntennas/{id}/restarts
Quando Usar:
Use quando for necessário forçar uma reinicialização da antena por motivos de falha, lentidão ou atualização de parâmetros de configuração.
Reiniciar a 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 ocorrer com sucesso
Quando ocorrer erro
7. Desabilitar Antena (por ID)
Descrição:
Desconecta a antena de tag veicular informada pelo seu ID.
POST/api/v1/vehicleAntennas/{id}/disconnections
Quando Usar:
Quando a antena for desinstalada fisicamente.
Para evitar que o sistema tente se comunicar com dispositivos inativos.
Para manter o ambiente limpo e atualizado.
Desconectar a antena de tag veicular por id
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 ocorrer com sucesso
Quando ocorrer erro
Atualizado