register_location_as_response#

TcpOslServer.register_location_as_response(uid: str, location: Any, name: str | None = None, reference_value: Any | None = None) str#

Register a certain (output) location as a response.

Parameters:
uid: str

Actor uid.

location: Any

Specification of location, depends on actor type.

name: Optional[str], optional

Response name.

reference_value: Optional[Any], optional

Response reference value.

Returns:
str

Name of the actual created response.

Raises:
OslCommunicationError

Raised when an error occurs while communicating with server.

OslCommandError

Raised when the command or query fails.

TimeoutError

Raised when the timeout float value expires.