RobotKit API
Public Member Functions | Properties
RKRobot Class Reference

Represents the robot connection data and physical properties. More...

#import <RKRobot.h>

List of all members.

Public Member Functions

(id) - initWithAccessory:
(BOOL) - isEqualToRobot:

Properties

EAAccessory * accessory
NSString * name
NSString * bluetoothAddress
BOOL supportsVectorCommand

Detailed Description

A RKRobot object provides the data needed to connect to a robotic data along physical properties associated with the device.


Member Function Documentation

- (id) initWithAccessory: (EAAccessory *)  anAccessory

Initializes with a EAAccesory object for the robot.

Parameters:
anAccessoryA EAAccesory object for the robot.
Returns:
The initialized RKRobot object or nil if initialization failed.
- (BOOL) isEqualToRobot: (RKRobot *)  robot

Test that the robot object is equal to this robot which means the represent the same device.

Parameters:
robotThe other robot object.
Returns:
YES if the other object represents the same robot device.

Property Documentation

- (EAAccessory *) accessory [read, assign]

The EAAccessory object that is associated with the robot

- (NSString *) bluetoothAddress [read, assign]

The bluetooth MAC address for the robot

- (NSString *) name [read, write, retain]

A product name for the robot

- (BOOL) supportsVectorCommand [read, assign]

Robot has firmware support for vector command. The default value is NO.


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