Commands API
Use the Commands API to schedule or directly send instructions to Entities.
Some Entities can be controlled remotely through our Commands API. Commands can instruct a device to take action or change its configuration.
What makes this API powerful
Just like Readings, Commands are normalized across all Entities. This allows you to send consistent instructions to any supported device across different manufacturers, models, and device variations.
Command types and compatibility
Whether an Entity supports a Command depends on the type of Entity and its manufacturer.
Command | Use | Value | Compatibility |
---|---|---|---|
StartCharging | Start a new charging session. | N/A | EV1 |
StopCharging | Stop an active charging session. | N/A | EV1 |
Reset | Set the default configuration. | N/A | PV |
Disconnect | Disconnect the system from the grid. | N/A | PV2 |
LimitFeedIn | Sets a feed-in limit. Used for curtailing injection. | Limit in W | PV |
StopFeedIn | Limits feed-in to a minimum. | N/A | PV |
The cooldown time
In rare cases, a Command can’t be executed immediately. The device might process it with a delay, or it may take some time for the Command to reach it. To prevent latency issues, we’ve introduced a cooldown period between Commands sent to the same Entity.
The cooldown period lasts 10 minutes. You can disable the cooldown if needed, but we recommend avoiding this whenever possible to maintain reliability.
When you Trigger a Command for an Entity, you can disable the cooldown by setting the query parameter to true
.
What you’ll need
- Your API credentials
- Contributor permission on an Entity that supports Commands
Let’s try it out
Use the to Trigger a Command for it.
You’ll also have to specify the Command and you may need to set a .
Available options: StartCharging
, StopCharging
, Reset
, Disconnect
, LimitFeedIn
, and StopFeedIn
.
Reference the compatibility table to understand what’s expected.
After creating it, your Command will typically be in a Pending
state. Fetch its updated at a later time by Retrieving your Command.
Footnotes
-
Charging Commands aren’t available for BMW vehicles unless onboarded through Enode. We partner with Enode to extend our support for vehicles through reversed-engeneered connectivity solutions. Read more about Enode’s capabilities on their website. ↩ ↩2
-
The Disconnect Command is currently not supported by Huawei. ↩