Skip to content

Commit

Permalink
Add documentation for simple battery fault
Browse files Browse the repository at this point in the history
  • Loading branch information
Yumeka Nagano committed Dec 19, 2024
1 parent 906607d commit 8cf2283
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/source/Support/bskReleaseNotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions src/simulation/power/simpleBattery/simpleBattery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 8cf2283

Please sign in to comment.