skidl.circuit module

Handles complete circuits made of parts and nets.

class skidl.circuit.Circuit(**kwargs)

Bases: SkidlBaseObject

Class object that holds the entire netlist of parts and nets.

parts

List of all the schematic parts as Part objects.

nets

List of all the schematic nets as Net objects.

buses

List of all the buses as Bus objects.

hierarchy

A ‘.’-separated concatenation of the names of nested SubCircuits at the current time it is read.

level

The current level in the schematic hierarchy.

context

Stack of contexts for each level in the hierarchy.

ERC(*args, **kwargs)

Run class-wide and local ERC functions on this circuit.

activate(name, tag)

Save the previous hierarchical group and activate a new one.

add_buses(*buses)

Add some Bus objects to the circuit. Assign a bus name if necessary.

add_hierarchical_name(name)

Record a new hierarchical name. Throw an error if it is a duplicate.

add_nets(*nets)

Add some Net objects to the circuit. Assign a net name if necessary.

add_packages(*packages)

add_parts(*parts)

Add some Part objects to the circuit.

add_stuff(*stuff)

Add Parts, Nets, Buses, and Interfaces to the circuit.

backup_parts(file_=None)

Saves parts in circuit as a SKiDL library in a file.

Parameters:

file – Either a file object that can be written to, or a string containing a file name, or None. If None, a standard library file will be used.

Returns:

Nothing.

deactivate()

Deactivate the current hierarchical group and return to the previous one.

erc_list = [<function dflt_circuit_erc>]

generate_dot(file_=None, engine='neato', rankdir='LR', part_shape='rectangle', net_shape='point', splines=None, show_values=True, show_anon=False, split_nets=['GND'], split_parts_ref=[])

Returns a graphviz graph as graphviz object and can also write it to a file/stream. When used in ipython the graphviz object will drawn as an SVG in the output.

See https://graphviz.readthedocs.io/en/stable/ and http://graphviz.org/doc/info/attrs.html

Parameters:

• file – A string containing a file name, or None.

• engine – See graphviz documentation

• rankdir – See graphviz documentation

• part_shape – Shape of the part nodes

• net_shape – Shape of the net nodes

• splines – Style for the edges, try ‘ortho’ for a schematic like feel

• show_values – Show values as external labels on part nodes

• show_anon – Show anonymous net names

• split_nets – splits up the plot for the given list of net names

• split_parts_ref – splits up the plot for all pins for the given list of part refs

Returns:

graphviz.Digraph

generate_graph(file_=None, engine='neato', rankdir='LR', part_shape='rectangle', net_shape='point', splines=None, show_values=True, show_anon=False, split_nets=['GND'], split_parts_ref=[])

Returns a graphviz graph as graphviz object and can also write it to a file/stream. When used in ipython the graphviz object will drawn as an SVG in the output.

See https://graphviz.readthedocs.io/en/stable/ and http://graphviz.org/doc/info/attrs.html

Parameters:

• file – A string containing a file name, or None.

• engine – See graphviz documentation

• rankdir – See graphviz documentation

• part_shape – Shape of the part nodes

• net_shape – Shape of the net nodes

• splines – Style for the edges, try ‘ortho’ for a schematic like feel

• show_values – Show values as external labels on part nodes

• show_anon – Show anonymous net names

• split_nets – splits up the plot for the given list of net names

• split_parts_ref – splits up the plot for all pins for the given list of part refs

Returns:

graphviz.Digraph

generate_netlist(**kwargs)

Return a netlist and also write it to a file/stream.

Parameters:

• file – Either a file object that can be written to, or a string containing a file name, or None.

• tool – The EDA tool the netlist will be generated for.

• do_backup – If true, create a library with all the parts in the circuit.

Returns:

A netlist.

generate_netlistsvg_skin(net_stubs, layout_options=None)

Generate SVG for schematic symbols for netlistsvg skin file.

Parameters:

• net_stubs (list) – List of nets that are stubbed rather than routed.

• layout_options (str, optional) – String of ELK layout options. Defaults to None. https://eclipse.dev/elk/reference/options.html

Returns:

SVG for skin file.

Return type:

str

generate_pcb(**kwargs)

Create a PCB file from the circuit.

Parameters:

• file – Either a file object that can be written to, or a string containing a file name, or None.

• tool – The EDA tool the netlist will be generated for.

• do_backup – If true, create a library with all the parts in the circuit.

• fp_libs – List of directories containing footprint libraries.

Returns:

None.

generate_schematic(**kwargs)

Create a schematic from a Circuit.

generate_svg(file_=None, tool=None, layout_options=None)

Create an SVG file displaying the circuit schematic and return the dictionary that can be displayed by netlistsvg.

Parameters:

• file (_type_, optional) – Filename to store SVG. Defaults to None.

• tool (_type_, optional) – Backend tool. Defaults to None.

• layout_options (_type_, optional) – Options to control netlistsvg/ELK layout algorithm. Defaults to None.

Returns:

JSON dictionary for input to netlistsvg.

Return type:

dict

generate_xml(file_=None, tool=None)

Return netlist as an XML string and also write it to a file/stream.

Parameters:

• file – Either a file object that can be written to, or a string containing a file name, or None.

• tool – Backend tool such as KICAD.

Returns:

A string containing the netlist.

get_net_nc_stubs()

Get all nets/buses that are stubs or no-connects.

get_nets()

Get all the distinct nets for the circuit.

instantiate_packages()

Run the package executables to instantiate their circuitry.

merge_net_names()

Assign same name to all segments of multi-segment nets.

merge_nets()

Merge multi-segment nets into a single net.

mini_reset(init=False)

Clear any circuitry but don’t erase any loaded part libraries.

property no_files

Prevent creation of output files (netlists, ERC, logs) by this Circuit object.

reset(init=False)

Clear any circuitry and cached part libraries and start over.

rmv_buses(*buses)

Remove some buses from the circuit.

rmv_hierarchical_name(name)

Remove an existing hierarchical name. Throw an error if non-existent.

rmv_nets(*nets)

Remove some Net objects from the circuit.

rmv_packages(*packages)

rmv_parts(*parts)

Remove some Part objects from the circuit.

rmv_stuff(*stuff)

Remove Parts, Nets, Buses, and Interfaces from the circuit.