Skip to content

Commit d40a37d

Browse files
committed
fix to cflib doc
1 parent 6e93153 commit d40a37d

File tree

2 files changed

+24
-53
lines changed

2 files changed

+24
-53
lines changed

docs/development/matlab.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ page_id: matlab
44
---
55

66

7-
Using Matlab with the Crazyflie API is easy -- you just need to install
8-
the python 'matlab engine' and then can access all matlab commands
7+
To use the Python cflib with matlab, you will need to install the python 'matlab engine' and then can access all matlab commands
98
directly from python.
109

11-
Prerequisites
10+
*Note that these are old instructions and they might not work anymore**
11+
12+
Tried with
1213
-------------
1314

14-
1. MATLAB 2014b or later
15+
1. MATLAB 2014b
1516
2. 64 bit python 2.7, 3.3 or 3.4
1617
3. The Crazyflie API
1718

docs/installation/install.md

Lines changed: 19 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,22 @@ page_id: install
77

88
This project requires Python 3.7+.
99
See below sections for more platform-specific requirements.
10-
## Development
11-
### Developing for the cflib
12-
* [Fork the cflib](https://help.github.com/articles/fork-a-repo/)
13-
* [Clone the cflib](https://help.github.com/articles/cloning-a-repository/), `git clone git@github.com:YOUR-USERNAME/crazyflie-lib-python.git`
14-
* [Install the cflib in editable mode](http://pip-python3.readthedocs.org/en/latest/reference/pip_install.html?highlight=editable#editable-installs), `pip install -e path/to/cflib`
15-
16-
17-
* [Uninstall the cflib if you don't want it any more](http://pip-python3.readthedocs.org/en/latest/reference/pip_uninstall.html), `pip uninstall cflib`
10+
## Install from Source
11+
### Clone the repository
12+
```
13+
git clone https://github.com/bitcraze/crazyflie-lib-python.git
14+
```
15+
### Install cflib from source
16+
```
17+
cd crazyflie-lib-pyhon
18+
pip install -e .
19+
```
20+
21+
### Uninstall cflib
22+
23+
```
24+
pip uninstall cflib
25+
```
1826

1927
Note: If you are developing for the cflib you must use python3. On Ubuntu (20.04+) use `pip3` instead of `pip`.
2028

@@ -34,9 +42,6 @@ you can skip this section.
3442

3543
* To deactivate the virtualenv when you are done using it `deactivate`
3644

37-
Note: For systems that support [make](https://www.gnu.org/software/make/manual/html_node/Simple-Makefile.html), you can use `make venv` to
38-
create an environment, activate it and install dependencies.
39-
4045
#### Install cflib dependencies
4146
Install dependencies required by the lib: `pip install -r requirements.txt`. If you are planning on developing on the lib you should also run: `pip install -r requirements-dev.txt`.
4247

@@ -61,47 +66,12 @@ For information and installation of the
6166
Note: Docker and the toolbelt is an optional way of running tests and reduces the
6267
work needed to maintain your python environment.
6368

64-
### Native python on Linux, OSX, Windows
65-
[Tox](http://tox.readthedocs.org/en/latest/) is used for native testing: `pip install tox`
66-
* If test fails after installing tox with `pip install tox`, installing with `sudo apt-get install tox`result a successful test run
67-
68-
* Test package in python3.4 `TOXENV=py34 tox`
69-
* Test package in python3.6 `TOXENV=py36 tox`
70-
71-
Note: You must have the specific python versions on your machine or tests will fail. (ie. without specifying the TOXENV, `tox` runs tests for python 3.3, 3.4 and would require all python versions to be installed on the machine.)
72-
73-
7469
## Platform notes
7570

7671
### Linux
7772

78-
#### Setting udev permissions
79-
80-
The following steps make it possible to use the USB Radio without being root.
73+
With linux, the crazyradio is easily recognized, but you have to setup UDEVpermissions. Look at the [usb permission instructions](/docs/installation/usb_permissions.md) to setup udev on linux.
8174

82-
```
83-
sudo groupadd plugdev
84-
sudo usermod -a -G plugdev $USER
85-
```
75+
### Windows
8676

87-
You will need to log out and log in again in order to be a member of the plugdev group.
88-
89-
Create a file named ```/etc/udev/rules.d/99-crazyradio.rules``` and add the
90-
following:
91-
```
92-
# Crazyradio (normal operation)
93-
SUBSYSTEM=="usb", ATTRS{idVendor}=="1915", ATTRS{idProduct}=="7777", MODE="0664", GROUP="plugdev"
94-
# Bootloader
95-
SUBSYSTEM=="usb", ATTRS{idVendor}=="1915", ATTRS{idProduct}=="0101", MODE="0664", GROUP="plugdev"
96-
```
97-
98-
To connect Crazyflie 2.0 via usb, create a file name ```/etc/udev/rules.d/99-crazyflie.rules``` and add the following:
99-
```
100-
SUBSYSTEM=="usb", ATTRS{idVendor}=="0483", ATTRS{idProduct}=="5740", MODE="0664", GROUP="plugdev"
101-
```
102-
103-
You can reload the udev-rules using the following:
104-
```
105-
sudo udevadm control --reload-rules
106-
sudo udevadm trigger
107-
```
77+
Look at the [Zadig crazyradio instructions](https://www.bitcraze.io/documentation/repository/crazyradio-firmware/master/building/usbwindows/) to install crazyradio on Windows

0 commit comments

Comments
 (0)