From: Sam Moore Date: Mon, 4 Nov 2013 00:06:11 +0000 (+0800) Subject: Update introduction X-Git-Url: https://git.ucc.asn.au/?a=commitdiff_plain;h=cb775fbb5a5841ee4b550e7c0b18e7689f18b39c;p=matches%2FMCTX3420.git Update introduction Fix broken links (sensor.c not sensors.c !) --- diff --git a/reports/final/chapters/Design.tex b/reports/final/chapters/Design.tex index 0b59c0b..1173834 100644 --- 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})\\ diff --git a/reports/final/chapters/Introduction.tex b/reports/final/chapters/Introduction.tex index bc46947..23f9c2c 100644 --- a/reports/final/chapters/Introduction.tex +++ b/reports/final/chapters/Introduction.tex @@ -6,9 +6,10 @@ The following report describes the work of the software team on the MCTX3420 pre The MCTX3420 project aimed to build an experimental apparatus for measuring the behaviour of a container with pressure --- in this case, testing how a drink can deformed as air pressure inside it increased. The desired result was a self-contained, safe, reliable, effective and easy-to-use system which could perform the desired experimental tasks, to be used by both students and wider industry professionals. -Unfortunately, the system is (as of 1st November 2013) still not complete; the hardware components have not been fully tested and integrated with the software, despite extensive work by all students. However, the project is very close to completion. The software can interact in the desired manner with the hardware components, and fulfils the majority of the required functionality. With some further testing and development using the final hardware, the software could easily be implemented --- and the report has been written with this in mind, allowing another group in the future to build upon the project software. +Unfortunately, the system is (as of 1st November 2013) still not complete; the hardware components have not been fully tested and integrated with the software, despite extensive work by all students. Very little time was available for testing and significant issues thus do remain. However, the project is very close to completion. The software is able interact in the desired manner with the hardware components, and fulfils the majority of the required functionality. With some further testing and development using the final hardware, the software could easily be implemented – and the report has been written with this in mind, allowing another group in the future to build upon the project software. -The report begins with an overview of the whole system and the design of the software component. Each subsection then focuses on a specific aspect of the software, going into detail about its design, development, functionality, testing, and integration. Following this, there are sections focusing on the administrative aspects of the project, including teamwork, the general development process, and costs. The report concludes with some documentation of the software and recommendations for future development. + +Chapter \ref{Introduction and Approach} of the report begins with an overview of the whole system and the software component. Following this, there is a discussion of the administrative aspects of the project, including teamwork, the general development process, and costings. Each subsection of Chapter \ref{Design and Implementation} then focuses on a specific aspect of the software, going into detail about its design, development, functionality, testing, and integration, with the appropriate descriptions and reasonings. Chapter \ref{Conclusions and Recommendations} of the report concludes with the final results and recommendations for future development. In-depth instructions regarding use of the software are given in the project's online documentation\cite{mctx3420_wiki}. \section{System Overview} diff --git a/reports/final/report.pdf b/reports/final/report.pdf index 0c24ac3..818ade8 100644 Binary files a/reports/final/report.pdf and b/reports/final/report.pdf differ