rusefi
/
atbetaflight
mirror of https://github.com/rusefi/atbetaflight.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #168 from stone/docs 

Documentation cleanup, thanks!
This commit is contained in:
Dominic Clifton 2014-11-21 23:29:24 +00:00
parent c6ed20a3ba 91d82c1b32
commit 5503131aa0
12 changed files with 36 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/Autotune.md
View File

@ -15,37 +15,25 @@ You may find a momentary switch more suitable than a toggle switch.
Turn off the autotune switch. If the autotune switch is on while not armed the warning LED will flash and you cannot arm.
Launch the multirotor.
1. Launch the multirotor.
Turn on/hold the autotune switch on your transmitter.
1. Turn on/hold the autotune switch on your transmitter. Observe roll left/right. A beep code will sound on the beeper.
Observe roll left/right. A beep code will sound on the beeper.
1. Turn off/release the switch while still flying to stop this phase of tuning. PID settings will have been updated for ROLL/YAW.
Turn off/release the switch while still flying to stop this phase of tuning.
1. Turn on/hold the switch again. Observe pitch forwards/backwards. A beep code will sound on the beeper.
PID settings will have been updated for ROLL/YAW.
1. Turn off/release the switch while still flying to stop this phase of tuning. PID settings will have been updated for PITCH/YAW.
Turn on/hold the switch again.
1. PIDS are updated, fly and see if it's better.
Observe pitch forwards/backwards. A beep code will sound on the beeper.
1. If it's worse, flip the switch again to restore previous pids that were present prior to arming.
Turn off/release the switch while still flying to stop this phase of tuning.
1. Land.
PID settings will have been updated for PITCH/YAW.
1. Verify results via an app while power still applied if desired. Cutting the power will loose the unsaved pids.
PIDS are updated, fly and see if it's better.
If it's worse, flip the switch again to restore previous pids that were present prior to arming.
Land.
Verify results via an app while power still applied if desired.
Cutting the power will loose the unsaved pids.
If you're happy with the pids then while disarmed flip the autotune switch again to save all settings then flip it back so you can arm again.
A beeper will sound indicating the settings are saved.
1. If you're happy with the pids then while disarmed flip the autotune switch again to save all settings then flip it back so you can arm again. A beeper will sound indicating the settings are saved.
# References

2
docs/Battery.md
View File

@ -18,7 +18,7 @@ All targets support battery voltage monitoring unless status.
## Connections
When dealing with batteries ALWAYS CHECK POLARITY!
When dealing with batteries **ALWAYS CHECK POLARITY!**
Measure expected voltages first and then connect to flight controller, connecting to the flight controller with
incorrect voltage or reversed polarity will likely fry your flight controller.

4
docs/Board - CC3D.md
View File

