TEMPLATE - Exchange

O módulo Exchange permite ao cliente integrar as informações coletadas e presentes no WEG Motion Fleet Management em seu próprio sistema de gestão e/ou plataformas.

Por meio de requisições de dados periódicas e automáticas do tipo Web Service REST, os dados do WEG Motion Fleet Management são enviados ao sistema do cliente ou de terceiros.

Para usufruir da camada Exchange, é necessário que o(s) respectivo(s) ativo(s) possua(m) assinatura da camada Management ativa. As assinaturas Exchange são anuais e por pacote de dados.

Este template tem como objetivo demonstrar a utilização do módulo Exchange e estão em seu escopo:

  • Descrever as etapas de criação de assinatura.
  • Demonstrar como se autenticar na API.
  • Informar sobre endpoints da API.
  • Montrar Resumo dos comandos disponíveis.
  • Fornecer casos de uso comuns da API, para servir como o ponto de partida dos projetos do usuário, como:
    • Listar todos os dispositivos;
    • Listar o relatório completo de 10 dispositivos;
    • Listar os alarmes ativos para os 10 dispositivos acima;

E tudo isso sendo demonstrado através dos próprios recursos do Wegnology e suas ferramentas low code para fazer as chamadas para a API do Exchange.

Componentes chave

  • Experience Workflow:

    • TemplateMFMExchange: É neste workflow que as implementações dos endpoints usados neste template estão localizadas. Demonstra a utilização de custom nodes que fazem consultas ao WEG Motion Fleet Exchange.
  • Dashboard:

    • TemplateMFMExchange: Consome os endpoints implementados no workflow mencionado acima. A partir dos resultados obtidos, uma tabela será montada e apresentada ao usuário em cada caso.
  • Custom Nodes:

    • AlarmsAndSensors: Busca informações dos dispositivos de um cliente e organiza a apresentação dos dados obtidos para mostrar os alarmes e dados dos sensores de cada dispositivo.
    • Auth: Retorna um token de autorização associado ao usuário, que é usado em todas as outras requisições.
    • CustomersSites: Retorna todos os sites associados ao cliente.
    • DeviceEvents: Retorna todos os eventos associados a um determinado dispositivo.
    • DeviceInformation: Retorna todas as informações do dispositivo.
    • DeviceSensors: Retorna informações dos sensores associados ao dispositivo.
    • Devices: Retorna informações dos dispositivos de um cliente e organiza a resposta por hierarquia: mostra os sites, dentro deles mostra as plantas e, dentro delas, mostra seus dispositivos.
    • PlantDevices: Retorna todos os dispositivos associados à planta do cliente.
    • SensorTimeSeries: Retorna o time series do sensor.
    • SitePlants: Retorna todas as plantas associadas com o site do cliente.

Configuração

  1. Certifique-se de possuir a estrutura completa: Cliente → Site → Planta → Device → Sensor, pois sem ela este template não funcionará!
  2. Habilite o workflow TemplateMFMExchange.
  3. Siga as instruções do dashboard mfmExchangeReadMe. Se você já tiver feito isso, pule para a etapa 3.
  4. Aproveite o dasboard ‘template’.

Documentação adicional

Aqui estão alguns recursos que desenvolvedores novos e experientes podem achar úteis:

Estatísticas sobre a aplicação (contagens de dispositivo e payloads) podem ser encontradas nas configurações da aplicação.

Sobre

Este template está na versão 1.0.0.

Para esclarecer qualquer dúvida, recomendamos fortemente o uso do fórum.

Copyright © 2021 WEG SA. Todos os direitos reservados.

Licenciado sob a licença MIT.

https://www.weg.net

logoMFM

TEMPLATE-Exchange.zip (2.0 MB)

1 Curtida