Commit graph

534 commits

Author SHA1 Message Date
Andrew Payne b4b4924df7 Rewrite section about props spinning when armed 2015-04-12 20:26:30 -04:00
Andrew Payne 53f45b8795 Make references to doc pages links 2015-04-12 20:14:07 -04:00
Alex Zaitsev 2fa4932f47 Added information about TPA rate. 2015-04-11 23:11:48 +03:00
Chris Mavrakis 89131ecd4a Added a how-to-setup-everything walkthrough guide as a README file. It explains the basic setup steps a CF noob should follow, linking to individual docs. The rest of the docs (the advanced ones) are listed and linked at the bottom. Incorporated thenickdude's, bhuism's and hydra's suggestions, too. 2015-04-11 17:49:41 +02:00
Denis Kisselev f882750e49 Update Autotune.md
Typo
2015-04-08 12:31:14 -07:00
Dominic Clifton 87091802e6 Update autotune documentation. 2015-04-07 21:39:45 +01:00
Dominic Clifton 939773ce4f Merge pull request #722 from modem158/patch-1
Update Cli.md
2015-04-07 21:03:42 +01:00
Dominic Clifton 687cc2823c Merge pull request #716 from Lordnibbler/patch-1
Fix typos in Profiles.md
2015-04-07 21:03:04 +01:00
Dominic Clifton caf253e4f8 Automatically disable pid_at_min_throttle when retarded_arm is
enabled.  Closes #719.
2015-04-07 20:59:38 +01:00
E Thomas f02d7403af Port of refactored beeper code 181_1
This the "Port of refactored beeper code #669" modification applied to
version 1.8.1 (4/4/2015) of the code.
2015-04-04 17:54:44 -04:00
t0mmg a6939a4743 Documentation update for cli.md
Added descriptions for acc_lpf_factor, gyro_cmpf_factor and gyro_cmpfm_factor.
2015-04-04 12:03:38 +01:00
modem158 a2ab44c382 Update Cli.md
Removed part of a confusing sentence
2015-04-03 13:27:12 -04:00
pulsar e6006232c8 using css overrides to restrict wide content resizing the pdf canvas
css overrides to restrict wide content resizing the pdf canvas

pdf manual building using ruby1.9, ci integration, cosmetics.

fixed typo

debugging travis build env

upload script bugfixes, fighting ruby env

fighting ruby env

fighting ruby env

