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

otArduCAM Class Reference
[ArduCam - 5MP OV5642 Mini Camera Module, ArduCam - 5MP OV5642 Mini Camera Module]

5MP OV5642 Mini Camera Module

#include <otArduCAM.h>


Public Types

typedef otArduCAM::SensorType SensorType
typedef otArduCAM::ImageFormat ImageFormat
typedef otArduCAM::JpegQuality JpegQuality
typedef otArduCAM::LightMode LightMode
typedef otArduCAM::ColorSaturation ColorSaturation
typedef otArduCAM::Brightness Brightness
typedef otArduCAM::Contrast Contrast
typedef otArduCAM::SpecialEffects SpecialEffects
typedef otArduCAM::Hue Hue
typedef otArduCAM::Exposure Exposure
typedef otArduCAM::Sharpness Sharpness
typedef otArduCAM::MirrorFlip MirrorFlip
enum  SensorType { OV5642, OV2640 }
enum  SensorResolution {
  OV2640_160x120, OV2640_176x144, OV2640_320x240, OV2640_352x288,
  OV2640_640x480, OV2640_800x600, OV2640_1024x768, OV2640_1280x1024,
  OV2640_1600x1200, OV5642_320x240 = 0, OV5642_640x480, OV5642_1024x768,
  OV5642_1280x960, OV5642_1600x1200, OV5642_2048x1536, OV5642_2592x1944,
  OV5642_1920x1080
}
enum  ImageFormat { IF_BMP = 0, IF_JPEG, IF_RAW }
enum  JpegQuality { P_HIGH_QUALITY, P_DEFAULT_QUALITY, P_LOW_QUALITY }
enum  LightMode {
  P_LM_A_AWB, P_LM_S_AWB, P_LM_M_DAY, P_LM_M_A,
  P_LM_M_CWF, P_LM_M_CLOUDY
}
enum  ColorSaturation {
  P_CS4, P_CS3, P_CS2, P_CS1,
  P_CS0, P_CS_1, P_CS_2, P_CS_3,
  P_CS_4
}
enum  Brightness {
  P_BS4, P_BS3, P_BS2, P_BS1,
  P_BS0, P_BS_1, P_BS_2, P_BS_3,
  P_BS_4
}
enum  Contrast {
  P_CT4, P_CT3, P_CT2, P_CT1,
  P_CT0, P_CT_1, P_CT_2, P_CT_3,
  P_CT_4
}
enum  SpecialEffects {
  P_SE_Antique, P_SE_Bluish, P_SE_Greenish, P_SE_Reddish,
  P_SE_BW, P_SE_Negative, P_SE_BWnegative, P_SE_Normal,
  P_SE_Sepia
}
enum  Hue {
  P_HUE_180, P_HUE_150, P_HUE_120, P_HUE_90,
  P_HUE_60, P_HUE_30, P_HUE0, P_HUE30,
  P_HUE60, P_HUE90, P_HUE120, P_HUE150
}
enum  Exposure {
  P_EXP_17, P_EXP_13, P_EXP_10, P_EXP_7,
  P_EXP_3, P_EXP_DEF, P_EXP3, P_EXP7,
  P_EXP10, P_EXP13, P_EXP17
}
enum  Sharpness {
  P_AUTO_SHPN_DEF, P_AUTO_SHPN_1, P_AUTO_SHPN_2, P_MAN_SHPN_OFF,
  P_MAN_SHPN_1, P_MAN_SHPN_2, P_MAN_SHPN_3, P_MAN_SHPN_4,
  P_MAN_SHPN_5
}
enum  MirrorFlip { P_NORMAL, P_FLIP, P_MIRROR, P_MIRROR_FLIP }

Public Member Functions

 otArduCAM ()
bool init (SensorType sensor, ImageFormat format)
void close ()
void shutdown (bool ena)
U8 * buffer ()
void setSize (U8 size)
U16 width ()
U16 height ()
void startGrab ()
U32 waitCompletion ()
U32 waitGrab ()
U32 grab ()
void setJpegQuality (JpegQuality q)
JpegQuality jpegQuality ()
void setLightMode (LightMode lm)
void setColorSaturation (ColorSaturation cs)
void setBrightness (Brightness br)
void setContrast (Contrast ct)
void setSpecialEffects (SpecialEffects se)
void setHue (Hue hue)
void setExposure (Exposure e)
void setSharpness (Sharpness s)
void setMirrorFlip (MirrorFlip mf)
MirrorFlip mirrorFlip ()

Member Typedef Documentation

typedef otArduCAM::Brightness otArduCAM.Brightness
 

typedef otArduCAM::ColorSaturation otArduCAM.ColorSaturation
 

