Interface to control the device's front panel display.
More...
|
constant int | SUCCESS = 0 |
| Error codes. More...
|
|
constant int | ERR_INVALID_VALUE = 1 |
| Invalid argument.
|
|
Interface to control the device's front panel display.
◆ getAvailableDefaultViews()
vector< DefaultViewItem > display::DisplayControl::getAvailableDefaultViews |
( |
| ) |
|
Get available default views.
This returns all views that can be used as default views on the device display.
- Returns
- Possible default views, or empty list if the default view can not be configured for the device's display
◆ getDefaultView()
string display::DisplayControl::getDefaultView |
( |
| ) |
|
Get the currently active default view.
- Returns
- View ID of current default view. If the device doesn't allow configuration of the default view, an empty string is returned.
◆ getInfo()
Info display::DisplayControl::getInfo |
( |
| ) |
|
Retrieve display's meta information.
- Returns
- Display information
◆ setDefaultView()
int display::DisplayControl::setDefaultView |
( |
in string |
id | ) |
|
Set the active default view.
- Parameters
-
id | View ID of new default view |
- Returns
- 0 on success
-
1 if id is not part of the key set returned by getAvailableDefaultViews
◆ showSmiley()
void display::DisplayControl::showSmiley |
( |
in boolean |
on, |
|
|
in boolean |
happy, |
|
|
in string |
msg |
|
) |
| |
Show smiley on display.
- Parameters
-
on | true to turn on smiley |
happy | true to show happy smiley,false to show sad smiley |
msg | String for message |
◆ SUCCESS
constant int display::DisplayControl::SUCCESS = 0 |
The documentation for this interface was generated from the following file: