Comentário de várias funções, métodos e campos. Redifinido o NSR.

Author: sornii

Arquivos.cpp

@@ -2,11 +2,6 @@
 #include "SD.h"
 #include "Constants.h"
 
-// O arquivo NSR.TXT servirá para guardar e servir o
-// número sequencial de registro, para cada operação na
-// "memória de registro principal" ou "memória de
-// registro de ponto".
-
 // O arquivo ID.TXT servirá para guardar e servir o
 // número de identificação dos empregados para o
 // controle do banco de dados.
@@ -20,6 +15,7 @@ char pastaPonto [] = "PONTO/";
 
 #pragma region Private Methods
 
+/* Não usaremos mais NSR por causa do tipo de memória
 void ArquivosClass::getNsrFromFile()
 {
 	char buffer[20];
@@ -42,6 +38,13 @@ void ArquivosClass::setNsrInFile()
 	file.close();
 }
 
+void ArquivosClass::incrementNsr()
+{
+nsr += 1;
+setNsrInFile();
+}
+*/
+
 void ArquivosClass::getIdFromFile()
 {
 	char buffer[20];
@@ -70,11 +73,7 @@ void ArquivosClass::incrementId()
 	setIdInFile();
 }
 
-void ArquivosClass::incrementNsr()
-{
-	nsr += 1;
-	setNsrInFile();
-}
+
 
 void ArquivosClass::addint(int i, char* c)
 {
@@ -150,18 +149,13 @@ void ArquivosClass::init(RTC_DS1307* rtc)
 {
 	_rtc = rtc;
 
-	nsr = 0;
+	//nsr = 0;
 	id = 0;
 
-	/*
-	if (SD.exists(idFile))
-	{
-		getIdFromFile();
-	}
-	*/
-
 	SD.remove(nsrFile);
 	SD.remove(idFile);
+	
+
 
 	File file = SD.open("COLAB/");
 
@@ -188,6 +182,18 @@ void ArquivosClass::init(RTC_DS1307* rtc)
 	}
 
 	file.close();
+
+	file = SD.open("PONTO/2014/4/");
+
+	while (entry = file.openNextFile())
+	{
+		char nome[20] = "PONTO/2014/4/";
+		strcat(nome, entry.name());
+		entry.close();
+		SD.remove(nome);
+	}
+
+	file.close();
 }
 
 uint32_t ArquivosClass::getId()

Arquivos.h

@@ -7,71 +7,121 @@
 #include "SD.h"
 #include "RTClib.h"
 
-#define QUANTIDADE_ARQUIVO 8
-
-#define INCLUSAO '1'
-#define ALTERACAO '2'
-#define EXCLUSAO '3'
-
 class ArquivosClass
 {
-private:
+private: 
+
+	//uint32_t nsr;
 
-	uint32_t nsr;
+	// Variável responsável por guardar em memória
+	// o ID que está sendo usado para atribuir novos
+	// cadastros e ao mesmo tempo marcar o último
+	// ID usado para não realizar leituras toda via
+	// que precisa-lo
 	uint32_t id;
 
 	RTC_DS1307* _rtc;
 
-	/*
+	/**************************************************
 		Helpers
-	*/
+	***************************************************/
 
 	void addint(int, char*);
 
-	/*
+	/*************************************************
 		Counters
-	*/
+	**************************************************/
 
+	/* Não iremos mais ter uso nisso por causa do tipo de memória
 	void getNsrFromFile();
 	void setNsrInFile();
 	void incrementNsr();
+	*/
 
+	// Realiza a leitura do ID diretamente do arquivo
+	// gravado no SD para a memória
 	void getIdFromFile();
+
+	// Realiza a gravação do ID em memória para
+	// o arquivo no SD
 	void setIdInFile();
+
+	// Realiza um incremento no ID de memória e após
+	// realiza a gravação do mesmo no arquivo SD
 	void incrementId();
 
-	/*
+	/*************************************************
 		Others
-	*/
-
+	**************************************************/
+
+	// Formata o Mês e o Ano do objeto DateTime
+	// para um formato válido para usar na leitura
+	// dos arquivos
+	//
+	// e.g. Se o DateTime for Ano: 2014, Mês: 04
+	// o resultado será 2014/04
+	//
+	// \DateTime& Objeto do DateTime para ser usado
+	// \char* Cadeia de caracteres que recebrá o resultado
 	void getMesAno(DateTime&, char*);
-	void pastaPonto(DateTime&);
+
+	// Formata o Mês e o Ano usando a função
+	// getMesAno(DateTime&, char*); e logo em seguida
+	// o formata diretamente para a pasta do ponto
+	//
+	// e.g. PONTO/2014/04
+	//
+	// \DateTime& DateTime para ser usado como tempo
+	// \char* Cadeia de caracteres que receberá o resultado
 	void pastaPonto(DateTime&, char*);
 
-public:
+public: 
 
 	void init(RTC_DS1307*);
 
-	/*
+	/**************************************************
 		Getters and Setters
-	*/
+	***************************************************/
 
+	// Retorna o ID registrado na memória do sistema
 	uint32_t getId();
 
-	/*
+	/**************************************************
 		Colaboradores
-	*/
-
+	***************************************************/
+
+	// Realiza a inclusão do colaborador na memória
+	//
+	// \char* Parâmetro responsável pela cadeia de
+	// caracteres que representa o Colaborador para
+	// que seja feita sua inserção na memória,
+	// o formato deve ser exclusivamente da seguinte
+	// forma: <PIS>;<NOME COMPLETO>
+	//
+	// e.g. 21552284859;Igor Henrique Pereira Fontana
 	uint32_t incluirColaborador(char*);
+
 	bool consultarColaborador(char*, uint32_t);
 
+	// Marca o ponto conforme o ID recebido pela função
+	//
+	// \uint32_t ID do colaborador responsável pelo ponto
 	void marcarPonto(uint32_t);
 
-	/* 
+	/************************************************** 
 		Public Helper
-	*/
+	***************************************************/
 
+	// Lê todo o contéudo do arquivo
+	//
+	// \char* Caminho do arquivo
+	// \char* Resultado da leitura
 	void getConteudo(char*, char*);
+
+	// Lê todo o contéudo do arquivo
+	//
+	// \File* Arquivo para ser lido
+	// \char* Resultado da leitura
 	void getConteudo(File*, char*);
 };
 

