Skip to content

Commit

Permalink
Adjust and canonicalise BATT_MON for disambiguation
Browse files Browse the repository at this point in the history
    now another backend has parameters which duplicate some in the analog backend we need to fix links to link to the analogue backend rather than the AD7091R5 backend

Also make these look just like other similar links, without spaces between name and ref
  • Loading branch information
peterbarker authored and Hwurzburg committed Dec 15, 2024
1 parent c159c2d commit 23b9881
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 17 deletions.
8 changes: 4 additions & 4 deletions common/source/docs/common-3dr-power-module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ Configuration
Most ground stations provide a battery monitor interface but the parameters can also be set manually:

- :ref:`BATT_MONITOR <BATT_MONITOR>` = **3** to measure only voltage or **4** to measure both voltage and current (you will need to reboot the board after changing this)
- :ref:`BATT_VOLT_PIN <BATT_VOLT_PIN>` = **2**. The autopilot pin connected to the power module's voltage pin
- :ref:`BATT_VOLT_MULT <BATT_VOLT_MULT>` converts the analog voltage received from the power module's voltage pin to the battery's voltage
- :ref:`BATT_CURR_PIN <BATT_CURR_PIN>` = **3**. The autopilot pin connected to the power module's current pin
- :ref:`BATT_AMP_PERVLT <BATT_AMP_PERVLT>` converts the analog voltage received from the power module's current pin to the battery's current
- :ref:`BATT_VOLT_PIN<BATT_VOLT_PIN__AP_BattMonitor_Analog>` = **2**. The autopilot pin connected to the power module's voltage pin
- :ref:`BATT_VOLT_MULT<BATT_VOLT_MULT__AP_BattMonitor_Analog>` converts the analog voltage received from the power module's voltage pin to the battery's voltage
- :ref:`BATT_CURR_PIN<BATT_CURR_PIN__AP_BattMonitor_Analog>` = **3**. The autopilot pin connected to the power module's current pin
- :ref:`BATT_AMP_PERVLT<BATT_AMP_PERVLT__AP_BattMonitor_Analog>` converts the analog voltage received from the power module's current pin to the battery's current
- :ref:`BATT_AMP_OFFSET <BATT_AMP_OFFSET>` voltage offset received from the power module's current pin when ther is no current being pulled from the battery

Instructions for setup and calibration using the :ref:`Mission Planner can be found here <common-power-module-configuration-in-mission-planner>`
Expand Down
10 changes: 5 additions & 5 deletions common/source/docs/common-omnibusnanov6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,9 @@ Set :ref:`BATT_MONITOR <BATT_MONITOR>` to 3 (= analog voltage only) and reboot.

Default pin values:

:ref:`BATT_VOLT_PIN <BATT_VOLT_PIN>` = 12
:ref:`BATT_VOLT_PIN<BATT_VOLT_PIN__AP_BattMonitor_Analog>` = 12

:ref:`BATT_VOLT_MULT <BATT_VOLT_MULT>` = 11
:ref:`BATT_VOLT_MULT<BATT_VOLT_MULT__AP_BattMonitor_Analog>` = 11

Optionally add voltage and / or current monitoring using ESC telemetry capable ESCs. See instructions :ref:`here <blheli32-esc-telemetry>`.

Expand All @@ -145,15 +145,15 @@ V6.x revision

V6.x revision has an additional ADC available for external current sensor hardware / PDB connection in 4in1 socket / respective pads.

:ref:`BATT_CURR_PIN <BATT_CURR_PIN>` = 11
:ref:`BATT_CURR_PIN<BATT_CURR_PIN__AP_BattMonitor_Analog>` = 11

:ref:`BATT_AMP_PERVLT <BATT_AMP_PERVLT>` = 18.2
:ref:`BATT_AMP_PERVLT<BATT_AMP_PERVLT__AP_BattMonitor_Analog>` = 18.2

Set :ref:`BATT_MONITOR <BATT_MONITOR>` to 4 (= analog voltage and current) and reboot for full battery monitoring support.

.. note::

