pcb_set_plane_net
Assigns an internal plane layer to an existing net so the plane copper connects to that net, rather than relying on a polygon pour.
Instructions
Tie an internal plane layer to a net.
An Altium internal plane is a NEGATIVE layer: the copper is
everywhere except where the plane is cleared, and the net lives on
the LAYER, not on a poured object. Pouring a polygon on a plane
layer is a different thing and does not connect the plane, so this
is the tool for "make Internal Plane 1 the PGND plane" --
pcb_place_polygon_rect is not.
The net must already exist on the board (see pcb_get_nets).
The layer must be an internal plane; a signal layer is refused
with NOT_A_PLANE. Layer names are resolved against the real
stack, so both "Internal Plane 1" (as pcb_get_layer_stackup
prints it) and "InternalPlane1" work, and a name this board does
not have is refused with UNKNOWN_LAYER rather than silently
retargeting another layer.
The net is written to the board's InternalPlaneNetName for that
layer and READ BACK before reporting; if that does not take, the
layer object's own net is tried and read back too. When neither
reads back the net the call answers success: false with
applied: false and a note, and the board is NOT marked changed.
Args: layer: Internal plane layer, e.g. "InternalPlane1" or the name the stackup reports for it net: Existing net name to tie the plane to, e.g. "PGND"
Returns: Dictionary with "success", "layer" (the RESOLVED layer), "layer_name", "net", "net_readback", "applied", "route" (which write took) and "note".
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| net | Yes | ||
| layer | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||