Internal beeper interface. More...

Public Types
enum	State { OFF, ON_NOTIFICATION, ON_ACTIVATION }
	Activation state. More...

Public Member Functions
void	mute (in boolean muted)
	Mute beeper, turn of all internal alarm notifications. More...

boolean	isMuted ()
	Check whether beeper is currently muted. More...

void	activate (in boolean on, in string reason, in int timeout)
	Activate the beeper for a given time. More...

State	getState (out string reason)
	Retrieve the current beeper activation state. More...

Public Attributes
valueobject	MuteChangedEvent: event::UserEvent { boolean muted
	Event: The beeper has been muted or unmuted.

valueobject	StateChangedEvent: idl::Event { State state
	Event: The beeper activation status has changed. More...

string	reason
	Activation reason.

Detailed Description

Internal beeper interface.

Member Enumeration Documentation

Activation state.

Enumerator
OFF	Beeper is currently off.
ON_NOTIFICATION	Beeper is currently active due to an internal alarm notification.
ON_ACTIVATION	Beeper is currently active due to an external activation.

void hmi::InternalBeeper_2_0_0::activate	(	in boolean	on,
		in string	reason,
		in int	timeout
	)

Activate the beeper for a given time.

Parameters

activate	Whether to turn on or off the beeper
reason	Description of the reason to turn on the beeper (only valid whtn turning on the beeper)
timeout	Activation timeout in milliseconds (only valid when turning on the beeper, 0 = infinite activation)

State hmi::InternalBeeper_2_0_0::getState ( out string reason )

Retrieve the current beeper activation state.

Parameters

reason Return value for activation reason if the beeper is currently active

boolean hmi::InternalBeeper_2_0_0::isMuted ( )

Check whether beeper is currently muted.

void hmi::InternalBeeper_2_0_0::mute ( in boolean muted )

Mute beeper, turn of all internal alarm notifications.

Parameters

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

valueobject hmi::InternalBeeper_2_0_0::StateChangedEvent

Event: The beeper activation status has changed.

The current beeper state

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