sml-exporter

command module
v0.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 12, 2026 License: Apache-2.0 Imports: 17 Imported by: 0

README

sml-exporter

sml-exporter is an exporter for SML-enabled smart meters. It currently supports exposing SML data in the following ways:

  • Prometheus metrics
  • MQTT

Usage

Usage of sml-exporter:
  -config string
    	Config file with OBIS code mappings
  -debug
    	Enable debug logging
  -health-timeout duration
    	Timeout duration for health check (default 10s)
  -metrics-address string
    	The address to listen on for HTTP requests (default ":9761")
  -mqtt-password string
    	MQTT password
  -mqtt-server string
    	MQTT server to publish values to as they are received
  -mqtt-topic-prefix string
    	MQTT topic prefix for publishing values (default "smartmeter")
  -mqtt-username string
    	MQTT username
  -serial string
    	Serial device to read from

A health check endpoint is available at /healthz. It returns 200 if data has been received within the configured -health-timeout, and 503 otherwise.

OBIS code mapping

How individual OBIS codes are exposed is configurable via a YAML configuration file (see example-config.yaml for a full example).

Each entry maps an OBIS code to an optional MQTT topic, Prometheus metric, or named variable:

1-0:96.1.0*255:
  type: string
  var: server_id
1-0:1.8.0*255:
  mqtt:
    topic: "smartmeter/wirkarbeit-verbrauch"
  metric:
    name: "smartmeter_wirkarbeit_verbrauch_wh_total"
    help: "Total active energy consumed in Wh"
1-0:2.8.0*255:
  mqtt:
    topic: "smartmeter/wirkarbeit-einspeisung"
  metric:
    name: "smartmeter_wirkarbeit_einspeisung_wh_total"
    help: "Total active energy fed back in Wh"
1-0:16.7.0*255:
  mqtt:
    topic: "smartmeter/momentane-wirkleistung"
  metric:
    name: "smartmeter_leistung_gesamt_w"
    help: "Current total active power in W"

Entries with type: string and var store the value as a named variable instead of exporting it. These variables can be referenced elsewhere — for example, server_id is automatically added as a label to all Prometheus metrics, identifying which smart meter the readings came from.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL