> ## 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.

# LED

## Parameters

<ParamField path="brightness" type="candela" />

<ParamField path="color" type="dimensionless" />

<ParamField path="current" type="ampere" />

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

<ParamField path="max_brightness" type="candela" />

<ParamField path="max_current" type="ampere" />

<ParamField path="reverse_leakage_current" type="ampere" />

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

## Interfaces

<ParamField path="anode" type="Electrical" />

<ParamField path="cathode" type="Electrical" />

## 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 LED, Resistor, ElectricPower

  led = new LED
  led.forward_voltage = 2.1V +/- 10%
  led.current = 20mA +/- 5%
  led.max_current = 30mA
  led.color = LED.Color.RED
  led.brightness = 100mcd
  led.package = "0603"

  # Connect with current limiting resistor
  current_resistor = new Resistor
  power_supply = new ElectricPower
  assert power_supply.voltage within 5V +/- 5%

  power_supply.hv ~> current_resistor ~> led ~> power_supply.lv

  # Alternative: use dedicated function
  led.connect_via_current_limiting_resistor(
      power_supply.voltage,
      current_resistor,
      power_supply.lv,
      low_side=True
  )
  ```
</RequestExample>