pyupm_scam module

class pyupm_scam.SCAM(uart, camAddr=0)

Bases: object

API for the Serial Camera.

ID: scam

Name: Serial Camera

Other Names: Grove Serial Camera

Category: other

Manufacturer: seeed

Connection: uart

Link:http://www.seeedstudio.com/wiki/Grove_-_Serial_Camera_Kit The driver was tested with the Serial Camera. There is no protocol documentation currently available, so this module was developed based completely on the Seeed Studio* Arduino* sketch.

It is connected via a UART at 115,200 baud.

C++ includes: scam.hpp

FORMAT_CIF = 5

FORMAT_OCIF = 3

FORMAT_VGA = 7

MAX_PKT_LEN = 128

dataAvailable(millis)

bool dataAvailable(unsigned int millis)

Checks to see if there is data available for reading

millis: Number of milliseconds to wait; 0 means no waiting.

True if there is data available for reading

doCapture()

bool doCapture()

Starts the capture

True if successful

drainInput()

void drainInput()

Reads serial input and discards until no more characters are available

getImageSize()

int getImageSize()

Returns the picture length. Note: this is only valid after doCapture() has run successfully.

Image length

init()

bool init()

Initializes the camera

preCapture(*args)

bool preCapture(PIC_FORMATS_T fmt=FORMAT_VGA)

Tells the camera to prepare for a capture

fmt: One of the PIC_FORMATS_T values

readData(buffer, len)

int readData(uint8_t *buffer, int len)

Reads any available data into a user-supplied buffer. Note: the call blocks until data is available to be read. Use dataAvailable() to determine whether there is data available beforehand, to avoid blocking.

buffer: Buffer to hold the data read

len: Length of the buffer

Number of bytes read

setupTty(*args)

bool setupTty(speed_t baud=B115200)

Sets up proper tty I/O modes and the baud rate. For this device, the default baud rate is 9,600 (B9600).

baud: Desired baud rate

True if successful

storeImage(fname)

bool storeImage(const char *fname)

Stores the captured image in a file

fname: Name of the file to write

True if successful

let the games begin…

writeData(buffer, len)

int writeData(uint8_t *buffer, int len)

Writes the data in the buffer to the device

buffer: Buffer to hold the data read

len: Length of the buffer

Number of bytes written