Diff: fw.h

Revision:

114:472502b31a12

Parent:

113:db67ae00550e

Child:

116:39a41ebb675c

--- a/fw.h	Thu Apr 16 12:57:13 2015 +0000
+++ b/fw.h	Mon Apr 20 14:40:09 2015 +0000
@@ -3,7 +3,7 @@
 
 #include "mbed.h"
 #include "EthernetInterface.h"
-#include "vz_protocol.h" // for CB_BUFFER_SIZE
+#include "vz_protocol.h" // for __CB_BUFFER_SIZE__
 #include "utils.h" // for itoa();
 #include "debug.h" // for [ en | dis ]able debugs
 
@@ -14,9 +14,8 @@
 #define __FW_HEADER_PORT__ 9482 
 ///< Estabelece a porta default da Header, de onde os pacotes de telemetria são enviados.
 
-#define __FW_SIZE__ CB_BUFFER_SIZE
+#define __FW_SIZE__ __CB_BUFFER_SIZE__
 
-extern uint16_t miss_fw_send_pkg;
 
 /**
  * @Synopsis 
@@ -28,6 +27,23 @@
  */
 void re_start_fw( void );
 
+/**
+ * @Synopsis Responsavel por formatar e enviar o pacote de telemetria para o servidor de interesse.
+ *
+ * @param ext Ramal do CBx emissor do pacote de telemetria.
+ * @param port Porta do CBx emissor do pacote de telemetria.
+ * @param data Vetor contendo os dados de telemetria em si.
+ *
+ * Exemplo:
+ * @code
+ * ...
+ *  ext = 5160;
+ *  port = 5060;
+ *  //assumindo que data_from_cb contém os dados vindos do Call_box.
+ *  build_telemetry_report( ext, port, ( char * )data_from_cb );
+ * ...
+ * @endcode
+ */
 void fw_cbx_pkg( int ext, int port, char * data );
 
 extern UDPSocket fw_sock;