Merge pull request #34 from Callum-/master
[matches/MCTX3420.git] / server / sensor.h
1 /**
2  * @file sensor.h
3  * @brief Declarations for sensor thread related stuff
4  */
5
6 #ifndef _SENSOR_H
7 #define _SENSOR_H
8
9 #include "data.h"
10
11 /** Number of sensors **/
12 #define NUMSENSORS 6 
13
14 typedef enum SensorId 
15 {
16         ANALOG_TEST0,
17         ANALOG_TEST1,
18         ANALOG_FAIL0,
19         DIGITAL_TEST0,
20         DIGITAL_TEST1,
21         DIGITAL_FAIL0
22 } SensorId;
23
24
25
26 /** Human readable names for the sensors **/
27 extern const char * g_sensor_names[NUMSENSORS];
28
29
30 /** Structure to represent a sensor **/
31 typedef struct
32 {
33         /** ID number of the sensor **/
34         SensorId id;
35         /** DataFile to store sensor values in **/
36         DataFile data_file;
37         /** Indicates whether the Sensor should record data **/
38         bool record_data;
39         /** Thread the Sensor is running in **/
40         pthread_t thread;
41         /** Most recently recorded data **/
42         DataPoint newest_data;
43
44 } Sensor;
45
46 // Structure to define the warning and error thresholds of the sensors
47 typedef struct
48 {
49         double max_error;
50         double min_error;
51         double max_warn;
52         double min_warn;
53 } SensorThreshold;
54
55 extern void Sensor_Init(); // One off initialisation of *all* sensors
56
57 extern void Sensor_StartAll(const char * experiment_name); // Start all Sensors recording data
58 extern void Sensor_StopAll(); // Stop all Sensors recording data
59 extern void Sensor_Start(Sensor * s, const char * experiment_name); // Start a sensor recording datas
60 extern void Sensor_Stop(Sensor * s); // Stop a Sensor from recording data
61
62
63 extern void * Sensor_Loop(void * args); // Main loop for a thread that handles a Sensor
64 extern bool Sensor_Read(Sensor * s, DataPoint * d); // Read a single DataPoint, indicating if it has changed since the last one
65 extern void Sensor_CheckData(SensorId id, double value); // Check a DataPoint
66 extern Sensor * Sensor_Identify(const char * str); // Identify a Sensor from a string Id
67
68 extern void Sensor_Handler(FCGIContext *context, char * params); // Handle a FCGI request for Sensor data
69
70 #endif //_SENSOR_H
71
72

UCC git Repository :: git.ucc.asn.au