Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
update in text MAVProxy links
  • Loading branch information
SamuelDudley authored Sep 26, 2017
1 parent d907912 commit d1c8543
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# MAVCesium - An experimental web based map display for [MAVProxy](https://github.com/Dronecode/MAVProxy) based on [Cesium](https://github.com/AnalyticalGraphicsInc/cesium)
# MAVCesium - An experimental web based map display for [MAVProxy](https://github.com/ArduPilot/MAVProxy) based on [Cesium](https://github.com/AnalyticalGraphicsInc/cesium)
**[ Click here to see a live demo ](http://www.MAVCesium.io/)** <-- 26/Sep/2017 Server currently down... Stand by as I get another running :)

*Notes: Your browser will need to support webgl and web sockets. Please view on a desktop machine as the application does not currently support responsive layouts.*


### About the project
As a ground control station operator I often find myself wishing [MAVProxy](https://github.com/Dronecode/MAVProxy) had a more intuitive way of displaying an air vehicle attitude and position. This project uses [Cesium](https://github.com/AnalyticalGraphicsInc/cesium) to display the position and attitude information being received by a [MAVProxy](https://github.com/Dronecode/MAVProxy) ground station in real time.
As a ground control station operator I often find myself wishing [MAVProxy](https://github.com/ArduPilot/MAVProxy) had a more intuitive way of displaying an air vehicle attitude and position. This project uses [Cesium](https://github.com/AnalyticalGraphicsInc/cesium) to display the position and attitude information being received by a [MAVProxy](https://github.com/ArduPilot/MAVProxy) ground station in real time.

The project is designed to run on a local machine to maximise performance, however the [demo](http://www.MAVCesium.io/) is displaying the output of a [MAVProxy](https://github.com/Dronecode/MAVProxy) ground station connected to a simulated vehicle flying around [CMAC](https://www.google.com.au/maps/place/Canberra+Model+Aircraft+Club+Flying+Field/@-35.362771,149.1636837,945m/data=!3m1!1e3!4m5!3m4!1s0x6b164b893600af05:0xa5e0eae0c1fb648e!8m2!3d-35.3627754!4d149.1658777).

Expand All @@ -29,7 +29,7 @@ On the TODO list...
Development is being undertaken on a Ubuntu 16.04 x64 machine and has been tested on a 14.04 x64 machine. As the (few) dependencies are pure python I expect it will install and run on a windows machine, however this is currently untested.

### How it works
When you load the MAVCesium module a single [tornado server](http://www.tornadoweb.org/en/stable/) is created. This server handles handles static data requests while also streaming JSON between [MAVProxy](https://github.com/Dronecode/MAVProxy) and your webgl enabled browser, driving the display.
When you load the MAVCesium module a single [tornado server](http://www.tornadoweb.org/en/stable/) is created. This server handles handles static data requests while also streaming JSON between [MAVProxy](https://github.com/ArduPilot/MAVProxy) and your webgl enabled browser, driving the display.

The display is updated only as new data is received via the telemetry stream, so the faster the telemetry stream the 'smoother' the display update will be.

Expand All @@ -38,22 +38,22 @@ The display is updated only as new data is received via the telemetry stream, so

* Install the python dependencies for MAVCesium located in [requirements.txt](https://github.com/SamuelDudley/MAVCesium/blob/master/requirements.txt) via pip

* MAVCesium is avalable as a git submodule of [MAVProxy](https://github.com/Dronecode/MAVProxy). If you already have an existing [MAVProxy](https://github.com/Dronecode/MAVProxy) repository setup, you can initialise the MAVCesium module by running the following in your MAVProxy base directory:
* MAVCesium is avalable as a git submodule of [MAVProxy](https://github.com/ArduPilot/MAVProxy). If you already have an existing [MAVProxy](https://github.com/ArduPilot/MAVProxy) repository setup, you can initialise the MAVCesium module by running the following in your MAVProxy base directory:
```
git submodule init
git submodule update
```

**Otherwise** if you would like to clone MAVProxy and get the MAVCesium module at the same time you can run the following command:
```
git clone --recursive https://github.com/Dronecode/MAVProxy.git
git clone --recursive https://github.com/ArduPilot/MAVProxy.git
```
You can then install MAVProxy as per the [developer guide](http://ardupilot.github.io/MAVProxy/html/development/index.html):
```
cd MAVProxy
python setup.py build install --user
```
* Run [MAVProxy](https://github.com/Dronecode/MAVProxy) and load the MAVCesium module with the `module load cesium` command in the MAVProxy console
* Run [MAVProxy](https://github.com/ArduPilot/MAVProxy) and load the MAVCesium module with the `module load cesium` command in the MAVProxy console
* Point your webgl enabled browser to http://127.0.0.1:5000/ and once you start receiving valid mavlink messages from the vehicle connected to the MAVProxy ground station you will see the vehicle model in the center of your screen with a HUD overlay

* If you have other computers / tablets / ipads on your network you can also open webgl capable browsers on them and point it to the network facing IP address of the computer that MAVProxy is running on.
Expand All @@ -72,7 +72,7 @@ If you get it running or find it useful let me know :) Issues and pull requests
### Credits
Some of the other projects which go into MAVCesium are:
[Cesium](https://github.com/AnalyticalGraphicsInc/cesium)
[MAVProxy](https://github.com/Dronecode/MAVProxy)
[MAVProxy](https://github.com/ArduPilot/MAVProxy)
[Ardupilot](http://ardupilot.org/ardupilot/index.html)
[tornado](http://www.tornadoweb.org/en/stable/)
[jQuery](https://jquery.com/)
Expand Down

0 comments on commit d1c8543

Please sign in to comment.