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

Class that encapsulates a set RGB LED output command. More...

#import <RKRGBLEDOutputCommand.h>

Inheritance diagram for RKRGBLEDOutputCommand:
RKDeviceCommand RKDeviceMessage

List of all members.

Public Member Functions

(id) - initWithRed:green:blue:

Static Public Member Functions

(void) + sendCommandWithRed:green:blue:
(float) + currentRed
(float) + currentGreen
(float) + currentBlue

Properties

float red
float green
float blue

Detailed Description

This class is used to change the red, green, blue brightness of the RGB LED on a Sphero.

See also:
RKRGBLEDOutputResponse

Member Function Documentation

+ (float) currentBlue

The current RGB LED blue value that was successfully sent to the device.

+ (float) currentGreen

The current RGB LED green value that was successfully sent to the device.

+ (float) currentRed

The current RGB LED red value that was successfully sent to the device.

- (id) initWithRed: (float)  red
green: (float)  green
blue: (float)  blue 

Initializer for the object.

Parameters:
redThe red brightness value between 0.0 to 1.0 with 0.0 being off and 1.0 being full brightness.
greenThe green brightness value between 0.0 to 1.0 with 0.0 being off and 1.0 being full brightness.
blueThe blue brightness value between 0.0 to 1.0 with 0.0 being off and 1.0 being full brightness.
Returns:
The initialized object.
+ (void) sendCommandWithRed: (float)  red
green: (float)  green
blue: (float)  blue 

Convience method for sending the command to the device.

Parameters:
redThe red brightness value between 0.0 to 1.0 with 0.0 being off and 1.0 being full brightness.
greenThe green brightness value between 0.0 to 1.0 with 0.0 being off and 1.0 being full brightness.
blueThe blue brightness value between 0.0 to 1.0 with 0.0 being off and 1.0 being full brightness.

Property Documentation

- (float) blue [read, assign]

The blue brightness that is sent with the command.

- (float) green [read, assign]

The green brightness that is sent with the command.

- (float) red [read, assign]

The red brightness that is sent with the command.


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