Raritan PX2/PX3 JSON-RPC API

PeripheralDevicePackage.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3 * Copyright 2013 Raritan Inc. All rights reserved.
4 */
5
6 #ifndef __PERIPHERAL_DEVICE_PACKAGE_IDL__
7 #define __PERIPHERAL_DEVICE_PACKAGE_IDL__
8
9 #include <PeripheralDeviceSlot.idl>
10
11 /** Peripheral Devices */
12 module peripheral {
13 /** Peripheral device package information */
14 structure PackageInfo_2_0_1 {
15 enumeration State {
16 NORMAL, ///< Device package is in normal operation
17 FW_UPDATE, ///< Device package's firmware is being updated
18 INTERNAL_ERROR, ///< Device package's internal error flag is set
19 CONFIG_ERROR ///< Device package's internal configuration is invalid
20 };
21
22 structure HardwareInfo {
23 string serial; ///< serial number
24 string packageClass; ///< serial number prefix for current packages
25 string model; ///< like 'DPX-CC2' or 'DX-D2C6'
26 int minDowngradeVersion; ///< minimum downgrade version (or -1)
27 string revision; ///< hardware revision
28 };
29
30 structure FirmwareInfo {
31 structure Version {
32 int majorNumber;
33 int minorNumber;
34 int bootloaderVersion;
35 };
36
37 time compileDate; ///< Date of firmware compilation (Deprecated: always returns 0)
38 Version version; ///< Firmware version (0.0 if not applicable)
39 time updateDate; ///< Date of device firmware update (Deprecated: always returns 0)
40 };
41
42 State state; ///< The peripheral device package operational state
43 vector<PosElement> position; ///< Position within 1-wire topo
44 HardwareInfo hwInfo; ///< Device package hardware specific information
45 FirmwareInfo fwInfo; ///< Device package firmware specific information
46 };
47
48 interface Package_1_0_1 {
49
50 PackageInfo_2_0_1 getPackageInfo();
51
52 };
53
54 interface DoorHandleControllerPackage_1_0_1 extends Package_1_0_1 {
55
56 constant int SUCCESS = 0;
57 constant int ERR_NOT_SUPPORTED = 1;
58 constant int ERR_OPERATION_FAILED = 2;
59
60 vector<string> getSupportedHandleTypes();
61
62 string getHandleType(in int channel);
63
64 int setHandleType(in int channel, in string handleType);
65
66 };
67 }
68
69 #endif /* !__PERIPHERAL_DEVICE_PACKAGE_IDL__ */
peripheral::PackageInfo_2_0_1::HardwareInfo::serial
string serial
serial number
Definition: PeripheralDevicePackage.idl:23
peripheral::PackageInfo_2_0_1::State
State
Definition: PeripheralDevicePackage.idl:15
peripheral::PackageInfo_2_0_1::FirmwareInfo::compileDate
time compileDate
Date of firmware compilation (Deprecated: always returns 0)
Definition: PeripheralDevicePackage.idl:37
peripheral::Package_1_0_1
Definition: PeripheralDevicePackage.idl:48
peripheral::PackageInfo_2_0_1::HardwareInfo
Definition: PeripheralDevicePackage.idl:22
peripheral
Peripheral Devices.
Definition: PeripheralDeviceManager.idl:17
peripheral::DoorHandleControllerPackage_1_0_1
Definition: PeripheralDevicePackage.idl:54
peripheral::PackageInfo_2_0_1::state
State state
The peripheral device package operational state.
Definition: PeripheralDevicePackage.idl:42
peripheral::PackageInfo_2_0_1::INTERNAL_ERROR
Device package&#39;s internal error flag is set.
Definition: PeripheralDevicePackage.idl:18
peripheral::PackageInfo_2_0_1::FirmwareInfo::version
Version version
Firmware version (0.0 if not applicable)
Definition: PeripheralDevicePackage.idl:38
peripheral::PackageInfo_2_0_1::FirmwareInfo
Definition: PeripheralDevicePackage.idl:30
peripheral::PackageInfo_2_0_1::FirmwareInfo::Version
Definition: PeripheralDevicePackage.idl:31
peripheral::PackageInfo_2_0_1::FirmwareInfo::updateDate
time updateDate
Date of device firmware update (Deprecated: always returns 0)
Definition: PeripheralDevicePackage.idl:39
peripheral::PackageInfo_2_0_1::HardwareInfo::packageClass
string packageClass
serial number prefix for current packages
Definition: PeripheralDevicePackage.idl:24
peripheral::PackageInfo_2_0_1::fwInfo
FirmwareInfo fwInfo
Device package firmware specific information.
Definition: PeripheralDevicePackage.idl:45
peripheral::PackageInfo_2_0_1
Peripheral device package information.
Definition: PeripheralDevicePackage.idl:14
peripheral::PackageInfo_2_0_1::position
vector< PosElement > position
Position within 1-wire topo.
Definition: PeripheralDevicePackage.idl:43
peripheral::PackageInfo_2_0_1::HardwareInfo::model
string model
like &#39;DPX-CC2&#39; or &#39;DX-D2C6&#39;
Definition: PeripheralDevicePackage.idl:25
peripheral::PackageInfo_2_0_1::HardwareInfo::revision
string revision
hardware revision
Definition: PeripheralDevicePackage.idl:27
peripheral::PackageInfo_2_0_1::hwInfo
HardwareInfo hwInfo
Device package hardware specific information.
Definition: PeripheralDevicePackage.idl:44
peripheral::PackageInfo_2_0_1::FW_UPDATE
Device package&#39;s firmware is being updated.
Definition: PeripheralDevicePackage.idl:17
peripheral::PackageInfo_2_0_1::NORMAL
Device package is in normal operation.
Definition: PeripheralDevicePackage.idl:16
peripheral::PackageInfo_2_0_1::HardwareInfo::minDowngradeVersion
int minDowngradeVersion
minimum downgrade version (or -1)
Definition: PeripheralDevicePackage.idl:26