|
virtual bool | getAccessoryBoardAvailable (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual size_t | getFlashSlotData (lh_device_id_t deviceID, lh_error_code_t *errorCode, uint32_t slotNumber, uint8_t data[], size_t dataLength) |
|
virtual void | setFlashSlotData (lh_device_id_t deviceID, lh_error_code_t *errorCode, uint32_t slotNumber, const uint8_t data[], size_t dataLength) |
|
virtual void | setI2CData (lh_device_id_t deviceID, lh_error_code_t *errorCode, uint32_t i2cBusIndex, uint32_t i2cTargetAddress, const uint8_t data[], size_t dataLength) |
|
◆ getAccessoryBoardAvailable()
virtual bool oceandirect::api::LHFlashAPI::getAccessoryBoardAvailable |
( |
lh_device_id_t |
deviceID, |
|
|
lh_error_code_t * |
errorCode |
|
) |
| |
|
virtual |
.getAccessoryBoardAvailable Ping the I2C accessory board (where supported by the device).
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- true if accessory is up and running, false otherwise or on error.
◆ getFlashSlotData()
virtual size_t oceandirect::api::LHFlashAPI::getFlashSlotData |
( |
lh_device_id_t |
deviceID, |
|
|
lh_error_code_t * |
errorCode, |
|
|
uint32_t |
slotNumber, |
|
|
uint8_t |
data[], |
|
|
size_t |
dataLength |
|
) |
| |
|
virtual |
.getFlashSlotData Read data from a non-volatile slot space.
- See also
- setFlashSlotData()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
slotNumber | the desired slot number to read from. Valid values range from 1 to 20 but may vary depending on FW version. |
data | the buffer to receive the slot data |
dataLength | the length of the supplied data buffer. |
- Returns
- the number of bytes written to the data buffer.
◆ setFlashSlotData()
virtual void oceandirect::api::LHFlashAPI::setFlashSlotData |
( |
lh_device_id_t |
deviceID, |
|
|
lh_error_code_t * |
errorCode, |
|
|
uint32_t |
slotNumber, |
|
|
const uint8_t |
data[], |
|
|
size_t |
dataLength |
|
) |
| |
|
virtual |
.setFlashSlotData Write data into a non-volatile slot space. This function is only applied to OBP2 device.
- See also
- getFlashSlotData()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
slotNumber | the desired slot number to write to. Valid values range from 1 to 20 but may vary depending on FW version. |
data | the buffer containing the slot data. |
dataLength | the slot data size. |
◆ setI2CData()
virtual void oceandirect::api::LHFlashAPI::setI2CData |
( |
lh_device_id_t |
deviceID, |
|
|
lh_error_code_t * |
errorCode, |
|
|
uint32_t |
i2cBusIndex, |
|
|
uint32_t |
i2cTargetAddress, |
|
|
const uint8_t |
data[], |
|
|
size_t |
dataLength |
|
) |
| |
|
virtual |
.setI2CData Writes I2C data to the device. This function is only applied to OBP2 device.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
i2cBusIndex | the desired I2C bus index. |
i2cTargetAddress | the desired I2C target address (device dependent). |
data | the array containing the I2C data to write. |
dataLength | the length of the I2C data array. |
The documentation for this class was generated from the following file: