Unit interface. More...

import"Unit.idl";

Public Member Functions
MetaData	getMetaData ()
	Retrieve the unit metadata. More...

Settings	getSettings ()
	Retrieve the unit settings. More...

int	setSettings (in Settings settings)
	Change the unit settings. More...

void	identify (in int seconds)
	Display something distictive to identify the unit. More...

void	muteBuzzer (in boolean mute)
	Mute buzzer, turn of all audible alarms. More...

Orientation	getDisplayOrientation ()
	Retrieve the current orientation of the display. More...

Public Attributes
constant int	ERR_INVALID_PARAM = 1
	Invalid parameters.

valueobject	IdentificationStartedEvent: event::UserEvent { int duration
	Event: Unit identification requested. More...

Detailed Description

Unit interface.

Member Enumeration Documentation

Display orientation.

Enumerator
NORMAL	Normal orientation.
FLIPPED	Upside-down.

Orientation pdumodel::Unit_2_0_1::getDisplayOrientation ( )

Retrieve the current orientation of the display.

MetaData pdumodel::Unit_2_0_1::getMetaData ( )

Retrieve the unit metadata.

Settings pdumodel::Unit_2_0_1::getSettings ( )

Retrieve the unit settings.

void pdumodel::Unit_2_0_1::identify ( in int seconds )

Display something distictive to identify the unit.

Parameters

seconds Number of seconds to display the identify string

void pdumodel::Unit_2_0_1::muteBuzzer ( in boolean mute )

Mute buzzer, turn of all audible alarms.

Parameters

mute	`true` to mute buzzer, `false` for normal mode

int pdumodel::Unit_2_0_1::setSettings ( in Settings settings )

Change the unit settings.

Parameters

settings New unit settings

valueobject pdumodel::Unit_2_0_1::IdentificationStartedEvent

Event: Unit identification requested.

Number of seconds the identification should be displayed

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