Skip to content

Commit

Permalink
Add readme and run script
Browse files Browse the repository at this point in the history
  • Loading branch information
Ernesto Corbellini committed Aug 27, 2021
1 parent 1a5abfb commit a0a5ffd
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

# Sojourner simulation

This is a simple simulation of NASA's Sojourner Mars rover. The rover starts moving on its own over a simulated martian surface and can be controlled using the keyboard.

The simulation runs on the [Webots](https://www.cyberbotics.com/) simulation engine.

It is designed to work with [InOrbit](https://www.inorbit.ai/) so you will need to install the agent and have an active account. It uses the [C++ SDK](https://github.com/inorbit-ai/robot-sdk-cpp).

## Data produced by the simulation

The simulation generates the following data that is streamed to the InOrbit dashboard:

- Pose: the robot's current pose
- Battery: energy currently available in the robot's battery measured in joules.
- Incident light: amount of light received by the robot's solar panels measured in watts per square meters.

## Install Webots

Follow the procedure [described in Webots page](https://www.cyberbotics.com/doc/guide/installation-procedure#installing-the-debian-package-with-the-advanced-packaging-tool-apt) to install the simulator in your system using APT.

## Clone the repo

Clone this repo with the following instructions. Note that the repo contains git submodules that need to be installed.

```
git clone --recurse-submodules https://github.com/ernestmc/sojourner.git
```

## Run the simulation

The following commands will build and run the simulation.

```
cd sojourner
./run
```

9 changes: 9 additions & 0 deletions run
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#! /bin/bash

export WEBOTS_HOME="/usr/local/webots"

pushd controllers >> /dev/null
make
popd >> /dev/null

webots worlds/sojourner.wbt

0 comments on commit a0a5ffd

Please sign in to comment.