Skip to main content
GET
/
api
/
tes
Get TES tank status
curl --request GET \
  --url http://aris.local/api/tes \
  --header 'Authorization: Bearer <token>'
{
  "tesId": "tes_main",
  "mode": "heat",
  "tempTopC": 41.5,
  "tempBottomC": 30.2,
  "stateOfChargePercent": 75,
  "chargeActive": false,
  "dischargeActive": true,
  "tempMidC": 36.5,
  "effectiveCapacityLiters": 180
}

Authorizations

​
Authorization
string
header
required

Session token or API token

Response

TES tank status

​
tesId
string
required

Unique identifier for the TES tank

Example:

"tes_main"

​
mode
enum<string>
required

Current TES usage mode:

  • heat: top is hot, bottom is cold
  • cool: top is cold, bottom is warm
  • idle: stratification reflects the last mode; no active charge/discharge
Available options:
heat,
cool,
idle
Example:

"heat"

​
tempTopC
number
required

Temperature at top of TES tank. Represents hottest available thermal energy.

Example:

41.5

​
tempBottomC
number
required

Temperature at bottom of tank. Indicates remaining thermal reserve.

Example:

30.2

​
stateOfChargePercent
integer
required

Calculated energy level (0-100%) based on stratification. Brain-computed.

Required range: 0 <= x <= 100
Example:

75

​
chargeActive
boolean
required

True when system is actively charging TES (HCU -> TES)

Example:

false

​
dischargeActive
boolean
required

True when distribution loop is drawing energy from TES

Example:

true

​
tempMidC
number

Mid-layer temperature. Improves stratification modeling. Only present if tank has mid-layer sensor.

Example:

36.5

​
effectiveCapacityLiters
number

Usable thermal capacity. Brain-computed.

Example:

180