Functions to communicate with network connected instruments (WiFiScopes). More...

Collaboration diagram for Server:

Functions
TIEPIE_HW_API tiepie_hw_bool	tiepie_hw_server_connect (tiepie_hw_handle handle, tiepie_hw_bool asynchronous)
	Connect to a specified network connected WiFiScope. This gives access to that network connected WiFiScope.

TIEPIE_HW_API tiepie_hw_bool	tiepie_hw_server_disconnect (tiepie_hw_handle handle, tiepie_hw_bool force)
	Disconnect from a specified network connected WiFiScope. This will close the opened network connected WiFiScope.

TIEPIE_HW_API tiepie_hw_bool	tiepie_hw_server_remove (tiepie_hw_handle handle, tiepie_hw_bool force)
	Remove a specified network connected WiFiScope from the list of network connected WiFiScopes.

TIEPIE_HW_API uint32_t	tiepie_hw_server_get_status (tiepie_hw_handle handle)
	Retrieve the status of a specified network connected WiFiScope.

TIEPIE_HW_API uint32_t	tiepie_hw_server_get_last_error (tiepie_hw_handle handle)
	Get the last error from a specified network connected WiFiScope.

TIEPIE_HW_API uint32_t	tiepie_hw_server_get_url (tiepie_hw_handle handle, char *buffer, uint32_t length)
	Get the URL of the specified network connected WiFiScope.

TIEPIE_HW_API uint32_t	tiepie_hw_server_get_id (tiepie_hw_handle handle, char *buffer, uint32_t length)
	Get the id of the specified network connected WiFiScope.

TIEPIE_HW_API uint32_t	tiepie_hw_server_get_ip_address (tiepie_hw_handle handle, char *buffer, uint32_t length)
	Get the IP address of the specified network connected WiFiScope.

TIEPIE_HW_API uint16_t	tiepie_hw_server_get_ip_port (tiepie_hw_handle handle)
	Get the IP port number of the specified network connected WiFiScope.

TIEPIE_HW_API uint32_t	tiepie_hw_server_get_name (tiepie_hw_handle handle, char *buffer, uint32_t length)
	Get the name of the specified network connected WiFiScope.

TIEPIE_HW_API uint32_t	tiepie_hw_server_get_description (tiepie_hw_handle handle, char *buffer, uint32_t length)
	Get the description of the specified network connected WiFiScope.

TIEPIE_HW_API uint32_t	tiepie_hw_server_get_version (tiepie_hw_handle handle, char *buffer, uint32_t length)
	Get the software version number of the specified network connected WiFiScope.

Detailed Description

Functions to communicate with network connected instruments (WiFiScopes).

Function Documentation

◆ tiepie_hw_server_connect()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_server_connect	(	tiepie_hw_handle	handle,
		tiepie_hw_bool	asynchronous
	)

Connect to a specified network connected WiFiScope. This gives access to that network connected WiFiScope.

Parameters

[in]	handle	A server handle identifying the network connected WiFiScope.
[in]	asynchronous	Connect asynchronously.

Returns: TIEPIE_HW_BOOL_TRUE if successful, TIEPIE_HW_BOOL_FALSE otherwise.

Since: 1.0

◆ tiepie_hw_server_disconnect()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_server_disconnect	(	tiepie_hw_handle	handle,
		tiepie_hw_bool	force
	)

Disconnect from a specified network connected WiFiScope. This will close the opened network connected WiFiScope.

Parameters

[in]	handle	A server handle identifying the network connected WiFiScope.
[in]	force	If TIEPIE_HW_BOOL_TRUE all open devices are closed, if TIEPIE_HW_BOOL_FALSE remove only succeeds if no devices are open.

Returns: TIEPIE_HW_BOOL_TRUE if successful, TIEPIE_HW_BOOL_FALSE otherwise.

Since: 1.0

◆ tiepie_hw_server_remove()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_server_remove	(	tiepie_hw_handle	handle,
		tiepie_hw_bool	force
	)

Remove a specified network connected WiFiScope from the list of network connected WiFiScopes.

Parameters

[in]	handle	A server handle identifying the network connected WiFiScope.
[in]	force	If TIEPIE_HW_BOOL_TRUE all open devices are closed, if TIEPIE_HW_BOOL_FALSE remove only succeeds if no devices are open.

Returns: TIEPIE_HW_BOOL_TRUE if successful, TIEPIE_HW_BOOL_FALSE otherwise.

Since: 1.0

◆ tiepie_hw_server_get_status()

TIEPIE_HW_API uint32_t tiepie_hw_server_get_status ( tiepie_hw_handle handle )

Retrieve the status of a specified network connected WiFiScope.

Parameters

[in] handle A server handle identifying the network connected WiFiScope.

