Skip to content

Commit

Permalink
readme fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@davidbuzz
davidbuzz committed Jun 27, 2021
1 parent 64a54d6 commit 6446e9e
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 47 deletions.
10 changes: 10 additions & 0 deletions BUGS.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
BUGS.md

## ARDUPILOT Configurator start minimized, what should I do?

You have to remove `C:\Users%Your_UserNname%\AppData\Local\ARDUPILOT-configurator` folder and all its content.

[https://www.youtube.com/watch?v=XMoULyiFDp4](https://www.youtube.com/watch?v=XMoULyiFDp4)

Alternatively, on Windows with PowerShell you can use `post_install_cleanup.ps1` script that will do the cleaning. (thank you James Cherrill)

34 changes: 34 additions & 0 deletions MAPS.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
MAPS.md

## Different map providers

ARDUPILOT Configurator 2.1 allows to choose between OpenStreetMap, Bing Maps, and MapProxy map providers.
ARDUPILOT Configurator is shipped **WITHOUT** API key for Bing Maps. That means: every user who wants to use Bing Maps has to create own account, agree to all _Terms and Conditions_ required by Bing Maps and configure ARDUPILOT Configuerator by himself.

### How to choose Map provider

1. Click **Settings** icon in the top-right corner of ARDUPILOT Configurator
1. Choose provider: OpenStreetMap, Bing, or MapProxy
1. In the case of Bing Maps, you have to provide your own, personal, generated by you, Bing Maps API key
1. For MapProxy, you need to provide a server URL and layer name to be used

### How to get Bing Maps API key

1. Go to the Bing Maps Dev Center at [https://www.bingmapsportal.com/](https://www.bingmapsportal.com/).
* If you have a Bing Maps account, sign in with the Microsoft account that you used to create the account or create a new one. For new accounts, follow the instructions in [Creating a Bing Maps Account](https://msdn.microsoft.com/library/gg650598.aspx).
1. Select **My keys** under **My Account**.
1. Select the option to create a new key.
1. Provide the following information to create a key:
1. Application name: Required. The name of the application.
1. Application URL: The URL of the application. This is an optional field which is useful in helping you remember the purpose of that key in the future.
1. Key type: Required. Select the key type that you want to create. You can find descriptions of key and application types here.
1. Application type: Required. Select the application type that best represents the application that will use this key. You can find descriptions of key and application types [here](https://www.microsoft.com/maps/create-a-bing-maps-key.aspx).
1. Click the **Create** button. The new key displays in the list of available keys. Use this key to authenticate your Bing Maps application as described in the documentation for the Bing Maps API you are using.

### How to setup a MapProxy server for offline caching and mission planning
1. Follow process described in [MAPPROXY.md](MAPPROXY.md)
1. Test your MapProxy server in web browser, eg: http://192.168.145.20/ARDUPILOTmapproxy/
1. Once you have a working MapProxy server choose MapProxy as your map provider
1. Enter MapProxy service URL, eg: http://192.168.145.20/ARDUPILOTmapproxy/service?
1. Enter MapProxy service layer (ARDUPILOT_layer if configured from MAPPROXY.md)
1. Once completed, you can zoom in on area you will be flying in while connected to the internet in either GPS or Mission Control tab to save the cache for offline use
57 changes: 10 additions & 47 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,6 @@ Various types of aircraft are supported by the tool and by ARDUPILOT, e.g. quadc
![pic6](https://github.com/davidbuzz/ardu-configurator/blob/master/configurator6.png?raw=true)


## ARDUPILOT Configurator start minimized, what should I do?

You have to remove `C:\Users%Your_UserNname%\AppData\Local\ARDUPILOT-configurator` folder and all its content.

[https://www.youtube.com/watch?v=XMoULyiFDp4](https://www.youtube.com/watch?v=XMoULyiFDp4)

Alternatively, on Windows with PowerShell you can use `post_install_cleanup.ps1` script that will do the cleaning. (thank you James Cherrill)

## Installation

Depending on target operating system, _ARDUPILOT Configurator_ is distributed as _standalone_ application or Chrome App.
Expand Down Expand Up @@ -76,47 +68,16 @@ in the `./dist/` directory.
directory. Running this task on macOS or Linux requires Wine, since it's needed to set the icon
for the Windows app. If you don't have Wine installed you can create a release by running the **release-only-linux** task.

## Different map providers

ARDUPILOT Configurator 2.1 allows to choose between OpenStreetMap, Bing Maps, and MapProxy map providers.
ARDUPILOT Configurator is shipped **WITHOUT** API key for Bing Maps. That means: every user who wants to use Bing Maps has to create own account, agree to all _Terms and Conditions_ required by Bing Maps and configure ARDUPILOT Configuerator by himself.

### How to choose Map provider

1. Click **Settings** icon in the top-right corner of ARDUPILOT Configurator
1. Choose provider: OpenStreetMap, Bing, or MapProxy
1. In the case of Bing Maps, you have to provide your own, personal, generated by you, Bing Maps API key
1. For MapProxy, you need to provide a server URL and layer name to be used

### How to get Bing Maps API key

1. Go to the Bing Maps Dev Center at [https://www.bingmapsportal.com/](https://www.bingmapsportal.com/).
* If you have a Bing Maps account, sign in with the Microsoft account that you used to create the account or create a new one. For new accounts, follow the instructions in [Creating a Bing Maps Account](https://msdn.microsoft.com/library/gg650598.aspx).
1. Select **My keys** under **My Account**.
1. Select the option to create a new key.
1. Provide the following information to create a key:
1. Application name: Required. The name of the application.
1. Application URL: The URL of the application. This is an optional field which is useful in helping you remember the purpose of that key in the future.
1. Key type: Required. Select the key type that you want to create. You can find descriptions of key and application types here.
1. Application type: Required. Select the application type that best represents the application that will use this key. You can find descriptions of key and application types [here](https://www.microsoft.com/maps/create-a-bing-maps-key.aspx).
1. Click the **Create** button. The new key displays in the list of available keys. Use this key to authenticate your Bing Maps application as described in the documentation for the Bing Maps API you are using.
## BUGs? absolutely.

### How to setup a MapProxy server for offline caching and mission planning
1. Follow process described in [MAPPROXY.md](MAPPROXY.md)
1. Test your MapProxy server in web browser, eg: http://192.168.145.20/ARDUPILOTmapproxy/
1. Once you have a working MapProxy server choose MapProxy as your map provider
1. Enter MapProxy service URL, eg: http://192.168.145.20/ARDUPILOTmapproxy/service?
1. Enter MapProxy service layer (ARDUPILOT_layer if configured from MAPPROXY.md)
1. Once completed, you can zoom in on area you will be flying in while connected to the internet in either GPS or Mission Control tab to save the cache for offline use
See [BUGS page](https://github.com/davidbuzz/ardu-configurator/blob/master/BUGS.md)

## Authors

Konstantin Sharlaimov/DigitalEntity - maintainer of the ARDUPILOT firmware and configurator.
## Different MAP providers?

ARDUPILOT Configurator was originally a [fork](#credits) of Cleanflight Configurator with support for ARDUPILOT instead of Cleanflight.
See [MAPS page](https://github.com/davidbuzz/ardu-configurator/blob/master/MAPS.md)

This configurator is the only configurator with support for ARDUPILOT specific features. It will likely require that you run the latest firmware on the flight controller.
If you are experiencing any problems please make sure you are running the [latest firmware version](https://github.com/ArduPilot/ardupilot). or from [the firmware server](https://firmware.ardupilot.org/).

## Notes

Expand Down Expand Up @@ -150,9 +111,11 @@ https://github.com/ArduPilot/ardupilot/issues

## Developers

We accept clean and reasonable patches, submit them!
We accept clean and reasonable patches or PRs, submit them!

## Credits
## Credits - happy to correct these credits if they are wrong or incomplete.

ctn - primary author and maintainer of Baseflight Configurator.
Hydra - author and maintainer of Cleanflight Configurator from which this project was forked.
ctn - author and maintainer ofof stuff from which this project was forked.
Hydra - author and maintainer of stuff from which this project was forked.
Konstantin Sharlaimov/DigitalEntity - author and maintainer of stuff from which this project was forked.
Paweł Spychalski - author and maintainer of stuff from which this project was forked.

0 comments on commit 6446e9e

Please sign in to comment.