{"id":18655883,"url":"https://github.com/michaelosthege/obis_exporter","last_synced_at":"2026-02-24T16:39:21.717Z","repository":{"id":75502244,"uuid":"582735053","full_name":"michaelosthege/obis_exporter","owner":"michaelosthege","description":"Exporting smart meter OBIS information as Prometheus metrics.","archived":false,"fork":false,"pushed_at":"2022-12-30T13:55:05.000Z","size":56,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-25T16:45:46.852Z","etag":null,"topics":["esp8266","obis","platformio","prometheus","smartmeter"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/michaelosthege.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-12-27T18:10:05.000Z","updated_at":"2023-01-14T13:18:24.000Z","dependencies_parsed_at":"2023-06-06T16:45:18.662Z","dependency_job_id":null,"html_url":"https://github.com/michaelosthege/obis_exporter","commit_stats":{"total_commits":22,"total_committers":1,"mean_commits":22.0,"dds":0.0,"last_synced_commit":"dd0130908014b77cfb176e898b626a7ffd33bd1b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelosthege%2Fobis_exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelosthege%2Fobis_exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelosthege%2Fobis_exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelosthege%2Fobis_exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michaelosthege","download_url":"https://codeload.github.com/michaelosthege/obis_exporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248449875,"owners_count":21105581,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["esp8266","obis","platformio","prometheus","smartmeter"],"created_at":"2024-11-07T07:20:38.755Z","updated_at":"2026-02-24T16:39:16.685Z","avatar_url":"https://github.com/michaelosthege.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OBIS Exporter\n\nAn ESP8266 based exporter of [Prometheus](http://prometheus.io/)/[OpenMetrics](https://openmetrics.io/) data from OBIS messages received from a smart meter infrared interface.\n\n## When to use this project\n\nUsing the same circuit design as described in https://github.com/mruettgers/smlreader one can receive data transmitted by smart meters via infrared outputs.\n\nHowever, some smart meters do not blink in the SML protocol, but instead blink raw OBIS messages in ASCII plain text.\nThis applies to at least:\n+ [eBZ DD3 \"OD type\"](https://www.manualslib.de/manual/409099/Ebz-Dd3.html?page=11#manual)\n+ EasyMeter ESY11 Q3DA1002 V3.04\n\nSee [this comment](https://github.com/mruettgers/SMLReader/issues/46#issuecomment-1366027583) for more information.\n\n## Set Up\n\nAfter flashing a Wemos D1 mini* using [PlatformIO](https://platformio.org/), the device spins up a WiFi hotspot \"OBISExporter\" to which you can connect without a password.\nIn the form, you'll have to set a password for the default WiFi hotspot, and enter your SSID and password for your regular WiFi.\n\n\u003csup\u003e*If you want to use something other than a Wemos D1 mini, make sure to change the `board` setting in the `platformio.ini` file.\u003c/sup\u003e\n\nAfter setting the configuration, the device should connect to your WiFi, and run a webserver exposing Prometheus metrics under `http://\u003cip_or_fqdn\u003e/metrics`.\n\nThis can be scaped by Prometheus, and visualized in Grafana:\n\n![](docs/grafana_screenshot.png)\n\n## FAQ\n\n__Why not send MQTT messages?__\n\nWe wanted this data to end up in Prometheus to make visualization with [Grafana](http://grafana.com/) as easy as possible.\nWith MQTT we'd have to run several more services (MQTT broker, NodeRED) to get the data into a database.\n\nAlso, the `\u003cip_or_fqdn\u003e:80/metrics` endpoint can be viewed in a browser, which is very convenient.\n\n__I'm not receiving infrared data__\n\nSome smart meters such as the eBZ DD3 have more than one IR output.\n\nOn the eBZ DD3 we got more consistent transfer quality from the IR port at the top.\n\nAlso remember to activate the IR output as described in the smart meter manual.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelosthege%2Fobis_exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelosthege%2Fobis_exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelosthege%2Fobis_exporter/lists"}