Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
|
Interface to control the device's front panel display. More...
Classes | |
struct | DefaultViewItem |
Representation of a possible default view. More... | |
struct | Info |
Collected display meta information. More... | |
struct | Settings |
struct | SettingsChangedEvent |
Event: Settings were changed. More... | |
Public Member Functions | |
vector< DefaultViewItem > | getAvailableDefaultViews () |
Get available default views. More... | |
Settings | getSettings () |
Get the current settings. More... | |
int | setSettings (in Settings settings) |
Update the settings. More... | |
Info | getInfo () |
Retrieve display's meta information. More... | |
void | showSmiley (in boolean on, in boolean happy, in string msg) |
Show smiley on display. More... | |
Public Attributes | |
constant int | SUCCESS = 0 |
Error codes. More... | |
constant int | ERR_INVALID_VALUE = 1 |
Invalid argument. | |
Interface to control the device's front panel display.
vector< DefaultViewItem > display::DisplayControl::getAvailableDefaultViews | ( | ) |
Get available default views.
This returns all views that can be used as default views on the device display.
Info display::DisplayControl::getInfo | ( | ) |
Retrieve display's meta information.
Settings display::DisplayControl::getSettings | ( | ) |
Get the current settings.
int display::DisplayControl::setSettings | ( | in Settings | settings | ) |
Update the settings.
settings | Settings to be applied |
void display::DisplayControl::showSmiley | ( | in boolean | on, |
in boolean | happy, | ||
in string | msg | ||
) |
Show smiley on display.
on | true to turn on smiley |
happy | true to show happy smiley,false to show sad smiley |
msg | String for message |
constant int display::DisplayControl::SUCCESS = 0 |
Error codes.
No error