Diff: headers/globals.h

Revision:

5:0c7d131e6089

Parent:

3:f20e114eb2ee

Child:

10:e8b66718a103

diff -r 9e98e7679a62 -r 0c7d131e6089 headers/globals.h
--- a/headers/globals.h	Tue Oct 04 16:52:21 2016 +0000
+++ b/headers/globals.h	Thu Oct 06 07:58:31 2016 +0000
@@ -1,12 +1,34 @@
-// *************
-// * globals.h *
-// *************
-//
-// Created: 2015/03/19
-// By: Damien Frost
-//
-// Description:
-// Provides global definitions.
+/**
+* @author Damien Frost
+*
+* @section LICENSE
+*
+*   Copyright (c) 2016 Damien Frost
+*
+*   Permission is hereby granted, free of charge, to any person obtaining a copy
+*   of this software and associated documentation files (the "Software"), to deal
+*   in the Software without restriction, including without limitation the rights
+*   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+*   copies of the Software, and to permit persons to whom the Software is
+*   furnished to do so, subject to the following conditions:
+*
+*   The above copyright notice and this permission notice shall be included in
+*   all copies or substantial portions of the Software.
+*
+*   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+*   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+*   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+*   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+*   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+*   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+*   THE SOFTWARE.
+*
+* @file "globals.h"
+*
+* @section DESCRIPTION
+*   Global definitions for the Internet of Things example.
+*
+*/
 
 #ifndef IQ_GLOBALS_H
 #define IQ_GLOBALS_H
@@ -26,21 +48,22 @@
 #define WS_PORT     4444
 #define SERVER_IP "192.168.1.99"
 
-extern char* wifissid;
-extern char* wifipassword;
-
+// Hardware:
 extern Serial          pc;
 extern InterruptIn     UIBut1;
 extern Timer           DisplayTimer;
 extern DigitalOut      Led;
 
-extern WiflyInterface eth;
-
+// Variables:
 extern int ReconnectAttempts;
 extern int SendCounter;
 extern int IoT_ID;
 extern float TempSensor;
+extern char* wifissid;
+extern char* wifipassword;
 
+// Communication:
+extern WiflyInterface eth;
 extern Websocket ws;
 
 // Functions:
@@ -54,7 +77,7 @@
 int SetupNetwork(int Tries);
 bool ConnectToServer(int Tries);
 void SendNetworkData(void);
-void ReceiveNetworkData(unsigned int * wifi_cmd, unsigned int * var, float * value);
+void ReceiveNetworkData(unsigned int * wifi_cmd, float * value);
 void ModifyVariable(unsigned int wifi_var, float wifi_data);