docs/MixerProfile.md

   1 # MixerProfile
   2
   3 A MixerProfile is a set of motor mixer, servo-mixer and platform type configuration settings. It is designed for experienced inav users.
   4
   5 ### For a tutorial of vtol setup, Read https://github.com/iNavFlight/inav/blob/master/docs/VTOL.md
   6
   7 Not limited to VTOL. air/land/sea mixed vehicle is also achievable with this feature. Model behaves according to current mixer_profile's platform_type and configured custom motor/servo mixer
   8
   9 Currently two profiles are supported on targets other than F411(due to resource constraints on F411). i.e VTOL transition is not available on F411.
  10
  11 For VTOL setup. one mixer_profile is used for multi-rotor(MR) and the other is used for fixed-wing(FW)
  12 By default, switching between profiles requires reboot to take affect. However, using the RC mode: `MIXER PROFILE 2` will allow in flight switching for things like VTOL operation
  13 . And will re-initialize pid and navigation controllers for current MC or FW flying mode.
  14
  15 Please note that this is an emerging / experimental capability that will require some effort by the pilot to implement.
  16
  17 ## Mixer Transition input
  18
  19 Typically, 'transition input' will be useful in MR mode to gain airspeed.
  20 The associated motor or servo will then move accordingly when transition mode is activated.
  21 Transition input is disabled when navigation mode is activate
  22
  23 The use of Transition Mode is recommended to enable further features and future developments like fail-safe support. Mapping motor to servo output, or servo with logic conditions is **not** recommended
  24
  25 ## Servo
  26
  27 `Mixer Transition` is the input source for transition input; use this to tilt motor to gain airspeed.
  28
  29 Example: Increase servo 1 output by +45 with speed of 150 when transition mode is activated for tilted motor setup:
  30
  31 ```
  32 # rule no; servo index; input source; rate; speed; activate logic function number
  33 smix 6 1 38 45 150 -1
  34 ```
  35
  36 ## Motor
  37
  38 The default `mmix` throttle value is 0.0, It will not show in `diff` command when throttle value is 0.0 (unused);
  39
  40 - 0.0<throttle<=1.0 : normal mapping
  41 - -1.0<throttle<=0.0 : motor stop, default value 0, set to -1 to use a place holder for subsequent motor rules
  42 - -2.0<throttle<-1.0 : spin regardless of throttle position at speed `abs(throttle)-1` when Mixer Transition is activated.
  43
  44 Example: This will spin motor number 5 (counting from 1) at 20%, in transition mode only, to gain speed for a "4 rotor 1 pusher" setup:
  45
  46 ```
  47 # motor number; throttle; roll; pitch; yaw
  48 mmix 4 -1.200  0.000  0.000  0.000
  49 ```
  50
  51 ## RC mode settings
  52
  53 It is recommend that the pilot uses a RC mode switch to activate modes or switch profiles.
  54 Profile files Switching is not available until the runtime sensor calibration is done. Switching is NOT available when navigation mode is activate.
  55
  56 `mixer_profile` 1 will be used as default, `mixer_profile` 2 will be used when the `MIXER PROFILE 2` mode box is activated.
  57 Set `MIXER TRANSITION` accordingly when you want to use `MIXER TRANSITION` input for motors and servos. Here is sample of using these RC modes:
  58
  59 ![Alt text](Screenshots/mixer_profile.png)
  60
  61 |  1000~1300 |  1300~1700  | 1700~2000 |
  62 | :-- | :-- | :-- |
  63 | FW(profile1) with transition off |  MC(profile2) with transition on  | MC(profile2) with transition off |
  64
  65 It is also possible to set it as 4 state switch by adding FW(profile1) with transition on.
  66
  67 ## Automated Transition
  68 This feature is mainly for RTH in a failsafe event. When set properly, model will use the FW mode to fly home efficiently, And land in the MC mode for easier landing.
  69 `ON` for a mixer_profile\`s `mixer_automated_switch` means to schedule a Automated Transition when RTH head home(applies for MC mixer_profile) or RTH Land(applies for FW mixer_profile) is requested by navigation controller.
  70 Set `mixer_automated_switch` to `ON` in mixer_profile for MC mode. Set `mixer_switch_trans_timer` in mixer_profile for MC mode for the time required to gain airspeed for your model before entering to FW mode.
  71 When `mixer_automated_switch`:`OFF` is set for all mixer_profiles(defaults). Model will not perform automated transition at all.
  72
  73 ## TailSitter (planned for INAV 7.1)
  74 TailSitter is supported by add a 90deg offset to the board alignment. Set the board aliment normally in the mixer_profile for FW mode(`set platform_type = AIRPLANE`), The motor trust axis should be same direction as the airplane nose. Then, in the mixer_profile for takeoff and landing set `tailsitter_orientation_offset = ON ` to apply orientation offset. orientation offset will also add a 45deg orientation offset.
  75
  76 ## Parameter list (Partial List)
  77 ####  Please be aware of what parameter is shared among FW/MC modes and what isn't.
  78 ### Shared Parameters
  79
  80 - **Timer Overrides**
  81 - **Outputs [Servo]:**
  82   - Servo min-point, mid-point, max-point settings
  83 - **Motor Configuration:**
  84   - motor_pwm_protocol
  85   - motor_poles
  86 - **Servo Configuration:**
  87   - servo_protocol
  88   - servo_pwm_rate
  89 - **Board Alignment**
  90 - ·······
  91 ### Profile-Specific Parameters in VTOL
  92 - **Mixer Profile**
  93     - **Mixer Configuration:**
  94         - platform_type
  95         - motor_stop_on_low
  96         - tailsitter_orientation_offset
  97         - motor_direction_inverted, and more·······
  98     - **Motor Mixing (mmix)**
  99     - **Servo Mixing (smix)**
 100 - **PID Profile**
 101   - PIDs for Roll, Pitch, Yaw
 102   - PIDs for Navigation Modes
 103   - TPA (Throttle PID Attenuation) Settings
 104   - Rate Settings
 105   - ·······
 106
 107 ### TailSitter support
 108 TailSitter is supported by add a 90deg offset to the board alignment. Set the board aliment normally in the mixer_profile for FW mode(`set platform_type = AIRPLANE`), The motor trust axis should be same direction as the airplane nose. Then, in the mixer_profile for takeoff and landing `set platform_type = TAILSITTER`. The `TAILSITTER` platform type is same as `MULTIROTOR` platform type, expect for a 90 deg board alignment offset. In `TAILSITTER` mixer_profile, when motor trust/airplane nose is pointing to the sky, 'airplane bottom'/'multi rotor front' should facing forward in model preview. Set the motor/servo mixer according to multirotor orientation, Model should roll around geography's longitudinal axis, the roll axis of `TAILSITTER` will be yaw axis of `AIRPLANE`. In addition, When `MIXER TRANSITION` input is activated, a 45deg offset will be add to the target angle for angle mode.
 109
 110 ## Happy flying
 111
 112 Remember that this is currently an emerging capability:
 113
 114 * Test every thing on bench first.
 115 * Try MR or FW mode separately see if there are any problems.
 116 * Use the INAV Discord for help and setup questions; use the Github Issues for reporting bugs and unexpected behaviors. For reporting on Github, a CLI `diff all`, a DVR and a Blackbox log of the incident will assist investigation.