From 8cf2283cced37189fd10cee0797677b375ad3cae Mon Sep 17 00:00:00 2001 From: Yumeka Nagano <> Date: Thu, 19 Dec 2024 12:23:14 -0700 Subject: [PATCH] Add documentation for simple battery fault --- docs/source/Support/bskReleaseNotes.rst | 1 + src/simulation/power/simpleBattery/simpleBattery.rst | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/docs/source/Support/bskReleaseNotes.rst b/docs/source/Support/bskReleaseNotes.rst index cea93017a2..5f7f1a2002 100644 --- a/docs/source/Support/bskReleaseNotes.rst +++ b/docs/source/Support/bskReleaseNotes.rst @@ -79,6 +79,7 @@ Version |release| the added setters and getters must be used. - Fixed a bug in which the ``MtbEffector.py`` module was not being imported correctly in Python due to lack of ``swig_eigen.i`` include file in ``MtbEffector.i``. +- Added the capability to simulate a fault in the :ref:`simpleBattery` module that reduces the actual storage capacity without directly altering the stated capacity. - Cleaned up what python packages are required to build BSK (``requirements_dev.txt``), to run BSK (``requirements.txt``) and to build BSK documentation (``requirements_doc.txt``). - The BSK install instructions are updated to ask users to install by first ``pip`` installing build diff --git a/src/simulation/power/simpleBattery/simpleBattery.rst b/src/simulation/power/simpleBattery/simpleBattery.rst index 0d96025cb7..706f7914f6 100644 --- a/src/simulation/power/simpleBattery/simpleBattery.rst +++ b/src/simulation/power/simpleBattery/simpleBattery.rst @@ -36,3 +36,8 @@ The next step is to attach one or more :ref:`PowerNodeUsageMsgPayload` instances For more information on how to set up and use this module, see the simple power system example :ref:`scenarioPowerDemo`. + +To simulate a battery capacity fault that reduces the actual storage capacity (without directly altering the stated capacity), users must set up the fault flag:: + + battery.fault = True + battery.faultCapacityRatio = 0.5 # 50% of the original capacity \ No newline at end of file