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

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

Loading...
Searching...
No Matches
TypeBResidualCurrentNumericSensor.idl
1/* SPDX-License-Identifier: BSD-3-Clause */
2/*
3 * Copyright 2016 Raritan Inc. All rights reserved.
4 */
5
6#ifndef __PDUMODEL_TYPE_B_RESIDUAL_CURRENT_NUMERIC_SENSOR_IDL__
7#define __PDUMODEL_TYPE_B_RESIDUAL_CURRENT_NUMERIC_SENSOR_IDL__
8
9#include <NumericSensor.idl>
10
11/** PDU Model */
12module pdumodel {
13
14 /** An RCM current sensor of type B (AC/DC) which allows degaussing the sensor */
15 interface TypeBResidualCurrentNumericSensor extends sensors.NumericSensor {
16 /**
17 * Trigger a degauss cycle of the residual current sensor
18 *
19 * In certain scenarios there's a possibility of magnetization of the residual
20 * current sensor, in which case current will be measured even if there is
21 * no actual current flow. When that happens, the sensor can be demagnetized
22 * by calling this method.
23 *
24 * IMPORTANT: Only call this while there is no actual current flow!
25 */
26 void degauss();
27 };
28}
29
30#endif
pdumodel::TypeBResidualCurrentNumericSensor
An RCM current sensor of type B (AC/DC) which allows degaussing the sensor.
Definition TypeBResidualCurrentNumericSensor.idl:15
pdumodel::TypeBResidualCurrentNumericSensor::degauss
void degauss()
Trigger a degauss cycle of the residual current sensor.
pdumodel
PDU Model.
Definition Circuit.idl:16
sensors
Sensors Model.
Definition AccumulatingNumericSensor.idl:13