fighting ruby env
2015-04-03 18:05:48 +02:00
Ben 15c2840779 Fix typos in Profiles.md 2015-04-02 21:39:52 -07:00
Dominic Clifton 9aa5753c03 Merge pull request #682 from dkisselev/patch-2
Fix vendor reference in GPS hardware table
2015-04-01 22:05:21 +01:00
Dominic Clifton 7dcb4d93e9 SmartPort - Updating telemetry documentation. 2015-04-01 21:52:24 +01:00
Paul Rogalinski 7899d3c38e support for build artifact upload to a remote server 2015-04-01 16:04:30 +02:00
Alex Zaitsev 45edf752df Update Cli.md 2015-04-01 16:46:20 +03:00
Dominic Clifton 8a9d2e3708 Updating port configuration documentation, closes #692. 2015-03-31 13:41:00 +01:00
Per Magnus Auby b83b9040f9 Updates sonar so that it can be used together with ADC current meter
Check if ADC current meter is enabled in sonarInit() and change
sonar pins to pwm 5 and 6 if it is. Same as when RX_PARALLEL is enabled.
2015-03-31 13:47:17 +02:00
Dominic Clifton 54419ef97c Updating Sparky battery monitoring documentation. 2015-03-30 21:49:07 +01:00
Dominic Clifton d33e4e6afd Merge branch 'Battery_monitoring' of git://github.com/MJ666/cleanflight into MJ666-Battery_monitoring 2015-03-30 19:44:33 +01:00
Matthew Evans f13e936601 fixed docs pidadjust screenshot. 2015-03-30 12:53:56 +01:00
Dominic Clifton 1bac2830aa Merge pull request #642 from ledvinap/doc-pid-internals
Augment/improve PID Internals
2015-03-30 11:37:08 +01:00
Dominic Clifton 6922857db0 Merge pull request #683 from sherlockflight/flash-N25Q064
Add support for Micron N25Q064 64Mbit SPI flash
2015-03-30 11:35:42 +01:00
Dominic Clifton 20fd7b8491 Merge pull request #565 from mosh1/new_failsafe_defaults
Default failsafe enabled and throttle off when no valid PPM signal is se...
2015-03-30 11:15:25 +01:00
Moshen Chan d6db3dbf08 Fix grammar 2015-03-29 23:44:12 -07:00
Moshen Chan e110a30efc Update docs with incorrect info for rssi_channel and add the renamed functionality. 2015-03-29 23:42:55 -07:00
Nicholas Sherlock 85dc16f96d Add support for Micron N25Q064 64-mbit SPI flash 2015-03-30 18:17:56 +13:00
Nicholas Sherlock 01b811cd8c Add support for Winbond 64Mbit SPI flash chip 2015-03-30 12:04:41 +13:00
Denis Kisselev 3ba865cbe7 Fix vendor reference in GPS hardware table 2015-03-29 15:08:14 -07:00
Dominic Clifton 16fda38eba Merge pull request #625 from OpCode1300/docs
Board recovery documentation.
2015-03-28 20:58:55 +00:00
Dominic Clifton 02d8313437 Additional cleanup of generic Flashing docs. 2015-03-28 20:48:01 +00:00
Dominic Clifton ab30a208e1 Updating generic flashing instructions.
Removing link to docs, doesn't make sense when compiled to PDF and all
documentation links must be relative.
2015-03-28 20:46:14 +00:00
Dominic Clifton 499ca8b203 Merge pull request #656 from cmavr8/docs-installation-additions
Docs: Added detailed steps for flashing
2015-03-28 20:40:00 +00:00
Dominic Clifton b40b35e162 Updating GPS tested hardware list. Closes #627 2015-03-28 20:37:43 +00:00
Dominic Clifton 0c82141472 Use preferred alternative formatting for code blocks in Cli.md docs.
See #650
2015-03-28 20:20:53 +00:00
Dominic Clifton 0d221bded9 Merge pull request #650 from mtrl/master
Put CLI commands in code blocks so they appear in the markdown correctly
2015-03-28 20:18:36 +00:00
Dominic Clifton 4e07899a06 Move the updated list of user-tested GPS hardware back into Gps.md - no
real reason to split it out to a seperate file.  Additionally the
seperate file was not listed in build_docs.sh and therefore was not
included in the PDF documentation.

If there was a section of supported hardware as an appendix to the
documentation that we could move it back, but that should be done for
GPS, RX's, LED, Buzzers, etc  and all at the same time.
2015-03-25 13:28:32 +00:00
Dominic Clifton 8c5050848d Update telemetry documentation now that telemetry_provider is gone.
Closes #670.
2015-03-25 13:23:15 +00:00
Dominic Clifton 497929816a Merge pull request #652 from sherlockflight/docs
Add building instructions for Mac OS X
2015-03-22 21:25:27 +00:00
Dominic Clifton 472409e7e0 Merge pull request #659 from digitalentity/patch-1
Update GPS tested hardware
2015-03-22 21:23:24 +00:00
Dominic Clifton 1ca00bdb9e Adding developer docs regarding configuration storage. 2015-03-22 09:41:37 +00:00
Konstantin Sharlaimov ec6df122cc Update GPS tested hardware
Added a GPS receiver I verified to be working with CF on my quad
2015-03-22 09:19:08 +10:00
Chris Mavrakis 78b8f8908d Added detailed steps for firmware flashing 2015-03-21 19:03:18 +01:00
Dominic Clifton 31616dd010 Merge pull request #655 from skyflyer/master
References cleanflight/cleanflight#631 - revised docs
2015-03-21 14:29:15 +00:00
Nicholas Sherlock 23908f9dd4 Add building instructions for Mac OS X 2015-03-21 19:12:47 +13:00
Mark Williams 8b3a5dbb73 Put CLI commands in code blocks so they appear in the markdown correctly 2015-03-19 21:17:56 +00:00
Mark Williams a94d73ad3b Typo fix for rate export commands in cli.md 2015-03-19 20:50:30 +00:00
Miha Valencic aedb666909 References cleanflight/cleanflight#631 - added feature FAILSAFE and spellchecked 2015-03-19 09:47:50 +01:00
Petr Ledvina e15322868e Augment/improve PID Internals 2015-03-18 19:51:25 +01:00
Michael Jakob 0c0b2e8461 Enable battery monitoring for Sparky and ALIENWII F3 2015-03-17 21:35:10 +01:00
Administrator 934adfc613 Merge remote-tracking branch 'cleanflight/master' into docs 2015-03-15 19:55:13 -04:00
tracernz 0f3c4afcc4 Add note on passthrough mode 2015-03-15 17:11:49 +13:00
Administrator f6ef4273b4 Markdown touchups 2015-03-14 23:50:32 -04:00
Administrator 4baec3eed2 Wrap ASCII board in code block to correct display formatting 2015-03-14 23:46:51 -04:00
Administrator 1747f621d4 Better formatting and more verbose 2015-03-14 23:31:34 -04:00
Administrator c38611191d Add 5V pad warning, and configurator setting. 2015-03-14 23:21:05 -04:00
Administrator ae83189085 Board recovery documentation. 2015-03-14 21:34:34 -04:00
Dominic Clifton 0e2356bf00 Updating failsafe documentation. 2015-03-14 22:14:39 +01:00
Dominic Clifton 9b092a841b Merge pull request #621 from OpCode1300/docs
GPS support and hardware split
2015-03-14 21:20:51 +01:00
Dominic Clifton 4cf6fe6571 Rename 'frsky_hiprec_vfas' to 'frsky_vfas_precision' and introduce enum
for FRSKY_VFAS_PRECISION_LOW and FRSKY_VFAS_PRECISION_HIGH.