Empregues.ino

@@ -30,10 +30,18 @@ EthernetUDP Udp;
 
 byte mac[] = { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED };
 
+void buzz(uint16_t tempo)
+{
+
+}
+
 void setup()
 {
 	//pinMode(BUZZER_PIN, OUTPUT);
 
+	pinMode(BUZZER_PIN, OUTPUT);
+	analogWrite(BUZZER_PIN, 200);
+
 	Serial.begin(9600);
 
 	// Quick fix
@@ -81,6 +89,8 @@ void setup()
 	contadorHora = millis();
 	contadorMensagem = millis();
 
+	digitalWrite(BUZZER_PIN, LOW);
+
 	delay(1000);
 }
 
@@ -211,6 +221,7 @@ void loop()
 
 			if (ultimoId != idcolaborador)
 			{
+				ultimoId = idcolaborador;
 				Arquivos.marcarPonto(ultimoId);
 
 				lcd.setCursor(0, 1);
@@ -220,7 +231,6 @@ void loop()
 				contadorMensagem = millis();
 
 				//Delay do ultimoId
-				ultimoId = idcolaborador;
 				contadorUltimoId = 0;
 			}
 		}

Pacote.cpp

@@ -1,5 +1,6 @@
 #include "Pacote.h"
 
+
 void Pacote::receber(EthernetClient* cliente)
 {
 	tamanho = cliente->read();
@@ -10,6 +11,7 @@ void Pacote::receber(EthernetClient* cliente)
 	buffer[tamanho] = 0;
 }
 
+
 void Pacote::enviar(EthernetClient* cliente)
 {
 	for (uint8_t i = tamanho; i > 0; i--)
@@ -21,6 +23,7 @@ void Pacote::enviar(EthernetClient* cliente)
 	cliente->write(buffer, tamanho + 2);
 }
 
+
 void Pacote::enviarNulo(EthernetClient* cliente)
 {
 	buffer[0] = 'a';
@@ -35,6 +38,8 @@ void Pacote::enviarNulo(EthernetClient* cliente)
 
 	cliente->write(buffer, tamanho + 2);
 }
+
+
 void Pacote::insertBefore(char* toInsert)
 {
 	int strInsertLength = strlen(toInsert);

Pacote.h

@@ -7,7 +7,10 @@
 #include "WProgram.h"
 #endif
 
+// Necessário para EthernetClient
 #include <Ethernet.h>
+
+// Necessário para BUFFER_SIZE
 #include "Constants.h"
 
 class Pacote
@@ -16,15 +19,40 @@ class Pacote
 
 
 public:
+	// Recebe um pacote conforme as regras do
+	// protocolo
+	//
+	// \cliente Cliente para receber o pacote
 	void receber(EthernetClient*);
+
+	// Envia o pacote conforme a atribuição
+	// dos valores do pacote em questão
+	//
+	// \cliente Cliente para enviar o pacote
 	void enviar(EthernetClient*);
+
+	// Envia um pacote nulo como sinalização
+	// de envio de vários pacotes
+	//
+	// \cliente Cliente para enviar o pacote nulo
 	void enviarNulo(EthernetClient*);
 
+	// Insere a cadeia de caracteres no começo
+	// do buffer
+	//
+	// \toInsert Cadeia de caracteres para ser
+	// inserida no buffer
 	void insertBefore(char*);
 
+	// Guarda o tipo do pacote
 	byte tipo;
+
+	// Define o tamanho do buffer a ser
+	// enviado/recebido
 	byte tamanho;
-	byte buffer[256];
+
+	// Guarda o buffer para ser enviado/recebido
+	byte buffer[BUFFER_SIZE];
 };
 
 #endif