ACME Inverter Company ASync API 1.0.0

Operations

ACME Inverter Company ASync API 1.0.0

Apache 2.0

The ASync API provides you metrics and control over your ACME Solar inverter.

Servers

mqtt://test.mosquitto.org mqtt 3.1.1

Operations

Pub acme/{id}/info

Provide inverter information

Inform about new info.

Parameters
id
required
string

Accepts the following message:

Payload
object
timestamp
string
date-time

Date and time when the message was sent

serial_number
string

Inverter serial serial_number

manufacturer
string

Inverter manufacturer

model
string

Inverter model

versions
array<string>
>= 3 items <= 6 items

Inverter software versions

Items:

0
string

Additional items are allowed.

Additional properties are NOT allowed.

Examples

{
  "timestamp": "2020-05-28T10:12:36Z",
  "serial_number": "SJ0220-73011217-9D",
  "manufacturer": "ACME Inverter Company",
  "model": "ACME5000H-US00BNN4",
  "versions": [
    "4.8.28",
    "1.13.1500",
    "2.19.2000"
  ]
}
This example has been generated automatically.

Pub acme/{id}/inverter_metrics

Provide inverter instantenious measurements

Inform about new inverter metrics.

Parameters
id
required
string

Accepts the following message:

Payload
object
timestamp
string
date-time

Date and time when the message was sent

ac_current
array
>= 1 items <= 3 items

AC current (Amps)

Additional items are allowed.

ac_voltage
array
>= 1 items <= 3 items

AC voltage, line-to-line (Volt)

Additional items are allowed.

ac_voltage_line_to_neutral
array
>= 1 items <= 3 items

AC voltage, line-to-neutral (Volt)

Additional items are allowed.

ac_active_power
number

Active power (Watt)

ac_freq
number

Grid frequency (Hz)

ac_apparent_power
number

Apparent power (VA)

ac_reactive_power
number

Reactive power (VAR)

ac_power_factor
array
>= 1 items <= 3 items

Power factor

Additional items are allowed.

ac_energy_produced
integer
int64

Lifetime AC production energy (Wh)

ac_energy_consumed
integer
int64

Lifetime AC charged energy (Wh)

solar_energy_produced
integer
int64

Lifetime solar production energy (Wh)

dc_current
number

DC current (Amps)

dc_voltage
number

DC voltage (Volt)

dc_power
number

DC power (Watt)

temperature_cabinet
number

Cabinet temperature (Celsius)

status
string

Inverter status

Enum: "Off" "Sleeping" "Starting" "MPPT" "Throttled" "Shutting down" "Fault" "Standby" "Vendor"
status_vendor
string

Inverter status, vendor specific

Additional properties are allowed.

Examples

{
  "timestamp": "2020-05-28T10:12:36Z",
  "ac_current": [
    56.08
  ],
  "ac_voltage": [
    240.41
  ],
  "ac_voltage_line_to_neutral": [],
  "ac_active_power": [
    13484.56
  ],
  "ac_freq": [
    50.01
  ],
  "ac_apparent_power": 0,
  "ac_reactive_power": 0,
  "ac_power_factor": [],
  "ac_energy_produced": 7281954,
  "ac_energy_consumed": 2521,
  "solar_energy_produced": 9596952,
  "dc_current": 34.2,
  "dc_voltage": 400.29,
  "dc_power": 13689.91,
  "temperature_cabinet": 81.2,
  "status": "MPPT",
  "status_vendor": "None"
}
This example has been generated automatically.

Pub acme/{id}/storage_metrics

Provide storage instantenious measurements

Inform about new storage metrics.

Parameters
id
required
string

Accepts the following message:

Payload
object
timestamp
string
date-time

Date and time when the message was sent

power
number

Storage charge/discharge power

state_of_energy
number
>= 0 <= 100

State of energy (%)

status
string

Storage system status

Enum: "Standby" "Charging" "Discharging" "Idle" "Maintenance" "Fault" "Sleeping"

Additional properties are allowed.

Examples

{
  "timestamp": "2020-05-28T10:12:36Z",
  "power": 0,
  "state_of_energy": 0,
  "status": "Standby"
}
This example has been generated automatically.

Pub acme/{id}/event

Inform about incoming events.

Parameters
id
required
string

Accepts the following message:

Payload
object
timestamp
string
date-time

Date and time when the message was sent

name
string

Event name

Enum: "Ground fault" "DC over voltage" "AC disconnect" "DC disconnect" "Grid disconnect" "Cabinet open" "Manual shutdown" "Over temperature" "Over frequency" "Under frequency" "AC over voltage" "AC under voltage" "Blown string fuse" "Under temperature" "Memory loss" "HW test failure"
type
string

Event type

Enum: "Info" "Warning" "Error" "Debug"

Additional properties are NOT allowed.

Examples

{
  "timestamp": "2020-05-28T10:12:36Z",
  "name": "Ground fault",
  "type": "Error"
}
This example has been generated automatically.

Sub acme/{id}/power_control

Control active/reactive power production

Control active/reactive power production

Parameters
id
required
string

Accepts the following message:

Payload
object
active_power_reference
number
>= 0 <= 100

Set active power reference limit

reactive_power_reference
number
>= 0 <= 100

Set reactive power reference limit

power_factor_reference
number
>= -1 <= 1

Power factor reference

active_power_priority
boolean

Prefer active power over reactive power

Additional properties are allowed.

Examples

{
  "active_power_reference": 90,
  "reactive_power_reference": 100,
  "power_factor_reference": 0.96,
  "active_power_priority": true
}
This example has been generated automatically.

Sub acme/{id}/storage_config

Configure storage system

Configure storage system

Parameters
id
required
string

Accepts the following message:

Payload
object
mode
string

Storage system operation mode

Enum: "Disabled" "Maximize self-consumption" "Time-of-Use" "Backup only"
backup_resereved
number
>= 10 <= 100

Reserved storage for backup operation (%)

Additional properties are allowed.

Examples

{
  "mode": "Maximize self-consumption",
  "backup_resereved": 50
}
This example has been generated automatically.