Skip to content

Commit e44511e

Browse files
committed
Mais comentários para tornar o arquivo a raiz da documentação.
1 parent a5f469f commit e44511e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CristalLiq-serial/CristalLiq-serial.ino

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,34 @@
1717
* Outras aplicações podem definir outros modelos de mensagens nos quadros do protocolo.
1818
*/
1919

20+
/**
21+
* @mainpage Módulo Arduino - CristalLiq
22+
*
23+
* @section intro_sec Introdução
24+
* Este projeto implementa a comunicação entre o display de cristal líquido
25+
* e o Arduino via porta serial, utilizando a classe `Frame` para estruturar
26+
* mensagens.
27+
*
28+
* @section features_sec Funcionalidades
29+
* - Exibição de mensagens em display LCD 4 linhas.
30+
* - Emissão de sinais sonoros via buzzer.
31+
* - Recepção de comandos da TV-Box através de protocolo serial.
32+
*
33+
* @section arch_sec Arquitetura
34+
* O sistema é dividido em:
35+
* - `CristalLiq-serial.ino`: ponto de entrada e lógica principal.
36+
* - `frame.h/.cpp`: implementação da classe Frame.
37+
* - `SerialProtocol`: abstração do protocolo de comunicação.
38+
*
39+
* @section usage_sec Uso
40+
* 1. Carregue o código no Arduino Nano.
41+
* 2. Conecte o display LCD e o buzzer conforme o diagrama de hardware.
42+
* 3. Estabeleça a comunicação serial via USB com a TV-Box.
43+
*
44+
* @section img_sec Diagrama
45+
* ![Arquitetura do Módulo](img/arquitetura.png)
46+
*/
47+
2048
#include <Wire.h> // Biblioteca utilizada para fazer a comunicação com o I2C
2149
#include <LiquidCrystal_I2C.h> // Biblioteca utilizada para fazer a comunicação com o display 20x4
2250
#include "frame.h"

0 commit comments

Comments
 (0)