Description
Sets the “PowerSetPoint” of a batter energy storage system.
In fact this is merely an action that is provided by the Battery Energy Storage System smart device type. See xxx “Execute Smart Device Actions” for a description of the generic execution of generic smart device actions.
Resource URL
https://app1pub.smappee.net/dev/v3/servicelocation/[SERVICELOCATIONID]/smartdevices/[SMARTDEVICEUUID]/actions/setPowerSetPoint
HTTP method
POST
HTTP header
Authorization: Bearer [ACCESS_TOKEN]
[ACCESS_TOKEN] being the access token received from the Get token or Refresh token authentication calls.
Parameters
Parameter | Type | Description |
|---|---|---|
SERVICELOCATIONID | Path Parameter | The actual id of an accessible service location (see Get Servicelocations) |
SMARTDEVICEUUID | Path Parameter | The actual lid id of a BESS smart device available at the specified service location (see Get Smart Devices ) |
from | Query Parameter | Any number of milliseconds since Jan 1st 1970 to obtain the values that were stored on that timestamp. |
to | Query Parameter | Optionally use any number of milliseconds since Jan 1st 1970 to obtain the values that were stored on that timestamp |
Example
https://app1pub.smappee.net/dev/v3/servicelocation/10236/smartdevices/6791ace2-017e-11ef-8af2-02e2e76ae149/actions/setPowerSetPoint
Result
Numbers are fictionalHttp Body
| Code Block | ||
|---|---|---|
| ||
[
{
"timestamp": 1728597600000,
"values": [
{
"name": "SoC",
"displayName": "State of charge [%]",
"value": 68.0,
"species": "BigDecimal"
},
{
"name": "SoCMIN",
"displayName": "Minimum state of charge [%]",
"value": 24.0,
"species": "BigDecimal"
},
{
"11.97",
"name": "SoCMAX",
"displayName": "Maximum state of charge [%]",
"value": 98.0,
"species": "BigDecimal"
},
"spec": {
"name": "BatteryEnergy",
"displayName": "Charging level [Wh]",
"value": 68.0,
"species": "BigDecimal"
},
{
"name": "InverterEnergy",
"displayName": "Inverter energy [Wh]",
"value": 34.0,
"species": "BigDecimal"
},
{
"name": "TotalACEnergy",
"displayName": "Total AC Energy [Wh]",
"value": 33.0,
"species": "BigDecimal"
}600",
{
"name": "AuxiliaryEnergy",
"displayName": "Auxiliary energy [Wh]",
"value": 33.0,
"species": "BigDecimal"
},
"spec": {
"name": "SolarEnergytimeout",
"displayName": "Solar energy [Wh]",
"value": 110.0,
"species": "BigDecimal"
},
{
"name": "BatteryTemperature",
"displayName": "Battery Temperature",
"value": 37.0,
"species": "BigDecimal"
},
{
"name": "InverterTemperature",
"displayName": "Inverter Temperature",
"value": 43.0,
"species": "BigDecimal"
},
{
"name": "MODE",
"displayName": "Mode",
"value": 3,
"species": "Integer"
},
{
"name": "G2BEnergy",
"displayName": "Energy from grid to battery",
"value": 12.0,
"species": "BigDecimal"
},
{
"name": "B2GEnergy",
"displayName": "Energy from battery to grid",
"value": 0.0,
"species": "BigDecimal"
},
{
"name": "S2BEnergy",
"displayName": "Energy from solar to battery",
"value": 0.0,
"species": "BigDecimal"
},
{
"name": "B2LEnergy",
"displayName": "Energy from battery to a load",
"value": 0.0,
"species": "BigDecimal"
},
{
"name": "G2LEnergy",
"displayName": "Energy from grid to a load",
"value": 0.0,
"species": "BigDecimal"
},
{
"name": "S2LEnergy",
"displayName": "Energy from solar to a load",
"value": 0.0,
"species": "BigDecimal"
},
{
"name": "S2GEnergy",
"displayName": "Energy from solar to the grid",
"value": 0.0,
"species": "BigDecimal"
},
{
"name": "TotalConsumed",
"displayName": "Total consumed energy [Wh]",
"value": 0.0,
"species": "BigDecimal"
},
{
"name": "TotalProduced",
"displayName": "Total produced energy [Wh]",
"value": 0.0,
"species": "BigDecimal"
},
{
"name": "TotalTimesCharged",
"displayName": "Total times charged",
"value": 0,
"species": "Long"
},
{
"name": "TotalTimesDischarged",
"displayName": "Total times discharged",
"value": 0,
"species": "Long"
}
]
}
]
] |
A positive “value” parameter equals discharging the battery (unit equals W). Vice versa, negative equals charging the battery system.
Note that the “timeout” parameter requires a value whose unit is “seconds” and is optional. If not specified than the default value of 300 seconds is applied.
Example
https://app1pub.smappee.net/dev/v3/servicelocation/10236/smartdevices/6791ace2-017e-11ef-8af2-02e2e76ae149/actions/setPowerSetPoint
Result
Returns nothing
Versioning
Version 1 (v1)
Not supported.
Version 2 (v2)
Not supported
Version 3 (v3)
This was introduced in this version.
| Page Properties | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Panel | ||
|---|---|---|
| ||
|