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

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

#import <RKBackLEDOutputCommand.h>

Inheritance diagram for RKBackLEDOutputCommand:
RKDeviceCommand RKDeviceMessage

List of all members.

Public Member Functions

(id) - initWithBrightness:

Static Public Member Functions

(void) + sendCommandWithBrightness:

Properties

float brightness

Detailed Description

This class is used to change the back blue LED brightness on Sphero. The back LED is designed to be inline with the forward direction (0° heading) of Sphero. Thus this can be used to aid in aiming Sphero (calibration), so a 0° heading set in the roll command goes in the user's prefered direction.

See also:
RKBackLEDOutputResponse

Member Function Documentation

- (id) initWithBrightness: (float)  brightness

Initializer for a object.

Parameters:
brightnessThe brightness value between 0.0 to 1.0 where 0.0 is off and 1.0 is full brightness.
Returns:
The initialized object.
+ (void) sendCommandWithBrightness: (float)  brightness

A convenience method for sending the command to the device.

Parameters:
brightnessThe brightness value between 0.0 to 1.0 where 0.0 is off and 1.0 is full brightness.

Property Documentation

- (float) brightness [read, assign]

The brightness value between 0.0 to 1.0 where 0.0 is off and 1.0 is full brightness.


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