Skip to content

Commit 03f9823

Browse files
authored
Update README.md
1 parent c640e1a commit 03f9823

1 file changed

Lines changed: 23 additions & 11 deletions

File tree

README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,47 @@
1-
mavctl-python
1+
# mavctl-python
22

33
An Open Source Library for Autonomous Drone Navigation.
4-
Things to be Familiar With
4+
5+
## Things to be Familiar With
56

67
Before diving into mavctl, it is recommended that you read up on or familiarize yourself with the following so that you have an easier time working on mavctl
78

8-
MAVLink (https://mavlink.io/) Take a look through introduction just to get an idea of how the MAVLink protocol works
9+
1. MAVLink (https://mavlink.io/)
10+
Take a look through introduction just to get an idea of how the MAVLink protocol works
911

10-
Shepard (https://github.com/uaarg/shepard) Take a look through here (https://github.com/uaarg/shepard/blob/main/src/modules/autopilot/navigator.py) to get an idea of what the navigation functions should sort of look like Another thing to take a look at is the flight tests scripts as well (https://github.com/uaarg/shepard/blob/main/src/modules/autopilot/navigator.py)
12+
2. Shepard (https://github.com/uaarg/shepard)
13+
Take a look through here (https://github.com/uaarg/shepard/blob/main/src/modules/autopilot/navigator.py) to get an idea of what the navigation functions should sort of look like
14+
Another thing to take a look at is the flight tests scripts as well (https://github.com/uaarg/shepard/blob/main/src/modules/autopilot/navigator.py)
1115

12-
DroneKit (OPTIONAL) (https://github.com/dronekit/dronekit-python) While this is optional, a lot of things from DroneKit are borrowed, specifically the things that DroneKit does well. Overall, mavctl-python is similar to dronekit but it is revamped and is meant to replace DroneKit for all of its functionality. Over time we will reach a point where we will have exceeded dronekit but that time has not been reached just yet.
16+
3. DroneKit (OPTIONAL) (https://github.com/dronekit/dronekit-python)
17+
While this is optional, a lot of things from DroneKit are borrowed, specifically the things that DroneKit does well.
18+
Overall, mavctl-python is similar to dronekit but it is revamped and is meant to replace DroneKit for all of its functionality.
19+
Over time we will reach a point where we will have exceeded dronekit but that time has not been reached just yet.
1320

14-
Contribution Guidelines
21+
## Contribution Guidelines
1522

1623
Push all of your changes to a seperate branch and make a pull request if you would like to merge to main
1724

18-
IMPORTANT: FOLLOW THE STRUCTURE. It is very important for you to follow the structure that mavctl-python follows in terms of its operation.
25+
IMPORTANT: FOLLOW THE STRUCTURE.
26+
It is very important for you to follow the structure that `mavctl-python` follows in terms of its operation.
1927

20-
mavctl-python works as follows:
28+
`mavctl-python` works as follows:
2129

22-
MAVLink connection is created and a PyMAVLink object is passed to the Navigator class. In the Navigator class, there are methods which conduct the drone navigation (ex. move the drone 1m North)
30+
`MAVLink` connection is created and a `PyMAVLink` object is passed to the `Navigator` class.
31+
In the `Navigator` class, there are methods which conduct the drone navigation (ex. move the drone 1m North)
2332

24-
More advanced maneuvers should be located in their own files, but should NOT be in their own respective class. Instead, you can pass the Navigator class object into these advanced maneuver functions.
33+
More advanced maneuvers should be located in their own files, but should NOT be in their own respective class.
34+
Instead, you can pass the `Navigator` class object into these advanced maneuver functions.
2535

2636
The structure of that would look as follows:
2737

38+
```
2839
import advanced
2940
3041
master = connect()
3142
nav = Navigator()
3243
3344
advanced_maneuver = advancedManeuver(nav)
45+
```
3446

35-
advanced would be a file named advanced.py and advancedManeuver() would be the advanced maneuver method in question.
47+
`advanced` would be a file named `advanced.py` and `advancedManeuver()` would be the advanced maneuver method in question.

0 commit comments

Comments
 (0)