Pular para o conteúdo principal

Módulos

A plataforma ION Guard é modular — funcionalidades são distribuídas em módulos que podem ser instalados, habilitados e desabilitados independentemente por site.

Módulos disponíveis

MóduloDescriçãoEscopo
SynapsysRastreamento BLE, alertas de pânico, mapa de zonas, analyticsPor site
DigiEyeIntegração com gateways DigiEye para acionamento de saídasPor site
AcceleroIntegração com controle de acesso AcceleroPor site
Câmara Fria

A Câmara Fria — monitoramento de tempo de permanência e pausas térmicas em ambientes refrigerados — é documentada como uma seção própria por ter escopo funcional extenso, mas não é um módulo independente: ela é entregue como o sub-recurso cold-room dentro do módulo Synapsys (ver Sub-recursos por site).

Gerenciamento de módulos

Acesso: Menu lateral → Módulos (/modules)

Perfil necessário

A instalação e desinstalação de módulos é exclusiva para Platform Admin. A habilitação por site também requer este perfil.

Visão geral

Grid de módulos instalados exibindo os cards (ex.: DigiEye e Synapsys)

A página de Módulos exibe um grid de cards com todos os módulos instalados. Cada card mostra:

  • Nome e identificador do módulo
  • Versão instalada
  • Descrição
  • Toggle por site — Habilitar/desabilitar para cada site

Instalar um módulo

  1. Clique em "Instalar Módulo"
  2. Selecione o arquivo do módulo (.enc, máximo 100 MB)
  3. O sistema valida, descriptografa e instala o módulo automaticamente
  4. Após a instalação, o módulo aparece no grid

O processo de instalação:

  • Valida a integridade do pacote
  • Executa migrations de banco de dados
  • Publica assets do frontend
  • Registra workers Docker (se o módulo declara processos como MQTT listeners)
  • Reinicia o PHP-FPM para carregar o novo módulo
Atenção

A instalação executa migrations de banco de dados automaticamente. Certifique-se de ter um backup recente antes de instalar módulos em produção.

Desinstalar um módulo

  1. No card do módulo, clique em "Desinstalar"
  2. Confirme a ação no diálogo

A desinstalação:

  • Verifica se existem alertas não resolvidos do módulo (bloqueia se houver)
  • Remove registros de habilitação por site
  • Remove arquivos do módulo
  • Limpa assets publicados
  • Atualiza Docker Compose (remove workers do módulo)
  • Reinicia PHP-FPM
Ação irreversível

A desinstalação remove os arquivos do módulo. Dados no banco de dados (tabelas criadas pelo módulo) são mantidos mas as migrations de remoção não são executadas automaticamente.

Habilitar/desabilitar por site

Tela de configuração do Synapsys por site, com os toggles de funcionalidades

Módulos com escopo "Por site" precisam ser habilitados individualmente para cada site:

  1. No card do módulo, localize o site desejado
  2. Use o toggle para habilitar ou desabilitar

Quando desabilitado:

  • As rotas do módulo retornam 404 para aquele site
  • Os menus do módulo desaparecem da sidebar
  • Alertas e jobs do módulo não são processados para o site
  • Dados existentes são preservados

Sub-recursos (features) por site

Além do liga/desliga do módulo inteiro, alguns módulos expõem sub-recursos que podem ser habilitados ou desabilitados individualmente por site, sem desligar o módulo. O Platform Admin ajusta esses toggles na tela de configuração do módulo; a preferência é persistida em site_modules.settings.features. Quando um site nunca configurou um sub-recurso, vale o padrão declarado pelo módulo.

O módulo Synapsys é o principal exemplo: expõe os sub-recursos panic-button (botão de pânico), asset-tracking (rastreamento de ativos) e cold-room (Câmara Fria). Desabilitar um sub-recurso remove os itens de menu e as funcionalidades correspondentes daquele site, mantendo o restante do módulo ativo.

Impacto nos menus

Módulos habilitados adicionam automaticamente itens ao menu lateral. Por exemplo, habilitar o Synapsys adiciona: Beacons, Antenas, Rastreamento, Mapa do Site e Analytics.

Desabilitar remove esses itens sem afetar os dados.