X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=server%2Fsensor.h;h=0285252dd0760167f412e96859e0f1a25781a167;hb=f486831f971d51f983a65b734ebd5af2b598d136;hp=e51ab0c5579e7abd0fc2424cb5463044a69c038d;hpb=72077d49c8dcf079d52a266717a8bda9db9db0ab;p=matches%2FMCTX3420.git

diff --git a/server/sensor.h b/server/sensor.h
index e51ab0c..0285252 100644
--- a/server/sensor.h
+++ b/server/sensor.h
@@ -1,60 +1,87 @@
-
 /**
  * @file sensor.h
- * @purpose Declarations for sensor thread related stuff
+ * @brief Declarations for sensor thread related stuff
  */
 
-
-
 #ifndef _SENSOR_H
 #define _SENSOR_H
 
-#include "common.h"
+#include "data.h"
+#include "device.h"
 
-/** Number of data points to keep in sensor buffers **/
-#define SENSOR_DATABUFSIZ 10
 
-/** Number of sensors **/
-#define NUMSENSORS 1
+/** 
+ * Maximum number of sensors program can be compiled with
+ * (If you get an error "Increase SENSORS_MAX from %d" this is what it refers to)
+ */
+#define SENSORS_MAX 10
+extern int g_num_sensors; // in sensor.c
 
-#define FILENAMESIZE 10
 
-/** Structure to represent data recorded by a sensor at an instant in time **/
+/** Structure to define the warning and error thresholds of the sensors **/
+//TODO: Replace with a call to an appropriate "Sanity" function? (see the actuator code)
 typedef struct
 {
-	/** Time at which data was taken **/
-	float time;
-	/** Value of data **/
-	float value;
-} DataPoint;
+	/** Maximum safe value **/
+	double max_error;
+	/** Minimum safe value **/
+	double min_error;
+	/** Maximum value before a warning is reported **/
+	double max_warn;
+	/** Minimum value before a warning is reported **/
+	double min_warn;
+} SensorThreshold;
 
 /** Structure to represent a sensor **/
 typedef struct
 {
 	/** ID number of the sensor **/
-	enum {SENSOR_TEST0=0, SENSOR_TEST1=1} id;
-	/** Buffer to store data from the sensor **/
-	DataPoint buffer[SENSOR_DATABUFSIZ];
-	/** Index of last point written in the data buffer **/
-	int write_index;
-	/** Offset position in binary file for query thread to read from**/
-	int read_offset;
-	/** File to write data into when buffer is full **/
-	char filename[FILENAMESIZE];
-	/** Thread running the sensor **/
+	int id;
+	/** User defined ID number **/
+	int user_id;
+	/** 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;
+	/** Function to read the sensor **/
+	ReadFn read;
+	/** Function to initialise the sensor **/
+	InitFn init;
+	/** Function to cleanup the sensor **/
+	CleanFn cleanup;
+	/** Function to sanity check the sensor readings **/
+	SanityFn sanity;
+	/** Human readable name of the sensor **/
+	const char * name;
+	/** Sampling rate **/
+	int sample_us;
+	/** Number of averages per sample **/
+	int averages;
+
 
 	
 } Sensor;
 
-/** Array of Sensors **/
-extern Sensor g_sensors[];
 
-extern void Sensor_Init(Sensor * s, int id); // Initialise sensor
-extern void * Sensor_Main(void * args); // main loop for sensor thread; pass a Sensor* cast to void*
+
+extern void Sensor_Init(); // One off initialisation of *all* sensors
+extern void Sensor_Cleanup(); // Cleanup all sensors
+
+extern void Sensor_SetModeAll(ControlModes mode, void * arg);
+extern void Sensor_SetMode(Sensor * s, ControlModes mode, void * arg);
+
+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 Sensor * Sensor_Identify(const char * str); // Identify a Sensor from a string
+
+extern void Sensor_Handler(FCGIContext *context, char * params); // Handle a FCGI request for Sensor data
+
+extern const char * Sensor_GetName(int id);
+
 
 
 #endif //_SENSOR_H
 
+