| Name | MAVez JSON |
| Version |
1.1.5
JSON |
| download |
| home_page | None |
| Summary | An intuitive MAVLink library for ArduPilot via pymavlink |
| upload_time | 2025-08-11 00:58:11 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
mavlink
ardupilot
uas
drone
pymavlink
mavez
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PSU UAS MAVez
**The Pennsylvania State University**
## Description
Library for controlling ArduPilot from an external computer via pymavlink.
For detailed documentation on pymavlink, visit [mavlink.io](https://mavlink.io/en/). "Standard Messages/Commands" > "common.xml" is a particularly useful resource.
## Table of Contents
- [Installation](#installation)
- [Example Usage](#example-usage)
- [Module Overview](#module-overview)
- [Error Codes](#error-codes)
- [License](#license)
- [Authors](#authors)
## Installation
1. In a terminal window, run `git clone git@github.com:UnmannedAerialSystems/MAVez.git`
2. Switch into the newly cloned directory by running `cd MAVez`
3. Install the required dependencies by running `pip install -r requirements.txt`
4. Create a python file in the parent directory of MAVez
```
your_project/
├── your_python_script.py
└── MAVez/
```
5. At the top of your file, import your desired modules with `from MAVez import Coordinate, flight_manager, ...`
While not required, it is highly recommended that you set up [ArduPilot's Software in the Loop (SITL)](https://ardupilot.org/dev/docs/sitl-simulator-software-in-the-loop.html) simulator to make testing significantly easier.
## Example Usage
Below is a simple script designed to work with SITL, assuming the directory structure is as described in the installation.
```Python
from MAVez import flight_manager
controller = flight_manager.Flight(connection_string='tcp:127.0.0.1:5762') # connection string for SITL
controller.prefight_check("sample_missions/landing_mission.txt", "sample_missions/geofence.txt") # unspecified home coordinate uses current
controller.arm() # must arm before takeoff
controller.takeoff(takeoff_mission.txt) # provide takeoff mission at time of takeoff
controller.append_detect_mission("sample_missions/detect_mission.txt") # provide a detect mission
controller.wait_and_send_next_mission() # wait until takeoff completes, send detect mission
```
## LICENSE:
This project is licensed under the [GNU General Public License v3.0](LICENSE).
## Authors:
[Ted Tasman](https://github.com/tedtasman)
[Declan Emery](https://github.com/dec4234)
[Vlad Roiban](https://github.com/Vladdapenn)
Raw data
{
"_id": null,
"home_page": null,
"name": "MAVez",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "MAVLink, ArduPilot, UAS, Drone, pymavlink, MAVez",
"author": null,
"author_email": "The Pennsylvania State University Unmanned Aerial Systems Club <psuuasofficial@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4a/60/84233b2320be7cd8f0640e38a9d5fe7645e1e933df027abeab58ff841bf4/mavez-1.1.5.tar.gz",
"platform": null,
"description": "# PSU UAS MAVez\n\n**The Pennsylvania State University**\n\n## Description\n\nLibrary for controlling ArduPilot from an external computer via pymavlink.\n\nFor detailed documentation on pymavlink, visit [mavlink.io](https://mavlink.io/en/). \"Standard Messages/Commands\" > \"common.xml\" is a particularly useful resource.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Example Usage](#example-usage)\n- [Module Overview](#module-overview)\n- [Error Codes](#error-codes)\n- [License](#license)\n- [Authors](#authors)\n\n## Installation\n\n1. In a terminal window, run `git clone git@github.com:UnmannedAerialSystems/MAVez.git`\n2. Switch into the newly cloned directory by running `cd MAVez`\n3. Install the required dependencies by running `pip install -r requirements.txt`\n4. Create a python file in the parent directory of MAVez\n\n```\nyour_project/\n \u251c\u2500\u2500 your_python_script.py\n \u2514\u2500\u2500 MAVez/\n```\n\n5. At the top of your file, import your desired modules with `from MAVez import Coordinate, flight_manager, ...`\n\nWhile not required, it is highly recommended that you set up [ArduPilot's Software in the Loop (SITL)](https://ardupilot.org/dev/docs/sitl-simulator-software-in-the-loop.html) simulator to make testing significantly easier.\n\n## Example Usage\n\nBelow is a simple script designed to work with SITL, assuming the directory structure is as described in the installation.\n\n```Python\nfrom MAVez import flight_manager\n\ncontroller = flight_manager.Flight(connection_string='tcp:127.0.0.1:5762') # connection string for SITL\n\ncontroller.prefight_check(\"sample_missions/landing_mission.txt\", \"sample_missions/geofence.txt\") # unspecified home coordinate uses current\n\ncontroller.arm() # must arm before takeoff\n\ncontroller.takeoff(takeoff_mission.txt) # provide takeoff mission at time of takeoff\n\ncontroller.append_detect_mission(\"sample_missions/detect_mission.txt\") # provide a detect mission\n\ncontroller.wait_and_send_next_mission() # wait until takeoff completes, send detect mission\n```\n\n## LICENSE:\n\nThis project is licensed under the [GNU General Public License v3.0](LICENSE).\n\n## Authors:\n\n[Ted Tasman](https://github.com/tedtasman)\n[Declan Emery](https://github.com/dec4234)\n[Vlad Roiban](https://github.com/Vladdapenn)\n",
"bugtrack_url": null,
"license": null,
"summary": "An intuitive MAVLink library for ArduPilot via pymavlink",
"version": "1.1.5",
"project_urls": {
"Homepage": "https://github.com/UnmannedAerialSystems/MAVez"
},
"split_keywords": [
"mavlink",
" ardupilot",
" uas",
" drone",
" pymavlink",
" mavez"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "652feb2ea6773f339823c0c68456a8e5ccce0dc60f77b0a2429b2ca6b7c06250",
"md5": "47c2c03c400404ce6baf00af223d3748",
"sha256": "ebe9a7b5a9fefe13f5fdfd5fa8884012954c3f5094a9348cc9bab30260718175"
},
"downloads": -1,
"filename": "mavez-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "47c2c03c400404ce6baf00af223d3748",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 28183,
"upload_time": "2025-08-11T00:58:10",
"upload_time_iso_8601": "2025-08-11T00:58:10.713655Z",
"url": "https://files.pythonhosted.org/packages/65/2f/eb2ea6773f339823c0c68456a8e5ccce0dc60f77b0a2429b2ca6b7c06250/mavez-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4a6084233b2320be7cd8f0640e38a9d5fe7645e1e933df027abeab58ff841bf4",
"md5": "b1d3d609d7507ef46c9ca427b84455ef",
"sha256": "4d0d5d5bed1e2eb7033b6110d88cd1046387c981d12de4f4c33150d391fe5ae2"
},
"downloads": -1,
"filename": "mavez-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "b1d3d609d7507ef46c9ca427b84455ef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27451,
"upload_time": "2025-08-11T00:58:11",
"upload_time_iso_8601": "2025-08-11T00:58:11.805899Z",
"url": "https://files.pythonhosted.org/packages/4a/60/84233b2320be7cd8f0640e38a9d5fe7645e1e933df027abeab58ff841bf4/mavez-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-11 00:58:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "UnmannedAerialSystems",
"github_project": "MAVez",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mavez"
}
