Cflib is the low-level python driver used to communicate with the Crazyflie and Crazyflie 2.0 quadcopters. It is intended to be used by client softwares to communicate with and control a Crazyflie quadcopter.
This lib is used by the [cfclient][cfclient] Crazyflie PC client.
cflib is an API written in Python that is used to communicate with the Crazyflie
and Crazyflie 2.0 quadcopters. It is intended to be used by client software to
communicate with and control a Crazyflie quadcopter. For instance the [cfclient][cfclient] Crazyflie PC client uses the cflib.
For more info see our [wiki](http://wiki.bitcraze.se/"Bitcraze Wiki").
...
...
@@ -11,32 +11,40 @@ Installation
See [bellow](#platform-notes) for platform specific instruction.
In this section you should replace ```python``` by the version you are using (usually either ```python2``` or ```python3```). Installing for [cfclient][cfclient] requires python3
In this section you should replace ```python``` by the version you are using
(usually either ```python2``` or ```python3```). Installing for [cfclient][cfclient] requires python3
The only dependencie is pyusb:
The only dependency is pyusb:
```
python -m pip install "pyusb>=1.0.0b2"
```
To install system-wide:
To install cflib as a system-wide library (as root):
```
python setup.py install
```
To install in development mode (you can then edit the code on place):
To install cflib as a system-wide library (as user):
```
python -m pip install --user -e .
```
To install cflib in development mode where you can then edit the code on place:
```
python -m pip install -e .
```
On Linux, you might want to install only for your user (to avoid sudo):
To uninstall any of the above:
```
python -m pip instal --user -e .
python -m pip uninstall cflib
```
Examples
--------
Examples on how to use cflib to communicate with Crazyflie can be found in the example folder. To run the example you should install cflib following the [installation](#installation) section.
Examples on how to use cflib to communicate with Crazyflie can be found in the
example folder. To run the example you should install cflib following
the [installation](#installation) section.
Platform notes
--------------
...
...
@@ -49,7 +57,7 @@ To install the Crazyflie PC client in Linux, you can run the setup script with:
```sudo setup_linux.sh```
This will install the Crazyflie lib systemwide, create a udev entry for
This will install the Crazyflie lib syste-mwide, create a udev entry for
the Crazyradio and setup the permissions so that the current user can use the
radio without root permissions after restarting the computer.
