# FlyDrone
## Description:
FlyDrone is still in its early stages, developing an easy and automated api for controlling drones using python.
## Getting Started:
Starting up, we create an instance of the ``Drone`` class, the ``Drone`` class takes the connection string as a parameter:
```py
from flydrone import Drone
my_first_drone = Drone("udpin:localhost:14550")
```
if no parameter is specified, it will be assigned to ``udpin:localhost:14550`` by default.
<br>
Now we have access to different awesome functions to control the drone, lets have some examples:
```py
my_first_drone.arm() # If your drone is ready, this should arm
my_first_drone.takeoff(15) # The drone should takeoff with altitude of 15
```
## Documentation: **STATUS - INCOMPLETE**
``Drone``: a class that holds all functionalities and takes the connection string as a parameter. You can refer to this documentation for more information about connection strings https://mavlink.io/en/mavgen_python/.
<br>
``Drone/arm()``: a function that make the drone arm if its ready.
<br>
``Drone/disarm()``: a function that make the drone disarm if its ready.
<br>
``Drone/takeoff()``: a function that make the drone takeoff if its armed and ready, takes the altitude as a parameter.
<br>
``Drone/change_mode()``: a function that changes the drone's mode if its ready, takes the mode as a parameter. You can refer to this documentation for more information about drone's modes https://ardupilot.org/copter/docs/flight-modes.html.
<br>
``Drone/return_to_launch()``: a function that changes the drone's mode to RTL so it returns to the place that its launched from.
<br>
``Drone/local_movement()``:
Raw data
{
"_id": null,
"home_page": "https://github.com/AnmarHani/FlyDrone",
"name": "flydrone",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,drone,embedded,automation",
"author": "Anmar Hani",
"author_email": "AnmarHaniV1@gmail.com",
"download_url": "",
"platform": null,
"description": "\n# FlyDrone\n## Description:\nFlyDrone is still in its early stages, developing an easy and automated api for controlling drones using python.\n\n## Getting Started:\nStarting up, we create an instance of the ``Drone`` class, the ``Drone`` class takes the connection string as a parameter:\n```py\nfrom flydrone import Drone\n\nmy_first_drone = Drone(\"udpin:localhost:14550\")\n```\nif no parameter is specified, it will be assigned to ``udpin:localhost:14550`` by default.\n<br>\nNow we have access to different awesome functions to control the drone, lets have some examples:\n```py\nmy_first_drone.arm() # If your drone is ready, this should arm\nmy_first_drone.takeoff(15) # The drone should takeoff with altitude of 15\n```\n\n## Documentation: **STATUS - INCOMPLETE**\n``Drone``: a class that holds all functionalities and takes the connection string as a parameter. You can refer to this documentation for more information about connection strings https://mavlink.io/en/mavgen_python/.\n<br>\n``Drone/arm()``: a function that make the drone arm if its ready.\n<br>\n``Drone/disarm()``: a function that make the drone disarm if its ready.\n<br>\n``Drone/takeoff()``: a function that make the drone takeoff if its armed and ready, takes the altitude as a parameter.\n<br>\n``Drone/change_mode()``: a function that changes the drone's mode if its ready, takes the mode as a parameter. You can refer to this documentation for more information about drone's modes https://ardupilot.org/copter/docs/flight-modes.html.\n<br>\n``Drone/return_to_launch()``: a function that changes the drone's mode to RTL so it returns to the place that its launched from.\n<br>\n``Drone/local_movement()``:\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple basic drone python api that is built on top of pymavlink",
"version": "0.0.2",
"split_keywords": [
"python",
"drone",
"embedded",
"automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c6d244116f0c80e7411568fc32b68a9126521dacf0121d236edd02e4a6ef0fa4",
"md5": "2b6f57011458bb0dd8b01981f7a7d0ee",
"sha256": "ecdc6afce5c28d2fa1007bf1a4cf7818da81b3469af09f8cb139595ddfe8be0b"
},
"downloads": -1,
"filename": "flydrone-0.0.2-py3.11.egg",
"has_sig": false,
"md5_digest": "2b6f57011458bb0dd8b01981f7a7d0ee",
"packagetype": "bdist_egg",
"python_version": "0.0.2",
"requires_python": null,
"size": 20599,
"upload_time": "2023-04-06T00:29:27",
"upload_time_iso_8601": "2023-04-06T00:29:27.843098Z",
"url": "https://files.pythonhosted.org/packages/c6/d2/44116f0c80e7411568fc32b68a9126521dacf0121d236edd02e4a6ef0fa4/flydrone-0.0.2-py3.11.egg",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-06 00:29:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "AnmarHani",
"github_project": "FlyDrone",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "flydrone"
}
JSON
