Skip to content

Python Core API Set Operations

asyncSetInt(path, value)

Asynchronously set the value as integer for a specified node.

Asynchronously means that the command is nonblocking and does not wait for the data server acknowledgement.

Warning

This command does have no error reporting at all.

Parameters:

Name Type Description Default
path str

Path string of the node.

required
value int

Value of the node.

required

asyncSetDouble(path, value)

Asynchronously set the value as double for a specified node.

Asynchronously means that the command is nonblocking and does not wait for the data server acknowledgement.

Warning

This command does have no error reporting at all.

Parameters:

Name Type Description Default
path str

Path string of the node.

required
value float

Value of the node.

required

asyncSetString(path, value)

Asynchronously set the value as string for a specified node.

Asynchronously means that the command is nonblocking and does not wait for the data server acknowledgement.

Warning

This command does have no error reporting at all.

Parameters:

Name Type Description Default
path str

Path string of the node.

required
value str

Value of the node.

required

set(items_or_path, value=None)

Overloaded function.

  1. set(self, items: _MultipleNodeItems)

    Set multiple nodes. items is a list of path/value pairs.

    A transaction is used to optimize the data transfer.

  2. set(self, path: str, value: Any)

    Set a single node value. path is the node path and value the value to set.

Parameters:

Name Type Description Default
items_or_path Union[Union[List[Tuple[str, Any]], Tuple[Tuple[str, Any]]], str]

A list of path/value pairs or the node path string.

required
value Optional[Any]

The value to set in case of a single node set (items is the node path).

None

setByte(path, value)

Set the value as byte array (string) for a specified node.

The command blocks until the data server has acknowledgement the set request.

Parameters:

Name Type Description Default
path str

Path string of the node.

required
value Any

Value of the node.

required

setComplex(path, value)

Set the value as complex double for a specified node.

The command blocks until the data server has acknowledgement the set request.

Parameters:

Name Type Description Default
path str

Path string of the node.

required
value complex

Value of the node.

required

setDeprecated(items)

DEPRECATED: superseded by set(...).

Set multiple nodes.

Parameters:

Name Type Description Default
items Union[List[Tuple[str, Any]], Tuple[Tuple[str, Any]]]

A list of path/value pairs.

required

setDouble(path, value)

Set the value as double for a specified node.

The command blocks until the data server has acknowledgement the set request.

Parameters:

Name Type Description Default
path str

Path string of the node.

required
value float

Value of the node.

required

setInt(path, value)

Set the value as integer for a specified node.

The command blocks until the data server has acknowledgement the set request.

Parameters:

Name Type Description Default
path str

Path string of the node.

required
value int

Value of the node.

required

setString(path, value)

Set the value as string for a specified node.

The command blocks until the data server has acknowledgement the set request.

Parameters:

Name Type Description Default
path str

Path string of the node.

required
value str

Value of the node.

required

setVector(path, value)

Set the value for a specified vector node.

The command is different from the other set commands and is Optimized for vector transfer. It blocks until the device itself has acknowledged the complete vector data set.

Parameters:

Name Type Description Default
path str

Path string of the node.

required
value Union[np.ndarray, List[Union[int, float, complex]], Tuple[Union[int, float, complex], ...], str]

Vector ((u)int8, (u)int16, (u)int32, (u)int64, float, double) or string to write.

required

syncSetDouble(path, value)

Synchronously set the value as double for a specified node.

Synchronously means that the command is blocking until the device has acknowledged the set request.

Warning

This command takes significantly longer than a non sync command and should be used with care.

Parameters:

Name Type Description Default
path str

Path string of the node.

required
value float

Value of the node.

required

Returns:

Type Description
float

Acknowledged value by the device.

syncSetInt(path, value)

Synchronously set the value as integer for a specified node.

Synchronously means that the command is blocking until the device has acknowledged the set request.

Warning

This command takes significantly longer than a non sync command and should be used with care.

Parameters:

Name Type Description Default
path str

Path string of the node.

required
value int

Value of the node.

required

Returns:

Type Description
int

Acknowledged value by the device.

syncSetString(path, value)

Synchronously set the value as string for a specified node.

Synchronously means that the command is blocking until the device has acknowledged the set request.

Warning

This command takes significantly longer than a non sync command and should be used with care.

Parameters:

Name Type Description Default
path str

Path string of the node.

required
value str

Value of the node.

required

Returns:

Type Description
str

Acknowledged value by the device.