#include <LHDeviceInformationAPI.h>
|
virtual | ~LHDeviceInformationAPI ()=default |
|
virtual size_t | getDeviceAlias (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength) |
|
virtual size_t | getManufacturer (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength) |
|
virtual size_t | getModel (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength) |
|
virtual size_t | getOriginalManufacturer (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength) |
|
virtual size_t | getOriginalModel (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength) |
|
virtual lh_usb_identifier_t | getOriginalUsbPID (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_usb_identifier_t | getOriginalUsbVID (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual size_t | getRevisionFirmware (lh_device_id_t deviceID, lh_error_code_t *errorCode, uint8_t buffer[], size_t bufferLength) |
|
virtual size_t | getRevisionFPGA (lh_device_id_t deviceID, lh_error_code_t *errorCode, uint8_t buffer[], size_t bufferLength) |
|
virtual size_t | getRevisionSystem (lh_device_id_t deviceID, lh_error_code_t *errorCode, uint8_t buffer[], size_t bufferLength) |
|
virtual size_t | getSerialNumber (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength) |
|
virtual size_t | getSerialNumberMaximumLength (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_usb_identifier_t | getUsbPID (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_usb_identifier_t | getUsbVID (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual void | resetDevice (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
◆ ~LHDeviceInformationAPI()
virtual oceandirect::api::LHDeviceInformationAPI::~LHDeviceInformationAPI |
( |
| ) |
|
|
virtualdefault |
◆ getDeviceAlias()
virtual size_t oceandirect::api::LHDeviceInformationAPI::getDeviceAlias |
( |
lh_device_id_t | deviceID, |
|
|
lh_error_code_t * | errorCode, |
|
|
char | buffer[], |
|
|
size_t | bufferLength ) |
|
virtual |
.getDeviceAlias Determine the device alias of the device.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
buffer | an array to receive the characters of the device alias. |
bufferLength | the size of the buffer array. |
- Returns
- the actual number of characters copied into the buffer or 0 on error.
◆ getManufacturer()
virtual size_t oceandirect::api::LHDeviceInformationAPI::getManufacturer |
( |
lh_device_id_t | deviceID, |
|
|
lh_error_code_t * | errorCode, |
|
|
char | buffer[], |
|
|
size_t | bufferLength ) |
|
virtual |
.getManufacturer Determine the current manufacturer stored string.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
buffer | an array to receive the characters of the current manufacturer string. |
bufferLength | the size of the buffer array. |
- Returns
- the actual number of characters copied into the buffer or 0 on error.
◆ getModel()
virtual size_t oceandirect::api::LHDeviceInformationAPI::getModel |
( |
lh_device_id_t | deviceID, |
|
|
lh_error_code_t * | errorCode, |
|
|
char | buffer[], |
|
|
size_t | bufferLength ) |
|
virtual |
.getModel Determine the current model stored string.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
buffer | an array to receive the characters of the current model string. |
bufferLength | the size of the buffer array. |
- Returns
- the actual number of characters copied into the buffer or 0 on error.
◆ getOriginalManufacturer()
virtual size_t oceandirect::api::LHDeviceInformationAPI::getOriginalManufacturer |
( |
lh_device_id_t | deviceID, |
|
|
lh_error_code_t * | errorCode, |
|
|
char | buffer[], |
|
|
size_t | bufferLength ) |
|
virtual |
.getOriginalManufacturer Determine the original manufacturer stored string.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
buffer | an array to receive the characters of the original manufacturer string. |
bufferLength | the size of the buffer array. |
- Returns
- the actual number of characters copied into the buffer or 0 on error.
◆ getOriginalModel()
virtual size_t oceandirect::api::LHDeviceInformationAPI::getOriginalModel |
( |
lh_device_id_t | deviceID, |
|
|
lh_error_code_t * | errorCode, |
|
|
char | buffer[], |
|
|
size_t | bufferLength ) |
|
virtual |
.getOriginalModel Determine the original model stored string.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
buffer | an array to receive the characters of the original model string. |
bufferLength | the size of the buffer array. |
- Returns
- the actual number of characters copied into the buffer or 0 on error.
◆ getOriginalUsbPID()
.getOriginalUsbPID Determine the original device USB Product ID.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the original USB Product ID or 0 on error.
◆ getOriginalUsbVID()
.getOriginalUsbVID Determine the original device USB Vendor ID.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the original USB Vendor ID or 0 on error.
◆ getRevisionFirmware()
virtual size_t oceandirect::api::LHDeviceInformationAPI::getRevisionFirmware |
( |
lh_device_id_t | deviceID, |
|
|
lh_error_code_t * | errorCode, |
|
|
uint8_t | buffer[], |
|
|
size_t | bufferLength ) |
|
virtual |
.getRevisionFirmware Determine the firmware version of the device.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
buffer | an array to receive the firmware version numbers (major, minor, point). |
bufferLength | the size of the buffer array. |
- Returns
- the actual number of values copied into the buffer or 0 on error.
◆ getRevisionFPGA()
virtual size_t oceandirect::api::LHDeviceInformationAPI::getRevisionFPGA |
( |
lh_device_id_t | deviceID, |
|
|
lh_error_code_t * | errorCode, |
|
|
uint8_t | buffer[], |
|
|
size_t | bufferLength ) |
|
virtual |
.getRevisionFPGA Determine the FPGA version of the device.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
buffer | an array to receive the FPGA version numbers (major, minor, point). |
bufferLength | the size of the buffer array. |
- Returns
- the actual number of values copied into the buffer or 0 on error.
◆ getRevisionSystem()
virtual size_t oceandirect::api::LHDeviceInformationAPI::getRevisionSystem |
( |
lh_device_id_t | deviceID, |
|
|
lh_error_code_t * | errorCode, |
|
|
uint8_t | buffer[], |
|
|
size_t | bufferLength ) |
|
virtual |
.getRevisionSystem Determine the System version of the device.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
buffer | an array to receive the System version numbers (major, minor, point). |
bufferLength | the size of the buffer array. |
- Returns
- the actual number of values copied into the buffer or 0 on error.
◆ getSerialNumber()
virtual size_t oceandirect::api::LHDeviceInformationAPI::getSerialNumber |
( |
lh_device_id_t | deviceID, |
|
|
lh_error_code_t * | errorCode, |
|
|
char | buffer[], |
|
|
size_t | bufferLength ) |
|
virtual |
.getSerialNumber Determine the serial number of the device.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
buffer | an array to receive the characters of the serial number. |
bufferLength | the size of the buffer array. |
- Returns
- the actual number of characters copied into the buffer or 0 on error.
◆ getSerialNumberMaximumLength()
.getSerialNumberMaximumLength Determine the maximum length of the serial number of the device.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the maximum size of the serial number or 0 on error.
◆ getUsbPID()
.getUsbPID Determine the current device USB Product ID.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the current USB Product ID or 0 on error.
◆ getUsbVID()
.getUsbVID Determine the current device USB Vendor ID.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the current USB Vendor ID or 0 on error.
◆ resetDevice()
.resetDevice Trigger a software reset of the device.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
The documentation for this class was generated from the following file: