Main Page | Modules | Class Hierarchy | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

otLepton Class Reference
[Lepton - The FLIR Lepton 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.Lepton - The FLIR Lepton 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.]

Class for FLIR Lepton radiometric long-wave infrared camera.

#include <otLepton.h>


Public Types

enum  Lepton {
  REG_POWER = 0, REG_STATUS = 2, REG_COMMAND_ID = 4, REG_DATA_LEN = 6,
  REG_DATA_BASE = 8, CMD_AGC_ENABLE = 0x0100, CMD_AGC_ROI = 0x0108, CMD_AGC_HISTOGRAM_STATISTICS = 0x010c,
  CMD_AGC_HEQ_DAMPING_FACTOR = 0x0124, CMD_AGC_HEQ_CLIP_LIMIT_HIGH = 0x012c, CMD_AGC_HEQ_CLIP_LIMIT_LOW = 0x0130, CMD_AGC_HEQ_EMPTY_COUNT = 0x013c,
  CMD_AGC_HEQ_SCALE_FACTOR = 0x0144, CMD_AGC_HEQ_CALC_ENABLE_STATE = 0x0148, CMD_SYS_PING = 0x0200, CMD_SYS_STATUS = 0x0204,
  CMD_SYS_FLIR_SERIAL_NUMBER = 0x0208, CMD_SYS_CAMERA_UPTIME = 0x020C, CMD_SYS_AUX_TEMPERATURE_KELVIN = 0x0210, CMD_SYS_FPA_TEMPERATURE_KELVIN = 0x0214,
  CMD_SYS_TELEMETRY_ENABLE = 0x0218, CMD_SYS_TELEMETRY_LOCATION = 0x021c, CMD_SYS_FRAMES_TO_AVERAGE = 0x0224, CMD_SYS_CUST_SERIAL_NUMBER = 0x0228,
  CMD_SYS_SCENE_STATISTICS = 0x022c, CMD_SYS_SCENE_ROI = 0x0230, CMD_SYS_THERMAL_SHUTDOWN_COUNT = 0x0234, CMD_SYS_SHUTTER_POSITION = 0x0238,
  CMD_SYS_FFC_SHUTTER_MODE = 0x023c, CMD_SYS_FFC_NORMALIZATION = 0x0240, CMD_SYS_FFC_STATUS = 0x0244, CMD_VID_USER_LUT = 0x0308,
  CMD_VID_FOCUS_CALC_ENABLE = 0x030c, CMD_VID_FOCUS_ROI = 0x0310, CMD_VID_FOCUS_METRIC_THRESHOLD = 0x0314, CMD_VID_FOCUS_METRIC = 0x0318,
  CMD_VID_FREEZE_ENABLE = 0x0324, STATUS_BIT_BUSY = 1, STATUS_BIT_BOOT_MODE = 2, STATUS_BIT_BOOT_STATUS = 4,
  TYPE_GET = 0, TYPE_SET = 1, TYPE_RUN = 2
}

Public Member Functions

 otLepton ()
bool init (U8 spiAdd)
F32 temperature (bool fpa=true)
void sync (U32 dly=0)
bool image (U16 *img)
bool agcEnable (bool ena)


Member Enumeration Documentation

enum otLepton::Lepton
 

