Apcupsd - Revision history

John3-16: Added See also: Nut-ups

2025-12-21T07:56:10Z

Added See also: Nut-ups

← Older revision		Revision as of 07:56, 21 December 2025
Line 82:		Line 82:

	Further configuration can be done to initiate automatic shutdown using the parameters in {{Path\|apcupsd.conf}} (see the original commented file {{Path\|apcupsd.conf~}} for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].		Further configuration can be done to initiate automatic shutdown using the parameters in {{Path\|apcupsd.conf}} (see the original commented file {{Path\|apcupsd.conf~}} for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].

			== See also ==
			* [[Nut-ups]]

	[[Category:Monitoring]]		[[Category:Monitoring]]
	[[Category:System Administration]]		[[Category:System Administration]]
	[[Category:Networking]]		[[Category:Networking]]

John3-16: 1. Added categories: Monitoring, System Administration, Networking; 2. Amended style, grammar

2025-12-20T05:01:25Z

1. Added categories: Monitoring, System Administration, Networking; 2. Amended style, grammar

← Older revision		Revision as of 05:01, 20 December 2025
Line 1:		Line 1:
	== Using apcupsd to Monitor a USB-Attached APC UPS ==		== Using apcupsd to Monitor a USB-Attached APC UPS ==

	This wiki page shows how to install and configure the apcupsd package to monitor and report the statistics for an APC branded USB attached Uninterruptible Power Supply (UPS). The UPS model used in the examples is an APC SmartUPS 1000, but any APC or compatible model should work.		This wiki page shows how to install and configure the {{Pkg\|apcupsd}} package to monitor and report the statistics for an APC-branded, USB-attached ''Uninterruptible Power Supply'' (UPS). The UPS model used in the following examples is an APC SmartUPS 1000, but any APC or compatible model should work.

	The end goal is to make the UPS status available over the network so it can be monitored and used to trigger actions in a home automation system like [https://www.home-assistant.io/ Home Assistant].		The end goal is to make the UPS status available over the network so that it can be monitored and used to trigger actions in a home automation system like [https://www.home-assistant.io/ Home Assistant].

	=== Installing and Configuring apcupsd ===		=== Installing and Configuring apcupsd ===

	The first step is to add the ~~alpine~~ package for apcupsd. After that, we'll rename the default configuration file and replace ~~them~~ with the parameters needed for our example USB attached APC Smart-UPS.		The first step is to add the Alpine Linux package for '''apcupsd'''. After that, we'll rename the default configuration file and replace it with the parameters needed for our example USB-attached APC Smart-UPS.

	Installation is by an APK package:		Installation is by an APK package:

	{{cmd\|# apk add ~~{{pkg\|~~apcupsd}}}}		{{cmd\|# apk add apcupsd}}

	There is one main configuration file ~~called ''~~/etc/apcupsd/apcupsd.conf~~'' that~~ has all the tunable parameters along with many comments. We~~'ll~~ keep the original as a reference and then edit the parameters to suit.		There is one main configuration file: {{Path\|/etc/apcupsd/apcupsd.conf}}. It has all of the tunable parameters, along with many comments. We will keep the original as a reference and then edit the parameters to suit.

	{{cmd\|<nowiki># mv /etc/apcupsd/apcupsd.conf /etc/apcupsd/apcupsd.conf~		{{cmd\|<nowiki># mv /etc/apcupsd/apcupsd.conf /etc/apcupsd/apcupsd.conf~
Line 25:		Line 25:
	* DEVICE - For a USB attached UPS, the parameter is not needed. Comment this line by using a # at the beginning.		* DEVICE - For a USB attached UPS, the parameter is not needed. Comment this line by using a # at the beginning.

	These four changes are enough to get started. Everything else can be left as default. Read the comments in the original {{path\|apcupsd.conf~}} file to find out what the other parameters do and if you want to use them.		These four changes are enough to get started. Everything else can be left as default. Read the comments in the original {{path\|apcupsd.conf~}} file to find out what the other parameters do and to decide whether you want to use them.

	{{Note\|The comments in the config file say UPSNAME should be eight characters or less. This appears to be a limitation of using the parameter for storing the name in the UPS's EPROM. If you're not planning to update EPROM, longer names do not appear to cause problems. See the config section after ''Configuration statements used in updating the UPS EPROM'' for more detail. }}		{{Note\|The comments in the config file say that UPSNAME should be eight characters or less. This appears to be a limitation about using the parameter for storing the name in the UPS's EPROM. If you're not planning to update EPROM, longer names do not appear to cause problems. See the config section after ''Configuration statements used in updating the UPS EPROM'' for more detail. }}

	== Starting apcupsd ==		== Starting apcupsd ==

	The apcupsd package installs a service that allows you to control apcupsd using the standard tools. The following example shows how to start it and ensure it starts each time the system boots.		The '''apcupsd''' package installs a service that allows you to control '''apcupsd''' using the standard tools. The following example shows how to start it and ensure it starts each time that the system boots.

	<nowiki>		<nowiki>
Line 42:		Line 42:
	== Checking the Configuration ==		== Checking the Configuration ==

	The '''apcaccess''' command will communicate with the UPS via the apcupsd daemon's network port and report back what it finds. This is a good way to test your connection and configuration.		The '''apcaccess''' command will communicate with the UPS via the '''apcupsd''' daemon's network port and report back what it finds. This is a good way to test your connection and configuration.

	A successful test will look similar to what's shown below.		A successful test will look similar to what's shown below.
Line 63:		Line 63:
	{{Note\|In order to receive notifications, you must have mail delivery setup and working on your Alpine host. In addition, you should have an alias that sends email intended for root to a regular user. See the Alpine HOWTO [[Small-Time_Email_with_Exim_and_Dovecot]] for help with that.}}		{{Note\|In order to receive notifications, you must have mail delivery setup and working on your Alpine host. In addition, you should have an alias that sends email intended for root to a regular user. See the Alpine HOWTO [[Small-Time_Email_with_Exim_and_Dovecot]] for help with that.}}

	apcupsd will send alerts for important events using shell scripts in the {{path\|/etc/apcupsd}} directory. These scripts and their alert functions are listed below.		'''apcupsd''' will send alerts for important events using shell scripts in the {{path\|/etc/apcupsd}} directory. These scripts and their alert functions are listed below.

	* changeme - sends an alert when batteries have reached the end of their useful life		* changeme - sends an alert when batteries have reached the end of their useful life
Line 81:		Line 81:
	== Next Steps ==		== Next Steps ==

	Further configuration can be done to initiate automatic shutdown using the parameters in apcupsd.conf (see the original commented file apcupsd.conf~ for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].		Further configuration can be done to initiate automatic shutdown using the parameters in {{Path\|apcupsd.conf}} (see the original commented file {{Path\|apcupsd.conf~}} for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].

			[[Category:Monitoring]]
			[[Category:System Administration]]
			[[Category:Networking]]

Zcrayfish: /* Configuring and Testing Email Alerts */ Use path and cmd templates as appropriate.

2024-10-14T22:29:28Z

Configuring and Testing Email Alerts: Use path and cmd templates as appropriate.

← Older revision		Revision as of 22:29, 14 October 2024
Line 63:		Line 63:
	{{Note\|In order to receive notifications, you must have mail delivery setup and working on your Alpine host. In addition, you should have an alias that sends email intended for root to a regular user. See the Alpine HOWTO [[Small-Time_Email_with_Exim_and_Dovecot]] for help with that.}}		{{Note\|In order to receive notifications, you must have mail delivery setup and working on your Alpine host. In addition, you should have an alias that sends email intended for root to a regular user. See the Alpine HOWTO [[Small-Time_Email_with_Exim_and_Dovecot]] for help with that.}}

	apcupsd will send alerts for important events using shell scripts in the /etc/apcupsd directory. These scripts and their alert functions are listed below.		apcupsd will send alerts for important events using shell scripts in the {{path\|/etc/apcupsd}} directory. These scripts and their alert functions are listed below.

	* changeme - sends an alert when batteries have reached the end of their useful life		* changeme - sends an alert when batteries have reached the end of their useful life
Line 73:		Line 73:
	All of the scripts have a similar setup and rely on two environment variables, SYSADMIN and APCUPSD_MAIL, to deliver email alerts. To test the alerts, temporarily export these two variables and run one of the scripts from the command-line. The example below shows how to send a test alert for battery change.		All of the scripts have a similar setup and rely on two environment variables, SYSADMIN and APCUPSD_MAIL, to deliver email alerts. To test the alerts, temporarily export these two variables and run one of the scripts from the command-line. The example below shows how to send a test alert for battery change.

	~~alpine:/~~# export SYSADMIN=root		{{cmd\|<nowiki># export SYSADMIN=root
	~~alpine:/~~# export APCUPSD_MAIL=mail		# export APCUPSD_MAIL=mail
	~~alpine:/~~# sh /etc/apcupsd/changeme</nowiki>		# sh /etc/apcupsd/changeme</nowiki>}}

	If all goes well, you should receive an email telling you the UPS battery needs changing NOW. If you find you need to use different values for SYSADMIN or APCUPSD_MAIL, be sure to make those changes in ''/etc/apcupsd/apccontrol''. The exported variables used in the test are temporary and will lost after you log out.		If all goes well, you should receive an email telling you the UPS battery needs changing NOW. If you find you need to use different values for SYSADMIN or APCUPSD_MAIL, be sure to make those changes in {{path\|/etc/apcupsd/apccontrol}}. The exported variables used in the test are temporary and will lost after you log out.

	== Next Steps ==		== Next Steps ==

	Further configuration can be done to initiate automatic shutdown using the parameters in apcupsd.conf (see the original commented file apcupsd.conf~ for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].		Further configuration can be done to initiate automatic shutdown using the parameters in apcupsd.conf (see the original commented file apcupsd.conf~ for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].

Zcrayfish: /* Installing and Configuring apcupsd */ Use cmd, path, and pkg templates, ass appropriate.

2024-10-14T22:26:40Z

Installing and Configuring apcupsd: Use cmd, path, and pkg templates, ass appropriate.

← Older revision		Revision as of 22:26, 14 October 2024
Line 9:		Line 9:
	The first step is to add the alpine package for apcupsd. After that, we'll rename the default configuration file and replace them with the parameters needed for our example USB attached APC Smart-UPS.		The first step is to add the alpine package for apcupsd. After that, we'll rename the default configuration file and replace them with the parameters needed for our example USB attached APC Smart-UPS.

	Installation is by an APK package.		Installation is by an APK package:

	~~<nowiki>~~		{{cmd\|# apk add {{pkg\|apcupsd}}}}
	~~alpine:/~~# ~~apk update &&~~ apk add apcupsd~~</nowiki>~~

	There is one main configuration file called ''/etc/apcupsd/apcupsd.conf'' that has all the tunable parameters along with many comments. We'll keep the original as a reference and then edit the parameters to suit.		There is one main configuration file called ''/etc/apcupsd/apcupsd.conf'' that has all the tunable parameters along with many comments. We'll keep the original as a reference and then edit the parameters to suit.

	<nowiki>		{{cmd\|<nowiki># mv /etc/apcupsd/apcupsd.conf /etc/apcupsd/apcupsd.conf~
	~~alpine:/~~# mv /etc/apcupsd/apcupsd.conf /etc/apcupsd/apcupsd.conf~		# grep -v '^\s$\\|^\s\#' /etc/apcupsd/apcupsd.conf~ >/etc/apcupsd/apcupsd.conf</nowiki>}}
	~~alpine:/~~# grep -v '^\s$\\|^\s\#' /etc/apcupsd/apcupsd.conf~ >/etc/apcupsd/apcupsd.conf</nowiki>

	Now, edit the parameters in ''/etc/apcupsd/apcupsd.conf'' using the backup copy of the original file as a reference for comments. Some of the important parameters are listed below in order of appearance.		Now, edit the parameters in {{path\|/etc/apcupsd/apcupsd.conf}} using the backup copy of the original file as a reference for comments. Some of the important parameters are listed below in order of appearance.

	* UPSNAME - This is to identify your UPS. Exact format is not important, but keep it short and don't use spaces.		* UPSNAME - This is to identify your UPS. Exact format is not important, but keep it short and don't use spaces.
Line 27:		Line 25:
	* DEVICE - For a USB attached UPS, the parameter is not needed. Comment this line by using a # at the beginning.		* DEVICE - For a USB attached UPS, the parameter is not needed. Comment this line by using a # at the beginning.

	These four changes are enough to get started. Everything else can be left as default. Read the comments in the original ''apcupsd.conf~'' file to find out what the other parameters do and if you want to use them.		These four changes are enough to get started. Everything else can be left as default. Read the comments in the original {{path\|apcupsd.conf~}} file to find out what the other parameters do and if you want to use them.

	{{Note\|The comments in the config file say UPSNAME should be eight characters or less. This appears to be a limitation of using the parameter for storing the name in the UPS's EPROM. If you're not planning to update EPROM, longer names do not appear to cause problems. See the config section after ''Configuration statements used in updating the UPS EPROM'' for more detail. }}		{{Note\|The comments in the config file say UPSNAME should be eight characters or less. This appears to be a limitation of using the parameter for storing the name in the UPS's EPROM. If you're not planning to update EPROM, longer names do not appear to cause problems. See the config section after ''Configuration statements used in updating the UPS EPROM'' for more detail. }}

Dhorton: /* Configuring and Testing Email Alerts */

2024-10-12T15:48:11Z

Configuring and Testing Email Alerts

← Older revision		Revision as of 15:48, 12 October 2024
Line 79:		Line 79:
	alpine:/# sh /etc/apcupsd/changeme</nowiki>		alpine:/# sh /etc/apcupsd/changeme</nowiki>

	If all goes well, you should receive an email telling you the UPS battery needs changing NOW. If you find you need to use different values for SYSADMIN or APCUPSD_MAIL, be sure to make those changes in /etc/apcupsd/apccontrol. The exported variables used in the test are temporary and will lost after you log out.		If all goes well, you should receive an email telling you the UPS battery needs changing NOW. If you find you need to use different values for SYSADMIN or APCUPSD_MAIL, be sure to make those changes in ''/etc/apcupsd/apccontrol''. The exported variables used in the test are temporary and will lost after you log out.

	== Next Steps ==		== Next Steps ==

	Further configuration can be done to initiate automatic shutdown using the parameters in apcupsd.conf (see the original commented file apcupsd.conf~ for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].		Further configuration can be done to initiate automatic shutdown using the parameters in apcupsd.conf (see the original commented file apcupsd.conf~ for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].

Dhorton at 15:46, 12 October 2024

2024-10-12T15:46:52Z

← Older revision		Revision as of 15:46, 12 October 2024
Line 79:		Line 79:
	alpine:/# sh /etc/apcupsd/changeme</nowiki>		alpine:/# sh /etc/apcupsd/changeme</nowiki>

	If all goes well, you should receive an email telling you the UPS battery needs changing NOW.		If all goes well, you should receive an email telling you the UPS battery needs changing NOW. If you find you need to use different values for SYSADMIN or APCUPSD_MAIL, be sure to make those changes in /etc/apcupsd/apccontrol. The exported variables used in the test are temporary and will lost after you log out.

	== Next Steps ==		== Next Steps ==

	Further configuration can be done to initiate automatic shutdown using the parameters in apcupsd.conf (see the original commented file apcupsd.conf~ for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].		Further configuration can be done to initiate automatic shutdown using the parameters in apcupsd.conf (see the original commented file apcupsd.conf~ for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].

Dhorton at 15:41, 12 October 2024

2024-10-12T15:41:36Z

@@ Line 1: / Line 1: @@
 == Using apcupsd to Monitor a USB-Attached APC UPS ==
@@ Line 43: / Line 41: @@
   alpine:/# rc-update add apcupsd
   * service apcupsd added to runlevel default</nowiki>
 == Configuring and Testing Email Alerts ==
@@ Line 66: / Line 83: @@
 == Next Steps ==
-Further configuration can be done to initiate automatic shutdown using the parameters in apcupsd.conf (see the original commented file for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].
+Further configuration can be done to initiate automatic shutdown using the parameters in apcupsd.conf (see the original commented file apcupsd.conf~ for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].

Dhorton at 15:26, 12 October 2024

2024-10-12T15:26:18Z

← Older revision		Revision as of 15:26, 12 October 2024
Line 9:		Line 9:
	=== Installing and Configuring apcupsd ===		=== Installing and Configuring apcupsd ===

	The first step is to add the alpine package. After that, we'll rename the default configuration file and replace them with the parameters needed for our example USB attached APC Smart-UPS.		The first step is to add the alpine package for apcupsd. After that, we'll rename the default configuration file and replace them with the parameters needed for our example USB attached APC Smart-UPS.

	Installation is by an APK package.		Installation is by an APK package.
Line 19:		Line 19:

	<nowiki>		<nowiki>
	alpine:/# cp /etc/apcupsd/apcupsd.conf /etc/apcupsd/apcupsd.conf~		alpine:/# mv /etc/apcupsd/apcupsd.conf /etc/apcupsd/apcupsd.conf~
	alpine:/# grep -v '^\s$\\|^\s\#' /etc/apcupsd/apcupsd.conf~ >/etc/apcupsd/apcupsd.conf</nowiki>		alpine:/# grep -v '^\s$\\|^\s\#' /etc/apcupsd/apcupsd.conf~ >/etc/apcupsd/apcupsd.conf</nowiki>

Line 29:		Line 29:
	* DEVICE - For a USB attached UPS, the parameter is not needed. Comment this line by using a # at the beginning.		* DEVICE - For a USB attached UPS, the parameter is not needed. Comment this line by using a # at the beginning.

	These four changes are enough to get started. Everything else can be left as default. Read the comments in the original ''apcupsd.conf~'' file to find out what the other parameters do.		These four changes are enough to get started. Everything else can be left as default. Read the comments in the original ''apcupsd.conf~'' file to find out what the other parameters do and if you want to use them.

			{{Note\|The comments in the config file say UPSNAME should be eight characters or less. This appears to be a limitation of using the parameter for storing the name in the UPS's EPROM. If you're not planning to update EPROM, longer names do not appear to cause problems. See the config section after ''Configuration statements used in updating the UPS EPROM'' for more detail. }}

	== Starting apcupsd ==		== Starting apcupsd ==

	The apcupsd package installs a service that allows you to control apcupsd using the standard tools. The following example shows how to start it and ensure it starts each time the system boots.		The apcupsd package installs a service that allows you to control apcupsd using the standard tools. The following example shows how to start it and ensure it starts each time the system boots.

Line 42:		Line 45:

	== Configuring and Testing Email Alerts ==		== Configuring and Testing Email Alerts ==

	{{Note\|In order to receive notifications, you must have mail delivery setup and working on your Alpine host. In addition, you should have an alias that sends email intended for root to a regular user. See the Alpine HOWTO [[Small-Time_Email_with_Exim_and_Dovecot]] for help with that.}}		{{Note\|In order to receive notifications, you must have mail delivery setup and working on your Alpine host. In addition, you should have an alias that sends email intended for root to a regular user. See the Alpine HOWTO [[Small-Time_Email_with_Exim_and_Dovecot]] for help with that.}}

Line 61:		Line 65:

	== Next Steps ==		== Next Steps ==

	Further configuration can be done to initiate automatic shutdown using the parameters in apcupsd.conf (see the original commented file for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].		Further configuration can be done to initiate automatic shutdown using the parameters in apcupsd.conf (see the original commented file for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].

Dhorton at 14:21, 12 October 2024

2024-10-12T14:21:24Z

← Older revision		Revision as of 14:21, 12 October 2024
Line 61:		Line 61:

	== Next Steps ==		== Next Steps ==
			Further configuration can be done to initiate automatic shutdown using the parameters in apcupsd.conf (see the original commented file for details.) You may also monitor the UPS via home automation using Home Assistant and the [https://www.home-assistant.io/integrations/apcupsd/ APC UPS Daemon integration].

Dhorton at 14:14, 12 October 2024

2024-10-12T14:14:18Z

@@ Line 1: / Line 1: @@
 {{Warning|Work in Progress}}
-== Installing and Configuring apcupsd ==
+== Using apcupsd to Monitor a USB-Attached APC UPS ==
 This wiki page shows how to install and configure the apcupsd package to monitor and report the statistics for an APC branded USB attached Uninterruptible Power Supply (UPS). The UPS model used in the examples is an APC SmartUPS 1000, but any APC or compatible model should work.