General Device Control

The Solinteg Open API provides a general parameter delivery API for controlling inverters.

It is suitable for simple parameter settings. For complex deliveries such as time groups, we prefer to provide dedicated APIs to shield you from the underlying complexity.

This document introduces how to use the general parameter delivery API with some common inverter control scenarios.

API Notes

1. This is a batch delivery API, so you can deliver all settings at once. We also recommend merging requests where possible to reduce the number of API calls and avoid triggering rate limits.
2. Parameters may depend on each other, and a delivered value does not necessarily take effect immediately. For example:
   1. Export power (gridSideMaxPowerLimit) only takes effect when Export switch (antiCounterCurrentStartStop) is enabled.

tip

You can learn about parameter dependencies on our monitoring platform.

1. The settable ranges of parameters may differ between single-unit systems and master-slave parallel systems, which is usually related to the rated power of the system.
2. When using the delivery result query API to determine whether a delivery succeeded, use the controlResult field instead of comparing currentValue.

Scenarios

1. Quick Inverter Configuration

Delivering Control Commands

curl -L 'http://8.209.107.231:7710/openapi/v2/wrapper/cmd/set' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'token: <token>' \
-d '{
  "deviceSn": "A11000010054409C",
  "sendSettingItemList": [
    {
      "settingCode": "hybridWorkMode",
      "value": "1#1"
    },
    {
      "settingCode": "antiCounterCurrentStartStop",
      "value": 1
    },
    {
      "settingCode": "gridSideMaxPowerLimit",
      "value": 25
    },
    {
      "settingCode": "safetyCountry",
      "value": 10
    },
    {
      "settingCode": "peakLoadShiftSwitch",
      "value": 1
    },
    {
      "settingCode":"gridMaximumCapacitySet",
      "value": 25
    },
    {
      "settingCode":"batteryTypeCode",
      "value": "1#1"
    }
  ]
}'

Response

{
  "errorCode": 0,
  "info": null,
  "body": "6aa1199626facc51d2f3a46a",
  "successful": true
}

Querying the Delivery Result

curl -L 'http://8.209.107.231:7710/openapi/v2/wrapper/cmd/checkControlResult?recordId=6aa1199626facc51d2f3a46a' \
-H 'Accept: application/json' \
-H 'token: <token>'

Response

{
  "errorCode": 0,
  "info": null,
  "body": {
    "batterytypecode": {
      "controlResult": true,
      "currentValue": "65537"
    },
    "anticountercurrentstartstop": {
      "controlResult": true,
      "currentValue": "1"
    },
    "safetycountry": {
      "controlResult": true,
      "currentValue": "10"
    },
    "hybirdworkmode": {
      "controlResult": true,
      "currentValue": "257"
    },
    "peakloadshiftswitch": {
      "controlResult": true,
      "currentValue": "1"
    },
    "gridmaximumcapacityset": {
      "controlResult": true,
      "currentValue": "25.0"
    }
  },
  "successful": true
}