Lepton - The FLIR Lepton 3 is a radiometric long-wave infrared camera solution designed to integrate easily into native mobile-device interfaces and other consumer electronics as an IR sensor or thermal imager.

Files
file	otLepton3.h
	Class for FLIR Lepton 3 radiometric long-wave infrared camera.
Modules
	Version History
Data Structures
struct	LEP_OEM_PART_NUMBER_T_TAG
class	otLepton3
	Class for FLIR Lepton 3 radiometric long-wave infrared camera. More...
class	otLepton3
	Class for FLIR Lepton 3 radiometric long-wave infrared camera. More...
Represents the different result codes the camera can return.
typedef enum Result	LEP_RESULT
enum	Result {   LEP_OK = 0, LEP_COMM_OK = LEP_OK, LEP_ERROR = -1, LEP_NOT_READY = -2,   LEP_RANGE_ERROR = -3, LEP_CHECKSUM_ERROR = -4, LEP_BAD_ARG_POINTER_ERROR = -5, LEP_DATA_SIZE_ERROR = -6,   LEP_UNDEFINED_FUNCTION_ERROR = -7, LEP_FUNCTION_NOT_SUPPORTED = -8, LEP_DATA_OUT_OF_RANGE_ERROR = -9, LEP_COMMAND_NOT_ALLOWED = -11,   LEP_OTP_WRITE_ERROR = -15, LEP_OTP_READ_ERROR = -16, LEP_OTP_NOT_PROGRAMMED_ERROR = -18, LEP_ERROR_I2C_BUS_NOT_READY = -20,   LEP_ERROR_I2C_BUFFER_OVERFLOW = -22, LEP_ERROR_I2C_ARBITRATION_LOST = -23, LEP_ERROR_I2C_BUS_ERROR = -24, LEP_ERROR_I2C_NACK_RECEIVED = -25,   LEP_ERROR_I2C_FAIL = -26, LEP_DIV_ZERO_ERROR = -80, LEP_COMM_PORT_NOT_OPEN = -101, LEP_COMM_INVALID_PORT_ERROR = -102,   LEP_COMM_RANGE_ERROR = -103, LEP_ERROR_CREATING_COMM = -104, LEP_ERROR_STARTING_COMM = -105, LEP_ERROR_CLOSING_COMM = -106,   LEP_COMM_CHECKSUM_ERROR = -107, LEP_COMM_NO_DEV = -108, LEP_TIMEOUT_ERROR = -109, LEP_COMM_ERROR_WRITING_COMM = -110,   LEP_COMM_ERROR_READING_COMM = -111, LEP_COMM_COUNT_ERROR = -112, LEP_OPERATION_CANCELED = -126, LEP_UNDEFINED_ERROR_CODE = -127 }
Radiometry Enable state
typedef enum LEP_RAD_ENABLE_E_TAG	LEP_RAD_ENABLE_E
typedef enum LEP_RAD_ENABLE_E_TAG *	LEP_RAD_ENABLE_E_PTR
enum	LEP_RAD_ENABLE_E_TAG { LEP_RAD_DISABLE = 0, LEP_RAD_ENABLE, LEP_END_RAD_ENABLE }
Video Output Format Selection
typedef enum LEP_OEM_VIDEO_OUTPUT_FORMAT_TAG	LEP_OEM_VIDEO_OUTPUT_FORMAT_E
typedef enum LEP_OEM_VIDEO_OUTPUT_FORMAT_TAG *	LEP_OEM_VIDEO_OUTPUT_FORMAT_E_PTR
typedef enum LEP_OEM_GPIO_MODE_E_TAG	LEP_OEM_GPIO_MODE_E
typedef enum LEP_OEM_GPIO_MODE_E_TAG *	LEP_OEM_GPIO_MODE_E_PTR
typedef U16	LEP_SYS_FPA_TEMPERATURE_KELVIN_T
typedef U16 *	LEP_SYS_FPA_TEMPERATURE_KELVIN_T_PTR
typedef char	LEP_CHAR8
typedef LEP_OEM_PART_NUMBER_T_TAG	LEP_OEM_PART_NUMBER_T
typedef LEP_OEM_PART_NUMBER_T_TAG *	LEP_OEM_PART_NUMBER_T_PTR
enum	LEP_OEM_VIDEO_OUTPUT_FORMAT_TAG {   LEP_VIDEO_OUTPUT_FORMAT_RAW8 = 0, LEP_VIDEO_OUTPUT_FORMAT_RAW10, LEP_VIDEO_OUTPUT_FORMAT_RAW12, LEP_VIDEO_OUTPUT_FORMAT_RGB888,   LEP_VIDEO_OUTPUT_FORMAT_RGB666, LEP_VIDEO_OUTPUT_FORMAT_RGB565, LEP_VIDEO_OUTPUT_FORMAT_YUV422_8BIT, LEP_VIDEO_OUTPUT_FORMAT_RAW14,   LEP_VIDEO_OUTPUT_FORMAT_YUV422_10BIT, LEP_VIDEO_OUTPUT_FORMAT_USER_DEFINED, LEP_VIDEO_OUTPUT_FORMAT_RAW8_2, LEP_VIDEO_OUTPUT_FORMAT_RAW8_3,   LEP_VIDEO_OUTPUT_FORMAT_RAW8_4, LEP_VIDEO_OUTPUT_FORMAT_RAW8_5, LEP_VIDEO_OUTPUT_FORMAT_RAW8_6, LEP_END_VIDEO_OUTPUT_FORMAT }
enum	LEP_OEM_GPIO_MODE_E_TAG {   LEP_OEM_GPIO_MODE_GPIO = 0, LEP_OEM_GPIO_MODE_I2C_MASTER = 1, LEP_OEM_GPIO_MODE_SPI_MASTER_VLB_DATA = 2, LEP_OEM_GPIO_MODE_SPIO_MASTER_REG_DATA = 3,   LEP_OEM_GPIO_MODE_SPI_SLAVE_VLB_DATA = 4, LEP_OEM_GPIO_MODE_VSYNC = 5, LEP_OEM_END_GPIO_MODE }
Defines
#define	LEP_OEM_MAX_PART_NUMBER_CHAR_SIZE   32
Typedefs
typedef U16	LEP_COMMAND_ID
typedef U16	LEP_ATTRIBUTE_T
typedef U16 *	LEP_ATTRIBUTE_T_PTR

