Interface: tos.interfaces.StdControl

interface StdControl

Please refer to TEP 115 for more information about this interface and its intended use.

This interface is used to switch between the on and off power states of the component providing it. A call to the start() command is a request to switch a component into the on state, and a call to the stop() is a request to switch a component into the off state.

Author:: Joe Polastre; Kevin Klues (klueska@cs.wustl.edu)

Commands

command error_t start() Start this component and all of its subcomponents.

command error_t stop() Stop the component and any pertinent subcomponents (not all subcomponents may be turned off due to wakeup timers, etc.).

Commands - Details

start

command error_t start()

Start this component and all of its subcomponents.

Returns:: SUCCESS if the component was either already on or was successfully turned on
FAIL otherwise

stop

command error_t stop()

Stop the component and any pertinent subcomponents (not all subcomponents may be turned off due to wakeup timers, etc.).

Returns:: SUCCESS if the component was either already off or was successfully turned off
FAIL otherwise