├── LICENSE
├── README.md
├── apcupsd-screenshot.png
└── apcupsd.widget.php


/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2021 Joel Marchewka
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # apcupsd-pfsense-widget
 2 | A pfsense widget for the apcupsd daemon
 3 | 
 4 | A simple widget to be used in conjunction with the apcupsd package that displays various information from the apcacess command.
 5 | This was based upon the output of apcacess with a BACKUPS RS 1000
 6 | 
 7 | INSTALLATION
 8 | 
 9 | Copy the apcupsd.widget.php to usr/local/www/widgets/widgets/ on your pfsense installation
10 | 
11 | ![apcupsd-widget-screenshot](https://raw.githubusercontent.com/jmarchewka/apcupsd-pfsense-widget/main/apcupsd-screenshot.png)
12 | 


--------------------------------------------------------------------------------
/apcupsd-screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jmarchewka/apcupsd-pfsense-widget/a0843b4e23e7cad52f77d6099827162618f00663/apcupsd-screenshot.png


--------------------------------------------------------------------------------
/apcupsd.widget.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * apcupsd.widget.php
  5 |  *
  6 |  * MIT License
  7 |  * 
  8 |  * Copyright (c) 2021 Joel Marchewka
  9 |  * 
 10 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 11 |  * of this software and associated documentation files (the "Software"), to deal
 12 |  * in the Software without restriction, including without limitation the rights
 13 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 14 |  * copies of the Software, and to permit persons to whom the Software is
 15 |  * furnished to do so, subject to the following conditions:
 16 |  * 
 17 |  * The above copyright notice and this permission notice shall be included in all
 18 |  * copies or substantial portions of the Software.
 19 |  * 
 20 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 21 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 22 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 23 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 24 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 25 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 26 |  * SOFTWARE.
 27 |  */
 28 | 
 29 | require_once("guiconfig.inc");
 30 | 
 31 | if ($_REQUEST['ajax']) { 
 32 |     $results = shell_exec("apcaccess");
 33 |     if($results !== null) {
 34 | 			$results_for_json=[];
 35 | 			foreach(explode("\n",$results) as $i=>$v) {
 36 | 				$results_for_json[trim(explode(': ',$v)[0])]=trim(explode(': ',$v)[1]);
 37 | 			}
 38 | 			$json_results=json_encode($results_for_json);
 39 | 			echo $json_results;
 40 |     } else {
 41 |         echo json_encode(null);
 42 |     }
 43 | } else {
 44 |     if(($results !== null) && (!is_object(json_decode($results)))) {
 45 |         $results = null;
 46 |     }
 47 | 
 48 | ?>
 49 | <table class="table table-hover table-striped table-condensed">
 50 | 	<tbody>
 51 | 		<tr>
 52 | 			<td>Status</td><td><span id="apcupsd_apcaccess_status"></span></td>
 53 | 		</tr>
 54 | 		<tr>
 55 | 			<td>Line Voltage</td><td><span id="apcupsd_apcaccess_line_v"></span></td>
 56 | 		</tr>
 57 | 		<tr>
 58 | 			<td>Load</td><td>
 59 | 				<div class="progress">
 60 | 					<div id="apcupsd_load_meter" class="progress-bar progress-bar-striped progress-bar-success" role="progressbar" aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%">
 61 | 					</div>
 62 | 				</div>
 63 | 				<span id="apcupsd_load_val"></span>
 64 | 			</td>
 65 | 		</tr>
 66 | 		<tr>
 67 | 			<td>Battery Charge</td><td>
 68 | 				<div class="progress">
 69 | 					<div id="apcupsd_bcharge_meter" class="progress-bar progress-bar-striped progress-bar-success" role="progressbar" aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%">
 70 | 					</div>
 71 | 				</div>
 72 | 				<span id="apcupsd_bcharge_val"></span>
 73 | 			</td>
 74 | 		</tr>
 75 | 		<tr>
 76 | 			<td>Time Remaining</td><td><span id="apcupsd_apcaccess_time_remaining"></span></td>
 77 | 		</tr>
 78 | 		<tr>
 79 | 			<td>Battery Age</td><td><span id="apcupsd_apcaccess_bat_age"></span></td>
 80 | 		</tr>
 81 | 	</tbody>
 82 | </table>
 83 | <a id="apcupsd_apcaccess_refresh" href="#" class="fa fa-refresh" style="display: none;"></a>
 84 | <script type="text/javascript">
 85 | function update_apcupsd_result(results) {
 86 |     if(results != null) {
 87 | 			if (results.STATUS!=undefined) {
 88 | 				var apcupsd_a_stat_var='<i class="fa fa-plug"/>';
 89 | 				$('#apcupsd_apcaccess_status').css('color','green');
 90 | 				if (results.STATUS.includes('ONBATT')) {
 91 | 					apcupsd_a_stat_var='<i class="fa fa-car-battery"/>';
 92 | 					$('#apcupsd_apcaccess_status').css('color','red');
 93 | 				} else if (results.STATUS.includes('CHARGING')) {
 94 | 					apcupsd_a_stat_var='<i class="fa fa-charging-station"/>';
 95 | 					$('#apcupsd_apcaccess_status').css('color','orange');
 96 | 				}
 97 | 				$('#apcupsd_apcaccess_status').html(apcupsd_a_stat_var+"&nbsp;"+results.STATUS);
 98 | 			}
 99 | 			if (results.LINEV!=undefined) {
100 | 				$('#apcupsd_apcaccess_line_v').html('<i class="fa fa-bolt"/>&nbsp;'+results.LINEV);
101 | 			}
102 | 			if (results.LOADPCT!=undefined) {
103 | 				setProgress('apcupsd_load_meter', parseInt(results.LOADPCT));
104 | 				$('#apcupsd_load_val').html(results.LOADPCT);
105 | 			}
106 | 			if (results.BCHARGE!=undefined) {
107 | 				setProgress('apcupsd_bcharge_meter', parseInt(results.BCHARGE));
108 | 				$('#apcupsd_bcharge_val').html('<i class="fa fa-battery-full"/>&nbsp;'+results.BCHARGE);
109 | 			}
110 | 			if (results.TIMELEFT!=undefined) {
111 | 				$('#apcupsd_apcaccess_time_remaining').html('<i class="fa fa-clock-o"/>&nbsp;'+results.TIMELEFT);
112 | 			}
113 | 			if (results.BATTDATE!=undefined) {
114 | 				var apcupsd_battdate_date = new Date(results.BATTDATE);
115 | 				var apcupsd_nowdate_date = Date.now();
116 | 				var apcupsd_battdays=Math.floor((apcupsd_nowdate_date-apcupsd_battdate_date.getTime()) / (1000 * 3600 * 24));
117 | 				var apcupsd_battdays_icon='<i class="fa fa-calendar-check-o"/>';
118 | 				$('#apcupsd_apcaccess_bat_age').css('color','green');
119 | 				if (apcupsd_battdays>730) {
120 | 					apcupsd_battdays_icon='<i class="fa fa-calendar-times-o"/>';
121 | 					$('#apcupsd_apcaccess_bat_age').css('color','orange');
122 | 				} else if(apcupsd_battdays>365) {
123 | 					apcupsd_battdays_icon='<i class="fa fa-calendar-minus-o"/>';
124 | 					$('#apcupsd_apcaccess_bat_age').css('color','red');
125 | 			}
126 | 				
127 | 				$('#apcupsd_apcaccess_bat_age').html(apcupsd_battdays_icon+'&nbsp;'+apcupsd_battdays.toString()+" days");
128 | 			}
129 | 		}
130 | }
131 | 
132 | function update_apcupsd_apcaccess() {
133 |     $.ajax({
134 |         type: 'POST',
135 |         url: "/widgets/widgets/apcupsd.widget.php",
136 |         dataType: 'json',
137 |         data: {
138 |             ajax: "ajax"
139 |         },
140 |         success: function(data) {
141 |             update_apcupsd_result(data);
142 |         },
143 |         error: function() {
144 |             update_apcupsd_result(null);
145 |         },
146 |         complete: function() {
147 |             $('#apcupsd_apcaccess_refresh').off("click").removeClass("fa-spin").click(function() {
148 |                 update_apcupsd_apcaccess();
149 |                 return false;
150 |             });
151 |         }
152 |     });
153 | }
154 | events.push(function() {
155 | 
156 |   update_apcupsd_apcaccess();
157 | 
158 | 	function apcupsd_refresh_callback(s) {
159 | 		update_apcupsd_apcaccess();
160 | 	}
161 | 
162 | 	var postdata = {
163 | 		ajax: "ajax",
164 | 	 };
165 | 
166 | 	var refreshObject = new Object();
167 | 	refreshObject.name = "RefreshAPCUPSD";
168 | 	refreshObject.url = "/widgets/widgets/apcupsd.widget.php";
169 | 	refreshObject.callback = apcupsd_refresh_callback;
170 | 	refreshObject.parms = postdata;
171 | 	refreshObject.freq = 1;
172 | 
173 | 	register_ajax(refreshObject);
174 | 
175 | });
176 | 
177 | </script>
178 | <?php } ?>
179 | 


--------------------------------------------------------------------------------