---

Detailed Description

Dependency:
Malloc - Memory management
I2C - System Management Bus
FPGA - Procedures for SharkDuino+ FPGA
SPI - Serial Protocol Interface

---

Define Documentation

#define LEP_OEM_MAX_PART_NUMBER_CHAR_SIZE   32

---

Typedef Documentation

typedef U16 LEP_ATTRIBUTE_T

typedef U16 * LEP_ATTRIBUTE_T_PTR

typedef char LEP_CHAR8

typedef U16 LEP_COMMAND_ID

typedef enum LEP_OEM_GPIO_MODE_E_TAG LEP_OEM_GPIO_MODE_E

typedef enum LEP_OEM_GPIO_MODE_E_TAG * LEP_OEM_GPIO_MODE_E_PTR

typedef struct LEP_OEM_PART_NUMBER_T_TAG LEP_OEM_PART_NUMBER_T

typedef struct LEP_OEM_PART_NUMBER_T_TAG * LEP_OEM_PART_NUMBER_T_PTR

typedef enum LEP_OEM_VIDEO_OUTPUT_FORMAT_TAG LEP_OEM_VIDEO_OUTPUT_FORMAT_E

typedef enum LEP_OEM_VIDEO_OUTPUT_FORMAT_TAG * LEP_OEM_VIDEO_OUTPUT_FORMAT_E_PTR

typedef enum LEP_RAD_ENABLE_E_TAG LEP_RAD_ENABLE_E

typedef enum LEP_RAD_ENABLE_E_TAG * LEP_RAD_ENABLE_E_PTR

typedef enum Result LEP_RESULT

typedef U16 LEP_SYS_FPA_TEMPERATURE_KELVIN_T

typedef U16 * LEP_SYS_FPA_TEMPERATURE_KELVIN_T_PTR

---

Enumeration Type Documentation

enum LEP_OEM_GPIO_MODE_E_TAG

Enumeration values: LEP_OEM_GPIO_MODE_GPIO  LEP_OEM_GPIO_MODE_I2C_MASTER  LEP_OEM_GPIO_MODE_SPI_MASTER_VLB_DATA  LEP_OEM_GPIO_MODE_SPIO_MASTER_REG_DATA  LEP_OEM_GPIO_MODE_SPI_SLAVE_VLB_DATA  LEP_OEM_GPIO_MODE_VSYNC  LEP_OEM_END_GPIO_MODE

enum LEP_OEM_VIDEO_OUTPUT_FORMAT_TAG

