module read_config

wagoplc.read_config

Read the configuration file.

Functions:

• read_config: read and validate the configuration
• validate_task: validate schema of tasks section to ensure all parameters are present.

Global Variables

• YAML_CONFIG
• INPUT
• OUTPUT
• LOG_FILE

function get_controller

get_controller(controller_id: str) → Controller

Get controller object by item number.

controller_id: item number

function read_config

read_config(
    tasks_obj: Tasks | None = None
) → tuple[list[Task], dict[str, Any], Controller]

Read the configuration file.

:param tasks_obj: Optional Tasks object from the application script :return: The tasks, the variable mapping and the controller object. :raise FileNotFoundError: If the configuration file does not exist. :raise exceptions.InvalidConfigError: if the configuration does not include the itemNumber field, a function block or a task entry point do not exist, or if there are duplicates in the variable mapping.

function validate_task

validate_task(config) → None

Validate task schema.

This file was automatically generated via lazydocs.