typedef otArduCAM::Contrast otArduCAM.Contrast
 

typedef otArduCAM::Exposure otArduCAM.Exposure
 

typedef otArduCAM::Hue otArduCAM.Hue
 

typedef otArduCAM::ImageFormat otArduCAM.ImageFormat
 

typedef otArduCAM::JpegQuality otArduCAM.JpegQuality
 

typedef otArduCAM::LightMode otArduCAM.LightMode
 

typedef otArduCAM::MirrorFlip otArduCAM.MirrorFlip
 

typedef otArduCAM::SensorType otArduCAM.SensorType
 

typedef otArduCAM::Sharpness otArduCAM.Sharpness
 

typedef otArduCAM::SpecialEffects otArduCAM.SpecialEffects
 

Member Enumeration Documentation

enum otArduCAM::Brightness
 

Enumeration values:
P_BS4  Brightness +4.
P_BS3  Brightness +3.
P_BS2  Brightness +2.
P_BS1  Brightness +1.
P_BS0  Brightness Standard.
P_BS_1  Brightness -1.
P_BS_2  Brightness -2.
P_BS_3  Brightness -3.
P_BS_4  Brightness -4.

enum otArduCAM::ColorSaturation
 

Enumeration values:
P_CS4  Saturation +4.
P_CS3  Saturation +3.
P_CS2  Saturation +2.
P_CS1  Saturation +1.
P_CS0  Saturation Standard.
P_CS_1  Saturation -1.
P_CS_2  Saturation -2.
P_CS_3  Saturation -3.
P_CS_4  Saturation -4.

enum otArduCAM::Contrast
 

Enumeration values:
P_CT4  Contrast +4.
P_CT3  Contrast +3.
P_CT2  Contrast +2.
P_CT1  Contrast +1.
P_CT0  Contrast Standard.
P_CT_1  Contrast -1.
P_CT_2  Contrast -2.
P_CT_3  Contrast -3.
P_CT_4  Contrast -4.

enum otArduCAM::Exposure
 

Enumeration values:
P_EXP_17  Exposure -17.
P_EXP_13  Exposure -13.
P_EXP_10  Exposure -10.
P_EXP_7  Exposure -7.
P_EXP_3  Exposure -3.
P_EXP_DEF  Normal.
P_EXP3  Exposure +3.
P_EXP7  Exposure +7.
P_EXP10  Exposure +10.
P_EXP13  Exposure +13.
P_EXP17  Exposure +17.

enum otArduCAM::Hue
 

Enumeration values:
P_HUE_180  Hue -180.
P_HUE_150  Hue -150.
P_HUE_120  Hue -120.
P_HUE_90  Hue -90.
P_HUE_60  Hue -60.
P_HUE_30  Hue -30.
P_HUE0  Normal.
P_HUE30  Hue 30.
P_HUE60  Hue 60.
P_HUE90  Hue 90.
P_HUE120  Hue 120.
P_HUE150  Hue 150.

enum otArduCAM::ImageFormat
 

Enumeration values:
IF_BMP  565 format for LCD preview
IF_JPEG  JPEG Reasonably the only usable mode.
IF_RAW  Very large and slow.

enum otArduCAM::JpegQuality
 

Enumeration values:
P_HIGH_QUALITY  High quality.
P_DEFAULT_QUALITY  Medium quality.
P_LOW_QUALITY  Low quality.

enum otArduCAM::LightMode
 

Enumeration values:
P_LM_A_AWB  Advanced_AWB.
P_LM_S_AWB  Simple_AWB.
P_LM_M_DAY  Manual_day.
P_LM_M_A  Manual_A.
P_LM_M_CWF  Manual_cwf.
P_LM_M_CLOUDY  Manual_cloudy.

enum otArduCAM::MirrorFlip
 

Enumeration values:
P_NORMAL  Normal.
P_FLIP  Vertical flip.
P_MIRROR  Horizontal mirror don't work correctly. Probably is a sync problem on FPGA.
P_MIRROR_FLIP  Horizontal and vertical flip.

enum otArduCAM::SensorResolution
 

Enumeration values:
OV2640_160x120  160x120
OV2640_176x144  176x144
OV2640_320x240  320x240
OV2640_352x288  352x288
OV2640_640x480  640x480
OV2640_800x600  800x600
OV2640_1024x768  1024x768
OV2640_1280x1024  1280x1024
OV2640_1600x1200  1600x1200
OV5642_320x240  320x240
OV5642_640x480  640x480
OV5642_1024x768  1024x768
OV5642_1280x960  1280x960
OV5642_1600x1200  1600x1200
OV5642_2048x1536  2048x1536
OV5642_2592x1944  2592x1944
OV5642_1920x1080  1920x1080