Enumeration values: LEP_VIDEO_OUTPUT_FORMAT_RAW8  To be supported in later release. LEP_VIDEO_OUTPUT_FORMAT_RAW10  To be supported in later release. LEP_VIDEO_OUTPUT_FORMAT_RAW12  To be supported in later release. LEP_VIDEO_OUTPUT_FORMAT_RGB888  To be supported in later release. LEP_VIDEO_OUTPUT_FORMAT_RGB666  To be supported in later release. LEP_VIDEO_OUTPUT_FORMAT_RGB565  To be supported in later release. LEP_VIDEO_OUTPUT_FORMAT_YUV422_8BIT  To be supported in later release. LEP_VIDEO_OUTPUT_FORMAT_RAW14  SUPPORTED in this release. LEP_VIDEO_OUTPUT_FORMAT_YUV422_10BIT  To be supported in later release. LEP_VIDEO_OUTPUT_FORMAT_USER_DEFINED  To be supported in later release. LEP_VIDEO_OUTPUT_FORMAT_RAW8_2  To be supported in later release. LEP_VIDEO_OUTPUT_FORMAT_RAW8_3  To be supported in later release. LEP_VIDEO_OUTPUT_FORMAT_RAW8_4  To be supported in later release. LEP_VIDEO_OUTPUT_FORMAT_RAW8_5  To be supported in later release. LEP_VIDEO_OUTPUT_FORMAT_RAW8_6  To be supported in later release. LEP_END_VIDEO_OUTPUT_FORMAT

enum LEP_RAD_ENABLE_E_TAG

Enumeration values: LEP_RAD_DISABLE  LEP_RAD_ENABLE  LEP_END_RAD_ENABLE

enum Result

Enumeration values: LEP_OK  Camera ok. LEP_COMM_OK  Camera comm ok (same as LEP_OK). LEP_ERROR  Camera general error. LEP_NOT_READY  Camera not ready error. LEP_RANGE_ERROR  Camera range error. LEP_CHECKSUM_ERROR  Camera checksum error. LEP_BAD_ARG_POINTER_ERROR  Camera Bad argument error. LEP_DATA_SIZE_ERROR  Camera byte count error. LEP_UNDEFINED_FUNCTION_ERROR  Camera undefined function error. LEP_FUNCTION_NOT_SUPPORTED  Camera function not yet supported error. LEP_DATA_OUT_OF_RANGE_ERROR  Camera input DATA is out of valid range error. LEP_COMMAND_NOT_ALLOWED  Camera unable to execute command due to current camera state. LEP_OTP_WRITE_ERROR  Camera OTP write error. LEP_OTP_READ_ERROR  Double bit error detected (uncorrectible). LEP_OTP_NOT_PROGRAMMED_ERROR  Flag read as non-zero. LEP_ERROR_I2C_BUS_NOT_READY  I2C Bus Error - Bus Not Avaialble. LEP_ERROR_I2C_BUFFER_OVERFLOW  I2C Bus Error - Buffer Overflow. LEP_ERROR_I2C_ARBITRATION_LOST  I2C Bus Error - Bus Arbitration Lost. LEP_ERROR_I2C_BUS_ERROR  I2C Bus Error - General Bus Error. LEP_ERROR_I2C_NACK_RECEIVED  I2C Bus Error - NACK Received. LEP_ERROR_I2C_FAIL  I2C Bus Error - General Failure. LEP_DIV_ZERO_ERROR  Attempted div by zero. LEP_COMM_PORT_NOT_OPEN  Comm port not open. LEP_COMM_INVALID_PORT_ERROR  Comm port no such port error. LEP_COMM_RANGE_ERROR  Comm port range error. LEP_ERROR_CREATING_COMM  Error creating comm. LEP_ERROR_STARTING_COMM  Error starting comm. LEP_ERROR_CLOSING_COMM  Error closing comm. LEP_COMM_CHECKSUM_ERROR  Comm checksum error. LEP_COMM_NO_DEV  No comm device. LEP_TIMEOUT_ERROR  Comm timeout error. LEP_COMM_ERROR_WRITING_COMM  Error writing comm. LEP_COMM_ERROR_READING_COMM  Error reading comm. LEP_COMM_COUNT_ERROR  Comm byte count error. LEP_OPERATION_CANCELED  Camera operation canceled. LEP_UNDEFINED_ERROR_CODE  Undefined error.

otStudio - Library Reference - (C) 2020-23 Officina Turini, All Rights Reserved
Document built with Doxygen 1.4.0