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

Loading...
Searching...
No Matches
TransferSwitchBypassStateSensor.idl
1/* SPDX-License-Identifier: BSD-3-Clause */
2/*
3 * Copyright 2017 Raritan Inc. All rights reserved.
4 */
5
6#ifndef __PDUMODEL_TRANSFER_SWITCH_BYPASS_STATE_SENSOR_IDL__
7#define __PDUMODEL_TRANSFER_SWITCH_BYPASS_STATE_SENSOR_IDL__
8
9#include <StateSensor.idl>
10
11/** PDU Model */
12module pdumodel {
13
14 /** Overcurrent protector trip sensor interface */
15 interface TransferSwitchBypassStateSensor extends sensors.StateSensor {
16 /* Bit masks for sensor state */
17 constant int STATE_ACTIVE_INLET_MASK = 0x7; ///< Active inlet, can be 0 (off), 1 or 2
18 constant int STATE_IS_BYPASS_SELECTED = 0x8; ///< Whether the "bypass" position is selected
19 constant int STATE_FAULT = 0x10; ///< If set, communication to the bypass controller failed unexpectedly
20
21 /**
22 * Acknowledge communication fault as expected
23 *
24 * If a bypass was present in the unit and later on removed, the STATE_FAULT bit will be set in the bypass state.
25 * If removing the bypass happened deliberately, this method can be used to reset the state back to 'unavailable'
26 * until the bypass is added to the unit again.
27 */
28 void acknowledgeFault();
29 };
30
31}
32
33#endif
pdumodel::TransferSwitchBypassStateSensor
Overcurrent protector trip sensor interface.
Definition TransferSwitchBypassStateSensor.idl:15
pdumodel::TransferSwitchBypassStateSensor::acknowledgeFault
void acknowledgeFault()
Acknowledge communication fault as expected.
pdumodel
PDU Model.
Definition Circuit.idl:16
sensors
Sensors Model.
Definition AccumulatingNumericSensor.idl:13