3 * @brief Implementation of sensor thread
4 * TODO: Finalise implementation
13 /** Array of sensors, initialised by Sensor_Init **/
14 static Sensor g_sensors[SENSORS_MAX];
15 /** The number of sensors **/
16 int g_num_sensors = 0;
21 * Add and initialise a Sensor
22 * @param name - Human readable name of the sensor
23 * @param user_id - User identifier
24 * @param read - Function to call whenever the sensor should be read
25 * @param init - Function to call to initialise the sensor (may be NULL)
26 * @param max_error - Maximum error threshold; program will exit if this is exceeded for the sensor reading
27 * @param min_error - Minimum error threshold; program will exit if the sensor reading falls below this value
28 * @param max_warn - Maximum warning threshold; program will log warnings if the value exceeds this threshold
29 * @param min_warn - Minimum warning threshold; program will log warnings if the value falls below this threshold
30 * @returns Number of actuators added so far
32 int Sensor_Add(const char * name, int user_id, ReadFn read, InitFn init, CleanFn cleanup, SanityFn sanity)
34 if (++g_num_sensors > SENSORS_MAX)
36 Fatal("Too many sensors; Increase SENSORS_MAX from %d in sensor.h and recompile", SENSORS_MAX);
37 // We could design the program to use realloc(3)
38 // But since someone who adds a new sensor has to recompile the program anyway...
40 Sensor * s = &(g_sensors[g_num_sensors-1]);
42 s->id = g_num_sensors-1;
44 Data_Init(&(s->data_file));
46 s->read = read; // Set read function
47 s->init = init; // Set init function
49 // Start by averaging values taken over a second
50 DOUBLE_TO_TIMEVAL(1, &(s->sample_time));
54 // Set sanity function
59 if (!init(name, user_id))
60 Fatal("Couldn't init sensor %s", name);
63 s->current_data.time_stamp = 0;
64 s->current_data.value = 0;
65 s->averaged_data.time_stamp = 0;
66 s->averaged_data.value = 0;
71 * Initialise all sensors used by the program
72 * TODO: Edit this to add any extra sensors you need
73 * TODO: Edit the includes as well
75 #include "sensors/resource.h"
76 #include "sensors/strain.h"
77 #include "sensors/pressure.h"
78 #include "sensors/dilatometer.h"
81 //Sensor_Add("cpu_stime", RESOURCE_CPU_SYS, Resource_Read, NULL, NULL, NULL);
82 //Sensor_Add("cpu_utime", RESOURCE_CPU_USER, Resource_Read, NULL, NULL, NULL);
83 Sensor_Add("pressure_high0", PRES_HIGH0, Pressure_Read, Pressure_Init, Pressure_Cleanup, NULL);
84 Sensor_Add("pressure_high1", PRES_HIGH1, Pressure_Read, Pressure_Init, Pressure_Cleanup, NULL);
85 Sensor_Add("pressure_low0", PRES_LOW0, Pressure_Read, Pressure_Init, Pressure_Cleanup, NULL);
86 //Sensor_Add("../testing/count.py", 0, Piped_Read, Piped_Init, Piped_Cleanup, 1e50,-1e50,1e50,-1e50);
87 Sensor_Add("strain0", STRAIN0, Strain_Read, Strain_Init, Strain_Cleanup, Strain_Sanity);
88 Sensor_Add("strain1", STRAIN1, Strain_Read, Strain_Init, Strain_Cleanup, Strain_Sanity);
89 Sensor_Add("strain2", STRAIN2, Strain_Read, Strain_Init, Strain_Cleanup, Strain_Sanity);
90 Sensor_Add("strain3", STRAIN3, Strain_Read, Strain_Init, Strain_Cleanup, Strain_Sanity);
91 //Sensor_Add("pressure0", PRESSURE0, Pressure_Read, Pressure_Init, 5000,0,5000,0);
92 //Sensor_Add("pressure1", PRESSURE1, Pressure_Read, Pressure_Init, 5000,0,5000,0);
93 //Sensor_Add("pressure_feedback", PRESSURE_FEEDBACK, Pressure_Read, Pressure_Init, 5000,0,5000,0);
94 //Sensor_Add("enclosure", ENCLOSURE, Enclosure_Read, Enclosure_Init, 1,1,1,1);
95 Sensor_Add("dilatometer", 0, Dilatometer_Read, Dilatometer_Init, Dilatometer_Cleanup, NULL);
101 void Sensor_Cleanup()
103 for (int i = 0; i < g_num_sensors; ++i)
105 Sensor * s = g_sensors+i;
106 if (s->cleanup != NULL)
107 s->cleanup(s->user_id);
113 * Sets the sensor to the desired control mode. No checks are
114 * done to see if setting to the desired mode will conflict with
115 * the current mode - the caller must guarantee this itself.
116 * @param s The sensor whose mode is to be changed
117 * @param mode The mode to be changed to
118 * @param arg An argument specific to the mode to be set.
119 * e.g for CONTROL_START it represents the experiment name.
121 void Sensor_SetMode(Sensor * s, ControlModes mode, void * arg)
128 char filename[BUFSIZ];
129 const char *experiment_path = (const char*) arg;
132 ret = snprintf(filename, BUFSIZ, "%s/sensor_%d", experiment_path, s->id);
136 Fatal("Experiment path \"%s\" too long (%d, limit %d)",
137 experiment_path, ret, BUFSIZ);
140 Log(LOGDEBUG, "Sensor %d with DataFile \"%s\"", s->id, filename);
142 Data_Open(&(s->data_file), filename);
144 case CONTROL_RESUME: //Case fallthrough, no break before
147 s->activated = true; // Don't forget this!
150 ret = pthread_create(&(s->thread), NULL, Sensor_Loop, (void*)(s));
153 Fatal("Failed to create Sensor_Loop for Sensor %d", s->id);
156 Log(LOGDEBUG, "Resuming sensor %d", s->id);
160 case CONTROL_EMERGENCY:
162 s->activated = false;
163 pthread_join(s->thread, NULL);
164 Log(LOGDEBUG, "Paused sensor %d", s->id);
168 if (s->activated) //May have been paused before
170 s->activated = false;
171 pthread_join(s->thread, NULL);
174 Data_Close(&(s->data_file)); // Close DataFile
175 Log(LOGDEBUG, "Stopped sensor %d", s->id);
178 Fatal("Unknown control mode: %d", mode);
183 * Sets all sensors to the desired mode.
184 * @see Sensor_SetMode for more information.
185 * @param mode The mode to be changed to
186 * @param arg An argument specific to the mode to be set.
188 void Sensor_SetModeAll(ControlModes mode, void * arg)
190 if (mode == CONTROL_START)
192 for (int i = 0; i < g_num_sensors; i++)
193 Sensor_SetMode(&g_sensors[i], mode, arg);
194 if (mode == CONTROL_STOP)
200 * Record data from a single Sensor; to be run in a seperate thread
201 * @param arg - Cast to Sensor* - Sensor that the thread will handle
202 * @returns NULL (void* required to use the function with pthreads)
204 void * Sensor_Loop(void * arg)
206 Sensor * s = (Sensor*)(arg);
207 Log(LOGDEBUG, "Sensor %d starts", s->id);
209 // Until the sensor is stopped, record data points
213 bool success = s->read(s->user_id, &(s->current_data.value));
216 clock_gettime(CLOCK_MONOTONIC, &t);
217 s->current_data.time_stamp = TIMEVAL_DIFF(t, *Control_GetStartTime());
221 if (s->sanity != NULL)
223 if (!s->sanity(s->user_id, s->current_data.value))
225 Fatal("Sensor %s (%d,%d) reads unsafe value", s->name, s->id, s->user_id);
228 s->averaged_data.time_stamp += s->current_data.time_stamp;
229 s->averaged_data.value = s->current_data.value;
231 if (++(s->num_read) >= s->averages)
233 s->averaged_data.time_stamp /= s->averages;
234 s->averaged_data.value /= s->averages;
235 Data_Save(&(s->data_file), &(s->averaged_data), 1); // Record it
237 s->averaged_data.time_stamp = 0;
238 s->averaged_data.value = 0;
243 // Silence because strain sensors fail ~50% of the time :S
244 //Log(LOGWARN, "Failed to read sensor %s (%d,%d)", s->name, s->id,s->user_id);
248 clock_nanosleep(CLOCK_MONOTONIC, 0, &(s->sample_time), NULL);
252 // Needed to keep pthreads happy
253 Log(LOGDEBUG, "Sensor %s (%d,%d) finished", s->name,s->id,s->user_id);
258 * Get a Sensor given its name
259 * @returns Sensor with the given name, NULL if there isn't one
261 Sensor * Sensor_Identify(const char * name)
263 for (int i = 0; i < g_num_sensors; ++i)
265 if (strcmp(g_sensors[i].name, name) == 0)
266 return &(g_sensors[i]);
272 * Helper: Begin sensor response in a given format
273 * @param context - the FCGIContext
274 * @param id - ID of sensor
275 * @param format - Format
277 void Sensor_BeginResponse(FCGIContext * context, Sensor * s, DataFormat format)
283 FCGI_BeginJSON(context, STATUS_OK);
284 FCGI_JSONLong("id", s->id);
285 FCGI_JSONLong("user_id", s->user_id); //NOTE: Might not want to expose this?
286 FCGI_JSONPair("name", s->name);
289 FCGI_PrintRaw("Content-type: text/plain\r\n\r\n");
295 * Helper: End sensor response in a given format
296 * @param context - the FCGIContext
297 * @param id - ID of the sensor
298 * @param format - Format
300 void Sensor_EndResponse(FCGIContext * context, Sensor * s, DataFormat format)
314 * Handle a request to the sensor module
315 * @param context - The context to work in
316 * @param params - Parameters passed
318 void Sensor_Handler(FCGIContext *context, char * params)
321 clock_gettime(CLOCK_MONOTONIC, &now);
322 double current_time = TIMEVAL_DIFF(now, *Control_GetStartTime());
324 const char * name = "";
325 double start_time = 0;
326 double end_time = current_time;
327 const char * fmt_str;
331 FCGIValue values[] = {
332 {"id", &id, FCGI_INT_T},
333 {"name", &name, FCGI_STRING_T},
334 {"format", &fmt_str, FCGI_STRING_T},
335 {"start_time", &start_time, FCGI_DOUBLE_T},
336 {"end_time", &end_time, FCGI_DOUBLE_T},
337 {"sample_s", &sample_s, FCGI_DOUBLE_T}
340 // enum to avoid the use of magic numbers
350 // Fill values appropriately
351 if (!FCGI_ParseRequest(context, params, values, sizeof(values)/sizeof(FCGIValue)))
353 // Error occured; FCGI_RejectJSON already called
358 if (FCGI_RECEIVED(values[NAME].flags))
360 if (FCGI_RECEIVED(values[ID].flags))
362 FCGI_RejectJSON(context, "Can't supply both sensor id and name");
365 s = Sensor_Identify(name);
368 FCGI_RejectJSON(context, "Unknown sensor name");
372 else if (!FCGI_RECEIVED(values[ID].flags))
374 FCGI_RejectJSON(context, "No sensor id or name supplied");
377 else if (id < 0 || id >= g_num_sensors)
379 FCGI_RejectJSON(context, "Invalid sensor id");
384 s = &(g_sensors[id]);
387 // Adjust sample rate if necessary
388 if (FCGI_RECEIVED(values[SAMPLE_S].flags))
392 FCGI_RejectJSON(context, "Negative sampling speed!");
395 DOUBLE_TO_TIMEVAL(sample_s, &(s->sample_time));
399 DataFormat format = Data_GetFormat(&(values[FORMAT]));
402 Sensor_BeginResponse(context, s, format);
405 Data_Handler(&(s->data_file), &(values[START_TIME]), &(values[END_TIME]), format, current_time);
408 Sensor_EndResponse(context, s, format);
413 * Get the Name of a Sensor
414 * @param id - ID number
416 const char * Sensor_GetName(int id)
418 return g_sensors[id].name;
421 DataPoint Sensor_LastData(int id)
423 Sensor * s = &(g_sensors[id]);
424 return s->current_data;