libtiepie-hw  1.2.1

Functions to retrieve information from a device. More...

Collaboration diagram for Info:

Functions

TIEPIE_HW_API tiepie_hw_date tiepie_hw_device_get_calibration_date (tiepie_hw_handle handle)
 Get the calibration date of the device. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_device_get_serial_number (tiepie_hw_handle handle)
 Get the serial number of the device. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_device_get_ip_address (tiepie_hw_handle handle, char *buffer, uint32_t length)
 Get the IP address of the device. More...
 
TIEPIE_HW_API uint16_t tiepie_hw_device_get_ip_port (tiepie_hw_handle handle)
 Get the IP port number of the device. More...
 
TIEPIE_HW_API tiepie_hw_productid tiepie_hw_device_get_product_id (tiepie_hw_handle handle)
 Get the product id of the device. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_device_get_type (tiepie_hw_handle handle)
 Get the device type. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_device_get_name (tiepie_hw_handle handle, char *buffer, uint32_t length)
 Get the full name of the device. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_device_get_name_short (tiepie_hw_handle handle, char *buffer, uint32_t length)
 Get the short name of the device. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_device_get_name_shortest (tiepie_hw_handle handle, char *buffer, uint32_t length)
 Get the short name of the device without model postfix. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_device_has_wireless_trigger_module (tiepie_hw_handle handle)
 Check whether the device has a wireless trigger module. More...
 

Detailed Description

Functions to retrieve information from a device.

Function Documentation

◆ tiepie_hw_device_get_calibration_date()

TIEPIE_HW_API tiepie_hw_date tiepie_hw_device_get_calibration_date ( tiepie_hw_handle  handle)

Get the calibration date of the device.

Parameters
[in]handleA device handle identifying the device.
Returns
The calibration date of the device, or zero if no calibration date is available.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device does not have a calibration date.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Example
printf("tiepie_hw_device_get_calibration_date = %u-%u-%u\n", date.year, date.month, date.day);
TIEPIE_HW_API tiepie_hw_date tiepie_hw_device_get_calibration_date(tiepie_hw_handle handle)
Get the calibration date of the device.
Definition: libtiepie-hw.h:1858
uint8_t day
Definition: libtiepie-hw.h:1861
uint16_t year
Definition: libtiepie-hw.h:1859
uint8_t month
Definition: libtiepie-hw.h:1860
Since
1.0

◆ tiepie_hw_device_get_serial_number()

TIEPIE_HW_API uint32_t tiepie_hw_device_get_serial_number ( tiepie_hw_handle  handle)

Get the serial number of the device.

Parameters
[in]handleA device handle identifying the device.
Returns
The serial number of the device.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device does not have a serial number.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0

◆ tiepie_hw_device_get_ip_address()

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

Get the IP address of the device.

Parameters
[in]handleA device handle identifying the device.
[out]bufferA pointer to a buffer for the IP address.
[in]lengthThe length of the buffer, in bytes.
Returns
The length of the name in bytes, excluding terminating zero.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device is not a network device.
TIEPIE_HW_STATUS_INVALID_VALUE The value of Id_kind is invalid.
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0

◆ tiepie_hw_device_get_ip_port()

TIEPIE_HW_API uint16_t tiepie_hw_device_get_ip_port ( tiepie_hw_handle  handle)

Get the IP port number of the device.

Parameters
[in]handleA device handle identifying the device.
Returns
The IP port number of the device, or zero if no IP port number is available.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device is not a network device.
TIEPIE_HW_STATUS_INVALID_VALUE The value of Id_kind is invalid.
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0

◆ tiepie_hw_device_get_product_id()

TIEPIE_HW_API tiepie_hw_productid tiepie_hw_device_get_product_id ( tiepie_hw_handle  handle)

Get the product id of the device.

Parameters
[in]handleA device handle identifying the device.
Returns
The tiepie_hw_productid "product id" of the device.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device does not support reading a product id.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0

◆ tiepie_hw_device_get_type()

TIEPIE_HW_API uint32_t tiepie_hw_device_get_type ( tiepie_hw_handle  handle)

◆ tiepie_hw_device_get_name()

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

Get the full name of the device.

E.g. Handyscope HS5-530XMS

Parameters
[in]handleA device handle identifying the device.
[out]bufferA pointer to a buffer for the name.
[in]lengthThe length of the buffer, in bytes.
Returns
The length of the name in bytes, excluding terminating zero.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device does not support reading a name.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_device_get_name_short
tiepie_hw_device_get_name_shortest
Example
uint32_t length = tiepie_hw_device_get_name(h_device, NULL, 0) + 1; // Add one for the terminating zero
char* name = malloc(sizeof(char) * length);
length = tiepie_hw_device_get_name(h_device, name, length);
printf("tiepie_hw_device_get_name = %s\n", name);
free(name);
TIEPIE_HW_API uint32_t tiepie_hw_device_get_name(tiepie_hw_handle handle, char *buffer, uint32_t length)
Get the full name of the device.
Since
1.0

◆ tiepie_hw_device_get_name_short()

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

Get the short name of the device.

E.g. HS5-530XMS

Parameters
[in]handleA device handle identifying the device.
[out]bufferA pointer to a buffer for the name.
[in]lengthThe length of the buffer, in bytes.
Returns
The length of the short name in bytes, excluding terminating zero.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device does not support reading a name.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_device_get_name
tiepie_hw_device_get_name_shortest
Example
uint32_t length = tiepie_hw_device_get_name_short(h_device, NULL, 0) + 1; // Add one for the terminating zero
char* name = malloc(sizeof(char) * length);
length = tiepie_hw_device_get_name_short(h_device, name, length);
printf("tiepie_hw_device_get_name_short = %s\n", name);
free(name);
TIEPIE_HW_API uint32_t tiepie_hw_device_get_name_short(tiepie_hw_handle handle, char *buffer, uint32_t length)
Get the short name of the device.
Since
1.0

◆ tiepie_hw_device_get_name_shortest()

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

Get the short name of the device without model postfix.

E.g. HS5

Parameters
[in]handleA device handle identifying the device.
[out]bufferA pointer to a buffer for the name.
[in]lengthThe length of the buffer, in bytes.
Returns
The length of the short name in bytes, excluding terminating zero.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device does not support reading a name.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_device_get_name
tiepie_hw_device_get_name_short
Example
uint32_t length = tiepie_hw_device_get_name_shortest(h_device, NULL, 0) + 1; // Add one for the terminating zero
char* s_name_shortest = malloc(sizeof(char) * length);
Length = tiepie_hw_device_get_name_shortest(h_device, s_name_shortest, length);
printf("tiepie_hw_device_get_name_shortest = %s\n", s_name_shortest);
free(s_name_shortest);
TIEPIE_HW_API uint32_t tiepie_hw_device_get_name_shortest(tiepie_hw_handle handle, char *buffer, uint32_t length)
Get the short name of the device without model postfix.
Since
1.0

◆ tiepie_hw_device_has_wireless_trigger_module()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_device_has_wireless_trigger_module ( tiepie_hw_handle  handle)

Check whether the device has a wireless trigger module.

Parameters
[in]handleA device handle identifying the device.
Returns
TIEPIE_HW_BOOL_TRUE if the device has a wireless trigger module, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.1