Add James' final edits

[matches/MCTX3420.git] / reports / final / chapters / Design.tex

diff --git a/reports/final/chapters/Design.tex b/reports/final/chapters/Design.tex
index 0b59c0b..3d8f6ff 100644 (file)
--- a/reports/final/chapters/Design.tex
+++ b/reports/final/chapters/Design.tex
@@ -145,13 +145,13 @@ Code to read sensor values is located in the \gitref{server}{sensors} subdirecto
        \item {\bf Dilatometer} (x2) - \gitref{server}{sensors/dilatometer.c} See Section \ref{Image Processing}
 \end{itemize}
 
-Additional sensors can be added and enabled through use of the \funct{Sensor_Add} function in \funct{Sensor_Init} in the file \gitref{server}{sensors.c}.
+Additional sensors can be added and enabled through use of the \funct{Sensor_Add} function in \funct{Sensor_Init} in the file \gitref{server}{sensor.c}.
 
 The function \funct{Data_Calibrate} located in \gitref{server}{data.c} can be used for interpolating calibration. The pressure sensors and microphone have been calibrated in collaboration with the Sensors Team; however only a small number of data points were taken and the calibration was not tested in detail. We would recommend a more detailed calibration of the sensors for future work.
 
 \subsection{Actuators}
 
-Code to set actuator values is located in the \gitref{server}{actuators} subdirectory. The following actuators are (as of writing) controlled by the software and have been successfully tested in collaboration with the Electronics and Pneumatics teams. Additional actuators can be added and enabled through use of the \funct{Actuator_Add} function in \funct{Actuator_Init} in the file \gitref{server}{actuators.c}.
+Code to set actuator values is located in the \gitref{server}{actuators} subdirectory. The following actuators are (as of writing) controlled by the software and have been successfully tested in collaboration with the Electronics and Pneumatics teams. Additional actuators can be added and enabled through use of the \funct{Actuator_Add} function in \funct{Actuator_Init} in the file \gitref{server}{actuator.c}.
 
 \subsubsection{Relay Controls} \gitref{server}{actuators/relay.c}
 
@@ -294,8 +294,8 @@ With increased usage, this was found to be insufficient. \funct{FCGI_ParseReques
        \begin{tabular}{llll}
                {\bf API} & {\bf File} & {\bf Function} & {\bf Purpose} \\
                \api{identify} & \gitref{server}{fastcgi.c} & \funct{IdentifyHandler} & Provide system information \\
-               \api{sensors} & \gitref{server}{sensors.c} & \funct{Sensor_Handler} & Query sensor data points or set sampling rate\\
-               \api{actuators} & \gitref{server}{actuators.c} & \funct{Actuator_Handler} & Set actuator values or query past history \\
+               \api{sensors} & \gitref{server}{sensor.c} & \funct{Sensor_Handler} & Query sensor data points or set sampling rate\\
+               \api{actuators} & \gitref{server}{actuator.c} & \funct{Actuator_Handler} & Set actuator values or query past history \\
                \api{image} & \gitref{server}{image.c} & \funct{Image_Handler} & Return image from a camera (See Section \ref{Image Processing}) \\
                \api{control} & \gitref{server}{control.c} & \funct{Control_Handler} & Start/Stop/Pause/Resume the Experiment \\
                \api{bind} & \gitref{server}{login.c} & \funct{Login_Handler} & Attempt to login to the system (See Section \ref{Cookies})\\
@@ -634,6 +634,9 @@ Once a design document was completed a Master Template was created.  Firstly a d
 
        With the template completed functionality was then added.  By copying the template exactly for each individual page the look of the software is kept the same throughout.  Adding functionality is a simple case of substituting in functional code in the demonstration panels as well as adding the necessary JavaScript for the pages to function.  Effort was made to keep as much functional code separated from the template itself and to load the code into the page from an external file in order to facilitate cleaner code with better expandability.
 
+
+Whilst this GUI built around the Master Template was not quite completed in time (a different GUI used for the final testing) it is recommended that further work on the software includes finishing and improving upon the Master Template version as it provides more flexibility.
+
 \begin{figure}[H]
        \centering
        \includegraphics[width=0.8\textwidth]{figures/draftGUI.png}