ECRobot C++ API for LEGO MINDSTORMS NXT  1.0.10
ecrobot::IrSeeker Class Reference

HiTechnic IR Seeker (http://www.hitechnic.com/) class. More...

#include <IrSeeker.h>

List of all members.

Public Member Functions

 IrSeeker (ePortS port)
 Constructor (activate I2C).
S16 getDirection (void) const
 Get the currently measured direction of the infrared signal.
void get (U8 data[6]) const
 Get raw I2C data.

Detailed Description

HiTechnic IR Seeker (http://www.hitechnic.com/) class.

[ How to use with TOPPERS/ATK1(OSEK) ]
I2C (derived/compositted) class and Clock class internally use RTOS features. Thus, user needs to implement a C function and RTOS provided events.

+ Invoke SleeperMonitor function in user_1msec_isr_type2 hook.
  void user_1ms_isr_type2(void)
  {
    SleeperMonitor(); // needed for I2C devices and Clock class
  }

+ Define EventSleepI2C and EventSleep Events in user oil file.
  EVENT EventSleepI2C
  {
    MASK = AUTO;
  };

  EVENT EventSleep
  {
    MASK = AUTO;
  };

  TASK TaskMain
  {
    AUTOSTART = TRUE
    {
      APPMODE = appmode1;
    };
    PRIORITY = 1;
    ACTIVATION = 1;
    SCHEDULE = FULL;
    STACKSIZE = 512;
    EVENT = EventSleepI2C; <- Here it is
    EVENT = EventSleep; <- Here it is
  };

[ How to use with TOPPERS/JSP(ITRON) ]
In case of using this class with TOPPERS/JSP(ITRON), RTOS specific definitions for the class are not needed.


Constructor & Destructor Documentation

ecrobot::IrSeeker::IrSeeker ( ePortS  port) [explicit]

Constructor (activate I2C).

Note:
This class must be constructed as a global object. Otherwise, a device assertion will be displayed
in the LCD when the object is constructed as a non global object.
When the object is destructed while the system is shut down, the device is de-activated automatically.

Parameters:
portIR Seeker connected port
Returns:
-

Member Function Documentation

void ecrobot::IrSeeker::get ( U8  data[6]) const [inline]

Get raw I2C data.

Parameters:
dataData representation from the sensor, per Hi-Technic's documentation:
data[0]: Direction 8 bits
data[1]: Intensity1 8 bits
data[2]: Intensity2 8 bits
data[3]: Intensity3 8 bits
data[4]: Intensity4 8 bits
data[5]: Intensity5 8 bits
Returns:
-
S16 ecrobot::IrSeeker::getDirection ( void  ) const

Get the currently measured direction of the infrared signal.

Parameters:
-
Returns:
Infrared signal direction

The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Enumerations Enumerator Friends Defines