RobotKit API
Public Member Functions | Static Public Member Functions | Properties
RKRawMotorValuesCommand Class Reference

Class to encapsulate a raw motor values command. More...

#import <RKRawMotorValuesCommand.h>

Inheritance diagram for RKRawMotorValuesCommand:
RKDeviceCommand RKDeviceMessage

List of all members.

Public Member Functions

(id) - initWithLeftMode:leftPower:rightMode:rightPower:

Static Public Member Functions

(void) + sendCommandWithLeftMode:leftPower:rightMode:rightPower:

Properties

RKRawMotorMode leftMotorMode
RKRawMotorPower leftMotorPower
RKRawMotorMode rightMotorMode
RKRawMotorPower rightMotorPower

Detailed Description

This command is used to set raw motor values to move the ball without the control system maintaining a heading and speed. The control system stabilization engine will be turned off when this command is run, and clients need to use RKStabilizationCommand to turn it back on.

See also:
RKRawMotorValuesCommand

Member Function Documentation

- (id) initWithLeftMode: (RKRawMotorMode leftMode
leftPower: (RKRawMotorPower leftPower
rightMode: (RKRawMotorMode rightMode
rightPower: (RKRawMotorPower rightPower 

Initializes the object with the raw motor values.

Parameters:
leftModeThe left motor mode.
leftPowerA value from 0 to 255 for the power to applied to the motor.
rightModeThe right motor mode.
rightPowerA value from 0 to 255 for the power to applied to the motor.
Returns:
Initialized object.
+ (void) sendCommandWithLeftMode: (RKRawMotorMode leftMode
leftPower: (RKRawMotorPower leftPower
rightMode: (RKRawMotorMode rightMode
rightPower: (RKRawMotorPower rightPower 

Convenience method to send a raw motor values command.

Parameters:
leftModeThe left motor mode.
leftPowerA value from 0 to 255 for the power to applied to the motor.
rightModeThe right motor mode.
rightPowerA value from 0 to 255 for the power to applied to the motor.

Property Documentation

- (RKRawMotorMode) leftMotorMode [read, assign]

Read only property for left motor mode.

- (RKRawMotorPower) leftMotorPower [read, assign]

Read only property for the left motor power. This is a value from 0 to 255.

- (RKRawMotorMode) rightMotorMode [read, assign]

Read only property for right motor mode.

- (RKRawMotorPower) rightMotorPower [read, assign]

Read only property for the right motor power. This is a value from 0 to 255.


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