Current pin defaults to pin 11 in ardupilot runtime. Alternatively, it can be used for analog RSSI input or connecting an analog airspeed sensor. Adjust :ref:`BATT_AMP_PERVLT <BATT_AMP_PERVLT>` default of 18.2 as required by the individual current sensor hardware used.
Current pin defaults to pin 11 in ardupilot runtime. Alternatively, it can be used for analog RSSI input or connecting an analog airspeed sensor. Adjust :ref:`BATT_AMP_PERVLT<BATT_AMP_PERVLT__AP_BattMonitor_Analog>` default of 18.2 as required by the individual current sensor hardware used.


Flashing Firmware
Expand Down
8 changes: 4 additions & 4 deletions common/source/docs/common-radiolinkpix6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -550,10 +550,10 @@ Power1 port(Analog)
The parameters should be set:

* :ref:`BATT_MONITOR <BATT_MONITOR>` = 4, then reboot.
* :ref:`BATT_VOLT_PIN <BATT_VOLT_PIN>` = 2
* :ref:`BATT_CURR_PIN <BATT_CURR_PIN>` = 5
* :ref:`BATT_VOLT_MULT <BATT_VOLT_MULT>` = 18
* :ref:`BATT_AMP_PERVLT <BATT_AMP_PERVLT>` = 24
* :ref:`BATT_VOLT_PIN<BATT_VOLT_PIN__AP_BattMonitor_Analog>` = 2
* :ref:`BATT_CURR_PIN<BATT_CURR_PIN__AP_BattMonitor_Analog>` = 5
* :ref:`BATT_VOLT_MULT<BATT_VOLT_MULT__AP_BattMonitor_Analog>` = 18
* :ref:`BATT_AMP_PERVLT<BATT_AMP_PERVLT__AP_BattMonitor_Analog>` = 24

Power2 port(I2C)
================
Expand Down
8 changes: 4 additions & 4 deletions common/source/docs/common-synthetic-current-monitor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ the following examples are for the first Battery Monitor. The parameter names wi

For Voltage, the normal Analog Sensor parameters apply:

- :ref:`BATT_VOLT_PIN <BATT_VOLT_PIN>` The autopilot pin connected to the power module's voltage pin
- :ref:`BATT_VOLT_MULT <BATT_VOLT_MULT>` converts the analog voltage received from the power module's voltage pin to the battery's voltage. Provided on the :ref:`autopilot's hardware page:<common-autopilots>` or manufacturers page.
- :ref:`BATT_VOLT_PIN<BATT_VOLT_PIN__AP_BattMonitor_Analog>` The autopilot pin connected to the power module's voltage pin
- :ref:`BATT_VOLT_MULT<BATT_VOLT_MULT__AP_BattMonitor_Analog>` converts the analog voltage received from the power module's voltage pin to the battery's voltage. Provided on the :ref:`autopilot's hardware page:<common-autopilots>` or manufacturers page.

For the Current, some of the normal analog current sensor parameters have been re-tasked to save flash and their names are therefore a bit misleading in this application:

- :ref:`BATT_AMP_PERVLT <BATT_AMP_PERVLT>` is the MAXIMUM current at full battery voltage in amps.
- :ref:`BATT_AMP_PERVLT<BATT_AMP_PERVLT__AP_BattMonitor_Analog>` is the MAXIMUM current at full battery voltage in amps.
- :ref:`BATT_AMP_OFFSET <BATT_AMP_OFFSET>` is the idle current (zero throttle) of the system in amps accounting for peripherals, video,etc. Normally in the 0.3 to 0.5 range.
- :ref:`BATT_MAX_VOLT<BATT_MAX_VOLT>` is the MAXIMUM fresh battery voltage. Used to scale the estimate as the battery voltage decreases during use.

Calibration of the :ref:`BATT_AMP_PERVLT <BATT_AMP_PERVLT>` value can either be done on the bench with a current meter, or iteratively by estimating an initial value, operating for while, measuring the amount of current needed to restore the battery to full charge, and using that value and a flight log's or OSD's total consumed mah for the flight to adjust the parameter value:
Calibration of the :ref:`BATT_AMP_PERVLT<BATT_AMP_PERVLT__AP_BattMonitor_Analog>` value can either be done on the bench with a current meter, or iteratively by estimating an initial value, operating for while, measuring the amount of current needed to restore the battery to full charge, and using that value and a flight log's or OSD's total consumed mah for the flight to adjust the parameter value:

new value = old value * (mah returned to batt/log or OSD value of consumed mah)

Expand Down

0 comments on commit 23b9881

Please sign in to comment.