Provides access to the low level functionality of the camera sensor. This includes sensor configuration as well as analog front end(AFE) configuration.
More...
#include <depth_sensor_interface.h>
Provides access to the low level functionality of the camera sensor. This includes sensor configuration as well as analog front end(AFE) configuration.
Definition at line 49 of file depth_sensor_interface.h.
◆ getAvailableFrameTypes()
Return all frame types that are supported by the sensor.
- Parameters
-
- Returns
- Status
◆ getDetails()
Get a structure that contains information about the instance of the sensor.
- Parameters
-
| [out] | details | - the variable where the sensor details should be stored |
- Returns
- Status
◆ getFrame()
Request a frame from the sensor.
- Parameters
-
| buffer | - a valid location where the new frame should be stored. The size of the frame is known (cached) internally and gets updated each time setFrameType() is called. |
| bufferInfo | - a struct containing extended frame details |
- Returns
- Status
◆ getHandle()
| virtual aditof::Status aditof::DepthSensorInterface::getHandle |
( |
void ** |
handle | ) |
|
|
pure virtual |
Gets a handle to be used by other devices such as Storage, Temperature, etc. This handle will allow the other devices to communicate remotely with the embedded target.
- Parameters
-
| [out] | handle | - the handle which is owned by this instance |
- Returns
- Status
◆ getName()
| virtual aditof::Status aditof::DepthSensorInterface::getName |
( |
std::string & |
sensorName | ) |
const |
|
pure virtual |
Get the name of the available image sensor.
- Parameters
-
| [out] | sensorName | - the location where to return the name. |
- Returns
- Status
◆ open()
Open the communication channels with the hardware.
- Returns
- Status
◆ program()
| virtual aditof::Status aditof::DepthSensorInterface::program |
( |
const uint8_t * |
firmware, |
|
|
size_t |
size |
|
) |
| |
|
pure virtual |
Program the sensor with the given firmware.
- Parameters
-
| firmware | - chunk of data representin the firmware |
| size | - the size of the firmware data in bytes |
- Returns
- Status
◆ readAfeRegisters()
| virtual aditof::Status aditof::DepthSensorInterface::readAfeRegisters |
( |
const uint16_t * |
address, |
|
|
uint16_t * |
data, |
|
|
size_t |
length |
|
) |
| |
|
pure virtual |
Read multiple registers from AFE.
- Parameters
-
| address | - memory location pointing to addresses of registers to be read |
| data | - a valid location to store the content read from AFE registers |
| length | - the number of registers to read |
- Returns
- Status
◆ setFrameType()
Set the sensor frame type to the given type.
- Parameters
-
| details | - frame details structure containing the frame type |
- Returns
- Status
◆ start()
Start the streaming of data from the sensor.
- Returns
- Status
◆ stop()
Stop the sensor data stream.
- Returns
- Status
◆ writeAfeRegisters()
| virtual aditof::Status aditof::DepthSensorInterface::writeAfeRegisters |
( |
const uint16_t * |
address, |
|
|
const uint16_t * |
data, |
|
|
size_t |
length |
|
) |
| |
|
pure virtual |
Write to multiple AFE registers.
- Parameters
-
| address | - memory location pointing to addresses of registers to be written |
| data | - the location of the content to be written to AFE registers |
| length | - the number of registers to write |
- Returns
- Status
The documentation for this class was generated from the following file:
