-
Notifications
You must be signed in to change notification settings - Fork 84
NOS3 Install, Build, Run Quick Start
On the host computer:
- Install [Oracle VirtualBox v6.1+](https://www.virtualbox.org)
- Install [Vagrant v2.2+](https://www.vagrantup.com)
- Install [Git 1.8+](https://git-scm.com/downloads)
-
Open a terminal and navigate to the desired location for the repository
-
Clone the repository in the terminal using
git clone https://github.com/nasa/nos3.git
-
cd nos3
-
git checkout dev
-
Clone the submodules with
git submodule update --init --recursive
- Run
vagrant up
and wait to return to a prompt
- This can take anywhere from a few minutes to hours depending on internet speeds and host PC specs
- Important: Internet access is required when installing
- The VM may reboot multiple times in order to finish installing packages for you automatically, so wait for that prompt!
- Sometimes ansible does not seem to install and there is an error like "Could not get lock /var/lib/apt/lists/lock". If this happens, run
vagrant provision
to install ansible and provision.
-
Vagrant will automatically load the virtual machine to Virtual Box, and it will be ready for use, though more RAM and CPU cores should probably be added if possible on Virtual Box before use.
-
Login to the jstar user using the password jstar123! and get to work! (If needed, the vagrant user has password vagrant)
Log in to the NOS3 VM, username / password : jstar
/ jstar123!
- Access the nos3 repository on the host machine. (This may already be done if you do
vagrant up
. Vagrant mounts the nos3 repository in the VM at/home/nos3/Desktop/github-nos3
.) From the guest VM: - Add Virtual Box Guest Additions:
1. Go to Virtual Box menu -> Devices -> Insert Guest Additions CD image...
2. Click
Run
in the resulting dialog box - Add a shared folder with the nos3 repository code:
1. Go to Virtual Box menu -> Devices -> Shared Folders -> Shared Folders Settings...
2. Add a new Shared Folder (folder with + sign) and select the location of the nos3 repository on the host
3. Check
Auto-mount
andMake Permanent
4. Reboot the VM - Build the NOS3 software
- In a terminal, navigate to the nos3 shared folder after the VM reboot above
- Run
make clean
- Run
make prep
- Once COSMOS is launched and you set the password and the terminal is done outputting, run
make
In the NOS3 VM:
-
In a terminal, navigate to the nos3 shared folder (created by Vagrant at
/home/nos3/Desktop/github-nos3
or created by you using the instructions above) -
Run
make launch
in the nos3 directory from the terminal -
To exit the simulation, run
make stop
in the nos3 directory from the terminal -
To rebuild NOS3 from the repository baseline, first run
make clean
and then runmake prep
and then runmake
Once make prep
is run, COSMOS 5 NOS3 Web Interface will start. Once make launch
is run, cFS and 42 will launch and link in to COSMOS. If using COSMOS 4, the COSMOS 4 GUI should launch during the make launch Script.
COSMOS 4 Launcher
COSMOS 4 Main Windows
COSMOS 5 Web UI
COSMOS may command cFS to send telemetry back to COSMOS by:
-
The NOS3 Web Interface should show the COSMOS Command and Telemetry Server by default. If not, switch to it and assure the following are done and true:
-
Run
make
if needed, thenmake launch
. At this point Flight Software will boot up. -
The terminals with cFS, along with the dynamics sim windows for 42, should show up.
-
Once they have, for the MISSION_INT interface, the Connected? attribute should read
true
-
From the NOS3 Web Interface, open the COSMOS Command Sender and enter:
-
In the Command Sender Window, select Target to be
CFS
-
Select Command to be
TO_ENABLE_OUTPUT_CC
-
Click
Send
Note: In current versions of NOS3, this debug output should already be set up by default. However, to enable Radio Telemetry, follow the same steps
except go to CFS_RADIO
, and run the command with the DEST_IP
of 'radio_sim'
and the DEST_PORT
of 5011
, of whatever values fit your setup.
COSMOS 4 Radio Enable
COSMOS 5 Radio Enable
- Notice under the COSMOS Command and Telemetry Server Window that the following data fields update:
-
Bytes Tx
andCmd Pkts
should change from 0 to a positive number -
Bytes Rx
andTlm Pkts
should start counting up as telemetry is received
COSMOS 4 Command and Telemetry Server with Radio Enabled
COSMOS 5 Command and Telemetry Server with Radio Enabled
- From the NOS3 Web Interface or COSMOS GUI, open the COSMOS Packet Viewer:
- In the Packet Viewer Window, select Target to be
CFS
- Select Packet to be
CFE_EVS_PACKET
- Scroll to see the MESSAGE field live updates (line 16)
- Telemetry packets may be viewed for other apps, once they are commanded to send telemetry
- Application telemetry fields which are stale are displayed in fuscia
Note: The same should apply for Radio, except go to
CFS_RADIO
instead ofCFS
COSMOS 4 EVS Packet
COSMOS 5 EVS Packet
- To exit the simulation, run make stop in the nos3 directory from the terminal
- To build NOS3 from the repository baseline, first run
make clean
and then run make launch - If you plan to switch ground software between COSMOS 4 and COSMOS 5, be sure to run
make stop-gsw
before runningmake clean
andmake prep
- Home
- NOS3 Architecture
- NOS Engine
- NOS3 Ground Systems
- NOS3 Install, Build, Run
- NOS3 Components, Repository and Directory Structure
- NOS3 Running Executables and Windows
- NOS3 Workflows
- NOS3 Hardware Simulator Framework / Example Simulator
- NOS3 42 Orbit and Attitude Dynamics
- NOS3 cFS Development
- NOS3 Component Directory
- NOS3 Component Development Flow
- NOS3 Custom cFS Table Development
- NOS3 OIPP
- CryptoLib
- NOS3 Igniter