Interacting with Circuits Lists

A list of every individual electrical connection that must be present in your system or harness to satisfy your channel and passthrough maps.

Columns

Columns are automatically generated when circuits_list.new() is called. Additional columns are ok but discouraged due to consistency. If you need more columns, use data structures in build instructions.

Column	Description
`harness`	harness refdes that carries this hop, taken from chain_of_harnesses
`harness_chain_index`	0-based index into channel map `chain_of_harnesses` for this segment
`circuit_id`	sequential id of this row, one per signal per harness hop, starting at 0
`from_signal`	from-side signal name; also the name used on passthrough hops
`to_signal`	to-side signal name when circuits_list.force() paired different names; blank when both ends use from_signal
`harness_from_refdes`	refdes at the from end of this harness hop
`harness_from_channel_id`	channel id on that from-end refdes
`harness_from_connector_name`	connector on that refdes for this signal
`harness_from_cavity`	cavity of this signal on that connector
`harness_to_refdes`	refdes at the to end of this hop; a junction id when the row ends on a multi-channel junction
`harness_to_channel_id`	channel id on that to-end refdes; the signal name on a junction row
`harness_to_connector_name`	connector on the to-end refdes; blank on a junction row
`harness_to_cavity`	cavity of this signal on that connector; blank on a junction row
`from_side_device_refdes`	channel-map from device; the same on every hop of the mapped channel
`from_side_device_chname`	channel id on that from device
`to_side_device_refdes`	channel-map to device; a junction id when the row ends on a multi-channel junction
`to_side_device_chname`	channel id on that to device; the signal name on a junction row
`from_channel_type`	channel type of the channel-map from endpoint
`to_channel_type`	channel type of the channel-map to endpoint, or the junction's channel type
`multi_ch_junction_id`	set when the circuit is from_channel.signal → mcj.signal

Commands

These functions are already available in build instructions as circuits_list. Use them as written.

circuits_list.read()

Use this when a system build needs every row of the circuits list in the revision that is open.

Return the circuits list (cached).

circuits_list.force(from_key, signal_pairs, drop=())

Use this when a system build has a pending channel_map.force patch and needs its from-signals paired to to-signals before circuits_list.new.

Pair the signals of one pending channel_map.force() patch.

from_key is the same endpoint key passed as the first argument to channel_map.force(). signal_pairs maps every from-side signal name to a to-side signal name ({"pos": "live", "neg": "neutral"}). drop lists every to-side signal left unwired (drop=["earth"]).

The circuit keeps the from-side name. The to-side cavity is looked up under the paired name. A from-side signal cannot be dropped: if the from channel has a signal the to channel does not, swap which endpoint is from_key so the extra name is on the to side, then drop it.

Raises ValueError if from_key is not pending (the signal names already matched, or channel_map.force() was not called), or if any from-side name is unpaired or any to-side name is neither paired nor dropped.

circuits_list.new()

Use this when a system build needs the circuits list compiled from the channel map and the passthrough map.

Build the circuits list from the channel map and passthrough map.

Uses chain_of_connectors / chain_of_harnesses (from passthrough_map.resolve()) and ordered satisfaction rows on the passthrough map for passthrough channel IDs.

A channel-map row with multi_ch_junction_id and no to_* partner becomes one circuit per signal: from is from_channel.signal, to is mcj.signal. Signal names come from the first channel type seen on that junction id.

A patch from channel_map.force() whose signal names differ must already have been burned down by circuits_list.force(). Those circuits keep the from-side name in from_signal and look up the to-side cavity under to_signal. Passthrough hops are still looked up under from_signal. Any pending forced patch raises ValueError.

Clears any existing circuits list.