Attributes in ato

This page lists all the attributes available in ato which effect the compiler.

Global Attributes

atopile.attributes.GlobalAttributes

Bases: Module

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

lcsc_id property writable

lcsc_id

Assign the LCSC ID of the module.

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

manufacturer property writable

manufacturer

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.

mpn property writable

mpn

This module's manufacturer part number, as a string.

For the picker to select the correct part from the manufacturer, this must be set.

datasheet_url property writable

datasheet_url

The URL of the datasheet for this component.

designator_prefix property writable

designator_prefix

The prefix used for automatically-generated designators on this module.

package property writable

package

The package of the module.

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

Must exactly match a known package name.

footprint property writable

footprint

Explicitly set the footprint to be used for this module.

Setting this will cause this component to be selected and placed on the PCB.

The footprint should be a string, naming the KiCAD ID of the footprint.

exclude_from_bom property writable

exclude_from_bom

override_net_name property writable

override_net_name

When set on an interface, this will override the net name of the interface.

This is useful for renaming nets which are automatically generated.

suggest_net_name property writable

suggest_net_name

Suggested net name which will have a higher priority than generated net names.

Components

atopile.attributes.Resistor

Bases: Resistor

This resistor is replaces generics/resistors.ato:Resistor every times it's referenced.

value property writable

value

Represents the resistance of the resistor.

footprint property writable

footprint

See GlobalAttributes.footprint

package property writable

package

See GlobalAttributes.package

has_ato_cmp_attrs_

has_ato_cmp_attrs_()

Ignore this field.

Source code in src/atopile/attributes.py

@L.rt_field
def has_ato_cmp_attrs_(self) -> _has_ato_cmp_attrs:
    """Ignore this field."""
    trait = _has_ato_cmp_attrs()
    trait.pinmap["1"] = self.p1
    trait.pinmap["2"] = self.p2
    return trait

atopile.attributes.CommonCapacitor

Bases: Capacitor

These attributes are common to both electrolytic and non-electrolytic capacitors.

value property writable

value

Represents the capacitance of the capacitor.

package property writable

package

See GlobalAttributes.package

footprint property writable

footprint

See GlobalAttributes.footprint

atopile.attributes.Capacitor

Bases: CommonCapacitor

This capacitor is replaces generics/capacitors.ato:Capacitor every times it's referenced.

value property writable

value

Represents the capacitance of the capacitor.

package property writable

package

See GlobalAttributes.package

footprint property writable

footprint

See GlobalAttributes.footprint

has_ato_cmp_attrs_

has_ato_cmp_attrs_()

Ignore this field.

Source code in src/atopile/attributes.py

@L.rt_field
def has_ato_cmp_attrs_(self) -> _has_ato_cmp_attrs:
    """Ignore this field."""
    trait = _has_ato_cmp_attrs()
    trait.pinmap["1"] = self.p1
    trait.pinmap["2"] = self.p2
    return trait

atopile.attributes.Inductor

Bases: Inductor

This inductor is replaces generics/inductors.ato:Inductor every times it's referenced.

package property writable

package

See GlobalAttributes.package

has_ato_cmp_attrs_

has_ato_cmp_attrs_()

Ignore this field.

Source code in src/atopile/attributes.py

@L.rt_field
def has_ato_cmp_attrs_(self) -> _has_ato_cmp_attrs:
    """Ignore this field."""
    trait = _has_ato_cmp_attrs()
    trait.pinmap["1"] = self.p1
    trait.pinmap["2"] = self.p2
    return trait

atopile.attributes.LED

Bases: LED

Temporary shim to translate LEDs.

v_f property

v_f

i_max property

i_max

Interfaces

atopile.attributes.Power

Bases: ElectricPower

Temporary shim to translate value to power.

current property

current

Maximum current the power interface can provide.

Negative is current draw.