shelly_exporter

command module

v1.0.0 Latest Latest Go to latest Published: Jan 15, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/aexel90/shelly_exporter

Links

Open Source Insights

README ¶

Shelly exporter for prometheus and grafana

This exporter exports some metrics from Shelly to prometheus.

ShellyPIC

Shelly API

Shelly API: https://shelly-api-docs.shelly.cloud/#shelly-h-amp-t

Shelly cloud API access: https://shelly.cloud/documents/developers/shelly_cloud_api_access.pdf

shelly-metrics.json

Determine "auth_key", "id" and "url" of your device via Shelly cloud API access and update in shelly-metrics.json. "shelly_name" and "name" can be determined on your own.

{
"account":{
    "auth_key": "...",
    "url": "..."
},
"products": [
    {
        "type": "ht",
        "export": {
            "isok": "isok",
            "temperature": "data.device_status.tmp.value",
            "humidity": "data.device_status.hum.value",
            "battery": "data.device_status.bat.value",
            "has_update": "data.device_status.update.has_update",
            "firmware": "data.device_status.getinfo.fw_info.fw",
            "mac": "data.device_status.mac",
            "updated": "data.device_status._updated"
        },
        "devices": [
            {
                "id": "956b54",                  
                "shelly_name": "S1",
                "name": "Indoor"
            },
            {
                "id": "9574a8",                   
                "shelly_name": "S2",
                "name": "Outdoor"
            }
        ]
    },
    ...

Build

go get github.com/aexel90/shelly_exporter/
cd $GOPATH/src/github.com/aexel90/shelly_exporter
go install

Execution

Usage:

$GOPATH/bin/shelly_exporter -h

Usage of ./shelly_exporter:
    -listen-address string
            The address to listen on for HTTP requests. (default "127.0.0.1:9784")
    -metrics-file string
            The JSON file with the metric definitions. (default "shelly-metrics.json")
    -test
            Test configured metrics

Execute:

$GOPATH/go/bin/shelly_exporter -metrics-file $GOPATH/go/bin/shelly-metrics.json

Testing:

$GOPATH/go/bin/shelly_exporter -metrics-file $GOPATH/go/bin/shelly-metrics.json -test

Metric: shelly_ht_info
- Exporter Result:
- Exporter Result 0:
    - humidity="53"
    - mac="E09806956B54"
    - name="Indoor"
    - isok="true"
    - shelly_name="S1"
    - temperature="22.88"
    - battery="85"
    - has_update="false"
    - firmware=""
    - updated="2021-11-23 19:43:54"
- Exporter Result 1:
    - has_update="false"
    - firmware="20210323-104951/v1.10.1-gf276b51"
    - isok="true"
    - name="Outdoor"
    - temperature="6.38"
    ...

Docker

    cp shelly-metrics.json.template shelly-metrics.json
    vi shelly-metrics.json
    docker-compose up -d --build

Grafana Dashboard

https://weatherwidget.io/

<!doctype html> <html lang="de">
<head>
</head>
<body>
<a class="weatherwidget-io" href="https://forecast7.com/de/51d0513d74/dresden/" data-label_1="DRESDEN" data-theme="original" data-highcolor="#88d976" >DRESDEN</a>
<script>
!function(d,s,id){
    var js,fjs=d.getElementsByTagName(s)[0];
    if(!d.getElementById(id)){
    js=d.createElement(s);
    js.id=id;
    js.src='https://weatherwidget.io/js/widget.min.js';
    fjs.parentNode.insertBefore(js,fjs);
    setInterval('__weatherwidget_init()', 1800000) <!-- refresh widget every 30 minutes (1800000 milliseconds): -->
    }
}(document,'script','weatherwidget-io-js');
</script>
</body>
</html>

dashboard

Grafana-ID: 13739 https://grafana.com/grafana/dashboards/13739

grafana.ini

[panels]
# If set to true Grafana will allow script tags in text panels. Not recommended as it enable XSS vulnerabilities.
disable_sanitize_html = true

Grafana Grafana Rollo