Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aportela/sh-shelly-influxdb
publish shelly (plug) device data on influxdb
https://github.com/aportela/sh-shelly-influxdb
automation curl grafana influxdb iot jq shell shelly smart-home
Last synced: about 1 month ago
JSON representation
publish shelly (plug) device data on influxdb
- Host: GitHub
- URL: https://github.com/aportela/sh-shelly-influxdb
- Owner: aportela
- License: gpl-3.0
- Created: 2024-06-18T07:59:46.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-19T21:40:45.000Z (7 months ago)
- Last Synced: 2024-10-16T19:16:00.875Z (3 months ago)
- Topics: automation, curl, grafana, influxdb, iot, jq, shell, shelly, smart-home
- Language: Shell
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sh-shelly-influxdb
Do you need a simple way to send data from Shelly smart plugs to an InfluxDB database without complicating things with dependencies? This is your script.
It only requires having the command-line tools curl and jq installed.
You need to have access credentials (password) configured for your Shelly device and have the RPC API enabled. The script assumes that all devices share the same credentials (password).
## INSTALL
Copy **shelly-infuxdb.sh** to **/usr/local/bin**
Add exec permissions to **shelly-influxdb.sh**
> sudo chmod +x /usr/local/bin/shelly-influxdb.sh
Copy **shelly-influxdb.conf** to **/usr/local/etc** and customize/edit your settings
## USAGE
### Manual launch:
> sh /usr/local/bin/shelly-influxdb.sh /usr/local/etc/shelly-influxdb.conf
### systemd
Create service definition:
> cat > /etc/systemd/system/shelly-influxdb.service
```
[Unit]
Description=Run shelly influxdb script every 10 seconds
After=network.target
[Service]
Type=simple
ExecStart=/bin/sh -c '/usr/local/bin/shelly-influxdb.sh /usr/local/etc/shelly-influxdb.conf'
Restart=always
RestartSec=10
[Install]
WantedBy=multi-user.target
```
NOTE: avoid log flooding (every 10 seconds) on /etc/systemd/system/shelly-influxdb.service redirecting stdout & stderr to null & hide notice/info/debug syslog messages
```
[Unit]
Description=Run shelly influxdb script every 10 seconds
After=network.target
[Service]
Type=simple
ExecStart=/bin/sh -c '/usr/local/bin/shelly-influxdb.sh /usr/local/etc/shelly-influxdb.conf'
Restart=always
RestartSec=10
StandardOutput=null
StandardError=null
LogLevelMax=3
[Install]
WantedBy=multi-user.target
```
Enable service
> sudo systemctl enable shelly-influxdb.service
Reload services
> sudo systemctl daemon-reload
> sudo systemctl restart shelly-influxdb.service
Verify service status
> sudo systemctl status shelly-influxdb.service
## Grafana
Here are some example (NOTE: change 111111111111 to your real MAC address) queries to visualize data in Grafana with line charts:
### Current power (watts)
```SQL
SELECT mean("power") FROM "autogen"."smarthome" WHERE ("brand"::tag = 'Shelly' AND "type"::tag = 'plug' AND "mac"::tag = '111111111111') AND $timeFilter GROUP BY time($__interval) fill(none)
```
### Energy (kW/hour)
```SQL
SELECT "energy" FROM "autogen"."smarthome" WHERE ("type"::tag = 'plug' AND "brand"::tag = 'Shelly' AND "mac"::tag = '111111111111') AND $timeFilter
```
### Voltage
```SQL
SELECT mean("voltage") FROM "autogen"."smarthome" WHERE ("type"::tag = 'plug' AND "brand"::tag = 'Shelly' AND "mac"::tag = '111111111111') AND $timeFilter GROUP BY time($__interval) fill(none)
```
### Temperature
```SQL
SELECT mean("temperature") FROM "autogen"."smarthome" WHERE ("type"::tag = 'plug' AND "brand"::tag = 'Shelly' AND "mac"::tag = '111111111111') AND $timeFilter GROUP BY time($__interval) fill(none)
```
## TODO
create debian package