Inlet Object

This object represents an inlet for a particular Power Distribution Unit (PDU). It let's you read basic inlet information, energy metrics, power consumption information, and inlet configuration settings.

JSON

{
  "id": "17374353",
  "inletType": "single",
  "inletPlug": "NEMA L6-20P",
  "inletName": "NEMA L6-20P Inlet",
  "inletEnergyAccumulation": 89.03,
  "inletPhase": "Single Phase",
  "timestamp": 1656699228132,
  "enclosureSerialNumber": 1024122712
}

Key	Type	Description
id	string	Unique identifier for Inlet
inletType	string	Describes configuration of specific Inlet Object. Either "single", "dual", or "ats".
inletPlug	string	Connector type for Inlet
inletName	string	User defined name for inlet
inletEnergyAccumulation	number	kWH value to show energy consumption for inlet plug. If multiple inlets, value will stay same for all inlets.
inletPhase	number	Either "Single Phase", or "Three Phase"
timestamp	number	Unix timestamp in milliseconds for the power metrics and current configuration
enclosureSerialNumber	number	Unique serial number for device enclosure

Inlet Object - 3 Phase Attributes

The following attributes will be included if the PDU is a 3 phase PDU

JSON

{
  "inletPowerFactor": 0.8,
  "threePhaseBalance": "80%",
  "inletLines": [
    {
      "currentRms": 1.31,
      "id": "L1-17374353",
      "line": "L1"
    },  
    {
      "currentRms": 2.41,
      "id": "L2-17374353",
      "line": "L2"
    },
    {
      "currentRms": 1.31,
      "id": "L3-17374353",
      "line": "L3"
    }
  ]
}

Key	Type	Description
inletPowerFactor	number	Power factor value for inlet plug
threePhaseBalance	string	Percentage unbalance for 3 phase circuit
inletLines	array	Contains 3 line objects, each with "currentRMS" in amps, unique "id", and "line" it is associated with.

Inlet Object - Single Phase Attributes

For ATS inlets, the following attributes will exist in the inlet with atsInletActive = true.

JSON

{
  "inletCurrentRms": 4.2,
  "inletVoltageRms": 202.4,
  "inletLineFrequency": 59.9,
  "inletPowerFactor": 0.8,
  "inletActivePower": 11,             
  "inletApparentPower": 10,
  "inletLineConfiguration": "L-L",
}

Key	Type	Description
inletCurrentRms	number	Inlet current draw in amps
inletVoltageRms	number	Inlet voltage RMS in volts
inletLineFrequency	number	Inlet line frequency in hertz
inletPowerFactor	number	Power factor ratio
inletActivePower	number	Inlet Active Power in watts
inletApparentPower	number	Inlet Apparent Power in Volt-amperes (VA)
inletLineConfiguration	string	Line configuration for outlets connected to this inlet.

Inlet Object - ATS (Auto Transfer Switch) Attributes

The following attributes will appear if the PDU has ATS functionality.

JSON

{
  "atsInletId": "A",
  "atsInletActive": true,
  "atsInletReady": true,
}

Key	Type	Description
atsInletId	string	Either "A" or "B". Matches label on PDU.
atsInletActive	boolean	true if inlet is used to power outlets.
atsInletReady	boolean	true if inlet has voltage potential