Skip to content

Commit

Permalink
common-ekf-sources: Add comments around source options
Browse files Browse the repository at this point in the history
  • Loading branch information
MattKear authored Feb 6, 2024
1 parent c195bb5 commit 022d07c
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions common/source/docs/common-ekf-sources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,10 @@ Three set of EKF position and velocity source parameters are provided which can

This feature is especially helpful when using :ref:`common-non-gps-to-gps`.

Source Switching
================

There is an option to fuse all sources of velocity into the EKF. This will take velocity information from the XY and Z sources defined by :ref:`EK3_SRC1_VELXY<EK3_SRCx_VELXY>` and :ref:`EK3_SRC1_VELZ<EK3_SRCx_VELZ>`, where 'x' is the source number (1-3). To enable this option set the first bit in the :ref:`EK3_SRC_OPTIONS<EK3_SRC_OPTIONS>` bitmask.

.. warning:: When using this option, users should ensure that the velocity measurements being provided to the EKF are both in the same reference frame/co-ordinate system.

0 comments on commit 022d07c

Please sign in to comment.