Loading...
Searching...
No Matches
ExternalBeeper.idl
/* SPDX-License-Identifier: BSD-3-Clause */
/*
* Copyright 2012 Raritan Inc. All rights reserved.
*/
#ifndef __HMI_EXTERNAL_BEEPER_IDL__
#define __HMI_EXTERNAL_BEEPER_IDL__
#include <Event.idl>
/**
* Human Machine Interface
*/
module hmi {
/** External Beeper interface */
interface ExternalBeeper {
/**
* Beeper state
*/
enumeration State {
OFF,
ON,
ALARMING
};
/**
* Event: beeper state has changed
*/
valueobject StateChangedEvent extends idl.Event {
State oldState;
State newState;
};
/**
* Get current beeper state
*/
State getState();
/**
* Start beeper alarm
*
* Starts and repeats an alarm sequence of beeper on and beeper off.
* The sequence will be infinitely repeated until "off" is called.
*/
void alarm();
/**
* Turn beeper on
*
* Enables the beeper sound.
*/
void on();
/**
* Turn beeper off
*
* Disables beeper sound and also stops beeper alarm.
*/
void off();
};
}
#endif /* __HMI_EXTERNAL_BEEPER_IDL__ */
hmi::ExternalBeeper
External Beeper interface.
Definition ExternalBeeper.idl:17
hmi::ExternalBeeper::alarm
void alarm()
Start beeper alarm.
hmi::ExternalBeeper::State
State
Beeper state.
Definition ExternalBeeper.idl:21
hmi::ExternalBeeper::getState
State getState()
Get current beeper state.
hmi::ExternalBeeper::on
void on()
Turn beeper on.
hmi::ExternalBeeper::off
void off()
Turn beeper off.
hmi
Human Machine Interface.
Definition ExternalBeeper.idl:14
idl
Basic IDL definitions.
Definition Event.idl:10
hmi::ExternalBeeper::StateChangedEvent
Event: beeper state has changed.
Definition ExternalBeeper.idl:30
idl::Event
Common base for all events.
Definition Event.idl:13