Improves naming for humans.  'hiprec' was meaningless and
untranslatable. See
https://cleancoders.com/episode/clean-code-episode-2/show
2015-03-13 23:49:24 +01:00
Dominic Clifton d82fc6b9be Merge pull request #477 from projectkk2glider/projectkk2glider/issue_316_frsky_voltages
Fixes #316: better arithmetics for FrSky CELL voltages, VFAS battery vol...
2015-03-13 23:40:24 +01:00
Dominic Clifton 626bd29dae Merge pull request #592 from sherlockflight/blackbox-serial-baud
Support new 230400 baud rate which allows >750Hz Blackbox logging
2015-03-13 23:24:57 +01:00
Dominic Clifton ecc6645783 CC3D - Adding instructions on how to restore the OpenPilot bootloader
via JLink.
2015-03-13 23:06:27 +01:00
Administrator 028d616169 GPS support and hardware split
Moved supported hardware to new doc. Added support for Ublox Neo-M8N
2015-03-13 14:06:20 -04:00
dascons 6f7f1d7430 Update LedStrip.md
Minor changes stating that the leds can now be configured by the GUI and a link to http://blog.oscarliang.net/setup-rgb-led-cleanflight/
2015-03-12 23:36:57 +13:00
Dominic Clifton 764b1ecc18 Merge pull request #576 from tracernz/vcm-doc
Fix error in VCM docs
2015-03-11 20:19:09 +01:00
Dominic Clifton bf95cbcaf4 Merge pull request #602 from dkisselev/patch-1
Fix default value on updated pid_at_main_throttle
2015-03-11 20:17:29 +01:00
Dominic Clifton f62b5c883d Merge pull request #601 from tricopterY/tricopterY-patch-1
Update serial_msp.c
2015-03-11 20:15:24 +01:00
Dominic Clifton 3a0a4e70f9 Merge pull request #608 from icdark/patch-1
Fix typo in "PID tuning.md"
2015-03-11 20:11:04 +01:00
Brnadon Miller 036fa9c049 Added custom mixer examples and documentation 2015-03-11 14:20:45 -04:00
Brnadon Miller eccdca9262 Merge remote-tracking branch 'remotes/cleanflight/master' 2015-03-11 14:04:12 -04:00
icdark e1be456b3c Fix typo in "PID tuning.md" 2015-03-11 12:36:54 +01:00
Nicholas Sherlock cee021706b Merge remote-tracking branch 'upstream/master' into blackbox-serial-baud 2015-03-11 13:31:30 +13:00
Denis Kisselev 1eae5e3ac3 Fix default value on updated pid_at_main_throttle
The code was updated changing the default to 1 with the last commit but that change was not reflected here
2015-03-09 19:25:38 -07:00
Dominic Clifton 44b36107a6 Documenting the ID's used for modes by the CLI.
See #509, #510, #518
2015-03-09 23:41:08 +00:00
tricopterY fe47223453 Merge pull request #2 from cleanflight/master
Update from Original
2015-03-10 10:11:07 +11:00
Dominic Clifton ed434fe47b Use a positive named setting and variable instead of a negative one to
simplify the logic and aid understanding.
2015-03-09 22:50:27 +00:00
Dominic Clifton acabbf41db Previously, at minimum throttle, the quad would do absolutely no self-leveling
and simply run the motors at constant minthrottle.  This allowed the chance
for the quad to lose control during flight if the throttle was set to minimum,
say, to drop from a high altitude to a lower one.

