docs/Mixer.md

   1 # Mixer
   2
   3 Cleanflight supports a number of mixing configurations as well as custom mixing.  Mixer configurations determine how the servos and motors work together to control the aircraft.
   4
   5 ## Configuration
   6
   7 To use a built-in mixing configuration, you can use the Chrome configuration GUI.  It includes images of the various mixer types to assist in making the proper connections.  See the Configuration section of the documentation for more information on the GUI.
   8
   9 You can also use the Command Line Interface (CLI) to set the mixer type:
  10
  11 1. Use `mixer list` to see a list of supported mixes
  12 2. Select a mixer.  For example, to select TRI, use `mixer TRI`
  13 3. You must use `save` to preserve your changes
  14
  15 ## Supported Mixer Types
  16
  17 | Name          | Description               | Motors         | Servos           |
  18 | ------------- | ------------------------- | -------------- | ---------------- |
  19 | TRI           | Tricopter                 | M1-M3          | S1               |
  20 | QUADP         | Quadcopter-Plus           | M1-M4          | None             |
  21 | QUADX         | Quadcopter-X              | M1-M4          | None             |
  22 | BI            | Bicopter (left/right)     | M1-M2          | S1, S2           |
  23 | GIMBAL        | Gimbal control            | N/A            | S1, S2           |
  24 | Y6            | Y6-copter                 | M1-M6          | None             |
  25 | HEX6          | Hexacopter-Plus           | M1-M6          | None             |
  26 | FLYING_WING   | Fixed wing; elevons       | M1             | S1, S2           |
  27 | Y4            | Y4-copter                 | M1-M4          | None             |
  28 | HEX6X         | Hexacopter-X              | M1-M6          | None             |
  29 | OCTOX8        | Octocopter-X (over/under) | M1-M8          | None             |
  30 | OCTOFLATP     | Octocopter-FlatPlus       | M1-M8          | None             |
  31 | OCTOFLATX     | Octocopter-FlatX          | M1-M8          | None             |
  32 | AIRPLANE      | Fixed wing; Ax2, R, E     | M1             | S1, S2, S3, S4   |
  33 | HELI_120_CCPM |                           |                |                  |
  34 | HELI_90_DEG   |                           |                |                  |
  35 | VTAIL4        | Quadcopter with V-Tail    | M1-M4          | N/A              |
  36 | HEX6H         | Hexacopter-H              | M1-M6          | None             |
  37 | PPM_TO_SERVO  |                           |                |                  |
  38 | DUALCOPTER    | Dualcopter                | M1-M2          | S1, S2           |
  39 | SINGLECOPTER  | Conventional helicopter   | M1             | S1               |
  40 | ATAIL4        | Quadcopter with A-Tail    | M1-M4          | N/A              |
  41 | CUSTOM        | User-defined              |                |                  |
  42
  43
  44 ## Servo filtering
  45
  46 A low-pass filter can be enabled for the servos.  It may be useful for avoiding structural modes in the airframe, for example.
  47
  48 ### Configuration
  49
  50 Currently it can only be configured via the CLI:
  51
  52 1. Use `set servo_lowpass_freq = nnn` to select the cutoff frequency.  Valid values range from 10 to 400.  This is a fraction of the loop frequency in 1/1000ths. For example, `40` means `0.040`.
  53 2. Use `set servo_lowpass_enable = 1` to enable filtering.
  54
  55 The cutoff frequency can be determined by the following formula:
  56 `Frequency = 1000 * servo_lowpass_freq / looptime`
  57
  58 For example, if `servo_lowpass_freq` is set to 40, and looptime is set to the default of 3500 us, the cutoff frequency will be 11.43 Hz.
  59
  60 ### Tuning
  61
  62 One method for tuning the filter cutoff is as follows:
  63
  64 1. Ensure your vehicle can move at least somewhat freely in the troublesome axis.  For example, if you are having yaw oscillations on a tricopter, ensure that the copter is supported in a way that allows it to rotate left and right to at least some degree.  Suspension near the CG is ideal.  Alternatively, you can just fly the vehicle and trigger the problematic condition you are trying to eliminate, although tuning will be more tedious.
  65
  66 2. Tap the vehicle at its end in the axis under evaluation.  Directly commanding the servo in question to move may also be used.  In the tricopter example, tap the end of the tail boom from the side, or command a yaw using your transmitter.
  67
  68 3. If your vehicle oscillates for several seconds or even continues oscillating indefinitely, then the filter cutoff frequency should be reduced. Reduce the value of `servo_lowpass_freq` by half its current value and repeat the previous step.
  69
  70 4. If the oscillations are dampened within roughly a second or are no longer present, then you are done.  Be sure to run `save`.
  71
  72 ## Custom Motor Mixing
  73
  74 Custom motor mixing allows for completely customized motor configurations. Each motor must be defined with a custom mixing table for that motor. The mix must reflect how close each motor is with reference to the CG (Center of Gravity) of the flight controller. A motor closer to the CG of the flight controller will need to travel less distance than a motor further away.
  75
  76 Steps to configure custom mixer in the CLI:
  77
  78 1. Use `mixer custom` to enable the custom mixing.
  79 2. Use `cmix reset` to erase the any existing custom mixing.
  80 3. Issue a cmix statement for each motor.
  81
  82 The cmix statement has the following syntax: `cmix n THROTTLE ROLL PITCH YAW`
  83
  84 | Mixing table parameter | Definition |
  85 | ---------------------- | ---------- |
  86 | n     | Motor ordering number |
  87 | THROTTLE      | All motors that are used in this configuration are set to 1.0. Unused set to 0.0. |
  88 | ROLL  | Indicates how much roll authority this motor imparts to the roll of the flight controller. Accepts values nominally from 1.0 to -1.0. |
  89 | PITCH | Indicates the pitch authority this motor has over the flight controller. Also accepts values nominally from 1.0 to -1.0. |
  90 | YAW   | Indicates the direction of the motor rotation in relationship with the flight controller. 1.0 = CCW -1.0 = CW. |
  91
  92 ### Example 1: A KK2.0 wired motor setup
  93 Here's an example of a X configuration quad, but the motors are still wired using the KK board motor numbering scheme.
  94
  95 ```
  96 KK2.0 Motor Layout
  97
  98   1CW      2CCW
  99      \    /
 100        KK
 101      /    \
 102   4CCW     3CW
 103 ```
 104
 105 1. Use `mixer custom`
 106 2. Use `cmix reset`
 107 3. Use `cmix 1 1.0,  1.0, -1.0, -1.0` for the Front Left motor. It tells the flight controller the #1 motor is used, provides positive roll, provides negative pitch and is turning CW.
 108 4. Use `cmix 2 1.0, -1.0, -1.0,  1.0` for the Front Right motor. It still provides a negative pitch authority, but unlike the front left, it provides negative roll authority and turns CCW.
 109 5. Use `cmix 3 1.0, -1.0,  1.0, -1.0` for the Rear Right motor. It has negative roll, provides positive pitch when the speed is increased and turns CW.
 110 6. Use `cmix 4 1.0,  1.0,  1.0,  1.0` for the Rear Left motor. Increasing motor speed imparts positive roll, positive pitch and turns CCW.
 111
 112 ### Example 2: A HEX-U Copter
 113
 114 Here is an example of a U-shaped hex; probably good for herding giraffes in the Sahara. Because the 1 and 6 motors are closer to the roll axis, they impart much more force than the motors mounted twice as far from the FC CG. The effect they have on pitch is the same as the forward motors because they are the same distance from the FC CG. The 2 and 5 motors do not contribute anything to pitch because speeding them up and slowing them down has no effect on the forward/back pitch of the FC.
 115
 116 ```
 117 HEX6-U
 118
 119 .4........3.
 120 ............
 121 .5...FC...2.
 122 ............
 123 ...6....1...
 124
 125 ```
 126 |Command| Roll | Pitch | Yaw |
 127 | ----- | ---- | ----- | --- |
 128 | Use `cmix 1 1.0, -0.5,  1.0, -1.0` | half negative | full positive | CW |
 129 | Use `cmix 2 1.0, -1.0,  0.0,  1.0` | full negative | none | CCW |
 130 | Use `cmix 3 1.0, -1.0, -1.0, -1.0` | full negative | full negative | CW |
 131 | Use `cmix 4 1.0,  1.0, -1.0,  1.0` | full positive | full negative | CCW  |
 132 | Use `cmix 5 1.0,  1.0,  0.0, -1.0` | full positive | none | CW |
 133 | Use `cmix 6 1.0,  0.5,  1.0,  1.0` | half positive | full positive | CCW |