Welcome to Spear MCT.
Spear MCT is an extension of NASA's OpenMCT built to provide telemetry from ROS via Roslib
How to install
Prerequisites
- nodejs & npm
- git (Recommended)
- ElasticDB/CouchDB (Optional)
Steps
- Clone this repository to your computer (or download it through the github page)
- Open Terminal (on Unix)/Power Shell (on Windows)
- Navigate to the folder directory using cd
- Run
npm start [Webhook url (optional)]
- If
npm start
is run without a URL, the server will run in offline mode.
How to add modules to SpearMCT
Prerequisites
- nodejs & npm
- git (Recommended)
- A text editor
- Open the modules.json file in a text editor of your choice
- Under the modules key, add the following, edit it and remove the comments (//)
{
"name": "Battery", //The name that appears to the user
"key": "rv.battery", //The ID of the object, should start with rv.
"graph": true, //Does this need to be graphed?
"values": [
{ // If you want more values, duplicate this value object, then change values
"name": "Voltage", //The name of the value that appears to the user
"key": "rv.battery.voltage", // the ID of the value, should start with the key above
"units": "V", //Units (not needed if not a graph)
"format": "float", //Type of data, usually float, string, or boolean
"min": 0, //Only for graphs
"max": 100, //Only for graphs
"hints": { //Only for graphs
"range": 1
},
"topic": "web/battery/voltage", //The ros topic on the rover
"message-type": "std_msgs/Float64" //Type of data
},
{ // WE NEED THIS, DO NOT REMOVE
"name": "Timestamp",
"key": "utc",
"source": "timestamp",
"format": "utc"
}
]
}
- Save file, then open Terminal (on Unix)/Power Shell (on Windows)
- Navigate to the folder directory using cd
- Run
npm start
to test if the modules were added correctly