zcsazzurroreceiver

README

ZCS Azzurro Receiver

Status
Stability	[alpha]:metrics

This receiver reads ZCS Azzurro inverters data from the ZCS cloud platform and turns them into metrics.

Configuration

client_id (Required)

A string with the ZCS API client ID (from ZCS support).

auth_key (Required)

A string with the ZCS API authenication key (from ZCS support).

thing_key (Required)

A string with the ZCS inverter serial number.

interval (Optional)

A string with the time interval between polls to fetch data from the ZCS API.

Default: 5m

Example configurations

Using connection string for authentication:

  zcsazzurro:
    client_id: ${ZCS_CLIENT_ID}
    auth_key: ${ZCS_AUTH_KEY}
    thing_key: ${ZCS_THING_KEY}
    interval: 30m

Format

The metrics are exported with the following schema:

Metric Name	Type	Unit	Description
power_autoconsuming	gauge	W	Power autoconsuming
power_charging	gauge	W	Power charging
power_consuming	gauge	W	Power consuming
power_discharging	gauge	W	Power discharging
power_exporting	gauge	W	Power exporting
power_generating	gauge	W	Power generating
power_total			Total power
battery_soc	gauge	%	Battery SOC
battery_cycletime_total	sum	cycles	Total battery cycletime
energy_autoconsuming	gauge		Energy autoconsuming
energy_autoconsuming_total	sum	Wh	Energy autoconsuming total
energy_charging	gauge		Energy charging
energy_charging_total	sum	Wh	Energy charging total
energy_consuming	gauge		Energy consuming
energy_consuming_total	sum	Wh	Energy consuming total
energy_discharging	gauge		Energy discharging
energy_discharging_total	sum	Wh	Energy discharging total
energy_exporting	gauge		Energy exporting
energy_exporting_total	sum	Wh	Energy exporting total
energy_generating	gauge		Energy generating
energy_generating_total	sum	Wh	Energy generating total
energy_importing	gauge		Energy importing
energy_importing_total	sum	Wh	Energy importing total

Documentation

Index

• func NewFactory() receiver.Factory
• type Config
  • func (cfg *Config) Validate() error
• type Scraper
  • func NewScraper(clientID, authKey, thingKey string, logger *zap.Logger) *Scraper
  • func (s *Scraper) Scrape(thingKey string) (azzurro.RealtimeDataResponse, error)

Functions

func NewFactory

func NewFactory() receiver.Factory

Types

type Config

type Config struct {
	Interval string `mapstructure:"interval"`
	ClientID string `mapstructure:"client_id"`
	AuthKey  string `mapstructure:"auth_key"`
	ThingKey string `mapstructure:"thing_key"`
}

func (*Config) Validate

func (cfg *Config) Validate() error

type Scraper

type Scraper struct {
	// contains filtered or unexported fields
}

func NewScraper

func NewScraper(clientID, authKey, thingKey string, logger *zap.Logger) *Scraper

func (*Scraper) Scrape

func (s *Scraper) Scrape(thingKey string) (azzurro.RealtimeDataResponse, error)