Enumeration values:
REG_POWER 
REG_STATUS 
REG_COMMAND_ID 
REG_DATA_LEN 
REG_DATA_BASE 
CMD_AGC_ENABLE  AGC Enable and Disable. To turn AGC ON is to enable AGC processing. Disabling the AGC will turn the AGC processing OFF and the video data will not be optimized for scene contrast.
CMD_AGC_ROI  AGC ROI Select. The AGC algorithms utilize a histogram, which is collected from within a specified rectangular window or Region of Interest (ROI).
CMD_AGC_HISTOGRAM_STATISTICS  AGC Histogram Statistics. The AGC algorithms use the image histogram as input.
CMD_AGC_HEQ_DAMPING_FACTOR  AGC HEQ Dampening Factor. This parameter is the amount of temporal dampening applied to the HEQ transformation function.
CMD_AGC_HEQ_CLIP_LIMIT_HIGH  AGC HEQ Clip Limit High. This parameter defines the maximum number of pixels allowed to accumulate in any given histogram bin.
CMD_AGC_HEQ_CLIP_LIMIT_LOW  AGC HEQ Clip Limit Low. This parameter defines an artificial population that is added to every non-empty histogram bin.
CMD_AGC_HEQ_EMPTY_COUNT  AGC HEQ Empty Counts. This parameter specifies the maximum number of pixels in a bin that will be interpreted as an empty bin.
CMD_AGC_HEQ_SCALE_FACTOR  AGC HEQ Output Scale Factor. This parameter specifies the output format for HEQ as either 8-bits (values range 0 to 255), or 14-bit (values range from 0 to 16383).
CMD_AGC_HEQ_CALC_ENABLE_STATE  AGC Calculation Enable State. This parameter controls the camera AGC calculations operations. If enabled, the current video histogram and AGC policy will be calculated for each input frame.
CMD_SYS_PING  SYS Ping Camera. This function sends the ping command to the camera.
CMD_SYS_STATUS  SYS Status. This command returns the system status: System Ready, System Initializing, System in Low-Power Mode, System Going into Standby, and FFC in Progress.
CMD_SYS_FLIR_SERIAL_NUMBER  SYS FLIR Serial Number. This command returns the Lepton Camera’s serial number as a 64-bit unsigned long integer (unsigned long long).
CMD_SYS_CAMERA_UPTIME  SYS Camera Uptime. This command returns the Lepton Camera’s current uptime in milliseconds.
CMD_SYS_AUX_TEMPERATURE_KELVIN  SYS AUX Temperature Kelvin. This command returns the Lepton Camera’s AUX Temperature in Kelvin.
CMD_SYS_FPA_TEMPERATURE_KELVIN  SYS FPA Temperature Kelvin. This command returns the Lepton Camera’s FPA Temperature in Kelvin.
CMD_SYS_TELEMETRY_ENABLE  SYS Telemetry Enable State. This command returns the Telemetry Enabled State as an Enum.
CMD_SYS_TELEMETRY_LOCATION  SYS Telemetry Location. This command Sets and Gets the Telemetry Location.
CMD_SYS_FRAMES_TO_AVERAGE  SYS Frame Average. This command executes the average frames command.
CMD_SYS_CUST_SERIAL_NUMBER  SYS Camera Customer Serial Number. This command returns the Lepton Camera’s Customer serial number as a 32-byte character string.
CMD_SYS_SCENE_STATISTICS  SYS Camera Video Scene Statistics. This command returns the current scene statistics for the video frame defined by the SYS ROI.
CMD_SYS_SCENE_ROI  SYS Scene ROI Select. The camera supports processing of pixels contained within a specified rectangular window or Region of Interest (ROI) to calculate scene statistics.
CMD_SYS_THERMAL_SHUTDOWN_COUNT  SYS Thermal Shutdown Count. This command returns the current number of frames remaining before a thermal shutdown is executed once the camera temperature exceeds a high-temperature threshold (around 80 degrees C).
CMD_SYS_SHUTTER_POSITION  SYS Shutter Position Control. This command is used to manually control the position of the attached shutter if one exists.
CMD_SYS_FFC_SHUTTER_MODE  SYS FFC Mode Control. This command controls the FFC mode and shutter control during an FFC.
CMD_SYS_FFC_NORMALIZATION  SYS Run FFC Normalization. This command executes the camera’s Flat-Field Correction (FFC) normalization.
CMD_SYS_FFC_STATUS  SYS FFC Status. This command returns the Flat-Field Correction normalization (FFC) status.
CMD_VID_USER_LUT  VID Pseudo-Color Look-Up Table Select. This function allows selection of the video output pseudo-color LUT.
CMD_VID_FOCUS_CALC_ENABLE  VID Focus Calculation Enable State. The camera can calculate a video scene focus metric (also useful as a metric of contrast).
CMD_VID_FOCUS_ROI  VID Focus ROI Select. The camera supports processing of pixels contained within a specified rectangular window or Region of Interest (ROI) to calculate a focus metric.
CMD_VID_FOCUS_METRIC_THRESHOLD  VID Focus Metric Threshold. This function specifies the focus metric threshold.
CMD_VID_FOCUS_METRIC  VID Focus Metric. This function returns the most recently calculated scene focus metric.
CMD_VID_FREEZE_ENABLE  VID Video Freeze Enable State. This function allows the current frame to be repeated in lieu of a live video stream.
STATUS_BIT_BUSY 
STATUS_BIT_BOOT_MODE 
STATUS_BIT_BOOT_STATUS 
TYPE_GET 
TYPE_SET 
TYPE_RUN 


Constructor & Destructor Documentation

otLepton.otLepton  ) 
 

Create the class


Member Function Documentation

bool otLepton.agcEnable bool  ena  ) 
 

Enable/disable AGC function

Parameters:
ena True to enable AGC

bool otLepton.image U16 img  ) 
 

Get a frame from Lepton module

Parameters:
img Pointer to image buffer
Returns:
True on success

bool otLepton.init U8  spiAdd  ) 
 

Init Lepton module

Parameters:
spiAdd Address of used SPI channel
Returns:
True on success

void otLepton.sync U32  dly = 0  ) 
 

Syncronize the Lepton sampling

Parameters:
dly Sync delay already done

F32 otLepton.temperature bool  fpa = true  ) 
 

Return the temperature (Kelivin) for FPA or for AUX

Parameters:
fpa True for FPA or false for AUX
Returns:
Temperature as Kelvin


The documentation for this class was generated from the following file: footer
otStudio - Library Reference - (C) 2020-23 Officina Turini, All Rights Reserved
Document built with Doxygen 1.4.0