Skip to main content

SoftwarePilot is an open source middleware and API that supports aerial applications for Parrot Anafi drones

Project description

SoftwarePilot

SoftwarePilot is an open source middleware and API that supports aerial applications. SoftwarePilot allows users to connect consumer Parrot Anafi drones to programmable pythonscripts that provide access to the drones flight controller, camera, and navigation system as well as custom rest api and dockerfile integration.

(Streaming features are currently bugged)

Getting Started

Install the library:

  1. Clone the repo
git clone https://github.com/boredbot2/SoftwarePilot.git
  1. Pip install
pip install SoftwarePilot

Examples

  1. Simple Start:
  from SoftwarePilot import SoftwarePilot

  '''
  This is short demo demonstrating how to connect to the drone, and execute a few basic commands
  '''

  sp = SoftwarePilot()

  # Setup a parrot anafi drone, connected through a controller, without a specific download directory
  drone = sp.setup_drone("parrot_anafi", 1, "None")

  drone.connect()

  drone.piloting.takeoff()

  # The drone will move forward 10 feet (x, y, z, angle)
  drone.piloting.move_by(10,0,0,0)

  drone.piloting.land()

  drone.disconnect()
  1. Handling Media
  from SoftwarePilot import SoftwarePilot
  import time

  '''
  This is short demo demonstrating how to get drone media
  '''

  sp = SoftwarePilot()

  # Setup a parrot anafi drone, connected through a controller, without a specific download directory
  drone = sp.setup_drone("parrot_anafi", 1, "None")

  drone.connect()

  # Without a specified directory, media will be automatically downloaded to AnafiMedia/

  # Example of how to setup, take, and download photos
  drone.camera.media.setup_photo()
  drone.camera.media.take_photo()
  drone.camera.media.download_last_media()

  # Example of how to setup, take, and download recordings
  drone.camera.media.setup_recording()
  drone.camera.media.start_recording()
  time.sleep(5)
  drone.camera.media.stop_recording()
  drone.camera.media.download_last_media()

  # Example of how to setup and process video live feed
  drone.camera.media.setup_stream(
  	yuv_frame_processing = "None", 
  	yuv_frame_cb = "None",
  	h264_frame_cb = "None",
  	start_cb = "None",
  	end_cb = "None",
  	flush_cb = "None",
  )
  # All the callbacks are optional and are automatically set to "None"
  # When set to default the stream will download all the frames and provide framerate and bitrate metadata
  drone.camera.media.start_stream()
  time.sleep(5)
  drone.camera.media.stop_stream()

  drone.disconnect()
  1. Service Interaction
  from SoftwarePilot import SoftwarePilot
  import time

  '''
  This is a short demo demonstrating how to boot up a dockerized service and requesting it with SoftwarePilot

  SoftwarePilot provides a python template of a Rest API which the user is meant to modify and dockerize
  This API is meant to offload the image processing workload to a more capable machine
  SoftwarePilot does not limit the service to which it will connect to, but the basic structure must be followed for proper behavior
  '''

  sp = SoftwarePilot()

  sp.setup_docker()
  time.sleep(5)

  # REPLACE : DOCKER_IMAGE
  container = sp.docker.deploy_container("DOCKER_IMAGE", detach = True, ports = {8000:8000})

  ip_host = sp.get_host_ip()
  service = sp.setup_service(ip_address = ip_host)
  response = service.get()
  print(response)

  # REPLACE : IMAGE_PATH
  response = service.run("IMAGE_PATH")
  print(response)
  1. All Together
  from SoftwarePilot import SoftwarePilot
  import time

  '''
  This is a short demo combining all the utilies demonstrated
  '''
  sp = SoftwarePilot()

  sp.setup_docker()
  time.sleep(5)
  # Dockerize SoftwarePilotAPITest and replace "DOCKER_IMAGE" for your custom name
  container = sp.docker.deploy_container("DOCKER_IMAGE", detach = True, ports = {8000:8000})

  ip_host = sp.get_host_ip()
  service = sp.setup_service(ip_address = ip_host)

  response = service.get()
  print(response)

  download_dir = service.get_download_path()
  drone = sp.setup_drone("parrot_anafi", 1, download_dir)
  drone.connect()

  drone.camera.media.setup_photo()
  drone.piloting.takeoff()

  num_img = 0
  while (num_img < 20):
  	drone.camera.media.take_photo()
  	image_path = drone.camera.media.download_last_media()
  	
  	response = service.run(image_path)
  	print(response)
  	drone.piloting.move_by(response['x'], response['y'], response['z'], response['angle'])
  	
  	num_img += 1

  drone.piloting.land()	

  drone.disconnect()

Authors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

SoftwarePilot-1.2.0.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

SoftwarePilot-1.2.0-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file SoftwarePilot-1.2.0.tar.gz.

File metadata

  • Download URL: SoftwarePilot-1.2.0.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.28.2 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.6

File hashes

Hashes for SoftwarePilot-1.2.0.tar.gz
Algorithm Hash digest
SHA256 4cb5532db7d37fcf194801b54ebf2e3cab84e1fe4ded928c59dab65def86e170
MD5 871b64862049dfb394b03435691c9a30
BLAKE2b-256 edf2f8354f306ff45a6ba9603decdb0e78487158174e7cfbd0151513338c1f63

See more details on using hashes here.

File details

Details for the file SoftwarePilot-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: SoftwarePilot-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.28.2 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.6

File hashes

Hashes for SoftwarePilot-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e9207688fcd5cd096bca208745cfb119a880e6f7ee1dfac8db07a247084a811a
MD5 ec6f5fbc096a666fdd745cd488551d4d
BLAKE2b-256 2f325a07c4c9486a46a998c3f3ad84bca2ff258c1762e2936bd89f2ed77174fd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page