Module that handles photo cameras hardware. More...

Enumerations
enum	CameraType { INNER_CAM , OUTER_CAM }
	Camera types. More...

enum	CameraRes { VGA_RES , QVGA_RES , QQVGA_RES , CIF_RES , QCIF_RES , PSP_RES , NGP_RES }
	Camera resolutions. More...

enum	CameraAntiFlick { ANTIFLICKER_AUTO , ANTIFLICKER_50HZ , ANTIFLICKER_60HZ }
	Camera antiflicker modes. More...

enum	CameraISO { ISO_AUTO , ISO_100 , ISO_200 , ISO_400 }
	Camera ISO speed mode. More...

enum	CameraWB { WB_AUTO , WB_DAYLIGHT , WB_CWF , WB_SLSA }
	Camera White Balance mode. More...

enum	CameraBacklight { BACKLIGHT_OFF , BACKLIGHT_ON }
	Camera Backlight mode. More...

enum	CameraNightmode { NIGHTMODE_OFF , NIGHTMODE_LOW , NIGHTMODE_MED , NIGHTMODE_HIGH }
	Camera Nightmode mode. More...

enum	CameraReverse { REVERSE_OFF , REVERSE_MIRROR , REVERSE_FLIP , REVERSE_BOTH }
	Camera Reverse mode. More...

enum	CameraEffect { EFFECT_NONE , EFFECT_NEGATIVE , EFFECT_BLACKWHITE , EFFECT_SEPIA , EFFECT_BLUE , EFFECT_RED , EFFECT_GREEN }
	Camera effects. More...

Functions
void	Camera::init (CameraType type, CameraRes resolution, int framerate)
	Init camera hardware. More...

void	Camera::term (void)
	Terminate camera hardware. More...

int	Camera::getOutput (void)
	Return current camera output as image. More...

void	Camera::setBrightness (int value)
	Set camera brightness. More...

int	Camera::getBrightness (void)
	Get current camera brightness. More...

void	Camera::setSaturation (number value)
	Set camera saturation. More...

int	Camera::getSaturation (void)
	Get current camera saturation. More...

void	Camera::setSharpness (int value)
	Set camera sharpness percentage. More...

int	Camera::getSharpness (void)
	Get current camera sharpness. More...

void	Camera::setContrast (int value)
	Set camera contrast. More...

int	Camera::getContrast (void)
	Get current camera contrast. More...

void	Camera::setReverse (CameraReverse mode)
	Set camera reverse mode. More...

CameraReverse	Camera::getReverse (void)
	Get current camera reverse mode. More...

void	Camera::setEffect (CameraEffect effect)
	Set camera effect. More...

CameraEffect	Camera::getEffect (void)
	Get current camera effect. More...

void	Camera::setZoom (int value)
	Set camera zoom. More...

int	Camera::getZoom (void)
	Get current camera zoom. More...

void	Camera::setAntiFlicker (CameraAntiFlick mode)
	Set camera antiflicker mode. More...

CameraAntiFlick	Camera::getAntiFlicker (void)
	Get current camera antiflicker mode. More...

void	Camera::setISO (CameraISO mode)
	Set camera ISO speed mode. More...

CameraISO	Camera::getISO (void)
	Get current camera ISO speed mode. More...

void	Camera::setGain (int value)
	Set camera gain. More...

int	Camera::getGain (void)
	Get current camera gain. More...

void	Camera::setWhiteBalance (CameraWB mode)
	Set camera white balance mode. More...

CameraWB	Camera::getWhiteBalance (void)
	Get current camera white balance mode. More...

void	Camera::setBacklight (CameraBacklight mode)
	Set camera backlight mode. More...

CameraBacklight	Camera::getBacklight (void)
	Get current camera backlight mode. More...

void	Camera::setNightmode (CameraNightmode mode)
	Set camera nightmode mode. More...

CameraNightmode	Camera::getNightmode (void)
	Get current camera nightmode mode. More...

Detailed Description

Module that handles photo cameras hardware.

Enumeration Type Documentation

◆ CameraType

enum CameraType

Camera types.

Enumerator
INNER_CAM	Front camera.
OUTER_CAM	Retro camera.

◆ CameraRes

enum CameraRes

Camera resolutions.

