server.mixins.ua_variable_container_mixins.ParameterSetMixin

class documentation

class ParameterSetMixin(Generic[ParameterSetType]):

View In Hierarchy

Mixin for UaObject with parameters.

Method __init_subclass__ Extract type for monitoring.
Async Method add_parameter_variable Add a new parameter variable to this UaObject.
Async Method lifecycle_parameter_set Initialize the monitoring UaVariableContainer.
Async Method read_parameter Read the value of the parameter with the given name.
Async Method read_parameters Read all parameters and return them as a dictionary.
Async Method write_parameter Write given value to parameter with given name.
Async Method write_parameters Write the parameters of according to given dictionary.
Property parameter_set Return the parameter set UaVariableContainer . Read-only property.
Class Variable __parameter_set Undocumented
def __init_subclass__(cls, **kwargs):

Extract type for monitoring.

@deprecated('Please use a typed ParameterSet subclass instead!')
async def add_parameter_variable(self, name: str, val: Any, *, varianttype: ua.VariantType | None = None, datatype: ua.NodeId | int | None = None, historize: bool = False, unit: str | int | None = None, _range: tuple[float, float] | None = None) -> Node:

Add a new parameter variable to this UaObject.

@lifecycle
async def lifecycle_parameter_set(self) -> AsyncGenerator[None]:

Initialize the monitoring UaVariableContainer.

@deprecated('Please use the typed .parameter_set.<name>.read() instead')
async def read_parameter(self, name: str) -> Any:

Read the value of the parameter with the given name.

@deprecated('Please use the typed .parameter_set.<name>.read() or untyped parameter_set.read_all() instead')
async def read_parameters(self) -> Mapping[str, Any]:

Read all parameters and return them as a dictionary.

Keys are the display name of OPC UA nodes, values the corresponding values.

@deprecated('Please use the typed .parameter_set.<name>.write(<value>) instead')
async def write_parameter(self, name: str, value: Any):

Write given value to parameter with given name.

@deprecated('Please use the typed .parameter_set.<name>.write(<value>) instead or untyped parameter_set.write_all()')
async def write_parameters(self, parameters: Mapping[str, Any]):

Write the parameters of according to given dictionary.

Keys of the dictionary are matched to the browse name of the OPC UA node. Values of the dictionary are written to the matched OPC UA node.

@property
parameter_set: ParameterSetType =

Return the parameter set UaVariableContainer . Read-only property.

__parameter_set: ParameterSetType | None =

Undocumented