> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atopile.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Battery

## Parameters

<ParamField path="capacity" type="ampere_hour" />

<ParamField path="voltage" type="volt" />

## Interfaces

<ParamField path="power" type="ElectricPower" />

## Global Attributes

These attributes are available to all modules and interfaces in a design.

<ParamField path="lcsc_id" type="str">
  Assign the LCSC ID of the module.

  If set, this will tell the picker to select that part from LCSC for this block.
</ParamField>

<ParamField path="manufacturer" type="str">
  This module's manufacturer name, as a string.

  Only exact matches on the manufacturer's name will be found by the picker.
  It's recommended to fill this information based on what `ato create component`
  provides.
</ParamField>

<ParamField path="mpn" type="str">
  This module's manufacturer part number, as a string.

  For the picker to select the correct part from the manufacturer,
  this must be set.
</ParamField>

<ParamField path="package" type="str">
  The package of the module.

  This drives which components can be selected, and what footprint is used.

  Must exactly match a known package name.
</ParamField>

<ParamField path="exclude_from_bom" type="bool" />

<ParamField path="override_net_name" type="str">
  When set on an interface, this will override the net name of the interface.

  This is useful for renaming nets which are automatically generated.
</ParamField>

<ParamField path="required" type="bool">
  Only for ModuleInterfaces.
  If set to `True`, require that interface is connected to something outside
  of the module it's defined in.
</ParamField>

<RequestExample>
  ```ato Basic Usage theme={null}
  import Battery, ElectricPower

  battery = new Battery
  battery.voltage = 3.7V +/- 10%  # Li-ion cell
  battery.capacity = 2000mAh +/- 5%

  # Connect to system power
  system_power = new ElectricPower
  battery.power ~ system_power

  # Battery specifications will constrain system voltage
  assert system_power.voltage within battery.voltage

  # For multiple cells in series
  battery_pack = new Battery
  battery_pack.voltage = 11.1V +/- 10%  # 3S Li-ion pack
  battery_pack.capacity = 2000mAh +/- 5%
  ```
</RequestExample>