1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-21 18:41:03 +00:00

updated comment per PR suggestion

This commit is contained in:
Tim Connors 2023-10-16 13:45:06 +11:00
parent 693509563c
commit 96250b3764

View file

@ -1,27 +1,45 @@
#!/bin/sh
#
# Copyright (C) 2019-2022 Tim Connors
# GNU Library General Public License v2 or later
#
#
# munin plugin that logs voltage, energy usage, power, power factor and current logged from tasmota power switches
#
# To install the plugin, copy or move the plugin to /usr/share/munin/plugins/ set
# the chmod to 755 and create a symbolic link:
# ln -s /usr/share/munin/plugins/tasmota_ /etc/munin/plugins/tasmota_hostname_voltage
# ln -s /usr/share/munin/plugins/tasmota_ /etc/munin/plugins/tasmota_hostname_energy
# ln -s /usr/share/munin/plugins/tasmota_ /etc/munin/plugins/tasmota_hostname_power
# ln -s /usr/share/munin/plugins/tasmota_ /etc/munin/plugins/tasmota_hostname_powerfactor
# ln -s /usr/share/munin/plugins/tasmota_ /etc/munin/plugins/tasmota_hostname_current
#
# Plugin also implements suggests, so if you have /etc/genders
# populated with "tasmota,powermon" flags for those tasmota devices
# that implement energy monitoring, and nodeattr installed, you can
# run an ansible play like this to set up your links:
# https://github.com/spacelama/ansible-initial-server-setup/tree/master/roles/monitoring/tasks
#
#%# family=auto
#%# capabilities=autoconf
: << =cut
=head1 NAME
tasmota_ - logs voltage, energy usage, power, power factor and current logged from tasmota power switches
To install the plugin, copy or move the plugin to /usr/share/munin/plugins/ set
the chmod to 755 and create a symbolic link:
ln -s /usr/share/munin/plugins/tasmota_ /etc/munin/plugins/tasmota_hostname_voltage
ln -s /usr/share/munin/plugins/tasmota_ /etc/munin/plugins/tasmota_hostname_energy
ln -s /usr/share/munin/plugins/tasmota_ /etc/munin/plugins/tasmota_hostname_power
ln -s /usr/share/munin/plugins/tasmota_ /etc/munin/plugins/tasmota_hostname_powerfactor
ln -s /usr/share/munin/plugins/tasmota_ /etc/munin/plugins/tasmota_hostname_current
Plugin also implements suggests, so if you have /etc/genders
populated with "tasmota,powermon" flags for those tasmota devices
that implement energy monitoring, and nodeattr installed, you can
run an ansible play like this to set up your links:
https://github.com/spacelama/ansible-initial-server-setup/tree/master/roles/monitoring/tasks
=head1 APPLICABLE SYSTEMS
Any host that can access tasmota systems and has "jq" installed. Can
auto suggest values if nodeattr genders (debian: apt install genders)
installed and configured with tasmota,powermon flag.
=head1 AUTHOR
Tim Connors <tconnors@rather.puzzling.org>
=head1 LICENSE
GPLv2 or later
=head1 MAGICK MARKERS
#%# family=auto
#%# capabilities=autoconf
=cut
SWITCH=$(basename "$0" | cut -d_ -f2)
FUNCTION=$(basename "$0" | cut -d_ -f3)