#include "actuator.h"
#include "options.h"
// Files containing GPIO and PWM definitions
-#include "gpio.h"
-#include "pwm.h"
+#include "bbb_pin.h"
+
+/** Number of actuators **/
+int g_num_actuators = 0;
/** Array of Actuators (global to this file) initialised by Actuator_Init **/
-static Actuator g_actuators[NUMACTUATORS];
+static Actuator g_actuators[ACTUATORS_MAX];
+/**
+ * Add and initialise an Actuator
+ * @param name - Human readable name of the actuator
+ * @param read - Function to call whenever the actuator should be read
+ * @param init - Function to call to initialise the actuator (may be NULL)
+ * @returns Number of actuators added so far
+ */
+int Actuator_Add(const char * name, int user_id, SetFn set, InitFn init, CleanFn cleanup, SanityFn sanity, double initial_value)
+{
+ if (++g_num_actuators > ACTUATORS_MAX)
+ {
+ Fatal("Too many sensors; Increase ACTUATORS_MAX from %d in actuator.h and recompile", ACTUATORS_MAX);
+ }
+ Actuator * a = &(g_actuators[g_num_actuators-1]);
+ a->id = g_num_actuators-1;
+ a->user_id = user_id;
+ Data_Init(&(a->data_file));
+ a->name = name;
+ a->set = set; // Set read function
+ a->init = init; // Set init function
+
+ a->sanity = sanity;
+
+ pthread_mutex_init(&(a->mutex), NULL);
+
+ if (init != NULL)
+ {
+ if (!init(name, user_id))
+ Fatal("Couldn't initialise actuator %s", name);
+ }
+
+ Actuator_SetValue(a, initial_value, false);
+
+ return g_num_actuators;
+}
-/** Human readable names for the Actuators **/
-const char * g_actuator_names[NUMACTUATORS] = {
- "actuator_test0", "actuator_test1", "actuator_test2"
-};
/**
* One off initialisation of *all* Actuators
*/
+#include "actuators/ledtest.h"
+#include "actuators/filetest.h"
void Actuator_Init()
{
- for (int i = 0; i < NUMACTUATORS; ++i)
- {
- g_actuators[i].id = i;
- Data_Init(&(g_actuators[i].data_file));
- pthread_mutex_init(&(g_actuators[i].mutex), NULL);
- }
+ //Actuator_Add("ledtest",0, Ledtest_Set, NULL,NULL,NULL);
+ Actuator_Add("filetest", 0, Filetest_Set, Filetest_Init, Filetest_Cleanup, Filetest_Sanity, 0);
}
/**
{
case CONTROL_START:
{
+ // Set filename
char filename[BUFSIZ];
- const char *experiment_name = (const char*) arg;
+ const char *experiment_path = (const char*) arg;
int ret;
- if (snprintf(filename, BUFSIZ, "%s_a%d", experiment_name, a->id) >= BUFSIZ)
+ ret = snprintf(filename, BUFSIZ, "%s/actuator_%d", experiment_path, a->id);
+
+ if (ret >= BUFSIZ)
{
- Fatal("Experiment name \"%s\" too long (>%d)", experiment_name, BUFSIZ);
+ Fatal("Experiment path \"%s\" too long (%d, limit %d)",
+ experiment_path, ret, BUFSIZ);
}
Log(LOGDEBUG, "Actuator %d with DataFile \"%s\"", a->id, filename);
// Open DataFile
Data_Open(&(a->data_file), filename);
-
+ }
+ case CONTROL_RESUME: //Case fallthrough; no break before
+ {
+ int ret;
a->activated = true; // Don't forget this
- a->allow_actuation = true;
-
a->control_changed = false;
- // Create the thread
ret = pthread_create(&(a->thread), NULL, Actuator_Loop, (void*)(a));
if (ret != 0)
{
Fatal("Failed to create Actuator_Loop for Actuator %d", a->id);
}
+
+ Log(LOGDEBUG, "Resuming actuator %d", a->id);
}
break;
case CONTROL_EMERGENCY: //TODO add proper case for emergency
case CONTROL_PAUSE:
- a->allow_actuation = false;
+ a->activated = false;
+ Actuator_SetControl(a, NULL);
+ pthread_join(a->thread, NULL); // Wait for thread to exit
+
+ Log(LOGDEBUG, "Paused actuator %d", a->id);
break;
- case CONTROL_RESUME:
- a->allow_actuation = true;
+
break;
case CONTROL_STOP:
- a->allow_actuation = false;
- a->activated = false;
- Actuator_SetControl(a, NULL);
- pthread_join(a->thread, NULL); // Wait for thread to exit
+ if (a->activated) //May have been paused before
+ {
+ a->activated = false;
+ Actuator_SetControl(a, NULL);
+ pthread_join(a->thread, NULL); // Wait for thread to exit
+ }
Data_Close(&(a->data_file)); // Close DataFile
+
+ Log(LOGDEBUG, "Stopped actuator %d", a->id);
break;
default:
Fatal("Unknown control mode: %d", mode);
*/
void Actuator_SetModeAll(ControlModes mode, void * arg)
{
- for (int i = 0; i < NUMACTUATORS; i++)
+ for (int i = 0; i < g_num_actuators; i++)
Actuator_SetMode(&g_actuators[i], mode, arg);
}
pthread_mutex_unlock(&(a->mutex));
if (!a->activated)
break;
- else if (!a->allow_actuation)
+
+ Actuator_SetValue(a, a->control.start, true);
+ // Currently does discrete steps after specified time intervals
+
+ struct timespec wait;
+ DOUBLE_TO_TIMEVAL(a->control.stepsize, &wait);
+ while (!a->control_changed && a->control.steps > 0 && a->activated)
+ {
+ clock_nanosleep(CLOCK_MONOTONIC, 0, &wait, NULL);
+ a->control.start += a->control.stepsize;
+ Actuator_SetValue(a, a->control.start, true);
+
+ a->control.steps--;
+ }
+ if (a->control_changed)
continue;
+ clock_nanosleep(CLOCK_MONOTONIC, 0, &wait, NULL);
- Actuator_SetValue(a, a->control.value);
+ //TODO:
+ // Note that although this loop has a sleep in it which would seem to make it hard to enforce urgent shutdowns,
+ // You can call the Actuator's cleanup function immediately (and this loop should later just exit)
+ // tl;dr This function isn't/shouldn't be responsible for the emergency Actuator stuff
+ // (That should be handled by the Fatal function... at some point)
}
//TODO: Cleanup?
* @param a - The Actuator
* @param value - The value to set
*/
-void Actuator_SetValue(Actuator * a, double value)
+void Actuator_SetValue(Actuator * a, double value, bool record)
{
- // Set time stamp
- struct timeval t;
- gettimeofday(&t, NULL);
-
- DataPoint d = {TIMEVAL_DIFF(t, *Control_GetStartTime()), value};
- //TODO: Set actuator
- switch (a->id)
+ if (a->sanity != NULL && !a->sanity(a->user_id, value))
{
- case ACTUATOR_TEST0:
- {
- // Onboard LEDs test actuator
- FILE *led_handle = NULL; //code reference: http://learnbuildshare.wordpress.com/2013/05/19/beaglebone-black-controlling-user-leds-using-c/
- const char *led_format = "/sys/class/leds/beaglebone:green:usr%d/brightness";
- char buf[50];
- bool turn_on = value;
-
- for (int i = 0; i < 4; i++)
- {
- snprintf(buf, 50, led_format, i);
- if ((led_handle = fopen(buf, "w")) != NULL)
- {
- if (turn_on)
- fwrite("1", sizeof(char), 1, led_handle);
- else
- fwrite("0", sizeof(char), 1, led_handle);
- fclose(led_handle);
- }
- else
- Log(LOGDEBUG, "LED fopen failed: %s", strerror(errno));
- }
- }
- break;
- case ACTUATOR_TEST1:
- // GPIO pin digital actuator
- {
- // Quick actuator function for testing pins
- // GPIOPin can be passed as argument, but is just defined here for testing purposes
- int GPIOPin = 13;
- // Modify this to only export on first run, only unexport on shutdown
- pinExport(setValue, GPIOString);
- pinDirection(GPIODirection, setValue);
- pinSet(value, GPIOValue, setValue);
- pinUnexport(setValue, GPIOString);
- }
- break;
- case ACTUATOR_TEST2:
- // PWM analogue actuator (currently generates one PWM signal with first PWM module)
- {
- if (pwminit == 0) { // If inactive, start the pwm module
- pwm_init();
- }
- if (pwmstart == 0) {
- pwm_start();
- pwm_set_period(FREQ); // Frequency is 50Hz defined in pwm header file
- }
- if(value >= 0 && value <= 1000) {
- double duty = value/1000 * 100; // Convert pressure to duty percentage
- pwm_set_duty((int)duty); // Set duty percentage for actuator (0-100%)
- }
- }
- break;
+ //ARE YOU INSANE?
+ Log(LOGERR,"Insane value %lf for actuator %s", value, a->name);
+ return;
+ }
+ if (!(a->set(a->user_id, value)))
+ {
+ Fatal("Failed to set actuator %s to %lf", a->name, value);
}
- Log(LOGDEBUG, "Actuator %s set to %f", g_actuator_names[a->id], value);
-
- // Record the value
- Data_Save(&(a->data_file), &d, 1);
+ // Set time stamp
+ struct timespec t;
+ clock_gettime(CLOCK_MONOTONIC, &t);
+ DataPoint d = {TIMEVAL_DIFF(t, *Control_GetStartTime()), a->last_setting.value};
+ // Record value change
+ if (record)
+ {
+ d.time_stamp -= 1e-6;
+ Data_Save(&(a->data_file), &d, 1);
+ d.value = value;
+ d.time_stamp += 1e-6;
+ Data_Save(&(a->data_file), &d, 1);
+ }
+ a->last_setting = d;
}
/**
* @param format - Format
* @param id - ID of Actuator
*/
-void Actuator_BeginResponse(FCGIContext * context, ActuatorId id, DataFormat format)
+void Actuator_BeginResponse(FCGIContext * context, Actuator * a, DataFormat format)
{
// Begin response
switch (format)
{
case JSON:
FCGI_BeginJSON(context, STATUS_OK);
- FCGI_JSONLong("id", id);
+ FCGI_JSONLong("id", a->id);
+ FCGI_JSONLong("user_id", a->user_id); //TODO: Don't need to show this?
+ FCGI_JSONPair("name", a->name);
break;
default:
FCGI_PrintRaw("Content-type: text/plain\r\n\r\n");
* @param id - ID of the Actuator
* @param format - Format
*/
-void Actuator_EndResponse(FCGIContext * context, ActuatorId id, DataFormat format)
+void Actuator_EndResponse(FCGIContext * context, Actuator * a, DataFormat format)
{
// End response
switch (format)
}
-
-
/**
* Handle a request for an Actuator
* @param context - FCGI context
*/
void Actuator_Handler(FCGIContext * context, char * params)
{
- struct timeval now;
- gettimeofday(&now, NULL);
+ struct timespec now;
+ clock_gettime(CLOCK_MONOTONIC, &now);
double current_time = TIMEVAL_DIFF(now, *Control_GetStartTime());
int id = 0;
- double set = 0;
+ char * name = "";
+ char * set = "";
double start_time = 0;
double end_time = current_time;
char * fmt_str;
// key/value pairs
FCGIValue values[] = {
- {"id", &id, FCGI_REQUIRED(FCGI_INT_T)},
- {"set", &set, FCGI_DOUBLE_T},
+ {"id", &id, FCGI_INT_T},
+ {"name", &name, FCGI_STRING_T},
+ {"set", &set, FCGI_STRING_T},
{"start_time", &start_time, FCGI_DOUBLE_T},
{"end_time", &end_time, FCGI_DOUBLE_T},
{"format", &fmt_str, FCGI_STRING_T}
// enum to avoid the use of magic numbers
typedef enum {
ID,
+ NAME,
SET,
START_TIME,
END_TIME,
// Get the Actuator identified
Actuator * a = NULL;
- if (id < 0 || id >= NUMACTUATORS)
+
+ if (FCGI_RECEIVED(values[NAME].flags))
+ {
+ if (FCGI_RECEIVED(values[ID].flags))
+ {
+ FCGI_RejectJSON(context, "Can't supply both id and name");
+ return;
+ }
+ a = Actuator_Identify(name);
+ if (a == NULL)
+ {
+ FCGI_RejectJSON(context, "Unknown actuator name");
+ return;
+ }
+
+ }
+ else if (!FCGI_RECEIVED(values[ID].flags))
+ {
+ FCGI_RejectJSON(context, "No id or name supplied");
+ return;
+ }
+ else if (id < 0 || id >= g_num_actuators)
{
FCGI_RejectJSON(context, "Invalid Actuator id");
return;
}
+ else
+ {
+ a = &(g_actuators[id]);
+ }
- a = g_actuators+id;
DataFormat format = Data_GetFormat(&(values[FORMAT]));
- // Begin response
- Actuator_BeginResponse(context, id, format);
- // Set?
+
+
if (FCGI_RECEIVED(values[SET].flags))
{
- if (format == JSON)
- FCGI_JSONDouble("set", set);
+
- ActuatorControl c;
- c.value = set;
-
+ ActuatorControl c = {0.0, 0.0, 0.0, 0}; // Need to set default values (since we don't require them all)
+ // sscanf returns the number of fields successfully read...
+ int n = sscanf(set, "%lf,%lf,%lf,%d", &(c.start), &(c.stepwait), &(c.stepsize), &(c.steps)); // Set provided values in order
+ if (n != 4)
+ {
+ // If the user doesn't provide all 4 values, the Actuator will get set *once* using the first of the provided values
+ // (see Actuator_Loop)
+ // Not really a problem if n = 1, but maybe generate a warning for 2 <= n < 4 ?
+ Log(LOGDEBUG, "Only provided %d values (expect %d) for Actuator setting", n, 4);
+ }
+ // SANITY CHECKS
+ if (c.stepwait < 0 || c.steps < 0 || (a->sanity != NULL && !a->sanity(a->user_id, c.start)))
+ {
+ FCGI_RejectJSON(context, "Bad Actuator setting");
+ return;
+ }
Actuator_SetControl(a, &c);
}
+
+ // Begin response
+ Actuator_BeginResponse(context, a, format);
+ if (format == JSON)
+ FCGI_JSONPair("set", set);
// Print Data
Data_Handler(&(a->data_file), &(values[START_TIME]), &(values[END_TIME]), format, current_time);
// Finish response
- Actuator_EndResponse(context, id, format);
+ Actuator_EndResponse(context, a, format);
+}
+
+/**
+ * Get the name of an Actuator given its id
+ * @param id - ID of the actuator
+ * @returns The Actuator's name
+ */
+const char * Actuator_GetName(int id)
+{
+ return g_actuators[id].name;
+}
+
+/**
+ * Identify an Actuator from its name string
+ * @param name - The name of the Actuator
+ * @returns Actuator
+ */
+Actuator * Actuator_Identify(const char * name)
+{
+ for (int i = 0; i < g_num_actuators; ++i)
+ {
+ if (strcmp(g_actuators[i].name, name) == 0)
+ return &(g_actuators[i]);
+ }
+ return NULL;
}