docs/Profiles.md

   1 # Profiles
   2
   3 A profile is a set of configuration settings.
   4
   5 Currently three profiles are supported. The default profile is profile `0`.
   6
   7 ## Changing profiles
   8
   9 Profiles can be selected using a GUI or the following stick combinations:
  10
  11 | Profile | Throttle | Yaw   | Pitch  | Roll   |
  12 | ------- | -------- | ----- | ------ | ------ |
  13 | 0       | Down     | Left  | Middle | Left   |
  14 | 1       | Down     | Left  | Up     | Middle |
  15 | 2       | Down     | Left  | Middle | Right  |
  16
  17 The CLI `profile` command can also be used:
  18
  19 ```
  20 profile <index>
  21 ```
  22
  23 # Rate Profiles
  24
  25 Cleanflight supports rate profiles in addition to regular profiles.
  26
  27 Rate profiles contain settings that adjust how your craft behaves based on control input.
  28
  29 Three rate profiles are supported.
  30
  31 Rate profiles can be selected while flying using the inflight adjustments feature.
  32
  33 Each normal profile has a setting called 'default_rate_profile`.  When a profile is activated the
  34 corresponding rate profile is also activated.
  35
  36 Profile 0 has a default rate profile of 0.
  37 Profile 1 has a default rate profile of 1.
  38 Profile 2 has a default rate profile of 2.
  39
  40 The defaults are set this way so that it's simple to configure a profile and a rate profile at the same.
  41
  42 The current rate profile can be shown or set using the CLI `rateprofile` command:
  43
  44 ```
  45 rateprofile <index>
  46 ```
  47
  48 The values contained within a rate profile can be seen by using the CLI `dump rates` command.
  49
  50 e.g
  51 ```
  52 # dump rates
  53
  54 # rateprofile
  55 rateprofile 0
  56
  57 set rc_rate = 90
  58 set rc_expo = 65
  59 set thr_mid = 50
  60 set thr_expo = 0
  61 set roll_pitch_rate = 0
  62 set yaw_rate = 0
  63 set tpa_rate = 0
  64 set tpa_breakpoint = 1500
  65 ```