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

# Ethernet

>  1000BASE-T Gigabit Ethernet Interface 

## Interfaces

<ParamField path="led_link" type="ElectricLogic" />

<ParamField path="led_speed" type="ElectricLogic" />

<ParamField path="pairs[0]" type="DifferentialPair" />

<ParamField path="pairs[1]" type="DifferentialPair" />

<ParamField path="pairs[2]" type="DifferentialPair" />

<ParamField path="pairs[3]" type="DifferentialPair" />

## 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 Ethernet, ElectricPower

  ethernet = new Ethernet

  # Connect power reference for logic levels
  power_3v3 = new ElectricPower
  ethernet.led_speed.reference ~ power_3v3
  ethernet.led_link.reference ~ power_3v3

  # Connect to PHY or connector
  # Four differential pairs for 1000BASE-T
  ethernet_connector.tx_pairs[0] ~ ethernet.pairs[0]
  ethernet_connector.tx_pairs[1] ~ ethernet.pairs[1]
  ethernet_connector.rx_pairs[2] ~ ethernet.pairs[2]
  ethernet_connector.rx_pairs[3] ~ ethernet.pairs[3]

  # Connect status LEDs
  ethernet.led_speed ~ speed_led_output
  ethernet.led_link ~ link_led_output
  ```
</RequestExample>