/CrazyflieDotNet

Dot.NET libraries written in C# for Crazyflie Quadcopters and Crazyradios.

Primary LanguageC#OtherNOASSERTION

#CrazyflieDotNet Dot.NET libraries written in C# for Crazyflie Quadcopters and Crazyradios.

######Builds:

Branch Build
master Build Status
dev Build Status

######Releases:

Version
v0.1 Github Releases (by Release)

Issues

#About The CrazyFlie The Crazyflie is a tiny open source picocopter/quadcopter that began as a side project by a bunch of engineers and grew to great internet acclaim via a HackADay posting in 2011.

A lot of hard and a couple years later, they were able to bring their Crazyflie open source quadcopter into mass production.

Check out their site here.

#About This Project This is currently a work in progress in my spare time.

⭐ Pull requests are welcome if good implementation and clean code! ⭐

##Milestones:

  • Working .NET abstraction "driver" for Crazyradio USB dongle - COMPLETED
  • Implement the Crazyradio Transfer Protocol (CRTP) - IN PROGRESS
    • Able to ping copter and send commander packages.
    • Working flight with wired in PS3 controller.
  • Cross platform support using Mono framework - IN PROGRESS
  • Front end design and development - NOT STARTED

The C# CrazyradioDriver is completed and working. This library (CrazyflieDotNet.Crazyradio.dll) provides a type safe API for communication with the Crazyradio USB dongle with Crazyflies. The library and "driver" expose all available configurations for the USB dongle, including defaults. The API is quite nice and easy to understand and use, even for a beginner.

#Development

##Windows

###Dev Environment:

  1. Windows OS.
  2. Visual Studio (with NuGet installed).
  3. GitHub Windows client: https://windows.github.com/
  4. Git for Windows libraries and tools: http://msysgit.github.io/
  5. Open the GitHub Windows client and clone this repository to a folder specifically used for your GitHub clones/repos. (ex: C:\Dev\GitHub...)
  6. Open Visual Studio.
  7. Tools > Options > Source Control > Microsoft Git Provider.
  8. File > Open > Open From Source Control.
  9. In Team Explorer Window: Local Git Repositories > Add. Browse to your GitHub repos folder (ex: C:\Dev\GitHub).
  10. Team Explorer should load all found git repos within that folder.
  11. Double click this repo. Now you should see the solution(s) listed, which you can double click to open.
  12. Go to Tools > Options > Text Editor > C# > Tabs > USE TABS!
  13. If you use ReSharper, please load the shared dot settings file and use that for the solution! Use the provided clean to clean your files! Keep the code style the same! Once in a while the MASTER branch will be cleaned to ensure consistensy in style. Finally, please comment your code as done in already submitted files!

###Dev Standards:

  1. Please attempt to follow the coding style throughout the solution including tabbing, spacing, and commenting.
  2. ReSharper is recommended. Please use the supplied DotSettings to adhere to formatting/standards and use code cleanup regularly.

###OS Driver:

  1. Get the Zadig USB Tool: http://zadig.akeo.ie/
  2. Run the Zadig executable.
  3. In the drop down, select the "Crazyradio USB Dongle".
  4. Select "libusb-win32 (vx.x.x.x)" as the driver to use for the device.
  5. Note the USB IDs. The default, assumed by this library, are: 1915 (vendor ID) and 7777 (product ID).
  6. Click Install Driver.
  7. Open Device Management (devmgmt.msc in run box).
  8. Navigate to "libusb-win32 devices" to ensure that "Crazyradio USB Dongle" is listed.

#License

MIT License

CrazyflieDotNet [https://github.com/ckarcz/CrazyflieDotNet]
Copyright (c) [2013] [Chris Karcz]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.