With this edit, the quad will still self-level at minimum throttle when armed,
allowing for safe decents from altitude.  To prevent motors spinning when
arming/disarming, the yaw input is ignored if the throttle is at minimum and
we're using the sticks to arm/disarm.

Conflicts:
	src/main/flight/mixer.c
2015-03-09 23:44:53 +01:00
Damjan Adamic 517d38c94f Re #316: Battery voltage calculation converted to integer arithmetic, unit tests updated to account for proper rounding of voltage
Added frsky_hiprec_vfas configuration option that selects how VFAS is sent
Better arithmetics for FrSky CELL voltages, VFAS battery voltage send with other ID that allows 0.1V resolution
2015-03-09 20:43:04 +01:00
Alex Gorbatchev 7331bdbd4f Update Inflight Adjustments.md
Adds separators between example images so that it's possible to tell what's what.
2015-03-06 21:08:22 -08:00
Nicholas Sherlock 3b5d2b6a16 Change recommended Blackbox baudrate to 250000
This is because the AVR's 230400 baudrate is very inaccurate, while the
250000 baudrate is spot-on.
2015-03-07 13:07:03 +13:00
Nicholas Sherlock 644db9b8fa Add baud rate identifier docs for new 230400 & 250000 speeds 2015-03-07 02:01:44 +13:00
Nicholas Sherlock 5e917090b6 Merge remote-tracking branch 'upstream/master' into blackbox-serial-baud 2015-03-07 02:01:03 +13:00
Nicholas Sherlock 54acc67767 Add notes about the performance of Sandisk Ultra cards 2015-03-06 23:44:05 +13:00
Nicholas Sherlock 8df0d03f44 Update docs for new Blackbox baud rate options 2015-03-06 20:31:33 +13:00
Moshen Chan 55d2ef684d Update with failsafe_throttle default. #488 2015-03-05 18:30:05 -08:00
Brnadon Miller 7366ecf60b Updated for colors in plain English. 2015-03-05 11:47:41 -05:00
Dominic Clifton 8e29afd167 Document baud rate identifiers. 2015-03-05 11:14:10 +00:00
Dominic Clifton d4dd1f6a58 Merge pull request #571 from fusterjj/docs_servotune
Servo tune documentation
2015-03-05 00:31:31 +00:00
Dominic Clifton 94e499f9aa Serial port documentation update. 2015-03-03 22:52:56 +00:00
Dominic Clifton dca984ff88 Merge branch 'master' into serial-cleanup
Conflicts:
	src/main/telemetry/hott.c
2015-03-03 17:21:43 +00:00
Brnadon Miller e5f23669c0 Added documentation for predefined light colors for orientation and flight modes 2015-03-02 18:12:01 -05:00
Brnadon Miller aed170f1a9 Add table for LED Strip Colors 2015-03-02 18:03:15 -05:00
Joel Fuster afeedf40c7 Servo tune documentation 2015-02-28 20:01:02 -05:00
Nicholas Sherlock b2e46ea5f4 Update blackbox doc to mention support for CC3d 2015-02-28 01:05:28 +13:00
Dominic Clifton b6509dd1eb Merge branch 'master' into serial-cleanup
Conflicts:
	src/main/blackbox/blackbox_io.c
	src/main/config/config.c
