Documentação
Tudo o que você precisa saber sobre o uso da Floox.co
Primeiros Passos
Bem-vindo a Floox.co! Esta documentação irá guiá-lo pelo processo de configuração e uso do nosso serviço de monitoramento IoT. A Floox.co fornece monitoramento em tempo real para seus dispositivos IoT com notificações inteligentes para mantê-lo informado sobre o status dos seus dispositivos.
Para começar a usar a Floox.co, você precisará:
- Entrar em contato conosco via e-mail em sales@floox.co
- Receber nosso e-mail de boas-vindas com instruções de configuração
- Registrar-se para uma demonstração usando o link fornecido
- Configurar seus grupos de dispositivos
- Configurar suas preferências de notificação
Nossa equipe está sempre disponível para ajudá-lo com quaisquer dúvidas ou problemas que você possa encontrar durante o processo de configuração.
Processo de Registro
O processo de registro é simples:
- Contato Inicial: Envie um e-mail para sales@floox.co expressando seu interesse em nosso serviço.
- E-mail de Boas-vindas: Nossa equipe responderá com um e-mail de boas-vindas contendo instruções detalhadas e um link para se registrar para uma demonstração.
- Registro para Demonstração: Siga o link para criar sua conta e acessar o ambiente de demonstração.
- Orientação de Configuração: Nossa equipe irá guiá-lo pelo processo de configuração inicial, ajudando-o a configurar seu primeiro grupo de dispositivos e adicionar seus dispositivos.
- Testes: Você poderá testar o sistema com seus dispositivos para garantir que tudo esteja funcionando corretamente.
Durante a fase de demonstração, você terá acesso a notificações do WhatsApp. Após a fase de desenvolvimento e uma semana de uso em produção, as notificações do Slack e e-mail ficarão disponíveis.
Grupos e Dispositivos
Floox.co organiza seu hardware IoT em Grupos e Dispositivos:
Grupos
Um Grupo é uma coleção de dispositivos relacionados que você deseja monitorar juntos. Os grupos ajudam você a organizar seus dispositivos logicamente, como por localização, função ou departamento.
Cada grupo:
- Pode conter até 50 dispositivos no plano básico
- Tem suas próprias configurações de notificação
Dispositivos
Um Dispositivo representa uma unidade de hardware IoT específica que você deseja monitorar. Cada Dispositivo:
- Possui um token único para autenticação
- Pode ter até 5 tags para filtragem e identificação
- Envia mensagens para o sistema Floox
Para configurar um novo Dispositivo:
- Navegue até o Grupo onde deseja adicionar o Dispositivo
- Clique em "Adicionar Novo Dispositivo"
- Salve o token único do Dispositivo para usar na configuração do seu hardware IoT
Níveis de Notificação
Floox.co suporta três níveis de notificações para ajudá-lo a priorizar problemas:
Info
Mensagens informativas que não requerem atenção imediata. Estas são tipicamente usadas para:
- Atualizações de status
- Operações bem-sucedidas
- Eventos de rotina
Aviso
Mensagens de aviso indicam problemas potenciais que podem exigir atenção, mas não são críticos. Estas são usadas para:
- Degradação de desempenho
- Aproximação de limites
- Anomalias menores
Erro
Mensagens de erro indicam problemas críticos que requerem atenção imediata. Estas são usadas para:
- Interrupções de serviço
- Falhas de hardware
- Violações de segurança
- Problemas de conectividade
Você pode configurar quais níveis de notificação acionam alertas para cada canal de comunicação (WhatsApp, Slack, E-mail).
Frequência de Notificação
Para evitar a fadiga de notificação, usamos um sistema de agregação inteligente para problemas sequenciais:
Agregação por Sequência de Fibonacci
Quando múltiplos problemas ocorrem em sequência, agregamos notificações usando um tempo baseado na sequência de Fibonacci:
- Primeiro problema: Notificação imediata
- Segundo problema: Agregado após 2 segundos
- Terceiro problema: Agregado após 3 segundos
- Quarto problema: Agregado após 5 segundos
- Quinto problema: Agregado após 8 segundos
- Sexto problema: Agregado após 13 segundos
- E assim por diante, até um máximo de 1 notificação por minuto
Esta abordagem garante que você seja notificado de problemas sequenciais urgentes sem ser sobrecarregado por notificações.
Seleção de Maior Prioridade
Quando múltiplos eventos ocorrem dentro da mesma janela de agregação, selecionamos a notificação de maior prioridade para enviar:
- Notificações de Erro têm precedência sobre Aviso e Info
- Notificações de Aviso têm precedência sobre Info
Isso garante que você sempre receba as informações mais críticas primeiro.
Limites de Mensagem
Adotamos os seguintes limites para mensagens:
Processamento de Mensagens
Não há limite para a quantidade de dados que seus dispositivos podem enviar. Processamos todas as mensagens recebidas e selecionamos a notificação de nível mais alto dentro de cada janela de um segundo para entrega.
Tamanho da Mensagem
Cada mensagem é limitada a 1024 caracteres. Este limite ajuda a garantir a entrega rápida e a legibilidade das notificações.
Nota: Planejamos melhorar os limites de tamanho de mensagem no futuro. Se você precisar testar com strings maiores, entre em contato com nossa equipe de suporte.
Armazenamento
Embora processemos todas as mensagens recebidas, armazenamos seletivamente com base no nível de prioridade. Esta abordagem nos permite manter o desempenho do sistema enquanto garantimos que você tenha acesso aos dados históricos mais importantes.
Tags de Dispositivos
Você pode adicionar até 5 tags para cada dispositivo em seu sistema. Essas tags são extremamente úteis para:
- Filtrar dispositivos no painel
- Organizar dispositivos por função, localização ou outros atributos
- Criar regras de notificação personalizadas baseadas em tags
- Gerar relatórios para categorias específicas de dispositivos
- Identificar rapidamente dispositivos durante a solução de problemas
Recomendamos usar uma estratégia de marcação consistente em toda a sua organização para maximizar os benefícios deste recurso.
Exemplo de Código
Para garantir que sua integração com Floox.co esteja funcionando corretamente, recomendamos a seguinte abordagem de teste:
Procedimento de Teste Recomendado
- Envie uma mensagem de nível Aviso ou Erro - Essas mensagens de maior prioridade são processadas imediatamente e ajudarão você a confirmar que as notificações estão sendo entregues ao seu WhatsApp.
- Teste notificações sequenciais - Envie várias mensagens em rápida sucessão para verificar se o sistema de agregação está funcionando conforme o esperado.
- Verifique o conteúdo da mensagem - Verifique se o conteúdo da mensagem está sendo exibido corretamente nas notificações.
- Teste diferentes níveis de notificação - Envie mensagens com diferentes níveis de prioridade (Info, Aviso, Erro) para garantir que o sistema esteja priorizando corretamente as notificações.
Código de Teste de Exemplo
Selecione sua linguagem de programação preferida para ver exemplos de código:
// Usando a API fetch (navegador) ou node-fetch (Node.js)
// Para Node.js, instale: npm install node-fetch
import fetch from 'node-fetch'; // Apenas necessário para Node.js
async function enviarMensagemDeTeste() {
try {
const response = await fetch('https://api.floox.co/v1/device/message', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer SEU_TOKEN_DO_DISPOSITIVO'
},
body: JSON.stringify({
level: 'error',
message: 'Esta é uma mensagem de erro de teste do meu dispositivo IoT'
})
});
const data = await response.json();
console.log('Resposta:', data);
} catch (error) {
console.error('Erro ao enviar mensagem:', error);
}
}
enviarMensagemDeTeste();
Nota: Para ambientes Node.js, você precisará instalar o pacote node-fetch. Em ambientes de navegador, a API fetch está disponível nativamente.
Se você encontrar algum problema durante o teste, entre em contato com nossa equipe de suporte para obter assistência.