Merge branch 'master' of https://github.com/szmoore/MCTX3420.git

[matches/MCTX3420.git] / server / sensor.h

diff --git a/server/sensor.h b/server/sensor.h
index 4c9de1b..182d8ae 100644 (file)
--- a/server/sensor.h
+++ b/server/sensor.h
@@ -6,71 +6,63 @@
 #ifndef _SENSOR_H
 #define _SENSOR_H
 
-/** Number of data points to keep in sensor buffers **/
-#define SENSOR_DATABUFSIZ 10
-/** Size of the query buffer. @see Sensor_Handler **/
-#define SENSOR_QUERYBUFSIZ 10
+#include "data.h"
 
 /** Number of sensors **/
-#define NUMSENSORS 4
+#define NUMSENSORS 8
 
-/** Safety Values for sensors **/
-#define ANALOG_TEST0_SAFETY 1000
-#define ANALOG_TEST1_SAFETY 1000
-#define DIGITAL_TEST0_SAFETY 1
-#define DIGITAL_TEST1_SAFETY 1
-
-
-typedef enum SensorId {
+/** Sensor ids - there should be correspondence with the names in g_sensor_names **/
+typedef enum SensorId 
+{
        ANALOG_TEST0,
        ANALOG_TEST1,
+       ANALOG_REALTEST,
+       ANALOG_FAIL0,
        DIGITAL_TEST0,
-       DIGITAL_TEST1
+       DIGITAL_TEST1,
+       DIGITAL_REALTEST,
+       DIGITAL_FAIL0
 } SensorId;
 
 /** Human readable names for the sensors **/
 extern const char * g_sensor_names[NUMSENSORS];
 
-/** Structure to represent data recorded by a sensor at an instant in time **/
-typedef struct
-{
-       /** Time at which data was taken **/
-       double time_stamp; 
-       /** Value of data **/
-       double value;
-} DataPoint;
-
 /** Structure to represent a sensor **/
 typedef struct
 {
        /** ID number of the sensor **/
        SensorId id;
-       /** Buffer to store data from the sensor **/
-       DataPoint buffer[SENSOR_DATABUFSIZ];
-       /** Index of last point written in the data buffer **/
-       int write_index;
-       /** Number of points read **/
-       long points_read;
-       /** Binary file to write data into when buffer is full **/
-       FILE * file;
-       /** Thread running the sensor **/
+       /** DataFile to store sensor values in **/
+       DataFile data_file;
+       /** Indicates whether the Sensor is active or not **/
+       bool activated;
+       /** Thread the Sensor is running in **/
        pthread_t thread;
-       /** Mutex to protect access to stuff **/
-       pthread_mutex_t mutex;
-
-       
+       /** Most recently recorded data **/
+       DataPoint newest_data;
 } Sensor;
 
+// Structure to define the warning and error thresholds of the sensors
+typedef struct
+{
+       double max_error;
+       double min_error;
+       double max_warn;
+       double min_warn;
+} SensorThreshold;
 
+extern void Sensor_Init(); // One off initialisation of *all* sensors
 
+extern void Sensor_SetModeAll(ControlModes mode, void * arg);
+extern void Sensor_SetMode(Sensor * s, ControlModes mode, void * arg);
 
-extern void Sensor_Spawn(); // Initialise sensor
-extern void Sensor_Join(); //Join sensor threads
-extern void * Sensor_Main(void * args); // main loop for sensor thread; pass a Sensor* cast to void*
-
-extern int Sensor_Query(Sensor * s, DataPoint * buffer, int bufsiz); // fill buffer with sensor data
+extern void * Sensor_Loop(void * args); // Main loop for a thread that handles a Sensor
+extern bool Sensor_Read(Sensor * s, DataPoint * d); // Read a single DataPoint, indicating if it has changed since the last one
+extern void Sensor_CheckData(SensorId id, double value); // Check a DataPoint
+extern Sensor * Sensor_Identify(const char * str); // Identify a Sensor from a string Id
 
-extern void Sensor_Handler(FCGIContext *context, char * params);
+extern void Sensor_Handler(FCGIContext *context, char * params); // Handle a FCGI request for Sensor data
 
 #endif //_SENSOR_H
 
+