Definition:

#include <aGP2D02.h>
object code: aGP2D02.c



aErr aGP2D02_ReadInt(

aStemLib stemLib, const unsigned char module, const unsigned char rangerIndex, int* pRangerValue);

Parameters:

stemLib	-	An opaque library reference representing the aStem library which manages the communication with the BrainStem modules.
module	-	The IIC address of the GP 1.0 module that is to be used to communicate with the GP2D02 ranger.  This need not be the router.
rangerIndex	-	The index of the GP2D02 ranger.  The GP 1.0 only has one GP2D02 ranger port with index 0.
pRangerValue	-	This is storage where the result will be stored as an integer.

Return Value:

This routine returns aErrNone when there are no errors.

Description:

This routine manages the BrainStem packets needed to initiate and retrieve a GP2D02 ranger value.  The data retrieved is in raw units.

To convert the raw data to inches, you can use the aGP2D02_RawToInches routine.

Related:

aStem_GetLibRef, aStem_ReleaseLibRef, aGP2D02_RawToInches