pyisyox.runtime.folder module

Runtime Folder — organisational grouping in the controller’s node tree.

Folders are pure organisation: they don’t accept commands, don’t carry property values, and exist only to group nodes/groups/sub-folders in the controller UI. The runtime wrapper exposes their identity (address + name + parent) so consumers can render the tree, but there’s no command surface beyond that.

Folders are sourced from the legacy /rest/nodes XML response (<folder> elements). The modern /api/nodes JSON endpoint returns nodes only.

class Folder(record)

Bases: object

User-facing handle for one folder in the node tree.

Parameters:

record (FolderRecord)

property address: str

Folder id — typically a 5-digit integer string.

property name: str

User-assigned label.

property parent_address: str | None

Address of the parent folder, or None for top-level folders.

property family_id: str

Family id — folders use family "13" (folder family) on IoX.

to_dict()

Flatten this folder to a JSON-compatible dict.

Mirrors the underlying FolderRecord’s fields; useful for the dumper / diagnostics consumers that want a uniform snapshot across the controller’s collections.

Return type:

dict[str, Any]