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

# TVS

## Parameters

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

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

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

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

<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 TVS, ElectricPower, Electrical

  tvs = new TVS
  tvs.reverse_breakdown_voltage = 5.1V +/- 5%
  tvs.max_current = 1A
  tvs.reverse_working_voltage = 5V
  tvs.package = "SOD-123"

  # Connect TVS for power line protection
  power_supply = new ElectricPower
  protected_line = new Electrical

  # TVS protects against voltage spikes
  protected_line ~ tvs.anode
  tvs.cathode ~ power_supply.lv  # Connect to ground

  # Bidirectional TVS for signal line protection
  signal_tvs = new TVS
  signal_tvs.reverse_breakdown_voltage = 3.3V +/- 5%
  signal_line = new Electrical

  signal_line ~ signal_tvs.anode
  signal_tvs.cathode ~ power_supply.lv

  # Common applications: ESD protection, power surge protection
  # TVS clamps voltage spikes to protect sensitive components
  ```
</RequestExample>