pyisyox.schema.linkdef module

Link definitions — Insteon scene/link metadata referenced from nodedefs.

A LinkDef describes a parameter slot on an Insteon link record. Most pyisyox consumers will not interact with LinkDefs directly; they’re carried through so plugin/profile parity is preserved.

Source schema: /rest/profiles instance linkdefs[].

class LinkParameter(editor_id, param_id='', init=None)

Bases: object

A single parameter on a link definition.

Variables:

• editor_id (str) – Reference to the editor defining valid values.

• param_id (str) – Parameter identifier within the link record.

• init (str | None) – Optional initial-value source.

Parameters:

• editor_id (str)

• param_id (str)

• init (str | None)

editor_id: str

param_id: str

init: str | None

class LinkDef(id, parameters=<factory>)

Bases: object

A link definition, identified by id and carrying parameter slots.

Variables:

• id (str) – Link definition identifier (e.g., "DON_OL", "DON_LinkPair").

• parameters (list[pyisyox.schema.linkdef.LinkParameter]) – Parameter slots in declaration order.

Parameters:

• id (str)

• parameters (list[LinkParameter])

id: str

parameters: list[LinkParameter]

classmethod from_json(raw)

Build a LinkDef from a JSON object.

Defensive against partial / null fields under PG3 dynamic profile reload.

Parameters:

raw (dict)

Return type:

LinkDef