2015-02-26 22:43:29 +00:00
Dominic Clifton ed434dd169 Cleanup ACC hardware enum so that 'None' is always '1' and doesn't
change every time a new sensor is added.  All the sensor enum values are
now aligned.
2015-02-26 22:31:38 +00:00
Richard Birkby da6bbf460f Fix docs for Alien Spider LED configuration 2015-02-26 07:54:02 +00:00
tracernz 872b1ea695 Fix error in VCM docs 2015-02-26 10:30:44 +13:00
Dominic Clifton b568b9c59d Update led strip documentation. 2015-02-22 22:20:27 +00:00
Dominic Clifton 2f09b7d1d9 Merge branch 'blackbox-flash' of https://github.com/sherlockflight/cleanflight-dev into sherlockflight-blackbox-flash 2015-02-22 17:24:39 +00:00
Dominic Clifton a1b01807cf Merge branch 'lowpass' of https://github.com/fusterjj/cleanflight into fusterjj-lowpass
Conflicts:
	src/main/flight/mixer.c
2015-02-22 14:55:04 +00:00
Dominic Clifton 4a1b27443f Enable/Disable LCD page cycling using stick combos. 2015-02-22 14:01:38 +00:00
tricopterY 145c761567 Update Safety.md
Added note to direct user to other important docs
2015-02-21 17:16:03 +11:00
Nicholas Sherlock f6c9f7cc4a Merge remote-tracking branch 'upstream/master' into blackbox-flash 2015-02-21 12:52:26 +13:00
Dominic Clifton 523980fc7b Merge remote-tracking branch 'cleanflight/master' into serial-cleanup 2015-02-20 20:15:09 +00:00
Dominic Clifton 1a7fe33e16 Merge pull request #511 from MJ666/AlienWii
ALIENWII F3/F1 target cleanup and documentation update
2015-02-20 16:41:08 +00:00
Dominic Clifton ae8be396d6 Correct markdown formatting on Oneshot.md. 2015-02-20 14:30:35 +00:00
Dominic Clifton da7a0a184c Merge branch 'patch-1' of https://github.com/MaxWinterstein/cleanflight into MaxWinterstein-patch-1 2015-02-20 14:27:46 +00:00
Dominic Clifton b4cc7c4cb4 Merge branch 'dave-pitman-pid' of https://github.com/dave-pitman/cleanflight into dave-pitman-dave-pitman-pid
Conflicts:
	docs/PID tuning.md
2015-02-20 14:20:24 +00:00
Dominic Clifton 4554feb5e7 Merge pull request #474 from Zappes/master
Update Spektrum bind.md
2015-02-20 13:48:32 +00:00
Dominic Clifton 81926974f4 Merge pull request #463 from dave-pitman/dave-pitman-rates
Add Rates & Expo documentation
2015-02-20 13:43:45 +00:00
Dominic Clifton 1fbc9087a0 Merge pull request #478 from JohnieBraaf/patch-1
Update Hardware Debugging.md
2015-02-20 13:42:33 +00:00
Dominic Clifton fdfb053897 Merge pull request #485 from ledvinap/doc-pid-internals
Doc pid internals
2015-02-20 13:41:51 +00:00
Dominic Clifton 97f71aed5f Merge pull request #507 from wiebel/patch-1
Some Linux secific remarks
2015-02-20 13:39:51 +00:00
Dominic Clifton 2a2b89f580 Merge pull request #519 from tracernz/safety-docs
Safety docs
2015-02-20 13:39:09 +00:00
Dominic Clifton 2df04ab403 Merge pull request #520 from tracernz/cli-docs
Document CLI variables
2015-02-20 13:36:29 +00:00
Dominic Clifton 4e72db6dad Merge pull request #508 from tracernz/vcm-doc
Clarify Virtual Current Meter docs
2015-02-20 13:22:22 +00:00
Michael Jakob 91b4cafbfa ALIENWII F3/F1 target cleanup and documentation update 2015-02-20 07:36:52 +01:00
tracernz 6418116130 Add baseflight docs 2015-02-18 19:16:13 +13:00
tracernz 59198905c0 Add safety documentation 2015-02-17 20:31:02 +13:00
Nicholas Sherlock a67c1ef443 Minor Blackbox doc fix 2015-02-16 23:39:01 +13:00
Nicholas Sherlock f21f5d51b4 Document Blackbox dataflash mode 2015-02-16 23:35:28 +13:00
tracernz 51727a2d96 Begin Documenting CLI Vars
The lack of documentation on these variables is a common complaint on the RCGroups thread. Begin to document them.
2015-02-16 20:30:30 +13:00
Dave Pitman d834552261 Update PID tuning.md 2015-02-14 09:07:12 -08:00
Dave Pitman 09c13f16af Update PID tuning.md
Added tpa note on Controller 1.
2015-02-14 09:05:03 -08:00
tracernz eb9841c41c Clarify Virtual Current Meter docs
The tuning method for the parameters wasn't totally clear.
2015-02-14 13:00:54 +13:00
wiebel 733c5fe971 Some Linux secific remarks 2015-02-13 13:14:19 +01:00
Dave Pitman c9747f397e Update PID tuning.md
Added note on PID cont. 1 about P_Level that has been merged since this PR was created.
2015-02-12 09:57:43 -08:00
Dave Pitman fe31a3016c Update PID tuning.md 2015-02-12 09:49:40 -08:00
Dave Pitman adf6f710f4 Update PID tuning.md
Added note about TPA not being used by all PID controllers.
2015-02-12 09:48:48 -08:00
Dominic Clifton 5163bef0b2 Refactor serial port configuration, stage 1.
Tested and working:
* multiple MSP ports at different baud rates.
* cli on any MSP port.
* GPS
* gps passthough on currently active cli port.

