class documentation

The remote interface for a server-side BaseComponent.

Method dto Return the data transfer object.
Property lock Return the remote lock instance if it exists. Is optional for components.

Inherited from BaseRemoteComponent:

Method __init__ Cooperative constructor.
Method name.setter Undocumented
Async Method read_current_state Read the current state of the remote component.
Async Method read_monitoring Read all parameter set variables.
Async Method read_parameters Read all parameter set variables.
Async Method ua_on_data_change Undocumented
Async Method ua_on_event Handle "message" event notifications.
Async Method write_parameters Write given parameter set variables.
Instance Variable attributes Undocumented
Instance Variable components Undocumented
Instance Variable feasibility_check_set Undocumented
Instance Variable identification Undocumented
Instance Variable method_set Undocumented
Instance Variable monitoring Undocumented
Instance Variable notification_received Undocumented
Instance Variable parameter_set Undocumented
Instance Variable precondition_check_set Undocumented
Instance Variable resources Undocumented
Instance Variable skill_set Undocumented
Instance Variable status_changed Undocumented
Property current_state (Cached) Current state of the remote component (may not be up-to-date due to subscription delay).
Property name Return the name of the remote module.
Property type Return human-readable component type (mainly for UI purposes).
Async Method _browse_component Browse a single component in given ua_node with name.
Async Method _browse_components Browse all components in given ua_node.
Async Method _browse_lock Browse a single lock in given ua_node.
Async Method _browse_machinery_building_blocks Undocumented
Async Method _browse_method Browse a single method in given ua_node with name.
Async Method _browse_methods Browse all methods in given ua_node.
Async Method _browse_resource Browse a single resource in given ua_node with name.
Async Method _browse_resources Browse all resources in given ua_node.
Async Method _browse_skill Undocumented
Async Method _browse_skill_set Browse all skills in given ua_node.
Async Method _init Set up all subscriptions for all subcomponents and itself.
Async Method _init_machinery_building_blocks_handle_node Handle child node found during browsing our machinery building blocks OPC UA node.
Class Variable _ua_components Undocumented
Class Variable _ua_state_machine_node Undocumented
Instance Variable _current_state Undocumented
Instance Variable _lock Undocumented
Instance Variable _name Undocumented
Instance Variable _ua_current_state Undocumented
Instance Variable _ua_skill_set_node Undocumented
def dto(self) -> RemoteComponentDTO:

Return the data transfer object.

@property
lock: RemoteLock | None =

Return the remote lock instance if it exists. Is optional for components.