Classes
class	AssetKind
	Determines to which asset kind the resource is being serialized. More...

class	Extent
	Determines to which extent the resource is being serialized. More...

class	IdEncoding
	Determines the ID encoding mode for API requests. More...

class	Level
	Determines the structural depth of the respective resource content. More...

class	SdkWrapper
	Represents a wrapper for the BaSyx Python SDK to communicate with a REST API. More...

Functions
SdkWrapper\|None	create_wrapper_by_url (str base_url, str basic_auth_username="", str basic_auth_password="", str o_auth_client_id="", str o_auth_client_secret="", str o_auth_token_url="", str bearer_auth_token="", str http_proxy="", str https_proxy="", int time_out=200, int connection_time_out=60, bool ssl_verify=True, bool trust_env=True, bool encoded_ids=True)
	Create a wrapper for a AAS server connection from the given parameters.

SdkWrapper\|None	create_wrapper_by_dict (dict configuration, str basic_auth_password="", str o_auth_client_secret="", str bearer_auth_token="")
	Create a wrapper for a AAS server connection from the given configuration.

SdkWrapper\|None	create_wrapper_by_config (Path config_file, str basic_auth_password="", str o_auth_client_secret="", str bearer_auth_token="")
	Create a wrapper for a AAS server connection from a given configuration file.

Function Documentation

◆ create_wrapper_by_config()

SdkWrapper \| None sdk_wrapper.create_wrapper_by_config	(	Path	config_file,
		str	basic_auth_password = `""`,
		str	o_auth_client_secret = `""`,
		str	bearer_auth_token = `""`
	)

Create a wrapper for a AAS server connection from a given configuration file.

Parameters

config_file	Path to the configuration file containing the AAS server connection settings
basic_auth_password	Password for the AAS server basic authentication, defaults to ""
o_auth_client_secret	Client secret for OAuth authentication, defaults to ""
bearer_auth_token	Bearer token for authentication, defaults to ""

Returns: An instance of SdkWrapper initialized with the provided parameters or None if initialization fails

Definition at line 962 of file sdk_wrapper.py.

SdkWrapper \| None sdk_wrapper.create_wrapper_by_dict	(	dict	configuration,
		str	basic_auth_password = `""`,
		str	o_auth_client_secret = `""`,
		str	bearer_auth_token = `""`
	)

Create a wrapper for a AAS server connection from the given configuration.

Parameters

configuration	Dictionary containing the AAS server connection settings
basic_auth_password	Password for the AAS server basic authentication, defaults to ""
o_auth_client_secret	Client secret for OAuth authentication, defaults to ""
bearer_auth_token	Bearer token for authentication, defaults to ""

Returns: An instance of SdkWrapper initialized with the provided parameters or None if initialization fails

Definition at line 946 of file sdk_wrapper.py.

SdkWrapper \| None sdk_wrapper.create_wrapper_by_url	(	str	base_url,
		str	basic_auth_username = `""`,
		str	basic_auth_password = `""`,
		str	o_auth_client_id = `""`,
		str	o_auth_client_secret = `""`,
		str	o_auth_token_url = `""`,
		str	bearer_auth_token = `""`,
		str	http_proxy = `""`,
		str	https_proxy = `""`,
		int	time_out = `200`,
		int	connection_time_out = `60`,
		bool	ssl_verify = `True`,
		bool	trust_env = `True`,
		bool	encoded_ids = `True`
	)

Create a wrapper for a AAS server connection from the given parameters.

Parameters

base_url	Base URL of the AAS server, e.g. "http://basyx_python_server:80/"
basic_auth_username	Username for the AAS server basic authentication, defaults to ""
basic_auth_password	Password for the AAS server basic authentication, defaults to ""
o_auth_client_id	Client ID for OAuth authentication, defaults to ""
o_auth_client_secret	Client secret for OAuth authentication, defaults to ""
o_auth_token_url	Token URL for OAuth authentication, defaults to ""
bearer_auth_token	Bearer token for authentication, defaults to ""
http_proxy	HTTP proxy URL, defaults to ""
https_proxy	HTTPS proxy URL, defaults to ""
time_out	Timeout for the API calls, defaults to 200
connection_time_out	Timeout for the connection to the API, defaults to 60
ssl_verify	Whether to verify SSL certificates, defaults to True
trust_env	Whether to trust environment variables for proxy settings, defaults to True
encoded_ids	If enabled, all IDs used in API requests have to be base64-encoded

Returns: An instance of SdkWrapper initialized with the provided parameters or None if initialization fails

Definition at line 900 of file sdk_wrapper.py.

sdk_wrapper._logger

protected

Definition at line 30 of file sdk_wrapper.py.