PeripheralDevicePackage.idl
/* SPDX-License-Identifier: BSD-3-Clause */
/*
* Copyright 2013 Raritan Inc. All rights reserved.
*/
#ifndef __PERIPHERAL_DEVICE_PACKAGE_IDL__
#define __PERIPHERAL_DEVICE_PACKAGE_IDL__
#include <PeripheralDeviceSlot.idl>
/** Peripheral Devices */
module peripheral {
/** Peripheral device package information */
structure PackageInfo_2_0_1 {
enumeration State {
NORMAL, ///< Device package is in normal operation
FW_UPDATE, ///< Device package's firmware is being updated
INTERNAL_ERROR, ///< Device package's internal error flag is set
CONFIG_ERROR ///< Device package's internal configuration is invalid
};
structure HardwareInfo {
string serial; ///< serial number
string packageClass; ///< serial number prefix for current packages
string model; ///< like 'DPX-CC2' or 'DX-D2C6'
int minDowngradeVersion; ///< minimum downgrade version (or -1)
string revision; ///< hardware revision
};
structure FirmwareInfo {
structure Version {
int majorNumber;
int minorNumber;
int bootloaderVersion;
};
time compileDate; ///< Date of firmware compilation (Deprecated: always returns 0)
Version version; ///< Firmware version (0.0 if not applicable)
time updateDate; ///< Date of device firmware update (Deprecated: always returns 0)
};
State state; ///< The peripheral device package operational state
vector<PosElement> position; ///< Position within 1-wire topo
HardwareInfo hwInfo; ///< Device package hardware specific information
FirmwareInfo fwInfo; ///< Device package firmware specific information
};
interface Package_1_0_1 {
PackageInfo_2_0_1 getPackageInfo();
};
interface DoorHandleControllerPackage_1_0_1 extends Package_1_0_1 {
constant int SUCCESS = 0;
constant int ERR_NOT_SUPPORTED = 1;
constant int ERR_OPERATION_FAILED = 2;
vector<string> getSupportedHandleTypes();
string getHandleType(in int channel);
int setHandleType(in int channel, in string handleType);
};
}
#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