This repo is now archived in favor of: https://github.com/PubInv/NASA-MCOG
The final report delivered to NASA for this project can be read here.
This is a repo for a control system made for NASA to drive a Ceramic Oxygen Generation technology they have developed. It was forked from ["The Ox"]() project of Public Invention run by Mr. Ben Coombs, which was in turn a fork of the VentOS project of Helpful Engineering let my Ben Coombs, Dr. Erich Schulz, and Robert L. Read.
However, the main reason we are starting with this fork is not that the Pressure Swing Adsorption system of the Ox is a particularly relevant, but rather that the code represents a nice platform of simple microcontroller control of related machines.
To wit, includes PlatformIO configuration, a state machine (finite automata), a superloop architecutre, and a hardware abstraction layer.
This particular project of NASA will improve life support technology in space, but may eventually greatly improve global health.
An unlisted YouTube video has been uploaded that shows this work in progress as of September, 2022.
The fundamental way to run this is to perform:
cd firmware
pio run -e native && ./.pio/build/native/program
We are currently creating the RibbonFish proof-of-concept. This can be run on a Due by executing:
make pio-run-due_ribbonfish
As this develops, it will use a specific Due hardware configuration,
please see the documentation for details to build your own.
With Visual Studio Code.
Install the Plateform IO extention
To open he project in Visual Studio Code.
Open Project. Navigate to the firmware folder.
Select the file platformio.ini
AFAIK, PlatformIO forces a directory tree depth of 5 levels.
This is not enough to organize the Hardware Abstraction Level they way I would prefer, forcing us to make some messy directories that are less than clear.
For example, to implement a Temperature Sensor, we would ideally have an abstract (or virtual) implementation, a folder for real hardware, and a folder for mock sensors. I have no choice now but to jam the mock sensors into the same directory with the real hardware and use a naming convnention.
The NASA-COG system needs to allow the user to enter commands. The most obvious of these is "turn off". Because the system should avoid thermal shocks, this is actually not simple.
We have previously used an approach of using simple JSON objects to represent commands. We propose to use the same idea here, but obviously, the command will be custom to the NASA-COG.
The general scheme is to use a JSON object like:
{ "com": "T",
"par": 7,
"mod": "T",
"val" : 732.3
}
For this problem space, we can specify some global parameters of the problem, some of which involve safety. These can of course have default values "hard wired" into the code, but an experimenter may wish to change these values (carefully).
We will need other commands that represent discrete events in time. For example, each transition in the state transition diagram below may be initiated by a command from the user (they may also occur automatically due to an internal fault or even normal operation.)
We can implement particular commands with the same scheme.
For example, the simple object:
{ "com": "C",
"par": 0,
"int": "s",
"mod": "U",
"val" : 0.0
}
Could mean "Cool Down". The value "U" is used becasue the "mod" command is "unusued" in this case.
{ "com": "W",
"par": M,
"int": "s",
"mod": "U",
"val" : 0.0
}
In actual practice, these commands will be pasted into the serial port using either PlatformIO or the Arduino IDE.
Eventually, a user interface may be implemented that uses a knob or a nice webpage to enter commands. However, by having each of these take only actions that can be implemented as such a command, we bring discipline to the internal code.
The serial port currently supports 6 one-character commands: w,c,e,a,i,o. These mean:
Note: "acknowledge" means that the operator acknowledges that a critical state has occurred and asserts it is okay to return to normal operation, either because the problem as been removed or for some other reason.
Addtionally, the system supports "full commands", that look like this:
{ "com": "W", "par": "M", "int": "s", "mod": "U", "val" : 0.0 }
{ "com": "C", "par": "M", "int": "s", "mod": "U", "val" : 0.0 }
{ "com": "E", "par": "M", "int": "s", "mod": "U", "val" : 0.0 }
{ "com": "A", "par": "M", "int": "s", "mod": "U", "val" : 0.0 }
{ "com": "I", "par": "M", "int": "s", "mod": "U", "val" : 0.0 }
{ "com": "O", "par": "M", "int": "s", "mod": "U", "val" : 0.0 }
In fact, each "one character" command is a short hand for these commands.
The following format can be used to set parameters (P). The three most important parameters are:
{ "com": "P", "par": "T", "int": "T", "mod": "U", "val" : 35 }
{ "com": "P", "par": "C", "int": "T", "mod": "U", "val" : 500 }
{ "com": "P", "par": "F", "int": "T", "mod": "U", "val" : 2000 }
These three commands set the:
In general we intend to follow the Public Invention Licensed Guidelines unless NASA requests something different. If you are starting your own project, please feel free to fork the license guidelines as a starting point if you like our license policy.
This program includes free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.