Banks

Banks are representation of groups of outlets. Banks are often referred to as circuits as well. Each bank has it's own energy measurement capabilities. Individual Outlet Current Measurements or/and individual Outlet Switching are optional additions. Otherwise energy information can be found in Inlets.

Endpoints

endpoint

GET    /api/banks                                Returns all banks
PUT    /api/banks/:bank_id                       Modifies individual bank

Bank Object

JSON

{
  "id": "286331153",
  "inletId": "I1-1000016",
  "firmwareVersion": "010100",
  "hardwareVersion": "010105",
  "outletSwitchingSupported": true,
  "outletMeteringSupported": true,
  "currentRms": 0.807,
  "voltageRms": 119.900,
  "lineFrequency": 60.138,
  "powerFactor": 0.810,
  "activePower": 0.009,
  "apparentPower": 0.930,
  "energyAccumulation": 42.21,
  "bankName": "Bank 1",
  "bankLines": "L1-L2",
  "circuitBreakerClosed": true,
  "hasCircuitBreakerProtection": true
}

Key	Type	Description
id	string	Unique identifier for the bank
inletId	string	ID of inlet which the bank is behind
firmwareVersion	string	Version for bank firmware
hardwareVersion	string	Version for hardware for bank
outletSwitchingSupported	boolean	true if bank outlets support individual outlet switching
outletMeteringSupported	boolean	true if bank outlets support individual outlet current metering
currentRms	number	The instantaneous current measured at the inlet in Amps
voltageRms	number	Instantaneous voltage reading at inlet and all outlets in volts
lineFrequency	number	Line Frequency measurement valid from 45-65 GHz
powerFactor	number	Power Factor reading. Value is signed value representing polarity of power factor
activePower	number	Active Power measured in KW (kiloWatts). Power consumed by electrical resistance
apparentPower	number	Power which is actually consumed or utilized
energyAccumulation	number	Number of kilowatt hours accumulated. Can be used as billing unit for energy delivered
bankName	string	User defined name for Bank
bankLines	string	Specific Lines or line configuration which this bank is utilizing
circuitBreakerClosed	boolean	State of circuit breakers. true if circuit breaker is closed and providing power correctly.

List All Banks

Returns a list of all banks that the controller has connected to.

endpoint

GET /api/banks    Returns all banks

Example Request

cURL

curl 'http://192.168.1.100/api/banks' \
  --header 'Authorization: Bearer j2d36cG2ciHKDDqFc3k'

Response

Expected response is an array of Bank Objects

JSON

[
  {
    "id": 286331153,
    "firmwareVersion": "1.0.1",
    "hardwareVersion": "1.0.0",
    "outletSwitchingSupported": true,
    "outletMeteringSupported": true,
    "currentRms": 0.807,
    "voltageRms": 119.900,
    "lineFrequency": 60.138,
    "powerFactor": 0.810,
    "activePower": -0.009,
    "apparentPower": 0.930,
    "energyAccumulation": 42,
    "bankName": "Bank 1",
    "bankLines": "L1-L2",
    "circuitBreakerClosed": true,
    "hasCircuitBreakerProtection": true
  },
  ...
]

Modify Bank Info

The only value changeable for banks is a custom name field for banks.

endpoint

PUT    /api/banks/:bank_id                       Modifies individual bank

Request

Follows Authentication Scheme.

JSON

{
  "bankName": "Critical Equipment Bank"
}

bankName required
Name string up to 100 characters.

Example Request

cURL

curl 'http://192.168.1.100/api/banks/286331153' \
  -H 'Authorization: Bearer j2d36cG2ciHKDDqFc3k' \
  --data '{"bankName":"Critical Equipment Bank"}'

Response

Expected response is newly modified Bank Object

JSON

{
  "id": 286331153,
  "firmwareVersion": "1.0.0",
  "hardwareVersion": "1.0.1",
  "outletSwitchingSupported": true,
  "outletMeteringSupported": true,
  "currentRms": 0.807,
  "voltageRms": 119.900,
  "lineFrequency": 60.138,
  "powerFactor": 0.810,
  "activePower": -0.009,
  "apparentPower": 0.930,
  "energyAccumulation": 42,
  "bankName": "Bank 1",
  "bankLines": "L1-L2",
  "circuitBreakerClosed": true,
  "hasCircuitBreakerProtection": true
}