Giter VIP home page Giter VIP logo

iot_alert_panel's Introduction

IOT Panel

Stack

  • Ruby 2.6.3
  • Rails 5.2.3
  • Postgresql 12

Sobre o projeto

Painel de cadastro para gerência de dispositívos de monitoração é em si um CRUD simples, com uma API com dois endpoints que estão descritos mais abaixo. A principal feature desse painel é a geração de alertas automatizados usando o grafana e o twilio. A ideia é que seja um sistema acoplável com qualquer datasource aceito pelo grafana.

Toda configuração do grafana é feita de maneira declarativa para alterar suas configurações, você deve alterá-las diretamente nos arquivos. Dentro da pasta grafana temos os seguintes arquivos e pastas:

  • dashboards - pasta com as dashboards em si, que são gerados pelo painel;

  • provisioning - pasta com arquivos de configurações;

  • provisioning/dashboards/all.yml - config da localização das pastas dos dashboards;

  • provisioning/datasources/influx.yml - modelo para configuração do datasource, no exemplo é usado o influx, mas você pode usar qualquer um que seja aceito pelo grafana;

  • provisioning/notifiers/api.yml - pasta com arquivos de configurações;

Também temos a configuração inicial config.ini, o Dockerfile, e o model.json, que é o modelo de dashboard padrão, mude esse arquivo conforme sua necessidade.

Instalação

IMPORTANTE: Antes de subir o projeto remova o .sample do arquivo config/twilio.yml.sample e configure suas chaves do twilio.

  • git clone [email protected]:matheusam/iot_alert_panel.git
  • cd iot_alert_panel
  • Para iniciar os serviços
  • docker-compose build && docker-compose up
  • Para acessar o container web
  • docker-compose exec web bash
  • Para rodar os testes
  • bundle exec rspec

O servidor web estará disponível na porta 80 e o grafana na porta 8080.

API

Consulta

Consulta um MAC, e deve ser retornado o nome e telefone no cadastro. e.g:

curl http://localhost/api/v1/search/<MAC_ADDRESS>

Alertas

Para gerar alertas por SMS envie um post com o MAC do dispositívo. e.g:

curl -d "mac=<MAC_ADDRESS>" http://localhost/api/v1/alert

iot_alert_panel's People

Contributors

dependabot[bot] avatar msbjx5 avatar the-harry avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

iot_alert_panel's Issues

Arrumar a edição

O sistema de edição de dashboards funciona local, mas remoto não funciona as vezes.

Atualizar docs

Incluir descrição mais detalhada sobre o projeto, e a api.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.