Enumerator
VGA_RES	VGA (640x480) resolution.
QVGA_RES	QVGA (320x240) resolution.
QQVGA_RES	QQVGA (160x120) resolution.
CIF_RES	CIF (352x288) resolution.
QCIF_RES	QCIF (176x144) resolution.
PSP_RES	PSP (480x272) resolution.
NGP_RES	NGP (640x360) resolution.

◆ CameraAntiFlick

enum CameraAntiFlick

Camera antiflicker modes.

Enumerator
ANTIFLICKER_AUTO	Automatic Antiflicker.
ANTIFLICKER_50HZ	50Hz Antiflicker
ANTIFLICKER_60HZ	60Hz Antiflicker

◆ CameraISO

enum CameraISO

Camera ISO speed mode.

Enumerator
ISO_AUTO	Automatic ISO speed mode.
ISO_100	100/21 ISO speed mode
ISO_200	100/24 ISO speed mode
ISO_400	100/27 ISO speed mode

◆ CameraWB

enum CameraWB

Camera White Balance mode.

Enumerator
WB_AUTO	Automatic White Balance mode.
WB_DAYLIGHT	Daylight White Balance mode.
WB_CWF	Cool White Fluorescent mode.
WB_SLSA	Standard Light Source A mode.

◆ CameraBacklight

enum CameraBacklight

Camera Backlight mode.

Enumerator
BACKLIGHT_OFF	Backlight disabled.
BACKLIGHT_ON	Backlight enabled.

◆ CameraNightmode

enum CameraNightmode

Camera Nightmode mode.

Enumerator
NIGHTMODE_OFF	Nightmode disabled.
NIGHTMODE_LOW	Nightmode for 10 lux or below.
NIGHTMODE_MED	Nightmode for 100 lux or below.
NIGHTMODE_HIGH	Nightmode for over 100 lux.

◆ CameraReverse

enum CameraReverse

Camera Reverse mode.

Enumerator
REVERSE_OFF	Reverse mode disabled.
REVERSE_MIRROR	Mirror reverse mode.
REVERSE_FLIP	Flip reverse mode.
REVERSE_BOTH	Flip and Mirror reverse mode.

◆ CameraEffect

enum CameraEffect

Camera effects.

Enumerator
EFFECT_NONE	No effect.
EFFECT_NEGATIVE	Negative effect.
EFFECT_BLACKWHITE	Black and White effect.
EFFECT_SEPIA	Sepia effect.
EFFECT_BLUE	Blue Neon effect.
EFFECT_RED	Red Neon effect.
EFFECT_GREEN	Green Neon effect.

Function Documentation

◆ init()

void Camera::init	(	CameraType	type,
		CameraRes	resolution,
		int	framerate
	)

Init camera hardware.

Usage example:: Camera.init(INNER_CAM, VGA_RES, 30)

Camera
Definition: luaCamera.cpp:106

Camera::init
void init(CameraType type, CameraRes resolution, int framerate)
Init camera hardware.

VGA_RES
@ VGA_RES
VGA (640x480) resolution.
Definition: luaCamera.cpp:20

INNER_CAM
@ INNER_CAM
Front camera.
Definition: luaCamera.cpp:11

Parameters

type	- Camera to init.
resolution	- Output resolution.
framerate	- Output framerate.

Note: framerate must be between 3 and 120.; framerate can be set to 120 only with QVGA_RES,QQVGA_RES or CIF_RES as resolution.

◆ term()

void Camera::term ( void )

Terminate camera hardware.

Usage example:: Camera.term()

Camera::term
void term(void)
Terminate camera hardware.

◆ getOutput()

int Camera::getOutput ( void )

Return current camera output as image.

Usage example:: img = Camera.getOutput()

Camera::getOutput
int getOutput(void)
Return current camera output as image.

Note: The returned image became invalid when Camera.term is called.

◆ setBrightness()

void Camera::setBrightness ( int value )

Set camera brightness.

Usage example:: Camera.setBrightness(200)

Camera::setBrightness
void setBrightness(int value)
Set camera brightness.

Parameters

value - Value to set.

Note: value must be between 0 and 255.

◆ getBrightness()

int Camera::getBrightness ( void )

Get current camera brightness.

Usage example:: brightness = Camera.getBrightness()

Camera::getBrightness
int getBrightness(void)
Get current camera brightness.

Returns: The current camera brightness.

