RKGoToSleepCommand Class Reference

Class that encapsulates a go to sleep command. More...

#import <RKGoToSleepCommand.h>

Inheritance diagram for RKGoToSleepCommand:

List of all members.

Public Member Functions
(id)	- initWithWakeUpTimeInterval:macroId:
Static Public Member Functions
(void)	+ sendCommandWithWakeUpTimeInterval:macroId:

---

Detailed Description

Class that encapsulates a go to sleep command which can be sent to a robot to have it sleep until the user wakes it or for a given time interval.

See also:

RKGoToSleepResponse

---

Member Function Documentation

- (id) initWithWakeUpTimeInterval:		(RKSleepTimeInterval)	interval
macroId:		(uint8_t)	identifier

Initializer for the Class which allows for a sleep interval to be set and a system macro to be ran upon waking.

Parameters:

interval	The time in seconds to sleep, or 0 for an indefinite time.
identifier	A system macro id to run upon awaking. This has no effect if the time interval is set to 0.

+ (void) sendCommandWithWakeUpTimeInterval:		(RKSleepTimeInterval)	interval
macroId:		(uint8_t)	identifier

Convience method that creates a RKGoToSleepCommand instance and uses RKDeviceMessenger to send the command to the robot.

Parameters:

interval	The time in seconds to sleep, or 0 for an indefinite time.
identifier	A system macro id to run upon awaking. This has no effect if the time interval is set to 0.

---

The documentation for this class was generated from the following file:

• RobotKit/RKGoToSleepCommand.h