RKCalibrateCommand Class Reference

Class to encapsulate a calibrate command and it's parameters. More...

#import <RKCalibrateCommand.h>

Inheritance diagram for RKCalibrateCommand:

List of all members.

Public Member Functions
(id)	- initWithHeading:
Static Public Member Functions
(void)	+ sendCommandWithHeading:
Properties
float	heading

---

Detailed Description

Class that encapsulates a calibrate command used to set the 0° heading. Client code can use this along with RKBackLEDOutputCommand and RKRollCommand to aim Sphero so sending a roll command with 0° moves it in a user desired direction.

See also:

RKCalibrateResponse

RKBackLEDOutputCommand

RKRollCommand

---

Member Function Documentation

- (id) initWithHeading:

(float)

heading

Initializer for a RKCalibrateCommand object.

Parameters:

heading

Typically this should be 0.0, but setting it will add to the current heading when setting the new 0° point. The value is in degrees.

Returns:

The initialized object.

+ (void) sendCommandWithHeading:

(float)

heading

Convenience method for sending the command through RKDeviceMessenger.

Parameters:

heading

Typically this should be 0.0, but setting it will add to the current heading when setting the new 0° point. The value is in degrees.

---

Property Documentation

- (float) heading [read, assign]

The angle that will be added to the current heading when setting the new 0° point. The value is in degrees.

---

The documentation for this class was generated from the following file:

• RobotKit/RKCalibrateCommand.h