AFBR-S50 API Reference Manual v1.5.6
AFBR-S50 Time-of-Flight Sensor SDK for Embedded Software
|
The following section contains the current command details as implemented in the Explorer App. The implementation can be found in the Sources\ExplorerApp\api
folder of the AFBR-S50 GitHub repository.
See Command Details for detailed description of all available commands.
Caption | Byte | Type | Comment |
---|---|---|---|
Invalid Command | 0x00 | - | Reserved! Invalid Command; |
Acknowledge (ACK) | 0x0A | auto/push | Slave does acknowledge the successful reception of the last command. |
Not Acknowledge (NAK) | 0x0B | auto/push | Slave does not-acknowledge the successful reception of the last command. |
Ping Command | 0x01 | get | A ping message the is sent from the master and reflected by the slave. Used to establish or test the UART connection. |
Log Message | 0x06 | auto/push | An event/debug log message sent from the slave to inform the user. |
Test Message | 0x04 | set / get | Sending a test message to the slave that will be echoed in order to test the interface. The slave will echo the exact message including the CRC values from the original message. |
MCU/Software Reset | 0x08 | cmd | Invokes the software reset command. |
Software Version | 0x0C | get | Gets the current software version number. |
Module Type | 0x0E | get | Gets the module information, incl. module type with version number, chip version and laser type. |
Module UID | 0x0F | get | Gets the chip/module unique identification number. |
Software Information / Identification | 0x05 | get | Gets the information about current software and device (e.g. version, device id, device family, ...) |
Caption | Byte | Type | Comment |
---|---|---|---|
Measurement: Single Shot | 0x10 | cmd | Executes a single shot measurement. |
Measurement: Start Auto | 0x11 | cmd | Starts the automatic, time-scheduled measurements with given frame rate. |
Measurement: Stop | 0x12 | cmd | Stops the time-scheduled measurements (after the current frame finishes). |
Measurement: Abort | 0x13 | cmd | Aborts the current measurements immediately. |
Calibration: Run | 0x18 | cmd | Executes a calibration sequence. |
Re-Initialize Device | 0x19 | cmd | Invokes the device (re-)initialization command. Resets and reinitializes the API + ASIC with given config. (e.g. after unintended power cycle). |
The modes of measurement data streaming. The actual data might depend on device configuration and calibration.
Caption | Byte | Type | Comment |
---|---|---|---|
Measurement Data Set (1D + 3D) - Debug | 0x31 | get / auto/push | Gets a measurement data set containing all the available data. |
Measurement Data Set (1D + 3D) | 0x32 | get / auto/push | Gets a measurement data set containing the essential data. |
3D Measurement Data Set - Debug | 0x33 | get / auto/push | Gets a 3D measurement data set containing all the available data per pixel. |
3D Measurement Data Set | 0x34 | get / auto/push | Gets a 3D measurement data set containing the essential data per pixel. |
1D Measurement Data Set - Debug | 0x35 | get / auto/push | Gets a 1D measurement data set containing all the available distance measurement data. |
1D Measurement Data Set | 0x36 | get / auto/push | Gets a 1D measurement data set containing the essential distance measurement data. |
Caption | Byte | Type | Comment |
---|---|---|---|
Data Output Mode | 0x41 | set / get | The measurement data output mode. (Hardware API only) |
Measurement Mode | 0x42 | set / get | Gets or sets the measurement mode. |
Frame Time (Frame Rate) | 0x43 | set / get | Gets or sets the measurement frame time (i.e. inverse frame rate). |
Dual Frequency Mode | 0x44 | set / get | Gets or sets the dual frequency mode. |
Smart Power Save Mode | 0x45 | set / get | Gets or sets the smart power saving feature enabled flag. |
Shot Noise Monitor Mode | 0x46 | set / get | Gets or sets the shot noise monitor mode. |
Crosstalk Monitor Mode | 0x47 | set / get | Gets or sets the crosstalk monitor mode. |
Dynamic Configuration Adaption | 0x52 | set / get | Gets or sets the full dynamic configuration adaption (DCA) feature configuration set. |
Pixel Binning Algorithm | 0x54 | set / get | Gets or sets the pixel binning algorithm (PBA) feature configuration. |
SPI Configuration | 0x58 | set / get | Gets or sets the SPI configuration (e.g. baud rate). |
UART Configuration | 0x59 | set / get | Gets or sets the UART configuration (e.g. baud rate). Only for UART version. |
Caption | Byte | Type | Comment |
---|---|---|---|
Global Range Offset | 0x61 | set / get | Gets or sets the global range offset calibration parameter. |
Pixel Range Offsets | 0x67 | set / get | Gets or sets the pixel-to-pixel range offset table. |
Pixel Range Offsets - Reset | 0x68 | cmd | Resets the pixel-to-pixel range offset table to factory calibrated default values. |
Range Offsets Cal. Sequence - Sample Time | 0x69 | set / get | Gets or sets the range offset calibration sequence sample time. |
Crosstalk Compensation - Vector Table | 0x62 | set / get | Gets or sets the crosstalk compensation vector table. |
Crosstalk Compensation - Reset | 0x63 | cmd | Resets the crosstalk compensation vector table to factory calibrated default values. |
Crosstalk Cal. Sequence - Sample Time | 0x64 | set / get | Gets or sets the crosstalk calibration sequence sample time. |
Crosstalk Cal. Sequence - Max. Amplitude | 0x65 | set / get | Gets or sets the crosstalk calibration sequence maximum amplitude threshold. |
Pixel-2-Pixel Crosstalk Compensation | 0x66 | set / get | Gets or sets the pixel-2-pixel crosstalk calibration parameter values. |