RobotKit API
Public Member Functions | Static Public Member Functions
RKDeviceCommand Class Reference

Base class for commands that can be sent to a robot. More...

#import <RKDeviceCommand.h>

Inheritance diagram for RKDeviceCommand:
RKDeviceMessage RKBackLEDOutputCommand RKCalibrateCommand RKGetBluetoothInfoCommand RKGoToSleepCommand RKJumpToBootloaderCommand RKJumpToMainAppCommand RKPingCommand RKRawMotorValuesCommand RKRGBLEDOutputCommand RKRollCommand RKRotationRateCommand RKSetDataStreamingCommand RKStabilizationCommand RKVersioningCommand

List of all members.

Public Member Functions

(NSDictionary *) - dictForCommand
(void) - sendCommand
(void) - sendCommandWithDelay:

Static Public Member Functions

(void) + sendCommand
(void) + sendCommandWithDelay:
(void) + sendCommandFromDict:

Detailed Description

This is an abstract class that function as the base class for subclasses which encapsulates the command set of a robot. The command objects can be sent to the robot by posting it to the RKDeviceMessenger singleton or by using on of the sendCommand class methods.

See also:
RKDeviceMessage

Member Function Documentation

- (NSDictionary*) dictForCommand

Used to serialize the command into a dictionary.

+ (void) sendCommand

Convenience method that will send a simple command without parameter using the RKDeviceMessenger singleton.

- (void) sendCommand

Convenience method that sends the command to the connected robot.

+ (void) sendCommandFromDict: (NSDictionary *)  dict

Method to send a command using a dictionary with a serialized command.

See also:
+ sendCommandFromDict:
Parameters:
dictThe serialized command in dictionary form.
+ (void) sendCommandWithDelay: (NSTimeInterval)  delay

Convenience method that will send a simple command without parameter using the RKDeviceMessenger singleton.

Parameters:
delayA delay time in seconds to send the command.
- (void) sendCommandWithDelay: (NSTimeInterval)  delay

Convenience method that send the command after a delay to the connected robot.


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