Returns: The status of the specified network connected WiFiScope, see TIEPIE_HW_SERVER_STATUS

Since: 1.0

◆ tiepie_hw_server_get_last_error()

TIEPIE_HW_API uint32_t tiepie_hw_server_get_last_error ( tiepie_hw_handle handle )

Get the last error from a specified network connected WiFiScope.

Parameters

[in] handle A server handle identifying the network connected WiFiScope.

Returns: The last error given by the specified network connected WiFiScope, see TIEPIE_HW_SERVER_ERROR

Since: 1.0

◆ tiepie_hw_server_get_url()

TIEPIE_HW_API uint32_t tiepie_hw_server_get_url	(	tiepie_hw_handle	handle,
		char *	buffer,
		uint32_t	length
	)

Get the URL of the specified network connected WiFiScope.

Parameters

[in]	handle	A server handle identifying the network connected WiFiScope.
[out]	buffer	A pointer to a buffer for the URL.
[in]	length	The length of the buffer, in bytes.

Returns: The length of the URL in bytes, excluding terminating zero.

Since: 1.0

◆ tiepie_hw_server_get_id()

TIEPIE_HW_API uint32_t tiepie_hw_server_get_id	(	tiepie_hw_handle	handle,
		char *	buffer,
		uint32_t	length
	)

Get the id of the specified network connected WiFiScope.

Parameters

[in]	handle	A server handle identifying the network connected WiFiScope.
[out]	buffer	A pointer to a buffer for the id.
[in]	length	The length of the buffer, in bytes.

Returns: The length of the id in bytes, excluding terminating zero.

Since: 1.0

◆ tiepie_hw_server_get_ip_address()

TIEPIE_HW_API uint32_t tiepie_hw_server_get_ip_address	(	tiepie_hw_handle	handle,
		char *	buffer,
		uint32_t	length
	)

Get the IP address of the specified network connected WiFiScope.

Parameters

[in]	handle	A server handle identifying the network connected WiFiScope.
[out]	buffer	A pointer to a buffer for the IP address.
[in]	length	The length of the buffer, in bytes.

Returns: The length of the URL in bytes, excluding terminating zero.

Since: 1.0

◆ tiepie_hw_server_get_ip_port()

TIEPIE_HW_API uint16_t tiepie_hw_server_get_ip_port ( tiepie_hw_handle handle )

Get the IP port number of the specified network connected WiFiScope.

Parameters

[in] handle A server handle identifying the network connected WiFiScope.

Returns: The IP port number of the specified network connected WiFiScope.

Since: 1.0

◆ tiepie_hw_server_get_name()

TIEPIE_HW_API uint32_t tiepie_hw_server_get_name	(	tiepie_hw_handle	handle,
		char *	buffer,
		uint32_t	length
	)

Get the name of the specified network connected WiFiScope.

Parameters

[in]	handle	A server handle identifying the network connected WiFiScope.
[out]	buffer	A pointer to a buffer for the name.
[in]	length	The length of the buffer, in bytes.

Returns: The length of the name in bytes, excluding terminating zero.

Since: 1.0

◆ tiepie_hw_server_get_description()

TIEPIE_HW_API uint32_t tiepie_hw_server_get_description	(	tiepie_hw_handle	handle,
		char *	buffer,
		uint32_t	length
	)

Get the description of the specified network connected WiFiScope.

Parameters

[in]	handle	A server handle identifying the network connected WiFiScope.
[out]	buffer	A pointer to a buffer for the description.
[in]	length	The length of the buffer, in bytes.

Returns: The length of the description in bytes, excluding terminating zero.

Since: 1.0

◆ tiepie_hw_server_get_version()

TIEPIE_HW_API uint32_t tiepie_hw_server_get_version	(	tiepie_hw_handle	handle,
		char *	buffer,
		uint32_t	length
	)

Get the software version number of the specified network connected WiFiScope.

Parameters

[in]	handle	A server handle identifying the network connected WiFiScope.
[out]	buffer	A pointer to a buffer for the description.
[in]	length	The length of the buffer, in bytes.

Returns: The length of the server version in bytes, excluding terminating zero.; The software version number of the network connected WiFiScope, or zero if no software version is available.

Example: uint32_t length = tiepie_hw_server_get_version(handle, NULL, 0) + 1; // Add one for the terminating zero

char* version = malloc(sizeof(char) * length);

length = tiepie_hw_server_get_version(handle, version, length);

printf("tiepie_hw_server_get_version = %s\n", version);

free(version);

tiepie_hw_server_get_version
TIEPIE_HW_API uint32_t tiepie_hw_server_get_version(tiepie_hw_handle handle, char *buffer, uint32_t length)
Get the software version number of the specified network connected WiFiScope.

Since: 1.0