All Functions Modules Pages
power

Functions

BOOLEAN power.plugged ()
 Power supply cable connected. More...
 
NIL power.suspend ()
 Let console in stand-by mode. More...
 
BOOLEAN power.lock ()
 Locks the power supply switch. More...
 
BOOLEAN power.unlock ()
 Unlock power supply switch. More...
 
NIL power.tick ()
 Keeps the console awake, avoiding entering to suspend mode. More...
 
NIL power.off ()
 Shutdown console. More...
 

Detailed Description

Power supply functions.

Function Documentation

BOOLEAN power.plugged ( )

Power supply cable connected.

Returns
true/false Depending on whether the cable is connected.
NIL power.suspend ( )

Let console in stand-by mode.

Returns
Nothing.
BOOLEAN power.lock ( )

Locks the power supply switch.

Returns
true/false Depending on whether the switch is blocked.
Note
If the switch is putted in stand-by mode, or you use one of those functions: power.suspend() or power.off() when the switch is unlocked with the power.unlock() the console will enter stand-by mode or will shutdown.
BOOLEAN power.unlock ( )

Unlock power supply switch.

Returns
true/false Depending on whether the switch is unlocked.
NIL power.tick ( )

Keeps the console awake, avoiding entering to suspend mode.

Returns
Nothing.
NIL power.off ( )

Shutdown console.

Returns
Nothing.