◆ setSaturation()

void Camera::setSaturation ( number value )

Set camera saturation.

Usage example:: Camera.setSaturation(2.0)

Camera::setSaturation
void setSaturation(number value)
Set camera saturation.

Parameters

value - Value to set.

Note: value must be between 0.0 and 4.0.

◆ getSaturation()

int Camera::getSaturation ( void )

Get current camera saturation.

Usage example:: saturation = Camera.getSaturation()

Camera::getSaturation
int getSaturation(void)
Get current camera saturation.

Returns: The current camera saturation.

◆ setSharpness()

void Camera::setSharpness ( int value )

Set camera sharpness percentage.

Usage example:: Camera.setSharpness(100)

Camera::setSharpness
void setSharpness(int value)
Set camera sharpness percentage.

Parameters

value - Value to set.

Note: value must be between 100 and 400.

◆ getSharpness()

int Camera::getSharpness ( void )

Get current camera sharpness.

Usage example:: sharpness = Camera.getSharpness()

Camera::getSharpness
int getSharpness(void)
Get current camera sharpness.

Returns: The current camera sharpness.

◆ setContrast()

void Camera::setContrast ( int value )

Set camera contrast.

Usage example:: Camera.setContrast(200)

Camera::setContrast
void setContrast(int value)
Set camera contrast.

Parameters

value - Value to set.

Note: value must be between 0 and 255.

◆ getContrast()

int Camera::getContrast ( void )

Get current camera contrast.

Usage example:: contrast = Camera.getBrightness()

Returns: The current camera contrast.

◆ setReverse()

void Camera::setReverse ( CameraReverse mode )

Set camera reverse mode.

Usage example:: Camera.setReverse(REVERSE_FLIP)

Camera::setReverse
void setReverse(CameraReverse mode)
Set camera reverse mode.

REVERSE_FLIP
@ REVERSE_FLIP
Flip reverse mode.
Definition: luaCamera.cpp:88

Parameters

mode	- Mode to set.

◆ getReverse()

CameraReverse Camera::getReverse ( void )

Get current camera reverse mode.

Usage example:: mode = Camera.getReverse()

Camera::getReverse
CameraReverse getReverse(void)
Get current camera reverse mode.

Returns: The current camera reverse mode.

◆ setEffect()

void Camera::setEffect ( CameraEffect effect )

Set camera effect.

Usage example:: Camera.setEffect(EFFECT_SEPIA)

Camera::setEffect
void setEffect(CameraEffect effect)
Set camera effect.

EFFECT_SEPIA
@ EFFECT_SEPIA
Sepia effect.
Definition: luaCamera.cpp:100

Parameters

effect - Effect to set.

Note: value must be between 0 and 255.

◆ getEffect()

CameraEffect Camera::getEffect ( void )

Get current camera effect.

Usage example:: effect = Camera.getEffect()

Camera::getEffect
CameraEffect getEffect(void)
Get current camera effect.

Returns: The current camera effect.

◆ setZoom()

void Camera::setZoom ( int value )

Set camera zoom.

Usage example:: Camera.setZoom(200)

Camera::setZoom
void setZoom(int value)
Set camera zoom.

Parameters

value - Value to set.

Note: value must be between 0 and 255.

◆ getZoom()

int Camera::getZoom ( void )

Get current camera zoom.

Usage example:: zoom = Camera.getZoom()

Camera::getZoom
int getZoom(void)
Get current camera zoom.

Returns: The current camera zoom.

◆ setAntiFlicker()

void Camera::setAntiFlicker ( CameraAntiFlick mode )

Set camera antiflicker mode.

Usage example:: Camera.setAntiFlicker(ANTIFLICKER_50HZ)

Camera::setAntiFlicker
void setAntiFlicker(CameraAntiFlick mode)
Set camera antiflicker mode.

ANTIFLICKER_50HZ
@ ANTIFLICKER_50HZ
50Hz Antiflicker
Definition: luaCamera.cpp:35

Parameters

mode	- Mode to set.

◆ getAntiFlicker()

CameraAntiFlick Camera::getAntiFlicker ( void )

Get current camera antiflicker mode.

Usage example:: mode = Camera.getAntiflicker()

Returns: The current camera antiflicker mode.

◆ setISO()

void Camera::setISO ( CameraISO mode )

