Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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 “Execute Smart Device Actions” for a description of the generic execution of 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 ) |
Http Body
Code Block | ||
---|---|---|
| ||
[ { "value": "11.97", "spec": { "name": "setPowerSetPointvalue", "species": "BigDecimal" } }, { "value": "600", "spec": { "name": "timeout", "species": "Integer" } } ] |
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 | ||
---|---|---|
| ||
|