class documentation

class BaseComponent(IdentificationMixin[MachineryComponentIdentification], BaseMachineryItem):

Constructor: BaseComponent(name, minimum_access_level, **kwargs)

View In Hierarchy

Base class for all components (= OPC UA machinery items).

Async Method _get_definition Undocumented

Inherited from BaseMachineryItem:

Method __init__ Cooperative constructor.
Async Method add_component Add given (sub-)component instance, initializes it and keep track of it.
Async Method add_method Add the given method instance to the asset.
Async Method add_methods Add given sequence of method instances to the asset.
Async Method add_skill Add the given skill instance to the asset.
Async Method add_skills Add given sequence of skill instances to the asset.
Async Method condition_as_dependency_ready Undocumented
Async Method condition_startup_completed Check if startup was completed.
Async Method halt Halt the machinery item.
Async Method halt_components Halt all components (None, default) of this machinery item or only specific ones.
Async Method halt_skills Halt all skills (None, default) of this machinery item or only specific ones.
Async Method lifecycle_machinery_item Lifecycle method which calls _init for initialization and _shutdown for shutdown.
Async Method reset Attempt to reset the machinery item.
Async Method reset_components Reset given components. If None given, resets all own components.
Async Method reset_skills Reset all given skills. If None given, resets all own skills.
Async Method set_current_operation_mode Set the current operation mode of this machinery item without any transition logic checks.
Async Method set_current_state Set the current state of this machinery item without any transition logic checks.
Property components (Untyped) subcomponents of this machinery item.
Property current_operation_mode Return the current machinery operation mode. Read-only property.
Property current_state Return the current machinery item state. Read-only property.
Property method_set Return untyped method set UaObjectContainer. Read-only property.
Property skill_set (Untyped) skill set of this machinery item.
Property startup_skill Return the startup skill of the machinery item.
Async Method __init_components Undocumented
Async Method __init_method_set Initialize the method set UaObjectContainer.
Async Method __init_skill_set Initialize the skill set UaObjectContainer.
Async Method _condition_component_ready Undocumented
Async Method _init Undocumented
Async Method _init_status Undocumented
Async Method _shutdown Undocumented
Instance Variable _components Undocumented
Instance Variable _current_operation_mode Undocumented
Instance Variable _current_state Undocumented
Instance Variable _method_set Undocumented
Instance Variable _skill_set Undocumented
Instance Variable _ua_machinery_building_blocks Undocumented
Instance Variable _ua_operation_mode Optional 'MachineryOperationMode' (finite state machine) OPC UA node.
Instance Variable _ua_operation_mode_current_state Optional current_state OPC UA node of 'MachineryOperationMode'.
Instance Variable _ua_state_machine Optional 'MachineryItemState' (finite state machine) OPC UA node.
Instance Variable _ua_state_machine_current_state Optional current_state OPC UA node of 'MachineryItemState'.
@override
async def _get_definition(self) -> UaObjectDefinition: ΒΆ

Undocumented