Legrand / Raritan Xerus™ JSON-RPC API for Remote Access Devices like KX4-101, KX3G2

Loading...
Searching...
No Matches
RawConfiguration.idl
1/* SPDX-License-Identifier: BSD-3-Clause */
2/*
3 * Copyright 2018 Raritan Inc. All rights reserved.
4 */
5
6#include <UserEvent.idl>
7
8/** Raw Configuration */
9module rawcfg {
10
11 /** Raw Configuration Interface */
12 interface RawConfiguration {
13
14 /** Status of the last raw configuration update operation */
15 enumeration Status {
16 UNKNOWN, ///< No raw configuration was done yet
17 UPLOAD_FAILED, ///< Uploading a raw configuration failed
18 UPDATE_PENDING, ///< Update is pending
19 UPDATE_OK, ///< Updating raw configuration successful
20 UPDATE_FAILED ///< Updating raw configuration failed
21 };
22
23 /**
24 * Retrieve the status of the last raw configuration update
25 * operation.
26 *
27 * @param status Result: Raw configuration update status
28 * @param timeStamp Result: Time of last update operation (UNIX timestamp, UTC)
29 */
30 void getStatus(out Status status, out time timeStamp);
31
32 /** Event: Raw configuration downloaded */
33 valueobject RawConfigDownloadedEvent extends event.UserEvent {};
34 /** Event: Raw configuration updated */
35 valueobject RawConfigUpdatedEvent extends event.UserEvent {};
36 };
37
38}
rawcfg::RawConfiguration
Raw Configuration Interface.
Definition RawConfiguration.idl:12
rawcfg::RawConfiguration::Status
Status
Status of the last raw configuration update operation.
Definition RawConfiguration.idl:15
rawcfg::RawConfiguration::UPLOAD_FAILED
@ UPLOAD_FAILED
Uploading a raw configuration failed.
Definition RawConfiguration.idl:17
rawcfg::RawConfiguration::UPDATE_OK
@ UPDATE_OK
Updating raw configuration successful.
Definition RawConfiguration.idl:19
rawcfg::RawConfiguration::UPDATE_FAILED
@ UPDATE_FAILED
Updating raw configuration failed.
Definition RawConfiguration.idl:20
rawcfg::RawConfiguration::UNKNOWN
@ UNKNOWN
No raw configuration was done yet.
Definition RawConfiguration.idl:16
rawcfg::RawConfiguration::UPDATE_PENDING
@ UPDATE_PENDING
Update is pending.
Definition RawConfiguration.idl:18
rawcfg::RawConfiguration::getStatus
void getStatus(out Status status, out time timeStamp)
Retrieve the status of the last raw configuration update operation.
rawcfg
Raw Configuration.
Definition RawConfiguration.idl:9
rawcfg::RawConfiguration::RawConfigDownloadedEvent
Event: Raw configuration downloaded.
Definition RawConfiguration.idl:33
rawcfg::RawConfiguration::RawConfigUpdatedEvent
Event: Raw configuration updated.
Definition RawConfiguration.idl:35