Team Walter / Mbed OS Low_Power_Long_Distance_IR_Vision_Robot

LP Long Distance IR Vision Robot

Dependencies:   max77650_charger_sample BufferedSerial SX1276GenericLib Adafruit-MotorShield NEO-6m-GPS MAX17055_EZconfig Adafruit_GFX USBDeviceHT Adafruit-PWM-Servo-Driver

Embed: (wiki syntax)

« Back to documentation index

GridEye Class Reference
Public Types | Public Member Functions

GridEye Class Reference

Object for interfacing to MAXREFDES131#. More...

#include <GridEye.h>

Public Types

enum  OperatingMode
 

GridEye operating modes.

More...
enum  FrameRate
 

GridEye operating modes.

More...
enum  GridEyeRegister
 

AMG8833 register map.

More...

Public Member Functions

 GridEye (I2C &i2c)
 GridEye Constructor.
int8_t gridEyeWriteReg (GridEyeRegister reg_addr, int num_bytes, char *data_buf)
 gridEyeWriteReg
int8_t gridEyeReadReg (GridEyeRegister reg_addr, int num_bytes, char *data_buf)
 gridEyeReadReg
int8_t getThermistorTemperature (int16_t &therm_temp)
 getThermistorTemperature
int8_t getPixelTemperature (uint8_t pixel_addr, int16_t &pixel_temp)
 getPixelTemperature
int8_t getRaw8x8FrameData (char *raw_frame_data)
 getRaw8x8FrameData
int8_t softwareReset ()
 softwareReset
int8_t setOperatingMode (GridEye::OperatingMode mode)
 setOperatingMode
int8_t setFrameRate (GridEye::FrameRate rate)
 setFrameRate

Detailed Description

Object for interfacing to MAXREFDES131#.

MAXREFDES131# combines the DS28E17 1-wire to I2C bridge with the Panasonic AMG8833 GridEye sensor. The reference design also includes a DS2413 2ch open drain switch for controlling the MAX4717 dual SPDT analog switch. The DS28E17 and AMG8833 are connected to the 1-wire bus via COM2 of the MAX4717 and COM1 is used for daisy-chaining additional modules. Disconnecting the DS28E17/AMG8833 from the main 1-wire branch puts both devices to sleep and reduces current consumption from 10mA to a couple hundred uA.

Definition at line 55 of file GridEye.h.

Member Enumeration Documentation

enum FrameRate

GridEye operating modes.

Definition at line 79 of file GridEye.h.

enum GridEyeRegister

AMG8833 register map.

Definition at line 88 of file GridEye.h.

enum OperatingMode

GridEye operating modes.

Definition at line 68 of file GridEye.h.

Constructor & Destructor Documentation

GridEye ( I2C &  i2c )

GridEye Constructor.

setI2CBridge() by passing in I2C parameter

Parameters:
[in]selector- MultidropRomIterator object that encapsulates ROM fxs of 1-wire protocol

Definition at line 38 of file GridEye.cpp.

Member Function Documentation

int8_t getPixelTemperature ( uint8_t  pixel_addr,
int16_t &  pixel_temp 
)

getPixelTemperature

Gets individual pixel temperature

On Entry:

Parameters:
[in]pixelAdrs- address of pixel to read
[in]pixelTemp- reference to int16_t var that will be overwritten with thermistor data

On Exit:

Parameters:
[out]pixelTemp- pixel data
Returns:
CmdResult - result of operation

Definition at line 106 of file GridEye.cpp.

int8_t getRaw8x8FrameData ( char *  raw_frame_data )

getRaw8x8FrameData

Gets pixel frame(64 pixels in 128 bytes) temperature

On Entry:

Parameters:
[in]raw_frame_data- buffer to hold 2 bytes data per pixel

On Exit:

Parameters:
[out]raw_frame_data- pixel data not yet formatted
Returns:
int8_t - result of operation, 0 on success, -1 on failure

Definition at line 122 of file GridEye.cpp.

int8_t getThermistorTemperature ( int16_t &  therm_temp )

getThermistorTemperature

Gets internal thermistor temperature

On Entry:

Parameters:
[in]thermTemp- reference to int16_t var that will be overwritten with thermistor data

On Exit:

Parameters:
[out]thermTemp- thermistor data
Returns:
CmdResult - result of operation

Definition at line 89 of file GridEye.cpp.

int8_t gridEyeReadReg ( GridEyeRegister  reg_addr,
int  num_bytes,
char *  data_buf 
)

gridEyeReadReg

Provides read/write access to the AMG8833

On Entry:

Parameters:
[in]regAdrs- AMG8833 register to start reading/writting from/to
[in]numBytes- Number of bytes to read
[in]dataBuf- Pointer to data buffer for storing data in on read, or data to be written on write

On Exit:

Parameters:
[out]dataBuf- Read data on read operation
Returns:
CmdResult - return 0 if the operation was sucessful, return -1 if unsucessful

Definition at line 49 of file GridEye.cpp.

int8_t gridEyeWriteReg ( GridEyeRegister  reg_addr,
int  num_bytes,
char *  data_buf 
)

gridEyeWriteReg

Provides read/write access to the AMG8833

On Entry:

Parameters:
[in]regAdrs- AMG8833 register to start reading/writting from/to
[in]numBytes- Number of bytes of data to write
[in]dataBuf- Pointer to data buffer for storing data in on read, or data to be written on write

On Exit:

Returns:
CmdResult - return 0 if the operation was sucessful, return -1 if unsucessful

Definition at line 68 of file GridEye.cpp.

int8_t setFrameRate ( GridEye::FrameRate  rate )

setFrameRate

Sets the frames per second that the grid eye device resolves

On Entry:

Parameters:
[in]mode- Choose option from either 10 fps or 1 fps
Returns:
int8_t - result of operation, 0 on success, -1 on failure

Definition at line 155 of file GridEye.cpp.

int8_t setOperatingMode ( GridEye::OperatingMode  mode )

setOperatingMode

Sets the mode of operation for the Grid Eye device

On Entry:

Parameters:
[in]mode- Choose power operating mode from struct
Returns:
int8_t - result of operation, 0 on success, -1 on failure

Definition at line 143 of file GridEye.cpp.

int8_t softwareReset (  )

softwareReset

Makes the Grid Eye device perform a software restart with Initial conditions

Returns:
int8_t - result of operation, 0 on success, -1 on failure

Definition at line 130 of file GridEye.cpp.

Generated on Wed Jul 13 2022 18:34:28 by  doxygen 1.7.2