libtiepie-hw  1.1.3
Combined devices

Functions to retrieve information from the individual devices in combined devices. More...

Collaboration diagram for Combined devices:

Functions

TIEPIE_HW_API uint32_t tiepie_hw_devicelistitem_get_contained_serial_numbers (tiepie_hw_handle handle, uint32_t *buffer, uint32_t length)
 Get the serial numbers of the individual devices contained in a combined device. More...
 
TIEPIE_HW_API tiepie_hw_productid tiepie_hw_devicelistitemcombined_get_product_id (tiepie_hw_handle handle, uint32_t contained_device_serial_number)
 Get the product id of a device contained in a combined device. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_devicelistitemcombined_get_name (tiepie_hw_handle handle, uint32_t contained_device_serial_number, char *buffer, uint32_t length)
 Get the full name of a device contained in a combined device. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_devicelistitemcombined_get_name_short (tiepie_hw_handle handle, uint32_t contained_device_serial_number, char *buffer, uint32_t length)
 Get the short name of a device contained in a combined device. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_devicelistitemcombined_get_name_shortest (tiepie_hw_handle handle, uint32_t contained_device_serial_number, char *buffer, uint32_t length)
 Get the short name without model postfix of a device contained in a combined device. More...
 
TIEPIE_HW_API tiepie_hw_date tiepie_hw_devicelistitemcombined_get_calibration_date (tiepie_hw_handle handle, uint32_t contained_device_serial_number)
 Get the calibration date of a device contained in a combined device. More...
 
TIEPIE_HW_API uint16_t tiepie_hw_devicelistitemcombined_get_oscilloscope_channel_count (tiepie_hw_handle handle, uint32_t contained_device_serial_number)
 Get the channel count of an oscilloscope contained in a combined oscilloscope. More...
 

Detailed Description

Functions to retrieve information from the individual devices in combined devices.

Function Documentation

◆ tiepie_hw_devicelistitem_get_contained_serial_numbers()

TIEPIE_HW_API uint32_t tiepie_hw_devicelistitem_get_contained_serial_numbers ( tiepie_hw_handle  handle,
uint32_t *  buffer,
uint32_t  length 
)

Get the serial numbers of the individual devices contained in a combined device.

Parameters
[in]handleA handle identifying the object.
[out]bufferA pointer to a buffer for the serial numbers.
[in]lengthThe length of the buffer, in bytes.
Returns
The number of devices in the combined device, or zero if the device isn't a combined device.
Status values
TIEPIE_HW_STATUS_INVALID_VALUE The value of Id_kind is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device is not a combined device.
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Example
uint32_t length = tiepie_hw_devicelistitem_get_contained_serial_numbers(handle, NULL, 0);
uint32_t* serial_numbers = malloc(sizeof(uint32_t) * length);
Length = tiepie_hw_devicelistitem_get_contained_serial_numbers(handle, serial_numbers, length);
for(i = 0 ; i < Length ; i++)
{
printf("%u\n", Serial_numbers[ i ]);
}
free(p_serial_numbers);
TIEPIE_HW_API uint32_t tiepie_hw_devicelistitem_get_contained_serial_numbers(tiepie_hw_handle handle, uint32_t *buffer, uint32_t length)
Get the serial numbers of the individual devices contained in a combined device.
Since
1.0

◆ tiepie_hw_devicelistitemcombined_get_product_id()

TIEPIE_HW_API tiepie_hw_productid tiepie_hw_devicelistitemcombined_get_product_id ( tiepie_hw_handle  handle,
uint32_t  contained_device_serial_number 
)

Get the product id of a device contained in a combined device.

Parameters
[in]handleA handle identifying the object.
[in]contained_device_serial_numberThe serial number identifying the contained device inside the combined device.
Returns
The tiepie_hw_productid "product id" of the contained device.
Status values
TIEPIE_HW_STATUS_INVALID_VALUE The value of Id_kind is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device is not a combined device or the contained device does not support reading a product id.
TIEPIE_HW_STATUS_INVALID_CONTAINED_DEVICE_SERIALNUMBERThere is no contained device with the requested serial number in the combined device.
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0

