diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af458ab3a..14de0a9c0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Issues and Support. -Please remember the issue tracker on github is _not_ for user support. Please also do not email developers directly for support. Instead please use IRC or the forums first, then if the problem is confirmed create an issue that details how to repeat the problem so it can be investigated. +Please remember the issue tracker on github is _not_ for user support. Please also do not email developers directly for support. Instead please use IRC or the forums first, Also read through the wiki for guidance. Then if the problem is confirmed create an issue that details how to repeat the problem so it can be investigated. Issues created without steps to repeat are likely to be closed. E-mail requests for support will go un-answered; All support needs to be public so that other people can read the problems and solutions. @@ -8,6 +8,14 @@ Remember that issues that are due to mis-configuration, wiring or failure to rea Please search for existing issues *before* creating new ones. +When submitting an issue the general rule is to include: + +1. What is your setup and a detailed explanation of the issue, also include last working version of iNav. +1. status dump from cli. +1. bootlog dump from cli. +1. dump dump from cli. +1. BLACKBOX log of the issue. + # Developers Please refer to the development section in the `docs/development` folder. diff --git a/docs/Cli.md b/docs/Cli.md index 20b2d54d5..7b4097a2d 100644 --- a/docs/Cli.md +++ b/docs/Cli.md @@ -107,7 +107,7 @@ Re-apply any new defaults as desired. | `emf_avoidance` | Default value is 0 for 72MHz processor speed. Setting this to 1 increases the processor speed, to move the 6th harmonic away from 432MHz. | OFF | ON | OFF | Master | UINT8 | | `i2c_overclock` | Default value is 0 for disabled. Enabling this feature speeds up IMU speed significantly and faster looptimes are possible. | OFF | ON | OFF | Master | UINT8 | | `gyro_sync` | Default value is Off. This option enables gyro_sync feature. In this case the loop will be synced to gyro refresh rate. Loop will always wait for the newest gyro measurement. Use gyro_lpf and gyro_sync_denom determine the gyro refresh rate. Note that different targets have different limits. Setting too high refresh rate can mean that FC cannot keep up with the gyro and higher gyro_sync_denom is needed, | OFF | ON | OFF | Master | UINT8 | -| `gyro_sync_denom` | This option determines the sampling ratio. Denominator of 1 means full gyro sampling rate. Denominator 2 would mean 1/2 samples will be collected. Denominator and gyro_lpf will together determine the control loop speed. | 0 | 1 | 1 | Master | UINT8 | +| `gyro_sync_denom` | This option determines the sampling ratio. Denominator of 1 means full gyro sampling rate. Denominator 2 would mean 1/2 samples will be collected. Denominator and gyro_lpf will together determine the control loop speed. | 1 | 32 | 1 | Master | UINT8 | | `mid_rc` | This is an important number to set in order to avoid trimming receiver/transmitter. Most standard receivers will have this at 1500, however Futaba transmitters will need this set to 1520. A way to find out if this needs to be changed, is to clear all trim/subtrim on transmitter, and connect to GUI. Note the value most channels idle at - this should be the number to choose. Once midrc is set, use subtrim on transmitter to make sure all channels (except throttle of course) are centered at midrc value. | 1200 | 1700 | 1500 | Master | UINT16 | | `min_check` | These are min/max values (in us) which, when a channel is smaller (min) or larger (max) than the value will activate various RC commands, such as arming, or stick configuration. Normally, every RC channel should be set so that min = 1000us, max = 2000us. On most transmitters this usually means 125% endpoints. Default check values are 100us above/below this value. | 0 | 2000 | 1100 | Master | UINT16 | | `max_check` | These are min/max values (in us) which, when a channel is smaller (min) or larger (max) than the value will activate various RC commands, such as arming, or stick configuration. Normally, every RC channel should be set so that min = 1000us, max = 2000us. On most transmitters this usually means 125% endpoints. Default check values are 100us above/below this value. | 0 | 2000 | 1900 | Master | UINT16 | @@ -257,7 +257,7 @@ Re-apply any new defaults as desired. | `flaperon_throw_inverted` | Inverts throw offset on both ailerons. Can be used to create SPOILERON or just to change throw direction | OFF | ON | OFF | Profile | UINT8 | | `fw_iterm_throw_limit` | Limits max/min I-term value in stabilization PID controller in case of Fixed Wing. It solves the problem of servo saturation before take-off/throwing the airplane into the air. By default, error accumulated in I-term can not exceed 1/3 of servo throw (around 165us). | 25 | 500 | 165 | Profile | UINT16 | -## New iNav spesific +## New iNav specific | `Variable` | Description/Units | Min | Max | Default | Type | Datatype | |-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|--------|------------------|--------------|----------| | `acczero_x` | Calculated value after '6 position avanced calibration'. See Wiki page. | 0 | 0 | 0 | Master | UNKNOWN | diff --git a/docs/development/Building in Ubuntu.md b/docs/development/Building in Ubuntu.md index 428dce95e..6c7625563 100755 --- a/docs/development/Building in Ubuntu.md +++ b/docs/development/Building in Ubuntu.md @@ -22,6 +22,19 @@ sudo add-apt-repository ppa:terry.guo/gcc-arm-embedded sudo apt-get update ``` +For Linux Mint 18 (Ubuntu 16, 2016-09-11) +``` +sudo apt install git +sudo apt install gcc +sudo apt install gcc-arm-none-eabi +sudo apt-get install libnewlib-arm-none-eabi + +cd src +git clone https://github.com/iNavFlight/inav.git +cd inav +make TARGET=NAZE +``` + For Ubuntu 14.10 (current release, called Utopic Unicorn), you should pin: ``` sudo apt-get install gcc-arm-none-eabi=4.9.3.2014q4-0utopic12