Maxim Integrated / OWGridEye

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   MAXREFDES131_Qt_Demo MAXREFDES130_131_Demo

Embed: (wiki syntax)

« Back to documentation index

OWGridEye Class Reference
Public Types | Public Member Functions

OWGridEye Class Reference

Object for interfacing to MAXREFDES131#. More...

#include <OWGridEye.h>

Public Types

enum  CmdResult
 

OWGridEye command results.

More...
enum  GridEyeRegister
 

AMG8833 register map.

More...

Public Member Functions

 OWGridEye (RandomAccessRomIterator &selector)
 OWGridEye Constructor.
void setOWSwitchRomId (const RomId &romId)
 setOWSwitchRomId
RomId getOWSwitchRomId (void)
 getOWSwitchRomId
void setI2CBridgeRomId (const RomId &romId)
 setI2CBridgeRomId
RomId getI2CBridgeRomId (void)
 getI2CBridgeRomId
CmdResult disconnectGridEye (void)
 disconnectGridEye
CmdResult connectGridEye (void)
 connectGridEye
CmdResult connectOWbus (void)
 connectOWbus
CmdResult disconnectOWbus (void)
 disconnectOWbus
CmdResult gridEyeAccess (bool readWrite, GridEyeRegister regAdrs, uint8_t numBytes, uint8_t *dataBuf)
 gridEyeAccess
CmdResult gridEyeGetThermistor (int16_t &thermTemp)
 gridEyeGetThermistor
CmdResult gridEyeGetPixelTemperature (uint8_t pixelAdrs, int16_t &pixelTemp)
 gridEyeGetPixelTemperature
CmdResult gridEyeGetFrameTemperature (int16_t *frameTemp)
 gridEyeGetFrameTemperature

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 61 of file OWGridEye.h.

Member Enumeration Documentation

enum CmdResult

OWGridEye command results.

Definition at line 74 of file OWGridEye.h.

enum GridEyeRegister

AMG8833 register map.

Definition at line 83 of file OWGridEye.h.

Constructor & Destructor Documentation

OWGridEye ( RandomAccessRomIterator &  selector )

OWGridEye Constructor.

setOWSwitchRomId() and setI2CBridgeRomId() must be called before any other member fxs.

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

Definition at line 38 of file OWGridEye.cpp.

Member Function Documentation

OWGridEye::CmdResult connectGridEye ( void   )

connectGridEye

Connects the DS28E17 and AMG883 to 1-wire bus

Returns:
CmdResult - result of operation

Definition at line 82 of file OWGridEye.cpp.

OWGridEye::CmdResult connectOWbus ( void   )

connectOWbus

Connects down stream devices on 1-wire bus

Returns:
CmdResult - result of operation

Definition at line 97 of file OWGridEye.cpp.

OWGridEye::CmdResult disconnectGridEye ( void   )

disconnectGridEye

Disconnects the DS28E17 and AMG8833 sensor putting both to sleep

Returns:
CmdResult - result of operation

Definition at line 45 of file OWGridEye.cpp.

OWGridEye::CmdResult disconnectOWbus ( void   )

disconnectOWbus

Disconnects down stream devices on 1-wire bus

Returns:
CmdResult - result of operation

Definition at line 112 of file OWGridEye.cpp.

RomId getI2CBridgeRomId ( void   )

getI2CBridgeRomId

Gets the RomId of the DS28E17 for this sensor. The romId must have been set first.

Returns:
RomId of the DS28E17 for this sensor

Definition at line 181 of file OWGridEye.h.

RomId getOWSwitchRomId ( void   )

getOWSwitchRomId

Gets the RomId of the DS2413 for this sensor. The romId must have been set first.

Returns:
RomId of the DS2413 for this sensor

Definition at line 151 of file OWGridEye.h.

OWGridEye::CmdResult gridEyeAccess ( bool  readWrite,
GridEyeRegister  regAdrs,
uint8_t  numBytes,
uint8_t *  dataBuf 
)

gridEyeAccess

Provides read/write access to the AMG8833

On Entry:

Parameters:
[in]readWrite- Boolean flag indicating desired access
[in]regAdrs- AMG8833 register to start reading/writting from/to
[in]numBytes- Number of bytes to read/write
[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 - result of operation

Definition at line 127 of file OWGridEye.cpp.

OWGridEye::CmdResult gridEyeGetFrameTemperature ( int16_t *  frameTemp )

gridEyeGetFrameTemperature

Gets pixel frame(64 pixels) temperature

On Entry:

Parameters:
[in]frameTemp- buffer to hold data

On Exit:

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

Definition at line 190 of file OWGridEye.cpp.

OWGridEye::CmdResult gridEyeGetPixelTemperature ( uint8_t  pixelAdrs,
int16_t &  pixelTemp 
)

gridEyeGetPixelTemperature

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 174 of file OWGridEye.cpp.

OWGridEye::CmdResult gridEyeGetThermistor ( int16_t &  thermTemp )

gridEyeGetThermistor

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 158 of file OWGridEye.cpp.

void setI2CBridgeRomId ( const RomId &  romId )

setI2CBridgeRomId

sets the RomId of the DS28E17

On Entry:

Parameters:
[in]romId- RomId of the DS28E17 for this module
Returns:
none

Definition at line 167 of file OWGridEye.h.

void setOWSwitchRomId ( const RomId &  romId )

setOWSwitchRomId

sets the RomId of the DS2413

On Entry:

Parameters:
[in]romId- RomId of the DS2413 for this module
Returns:
none

Definition at line 137 of file OWGridEye.h.

Generated on Thu Jul 14 2022 15:33:01 by  doxygen 1.7.2