@ -5,7 +5,7 @@ auto-piloting. It only has one sensor, the MPU6000 SPI based Accelerometer/Gyro
It also features a 16mbit SPI based EEPROM chip. It has 6 ports labelled as inputs (one pin each)
and 6 ports labelled as motor/servo outputs (3 pins each).
If issues are found with this board please report via the github issue tracker.
If issues are found with this board please report via the [github issue tracker](https://github.com/cleanflight/cleanflight/issues).
The board has a USB port directly connected to the processor. Other boards like the Naze and Flip32
have an on-board USB to uart adapter which connect to the processor's serial port instead.
@ -13,7 +13,7 @@ have an on-board USB to uart adapter which connect to the processor's serial por
Currently there is no support for virtual com port functionality on the CC3D which means that cleanflight
does not currently use the USB socket at all.
The board cannot current be used for hexacopters/octocopters.
The board cannot currently be used for hexacopters/octocopters.
Tricopter & Airplane support is untested, please report success failure if you try it.

2
docs/Board - Naze32.md
View File

@ -2,7 +2,7 @@
The Naze32 target supports all Naze hardware revisions. Revison 4 and Revision 5 are used and
frequently flown by the primary maintainer. Previous Naze hardware revisions may have issues,
if found please report via the github issue tracker.
if found please report via the [github issue tracker](https://github.com/cleanflight/cleanflight/issues).
# Serial Ports

10
docs/Buzzer.md
View File

@ -16,15 +16,17 @@ This means the buzzer must be able to generate it's own tone simply by having po
Buzzers that need an analogue or PWM signal do not work and will make clicking noises or no sound at all.
Example of a known-working buzzer.
Examples of a known-working buzzers.
http://www.rapidonline.com/Audio-Visual/Hcm1205x-Miniature-Buzzer-5v-35-0055
* [Hcm1205x Miniature Buzzer 5v](http://www.rapidonline.com/Audio-Visual/Hcm1205x-Miniature-Buzzer-5v-35-0055)
* [5V Electromagnetic Active Buzzer Continuous Beep](http://www.banggood.com/10Pcs-5V-Electromagnetic-Active-Buzzer-Continuous-Beep-Continuously-p-943524.html)
## Connections
### Naze32
Connect a supported buzzer directly to the BUZZ pins. Observe polarity.
Connect a supported buzzer directly to the BUZZ pins. Observe polarity.
### CC3D
@ -32,4 +34,4 @@ Buzzer support on the CC3D requires that a buzzer circuit be created to which th
PA15 is unused and not connected according to the CC3D Revision A schematic.
Connecting to PA15 requires careful soldering.
See the CC3D - buzzer circuir.pdf for details.
See the [CC3D - buzzer circuir.pdf](Wiring/CC3D - buzzer circuir.pdf) for details.

8
docs/Configuration.md
View File

@ -14,10 +14,14 @@ See the Board specific sections for details of the serial ports available on the
## GUI
![Cleanflight Gui](cleanflight-gui.png)
The GUI tool is the preferred way of configuration. The GUI tool also includes a terminal which
can be used to interact with the CLI.
https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb
[Cleanflight Configurator on Chrome store](https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb)
## CLI
@ -25,7 +29,7 @@ Cleanflight can also be configured by a command line interface.
The CLI can be accessed via the GUI tool or by sending a single '#' character to the main serial port.
To exit the CLI without saving power off the flight controller.
To exit the CLI without saving power off the flight controller or type in 'exit'.
To see a list of commands type in 'help' and press return.

8
docs/Display.md
View File

@ -30,10 +30,10 @@ before they work. Choose wisely!
Links to screens:
http://www.banggood.com/0_96-Inch-I2C-IIC-SPI-Serial-128-X-64-OLED-LCD-LED-Display-Module-p-922246.html
http://www.wide.hk/products.php?product=I2C-0.96%22-OLED-display-module-%28-compatible-Arduino-%29
http://witespyquad.gostorego.com/accessories/readytofly-1-oled-128x64-pid-tuning-display-i2c.html
http://www.multiwiicopter.com/products/1-oled
* [banggood.com](http://www.banggood.com/0_96-Inch-I2C-IIC-SPI-Serial-128-X-64-OLED-LCD-LED-Display-Module-p-922246.html) 0.96 Inch I2C IIC Serial 128 x 64 OLED LCD
* [wide.hk](http://www.wide.hk/products.php?product=I2C-0.96%22-OLED-display-module-%28-compatible-Arduino-%29) I2C 0.96" OLED display module
* [witespyquad.gostorego.com](http://witespyquad.gostorego.com/accessories/readytofly-1-oled-128x64-pid-tuning-display-i2c.html) ReadyToFlyQuads 1" OLED Display
* [multiwiicopter.com](http://www.multiwiicopter.com/products/1-oled) PARIS 1" OLED 128x64 PID tuning screen AIR
The banggood.com screen is the cheapest at the time fo writing and will correctly send I2C ACK signals.

3
docs/LedStrip.md
View File

@ -287,9 +287,8 @@ led 27 2,9:S:FWT
All LEDs should face outwards from the chassis in this configuration.
Note:
This configuration is specifically designed for the Alien Spider AQ50D PRO 250mm frame.
This configuration is specifically designed for the [Alien Spider AQ50D PRO 250mm frame](http://www.goodluckbuy.com/alien-spider-aq50d-pro-250mm-mini-quadcopter-carbon-fiber-micro-multicopter-frame.html).
http://www.goodluckbuy.com/alien-spider-aq50d-pro-250mm-mini-quadcopter-carbon-fiber-micro-multicopter-frame.html
## Troubleshooting

2
docs/Migrating from baseflight.md
View File

@ -2,7 +2,7 @@
## Procedure
First ensure your main flight battery is disconnected or your props are off!
**First ensure your main flight battery is disconnected or your props are off!**
Before flashing with cleanflight, dump your configs for each profile via the CLI and save to a text file.

2
docs/Rx.md
View File

@ -27,7 +27,7 @@ Allows you to use MSP commands as the RC input. Only 8 channel support to maint
If using OpenTX set the transmitter module to D16 mode and select CH1-16 on the transmitter before binding to allow reception
of 16 channels.
OpenTX 2.09, which is shipped on some Taranis X9D Plus transmitters, has a bug - https://github.com/opentx/opentx/issues/1701
OpenTX 2.09, which is shipped on some Taranis X9D Plus transmitters, has a bug - [issue:1701](https://github.com/opentx/opentx/issues/1701).
The bug prevents use of all 16 channels. Upgrade to the latest OpenTX version to allow correct reception of all 16 channels,
without the fix you are limited to 8 channels regardless of the CH1-16/D16 settings.

5
docs/Serial.md
View File

@ -23,8 +23,9 @@ These are sometimes referred to as FTDI boards. FTDI is just a common manufacte
When selecting a USB to UART converter choose one that has DTR exposed as well as a selector for 3.3v and 5v since they are more useful.
Examples:
http://www.banggood.com/FT232RL-FTDI-USB-To-TTL-Serial-Converter-Adapter-Module-For-Arduino-p-917226.html
http://www.banggood.com/Wholesale-USB-To-TTL-Or-COM-Converter-Module-Buildin-in-CP2102-New-p-27989.html
* [FT232RL FTDI USB To TTL Serial Converter Adapter](http://www.banggood.com/FT232RL-FTDI-USB-To-TTL-Serial-Converter-Adapter-Module-For-Arduino-p-917226.html)
* [USB To TTL / COM Converter Module buildin-in CP2102](http://www.banggood.com/Wholesale-USB-To-TTL-Or-COM-Converter-Module-Buildin-in-CP2102-New-p-27989.html)
Both SoftSerial and UART ports can be connected to your computer via USB to UART converter boards.

BIN
docs/cleanflight-gui.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 70 KiB