enum otArduCAM::SensorType
 

Enumeration values:
OV5642  Color sensor 2592x1944.
OV2640  Color sensor 1600x1200.

enum otArduCAM::Sharpness
 

Enumeration values:
P_AUTO_SHPN_DEF  Auto Sharpness default.
P_AUTO_SHPN_1  Auto Sharpness +1.
P_AUTO_SHPN_2  Auto Sharpness +2.
P_MAN_SHPN_OFF  Manual Sharpness off.
P_MAN_SHPN_1  Manual Sharpness -1.
P_MAN_SHPN_2  Manual Sharpness -2.
P_MAN_SHPN_3  Manual Sharpness -3.
P_MAN_SHPN_4  Manual Sharpness -4.
P_MAN_SHPN_5  Manual Sharpness -5.

enum otArduCAM::SpecialEffects
 

Enumeration values:
P_SE_Antique  Not implemented.
P_SE_Bluish  Blueish (cool light).
P_SE_Greenish  Greenish.
P_SE_Reddish  Redish (warm).
P_SE_BW  Black and white.
P_SE_Negative  Negative.
P_SE_BWnegative  Not implemented.
P_SE_Normal  Normal.
P_SE_Sepia  Sepia.

Constructor & Destructor Documentation

otArduCAM.otArduCAM (   ) 
 

Create the class.

Member Function Documentation

U8* otArduCAM.buffer (   ) 
 

Get the buffer address of the image

Returns:
Buffer address

void otArduCAM.close (   ) 
 

Free all allocated resources

U32 otArduCAM.grab (   ) 
 

Grab and transfer un image in the image buffer

U16 otArduCAM.height (   ) 
 

Get current image height

Returns:
Image height

bool otArduCAM.init (  SensorType  sensor,
ImageFormat  format
) 
 

Init the ArduCam

Parameters:
sensor Used sensor, see SensorType
format Sensor resolution, see ImageFormat
Returns:
True on success

JpegQuality otArduCAM.jpegQuality (   ) 
 

Read JPEG quality

Returns:
JPEG quality, See JpegQuality

MirrorFlip otArduCAM.mirrorFlip (   ) 
 

Read mirror or flip current setting

Returns:
Current mirror of flip settings

void otArduCAM.setBrightness (  Brightness  br  ) 
 

Image enhancement function, set the brightness, see Brightness

Parameters:
br Set the brightness, see Brightness

void otArduCAM.setColorSaturation (  ColorSaturation  cs  ) 
 

Image enhancement function, set the color saturation, see ColorSaturation

Parameters:
cs Color saturation, see ColorSaturation

void otArduCAM.setContrast (  Contrast  ct  ) 
 

Image enhancement function, set the contrast, see Contrast

Parameters:
ct Set the brightness, see Contrast

void otArduCAM.setExposure (  Exposure  e  ) 
 

Change the exposure, see Exposure

Parameters:
e Exposure set, see Exposure

void otArduCAM.setHue (  Hue  hue  ) 
 

Image enhancement function, set the hue, see Hue

Parameters:
hue Set the hue, see Hue

void otArduCAM.setJpegQuality (  JpegQuality  q  ) 
 

Set JPEG quality

Parameters:
q See JpegQuality

void otArduCAM.setLightMode (  LightMode  lm  ) 
 

Image enhancement function, set the light mode, see LightMode

Parameters:
lm Light mode, see LightMode

void otArduCAM.setMirrorFlip (  MirrorFlip  mf  ) 
 

Invert or not the image along vertical or horizontal. See MirrorFlip

Parameters:
mf Mirror or flip the image. See MirrorFlip

void otArduCAM.setSharpness (  Sharpness  s  ) 
 

Image enhancement function, set the sharpness, see Sharpness

Parameters:
s Set the sharpness, see Sharpness

void otArduCAM.setSize (  U8  size  ) 
 

Change the image resolution of grabbed image. See ImageFormat

Parameters:
size See ImageFormat

void otArduCAM.setSpecialEffects (  SpecialEffects  se  ) 
 

Image enhancement function, set a special effects, see SpecialEffects

Parameters:
se Set a special effects, see SpecialEffects

void otArduCAM.shutdown (  bool  ena  ) 
 

Shut down enable/disable. Used for power reduction

Parameters:
ena True to shutdown

void otArduCAM.startGrab (   ) 
 

Start an image grab but don't wait completion

U32 otArduCAM.waitCompletion (   ) 
 

Wait grab process to complete

Returns:
FIFO length

U32 otArduCAM.waitGrab (   ) 
 

Start a new image grab waiting to complete but don't transfer the image

U16 otArduCAM.width (   ) 
 

Get current image width

Returns:
Imnage width

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