◆ tiepie_hw_devicelistitemcombined_get_name()

TIEPIE_HW_API uint32_t tiepie_hw_devicelistitemcombined_get_name ( tiepie_hw_handle  handle,
uint32_t  contained_device_serial_number,
char *  buffer,
uint32_t  length 
)

Get the full name of a device contained in a combined device.

E.g. Handyscope HS5-530XMS

Parameters
[in]handleA handle identifying the object.
[in]contained_device_serial_numberThe serial number identifying the contained device inside the combined 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_INVALID_VALUE The value of Id_kind is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device is not a combined device or the contained device does not support reading a name.
TIEPIE_HW_STATUS_INVALID_CONTAINED_DEVICE_SERIALNUMBERThere is no contained device with the requested serial number in the combined device.
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0

◆ tiepie_hw_devicelistitemcombined_get_name_short()

TIEPIE_HW_API uint32_t tiepie_hw_devicelistitemcombined_get_name_short ( tiepie_hw_handle  handle,
uint32_t  contained_device_serial_number,
char *  buffer,
uint32_t  length 
)

Get the short name of a device contained in a combined device.

E.g. HS5-530XMS

Parameters
[in]handleA handle identifying the object.
[in]contained_device_serial_numberThe serial number identifying the contained device inside the combined 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_INVALID_VALUE The value of Id_kind is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device is not a combined device or the contained device does not support reading a name.
TIEPIE_HW_STATUS_INVALID_CONTAINED_DEVICE_SERIALNUMBERThere is no contained device with the requested serial number in the combined device.
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0

◆ tiepie_hw_devicelistitemcombined_get_name_shortest()

TIEPIE_HW_API uint32_t tiepie_hw_devicelistitemcombined_get_name_shortest ( tiepie_hw_handle  handle,
uint32_t  contained_device_serial_number,
char *  buffer,
uint32_t  length 
)

Get the short name without model postfix of a device contained in a combined device.

E.g. HS5

Parameters
[in]handleA handle identifying the object.
[in]contained_device_serial_numberThe serial number identifying the contained device inside the combined 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_INVALID_VALUE The value of Id_kind is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device is not a combined device or the contained device does not support reading a name.
TIEPIE_HW_STATUS_INVALID_CONTAINED_DEVICE_SERIALNUMBERThere is no contained device with the requested serial number in the combined device.
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0

◆ tiepie_hw_devicelistitemcombined_get_calibration_date()

TIEPIE_HW_API tiepie_hw_date tiepie_hw_devicelistitemcombined_get_calibration_date ( tiepie_hw_handle  handle,
uint32_t  contained_device_serial_number 
)

Get the calibration date of a device contained in a combined device.

Parameters
[in]handleA handle identifying the object.
[in]contained_device_serial_numberThe serial number identifying the contained device inside the combined device.
Returns
The calibration date of the contained device, or zero if no calibration date is available.
Status values
TIEPIE_HW_STATUS_INVALID_VALUE The value of Id_kind is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device is not a combined device or the contained device does not have a calibration date.
TIEPIE_HW_STATUS_INVALID_CONTAINED_DEVICE_SERIALNUMBERThere is no contained device with the requested serial number in the combined device.
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0

◆ tiepie_hw_devicelistitemcombined_get_oscilloscope_channel_count()

TIEPIE_HW_API uint16_t tiepie_hw_devicelistitemcombined_get_oscilloscope_channel_count ( tiepie_hw_handle  handle,
uint32_t  contained_device_serial_number 
)

Get the channel count of an oscilloscope contained in a combined oscilloscope.

Parameters
[in]handleA handle identifying the object.
[in]contained_device_serial_numberThe serial number identifying the contained oscilloscope inside the combined oscilloscope.
Returns
The channel count of the contained oscilloscope.
Status values
TIEPIE_HW_STATUS_INVALID_VALUE The value of Id_kind is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated device is not a combined oscilloscope.
TIEPIE_HW_STATUS_INVALID_CONTAINED_DEVICE_SERIALNUMBERThere is no contained device with the requested serial number in the combined device.
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0