Set camera ISO speed mode.

Usage example:: Camera.setISO(ISO_AUTO)

Camera::setISO
void setISO(CameraISO mode)
Set camera ISO speed mode.

ISO_AUTO
@ ISO_AUTO
Automatic ISO speed mode.
Definition: luaCamera.cpp:44

Parameters

mode	- Mode to set.

◆ getISO()

CameraISO Camera::getISO ( void )

Get current camera ISO speed mode.

Usage example:: mode = Camera.getISO()

Camera::getISO
CameraISO getISO(void)
Get current camera ISO speed mode.

Returns: The current camera ISO speed mode.

◆ setGain()

void Camera::setGain ( int value )

Set camera gain.

Usage example:: Camera.setGain(5)

Camera::setGain
void setGain(int value)
Set camera gain.

Parameters

value - Value to set.

Note: value must be between 0 and 16.

◆ getGain()

int Camera::getGain ( void )

Get current camera gain.

Usage example:: gain = Camera.getGain()

Camera::getGain
int getGain(void)
Get current camera gain.

Returns: The current camera gain.

◆ setWhiteBalance()

void Camera::setWhiteBalance ( CameraWB mode )

Set camera white balance mode.

Usage example:: Camera.setWhiteBalance(WB_SLSA)

Camera::setWhiteBalance
void setWhiteBalance(CameraWB mode)
Set camera white balance mode.

WB_SLSA
@ WB_SLSA
Standard Light Source A mode.
Definition: luaCamera.cpp:58

Parameters

mode	- Mode to set.

◆ getWhiteBalance()

CameraWB Camera::getWhiteBalance ( void )

Get current camera white balance mode.

Usage example:: mode = Camera.getWhiteBalance()

Camera::getWhiteBalance
CameraWB getWhiteBalance(void)
Get current camera white balance mode.

Returns: The current camera white balance mode.

◆ setBacklight()

void Camera::setBacklight ( CameraBacklight mode )

Set camera backlight mode.

Usage example:: Camera.setBacklight(BACKLIGHT_ON)

Camera::setBacklight
void setBacklight(CameraBacklight mode)
Set camera backlight mode.

BACKLIGHT_ON
@ BACKLIGHT_ON
Backlight enabled.
Definition: luaCamera.cpp:67

Parameters

mode	- Mode to set.

◆ getBacklight()

CameraBacklight Camera::getBacklight ( void )

Get current camera backlight mode.

Usage example:: mode = Camera.getBacklight()

Camera::getBacklight
CameraBacklight getBacklight(void)
Get current camera backlight mode.

Returns: The current camera backlight mode.

◆ setNightmode()

void Camera::setNightmode ( CameraNightmode mode )

Set camera nightmode mode.

Usage example:: Camera.setNightmode(NIGHTMODE_LOW)

Camera::setNightmode
void setNightmode(CameraNightmode mode)
Set camera nightmode mode.

NIGHTMODE_LOW
@ NIGHTMODE_LOW
Nightmode for 10 lux or below.
Definition: luaCamera.cpp:76

Parameters

mode	- Mode to set.

◆ getNightmode()

CameraNightmode Camera::getNightmode ( void )

Get current camera nightmode mode.

Usage example:: mode = Camera.getNightmode()

Camera::getNightmode
CameraNightmode getNightmode(void)
Get current camera nightmode mode.

Returns: The current camera nightmode mode.

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ CameraType

◆ CameraRes

◆ CameraAntiFlick

◆ CameraISO

◆ CameraWB

◆ CameraBacklight

◆ CameraNightmode

◆ CameraReverse

◆ CameraEffect

Function Documentation

◆ init()

◆ term()

◆ getOutput()

◆ setBrightness()

◆ getBrightness()

◆ setSaturation()

◆ getSaturation()

◆ setSharpness()

◆ getSharpness()

◆ setContrast()

◆ getContrast()

◆ setReverse()

◆ getReverse()

◆ setEffect()

◆ getEffect()

◆ setZoom()

◆ getZoom()

◆ setAntiFlicker()

◆ getAntiFlicker()

◆ setISO()

◆ getISO()

◆ setGain()

◆ getGain()

◆ setWhiteBalance()

◆ getWhiteBalance()

◆ setBacklight()

◆ getBacklight()

◆ setNightmode()

◆ getNightmode()