Skip to main content

Get system settings for a site

GET 
/v1/sites/:siteId/settings

Get the current system settings for a site.

These settings interact to determine how the system exchanges energy with the grid. The notes below explain what can be derived from combinations of settings.

Most settings are configured during installation or by the operator. Of the settings returned here, only batteryChargingConstraint and gridExportSetting can be changed by the end user through the mobile app.

Exporting battery energy to the grid

Battery energy reaches the grid only when battGridDischargeEnable is true and gridExportSetting is BATTERY_AND_SOLAR. When battGridDischargeLimitEnable is true, battGridDischargeLimit caps how much power (in watts) the battery may export to the grid; when it is false, no such limit is enforced.

Charging the battery from the grid

The battery charges from the grid only when battGridChargeEnable is true and batteryChargingConstraint is GRID_AND_SOLAR. Otherwise the battery charges from solar only.

Limiting total site export

When siteExportPowerLimitEnabled is true, siteExportPowerLimit caps the total power (in watts) the site may export to the grid; when it is false, no such limit is enforced.

Permission to operate (PTO)

ptoGranted reflects storage permission to operate: when false, the system cannot export to the grid at all (neither solar nor storage), though the battery may still charge from the grid. solarPtoGranted reflects solar permission to operate: when false, solar export is disabled.

Request​

Responses​

OK