Legrand / Raritan / Server Technology Xerus™ JSON-RPC API: ExternalBeeper.idl Source File

Legrand / Raritan / Server Technology Xerus™ JSON-RPC API

Loading...
Searching...
No Matches
ExternalBeeper.idl
1/* SPDX-License-Identifier: BSD-3-Clause */
2/*
3 * Copyright 2012 Raritan Inc. All rights reserved.
4 */
5
6#ifndef __HMI_EXTERNAL_BEEPER_IDL__
7#define __HMI_EXTERNAL_BEEPER_IDL__
8
9#include <Event.idl>
10
11/**
12 * Human Machine Interface
13 */
14module hmi {
15
16 /** External Beeper interface */
17 interface ExternalBeeper {
18 /**
19 * Beeper state
20 */
21 enumeration State {
22 OFF,
23 ON,
24 ALARMING
25 };
26
27 /**
28 * Event: beeper state has changed
29 */
30 valueobject StateChangedEvent extends idl.Event {
31 State oldState;
32 State newState;
33 };
34
35 /**
36 * Get current beeper state
37 */
38 State getState();
39
40 /**
41 * Start beeper alarm
42 *
43 * Starts and repeats an alarm sequence of beeper on and beeper off.
44 * The sequence will be infinitely repeated until "off" is called.
45 */
46 void alarm();
47
48 /**
49 * Turn beeper on
50 *
51 * Enables the beeper sound.
52 */
53 void on();
54
55 /**
56 * Turn beeper off
57 *
58 * Disables beeper sound and also stops beeper alarm.
59 */
60 void off();
61
62 };
63}
64
65#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