Example config used for testing:

feature SOFTSERIAL
feature GPS
feature RX_PPM
serial_port_1_functions = 1
serial_port_1_baudrate = 115200
serial_port_2_functions = 128
serial_port_2_baudrate = 115200
serial_port_3_functions = 1
serial_port_3_baudrate = 19200
serial_port_4_functions = 0
serial_port_4_baudrate = 0

Known broken:
* Telemetry and shared serial ports
* Telemetry when unarmed.

Probably broken:
* Blackbox on shared port.

Untested.
* Serial RX.
* Blackbox.
2015-02-12 01:28:53 +00:00
Dominic Clifton 519cc5f238 CC3D - Updating docs regarding inverter. 2015-02-11 19:44:00 +00:00
Petr Ledvina 8edce9062f fix typo 2015-02-09 08:30:30 +01:00
Petr Ledvina 03900bab40 formating 2015-02-07 17:16:14 +01:00
Petr Ledvina 8e6946da5a Starting PID internals documentation 2015-02-07 16:58:50 +01:00
Dominic Clifton 2dc09cd24b Merge pull request #457 from dave-pitman/patch-1
Update PID tuning.md
2015-02-06 14:08:11 +00:00
Max Winterstein fb822c0009 Update Oneshot.md
BLHeli rev13.0 also supports oneshot125. see https://github.com/bitdump/BLHeli/blob/master/Atmel/BLHeli.asm#L33
2015-02-05 23:22:31 +01:00
Dave Pitman b07a001298 Update PID tuning.md 2015-02-04 22:41:56 -08:00
Dave Pitman 8c18b59530 Update PID tuning.md 2015-02-04 17:52:13 -08:00
Dave Pitman fddf3a5761 Update PID tuning.md 2015-02-04 17:33:47 -08:00
JohnieBraaf c28d2f4377 Update Hardware Debugging.md
Added reference to detailed guide in the wiki, and visual studio IDE setup
2015-02-05 01:52:47 +01:00
Dave Pitman e0e815ce73 Update PID tuning.md 2015-02-04 16:26:01 -08:00
Dave Pitman a408041df8 Update PID tuning.md 2015-02-04 14:52:10 -08:00
Gregor Ottmann 5867f3a6db Update Spektrum bind.md
Updated as per MJ666's instructions
2015-02-04 12:34:54 +01:00
Gregor Ottmann e9e3829cf5 Update Spektrum bind.md
Added tested satellite transmitter combinations as given by MJ666
2015-02-04 11:55:16 +01:00
Gregor Ottmann ac5f45d7f2 Update Spektrum bind.md
Section about connecting a satellite to the Flip32+ was changed so it wasn't specific for the Orange RX anymore.
2015-02-04 08:39:36 +01:00
Gregor Ottmann 23c966c6f1 Update Spektrum bind.md
Added a description for connecting the SAT to a Flip32+ board
2015-02-03 19:04:04 +01:00