Adafruit_VC0706 Class Reference

Blocking VC0706 UART camera commands. Call begin() before camera access. Returned buffers belong to the driver and are overwritten by subsequent commands. Boolean command results normally indicate acknowledgement, except setPTZ(). More...

#include <Adafruit_VC0706.hpp>

Public Member Functions
	Adafruit_VC0706 (SerialPort &)
	Bind the camera UART, which must outlive the driver.
boolean	begin (uint16_t baud=38400)
	Start the UART at baud and reset the camera; return reset acknowledgement.
boolean	reset (void)
	Send a camera reset and return whether its response was acknowledged.
boolean	TVon (void)
	Enable TV output; return command acknowledgement.
boolean	TVoff (void)
	Disable TV output; return command acknowledgement.
boolean	takePicture (void)
	Freeze the current frame and reset the internal read offset; return acknowledgement.
uint8_t *	readPicture (uint8_t n, uint16_t offset=0xFFFF)
	Read a JPEG chunk into the shared camera buffer.
boolean	resumeVideo (void)
	Resume frame acquisition after a frozen picture; return acknowledgement.
uint32_t	frameLength (void)
	Return the frozen JPEG frame length in bytes, or zero on command failure.
char *	getVersion (void)
	Return the camera version in the shared response buffer, or nullptr on failure.
uint8_t	available ()
	Return the byte count from the most recent response read, including protocol bytes.
uint8_t	getDownsize (void)
	Return the downsize register value, or 0xFF on command failure.
boolean	setDownsize (uint8_t)
	Set the camera downsize register byte; return acknowledgement.
uint8_t	getImageSize ()
	Return a VC0706_* image-size code, or 0xFF on failure.
boolean	setImageSize (uint8_t)
	Set a VC0706_640x480, VC0706_320x240, or VC0706_160x120 size code.
boolean	getMotionDetect ()
	Return the motion-detection enable response; false also indicates command failure.
uint8_t	getMotionStatus (uint8_t)
	Query a motion-control selector; returns command success (0/1), not the response payload.
boolean	motionDetected ()
	Read and validate a motion-detected notification; return false on timeout or mismatch.
boolean	setMotionDetect (boolean f)
	Enable or disable motion detection and UART motion reporting; return acknowledgement.
boolean	setMotionStatus (uint8_t x, uint8_t d1, uint8_t d2)
	Write motion-control selector x and raw payload bytes d1/d2.
boolean	cameraFrameBuffCtrl (uint8_t command)
	Send a VC0706 frame-buffer control command; return acknowledgement.
uint8_t	getCompression ()
	Return the compression response byte; command failure is not separately reported.
boolean	setCompression (uint8_t c)
	Write the compression byte c; return command acknowledgement.
boolean	getPTZ (uint16_t &w, uint16_t &h, uint16_t &wz, uint16_t &hz, uint16_t &pan, uint16_t &tilt)
	Read image width/height, zoom dimensions, pan, and tilt into the reference arguments.
boolean	setPTZ (uint16_t wz, uint16_t hz, uint16_t pan, uint16_t tilt)
	Set zoom width/height and pan/tilt offsets in camera pixel coordinates.
void	OSD (uint8_t x, uint8_t y, char *s)
	Send an on-screen text command at x/y; chipset support is not guaranteed.
char *	setBaud9600 ()
	Request camera UART baud 9600; return shared response buffer or nullptr. The host UART baud is not changed by this method.
char *	setBaud19200 ()
	Request camera UART baud 19200; return shared response buffer or nullptr. The host UART baud is not changed by this method.
char *	setBaud38400 ()
	Request camera UART baud 38400; return shared response buffer or nullptr. The host UART baud is not changed by this method.
char *	setBaud57600 ()
	Request camera UART baud 57600; return shared response buffer or nullptr. The host UART baud is not changed by this method.
char *	setBaud115200 ()
	Request camera UART baud 115200; return shared response buffer or nullptr. The host UART baud is not changed by this method.

Detailed Description

Blocking VC0706 UART camera commands. Call begin() before camera access. Returned buffers belong to the driver and are overwritten by subsequent commands. Boolean command results normally indicate acknowledgement, except setPTZ().

Member Function Documentation

getPTZ()

boolean Adafruit_VC0706::getPTZ	(	uint16_t &	w,
		uint16_t &	h,
		uint16_t &	wz,
		uint16_t &	hz,
		uint16_t &	pan,
		uint16_t &	tilt )

Read image width/height, zoom dimensions, pan, and tilt into the reference arguments.

Returns

True on command acknowledgement, false on failure.

readPicture()

uint8_t * Adafruit_VC0706::readPicture	(	uint8_t	n,
		uint16_t	offset = 0xFFFF )

Read a JPEG chunk into the shared camera buffer.

Parameters

n	JPEG byte count; keep n + 5 within CAMERABUFFSIZ.
offset	Absolute read offset, or 0xFFFF to continue from the current offset.

Returns

Borrowed buffer pointer, or nullptr on command/receive failure. The driver advances its 16-bit read offset by n on success.

setPTZ()

boolean Adafruit_VC0706::setPTZ	(	uint16_t	wz,
		uint16_t	hz,
		uint16_t	pan,
		uint16_t	tilt )

Set zoom width/height and pan/tilt offsets in camera pixel coordinates.

Returns

False on acknowledgement, true on failure (inverted in this implementation).

---

The documentation for this class was generated from the following file:

• include/dev/Adafruit_VC0706.hpp