Interacting with Channel Maps

A list of channels on devices within groups of connected harnesses. Each completed pairing is a mapped channel; remaining rows are unmapped.

---

Columns

Columns are automatically generated when channel_map.new() is called. Additional columns are not supported and may result in an error when parsing.

Column	Description
group_of_connected_harnesses	harnesses linked through passthroughs (or a single standalone harness)
from_device_refdes	documentation needed
from_device_channel_id	documentation needed
from_repeat_channel_id	required when that channel has two endpoints; blank otherwise
from_channel_type	documentation needed
to_device_refdes	documentation needed
to_device_channel_id	documentation needed
to_repeat_channel_id	required when that channel has two endpoints; blank otherwise
to_channel_type	documentation needed
multi_ch_junction_id	documentation needed
chain_of_connectors	documentation needed
chain_of_harnesses	documentation needed
manual_map_channel_python_equiv	documentation needed

---

Commands:

Use the following functions by first importing the module in your script like this:

from harnice.lists import channel_map

then use as written.

channel_map.new()

Makes a new blank channel map. Overwrites existing channel map.

Seeds one row per channel endpoint, including both faces of a passthrough. Auto-map skips those multi-endpoint rows; map() uses a 3-tuple to name a face.

Args: none

Returns: none

channel_map.map(from_key, to_key=None, multi_ch_junction_key='')

Map one channel endpoint to another (a patch).

Each key is (device_refdes, channel_id) when that channel has one endpoint, or (device_refdes, channel_id, repeat_channel_id) when it has two. A 3-tuple on a single-instance channel is an error; omitting the repeat on a two-instance channel is an error.

Dual-map is two calls to the two repeats of the same passthrough. That consumes both faces as patch ends and does not write a passthrough-map row.

Both endpoints must belong to the same group_of_connected_harnesses. Unmated terminating connectors are in no group. An unmated passthrough face still belongs to the group of its other, mated face.

A patch may end by crossing a device only if the destination face has no harness. If that face has a harness, the last hop must be that harness.

channel_map.already_mapped_set_append(key)

Documentation needed.

channel_map.already_mapped_set()

Documentation needed.

channel_map.already_mapped(key)

Documentation needed.