User Tools

Site Tools


supported_hardware:apc

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
supported_hardware:apc [2018/11/17 15:13]
James Sentman [XTension Units]
supported_hardware:apc [2020/02/18 18:46] (current)
James Sentman [Install APCUPSD]
Line 67: Line 67:
 static ip_address=192.168.0.91/​24 static ip_address=192.168.0.91/​24
 static routers=192.168.0.1 static routers=192.168.0.1
-status ​domain_name_server=192.168.0.1 8.8.8.8 fd51:​42f8:​caae:​d92e::​1+static ​domain_name_server=192.168.0.1 8.8.8.8 fd51:​42f8:​caae:​d92e::​1
 </​code>​ </​code>​
  
Line 93: Line 93:
 sudo nano /​etc/​default/​apcupsd sudo nano /​etc/​default/​apcupsd
  
-and change the single line from “isconfigured=no” to “isconfigured=yet” and save the file.+and change the single line from “isconfigured=no” to “isconfigured=yes” and save the file.
  
 ====Configure APCUPSD==== ====Configure APCUPSD====
Line 223: Line 223:
  
 **Humidity**:​ The humidity of the room. **Humidity**:​ The humidity of the room.
 +
 +====Interface Script====
 +
 +If you have installed the user scripts above then you can trap all broadcast events from the UPS inside the Interface Script. In the Edit Interface window click the “Edit” button for the interface script. Then use the “Insert...” toolbar button to insert the “UPS Event Handler” The AppleScript code that is inserted will give you a full list of the known events though depending on your model there may be others that could be sent as well.
 +
 +Some of the events are also reflected as Unit changes such as the power fail and error messages. Others can only be caught by installing this handler.
 +
 +<​code>​
 +(*
 + U P S   E V E N T   H A N D L E R
 +
 + Called when the UPS sends a broadcast event. This is where you 
 + can trap events other than those that have units associated
 + with them. In order to receive these you must have installed the
 + xtevent script on the raspberry pi.
 +
 + EventName will be one of the following:
 +
 + annoyme ​
 + If we were letting the UPS shutdown our machine this is the alert that it is about
 + to happen. The events scripts stop the shutdown from happening however.
 + changeme
 + The battery needs changing. If we were allowing system shutdown that would happen next.
 + This event also turns on the ERROR unit.
 + commfailure
 + The UPS is no longer responding, possibly unplugged the USB cable?
 + This event also turns on the ERROR unit.
 + commok
 + Only sent after a commfailure event, the UPS is now responding.
 + doshutdown
 + When the config time limits or battery levels have dropped to the point that if it
 + were automatically going to shutdown it would now be doing so.
 + emergency
 + While in the software, nobody knows what would generate an emergency shutdown.
 + failing
 + The batteries are exhausted. The next event will be doshutdown.
 + loadlimit
 + The battery charge is below the low limit set in the config file.
 + The next event will be doshutdown
 + powerout
 + This is sent immediately when the power fails. It can also be generated during
 + a self test of the UPS.
 + onbattery
 + Send 5 or 6 seconds after the powerout event if the power has not returned. ​
 + This could be used to filter self test events. The timing of this can be set
 + in the config file.
 + offbattery
 + Send when power returns but only if the power has been off long enough to generate
 + the onbattery event.
 + mainsback
 + The power has returned
 + runlimit
 + The Time Left property of the battery has fallen below the configured value.
 + timeout
 + The maximum time on battery value in the configuration has expired.
 + startselftest
 + A self test has been detected. This may not be reliable depending on the onbattery timing
 + endselftest
 + The end of a self test has been detected.
 + battdetatch
 + The batteries have been disconnected
 + battattach
 + The batteries are reconnected
 +*)
 +
 +on UPSEvent( EventName)
 +  write log "UPS Event Received: " & EventName
 +end UPSEvent
 +
 +
 +</​code>​
  
 ====History==== ====History====
   * The apcupsd plugin first appeared in XTension 9.4.12 on Oct 2nd 2018 and is written by James Sentman   * The apcupsd plugin first appeared in XTension 9.4.12 on Oct 2nd 2018 and is written by James Sentman
   * Version 2.0 of the plugin added support for realtime event reception of power fails and other messages. It also stops the ups software from shutting down the pi and killing the power from the UPS early. It was released in XTension version 9.4.13 in November of 2018.    * Version 2.0 of the plugin added support for realtime event reception of power fails and other messages. It also stops the ups software from shutting down the pi and killing the power from the UPS early. It was released in XTension version 9.4.13 in November of 2018. 
supported_hardware/apc.1542467593.txt.gz · Last modified: 2018/11/17 15:13 by James Sentman