OPT_BESTPOWER V. 1.0  - Anbindung einer POWERWARE  
(ehem. BESTPOWER) 3110 USV an den fli4l Router 
-------------------------------------------------

Requirements
------------

1.) USV Typ 3110 der Firma POWERWARE (BESTPOWER) 
    (250VA - 700VA) mit BASIC Communication ! 

2.) Serielles Kabel des USV Herstellers.
    ( basic communication )

3.) FLi4l in der Version 2.0 bis 2.08,
    getestet wurde 2.01, 2.06,7 und 8.
    
4.) Anerkennung der Lizenz fr die Software CheckUPS II
    BASIC von 1997, Eingetragenes Warenzeichen
    der Firma Best Power.
    Wir berufen uns auf Punkt 3 der LIZENSBESTIMMUNGEN:
    "Transfer the program and license to another party
     if the other party agrees to accept the terms and
     conditions of this agreement."
     
    Nheres siehe unten unter "***LICENSE***" 
    
    Die vollstndige Lizenzdefinition, sowie die Programm-
    anleitung entnehmen Sie bitte dem text:"BASIC.TXT"
    der sich in diesem Verzeichnis befindet.
    Sollten Sie irgendwelche Einwnde gegen die Lizenz
    -bestimmungen der Firma BEST POWER haben ,so lschen
    Sie dieses Paket unverzglich ! 
    
---------------- !! ACHTUNG !! ---------------------------   
              
   in der base.txt muss die Opt-Partition beschreibbar sein
   =>  MOUNT_OPT='rw'
----------------------------------------------------------             

Konfiguration
-------------

OPT_BESTPOWER='yes'   zur Installation der USV Untersttzung

BESTPOWER_ALLOW_TIME='65' 	(Vorgabe) Verzgerungszeit, bis
				das CHECKUPS II Programm aktiv wird.
				Zeit wurde auf 65 Sekunden gestellt, 	
				damit erst nach abgelaufener 
				Recoverytime aktiv.
			
BESTPOWER_COUNTDOWN_TIME='5' 	Hier wird die Zeit in Minuten			
				eingestellt, wie viele Minuten 
				der Kontdown bei Stromausfall
				laufen soll.

Ist die Kontdownzeit abgelaufen, so warnt CHECKUPS II,
dass in einer Minute der Shutdown erfolgt.

Somit betrgt die Zeit bis zum Shutdown BESTPOWER_COUNTDOWN_TIME 
+ 1 Minute. 
	
Nachfolgend knnen max.4 Befehlszeilen definiert werden,
die im Falle des Stromausfalles der Reihe nach abgearbeitet werden.
Haben Sie keinen Bedarf, bestimmte Dienste schon wrend der 
Countdownzeit zu beenden, so knnen die Angaben BESTPOWER_EVENT_X
leer bleiben. (wie bei Event_3 zu sehen.)
Sinn macht die Definition , wenn ein Serverdienst z.B. bis 180 Sekunden
fr ein sanftes Beenden bentigt.
Dieser wird dann z.B. unter EVENT_1_TIME mit 0 (= sofort ausfhren)
oder 4 (= vier Minuten vor Countdownende) eingetragen.
Die angaben mssen in vollen Minuten erfolgen und sollten
zwischen 1 (= 1 Minute vor Countdownende) und BESTPOWER_COUNTDOWN_TIME
liegen. 
 					
BESTPOWER_EVENT_1='/usr/local/bin/mldaliveoff.sh'
BESTPOWER_EVENT_2='/usr/local/bin/mldstop.sh'
BESTPOWER_EVENT_3=''       
BESTPOWER_EVENT_4='/usr/local/bin/mldbackup.sh'
				
BESTPOWER_EVENT_1_TIME='0'	0 = Unverzglich, wenn festgestellt wird,
			        da das System auf Notstrom luft 
			        
BESTPOWER_EVENT_2_TIME='4'     # 4 = Fhre EVENT_2 4 Minuten
			       # vor UPS Shutdown aus.
		
BESTPOWER_EVENT_3_TIME=''      # leer = EVENT_3 nicht ! ausfhren.
				
BESTPOWER_EVENT_4_TIME='2'     # 2 = Fhre EVENT_4 2 Minuten
			       # vor UPS Shutdown aus.	
			       
Sollte der Stromausfall nicht bis zum Ende des Countdown anhalten,
so wird kein Shutdown eingeleitet und dies im Protokoll vermerkt.
ber nachvolgende vier BESTPOWER_BACK_EVENT Definitionen ist es
mglich, z.B. Serverdienste wieder zu starten.

(In dem Beispiel unten wird der 'Donkeyschupser' neu gestartet,
der den rest erledigt )  			       
			   				       

BESTPOWER_BACK_EVENT_1='/usr/local/bin/mldalive.sh'
BESTPOWER_BACK_EVENT_2=''      # kein EVENT vorhanden  
BESTPOWER_BACK_EVENT_3=''      # kein EVENT vorhanden
BESTPOWER_BACK_EVENT_4=''      # kein EVENT vorhanden

				
BESTPOWER_SLEEP_TIME='30'	Wert in Sekunden, der vorgibt,
				in welchen Abstnden das 
				CHECKUPS II Programm den USV
				Status abfragt.	
				
BESTPOWER_LBALARM='no'		(Vorgabe) Wird dieser Wert auf
				'yes' gesetzt, wird KEIN !
				Herunterfahren (halt) eingeleitet.					
				Das CHECKUPS II Programm schreibt
				jedoch weiterhin seine Logdatei.
				( im Verz. /etc/best ) 
				
BESTPOWER_PORT='com1'           Routerport, der mit der USV verbunden 
				ist: com1, com2, ..
				
BESTPOWER_TTY='3'               CHECKUPS II Statusanzeige auf Konsole 3. 
				Achtung: Konsole wird exklusiv bentigt.
				Konsole 2 ist fr recovery Status 
				reserviert.	
				
BESTPOWER_LOG='yes'            # Soll ein Logfile erstellt werden ? 

BESTPOWER_LOGDIR='/hda4/log'   # Wohin mit der Logdatei ? ( e.g. /var/log )
			        							
				
				
Funktionen:
----------- 

Durch ein Fli4l Script wird das Programm CHECKUPS II Version 2.0 
von der Firma BEST POWER gestartet. Dieses berwacht unter Bercksichtigung
der in der fli4l config gemachten Parameter die angeschlossene
USV und fhrt den Router bei Stromausfall bei Bedarf herunter.

Ausserdem wird regelmssig nachgeschaut, ob ein Dienst x Minuten
vor Ende Countdown zu beenden ist. Ist dies der Fall, so wird eine
entsprechende Meldung bzw. ein Logeintrag vorgenommen. (oder beides)

Wird innerhalb der Countdownzeit die Netzspannung wiederhergestellt,
so wird der Countdown gestoppt und eventuell definierte Befehle
unter 'BESTPOWER_BACK_EVENT' ausgefhrt.

Desweiteren Protokolliert CHECKUPS II alle vom Normalbetrieb
abweichenden Zustnde im Zeitinterwall, der durch den Parameter
BESTPOWER_SLEEP_TIME='30' vorgegeben wurde. (hier:alle 30 Sekunden) 

Die  CHECKUPS II Einstellungen knnen auf Konsole, wie angegeben,
(z.B.3) eingesehen werden.
(ALT-F(X)) mit ALT-F1 kommt man auf die Eingabekonsole zurck.
[(ALT-F2) gibt den Recoverystatus wieder] 
				
Bitte darauf achten, da die Konsole X exclusiv fr die CHECKUPS II
Statusausgabe zur verfgung steht.

Auf der Standardkonsole wird ein Shutdown durch die USV gemeldet.

Alle weiteren Statusausgaben werden auf der angegebenen Konsole, sowie
in dem Logfile protokolliert


--------- Hinweis zur Einstellung BESTPOWER_COUNTDOWN_TIME -------

Die vorgegebene Zeit von 5 Minuten (6 Minuten bis Shutdown !)
ist nur bei Systemen ohne Monitor bei einer kleinen USV von 250~ VA Sinnvoll.
( dies ist jedoch bei den meisten Routern der Fall, da diese
ohne Monitor betrieben werden. ) 
Sollte das System nicht in der Lage sein, die vorgegebene Zeit
"Durchzuhalten", so wird ein vorzeitiges Herunterfahren des Systems
initialisiert. im Protokoll (und auf der entsprechenden Konsole )
wird dies mit der Meldung:

ALARM: CheckUPS hat einen schwachen USV AKKU erkannt !!!
ALARM: Das System wird JETZT!! heruntergefahren !!! 

vermerkt.

Der eigendliche Shutdownvorgang wird mit der Meldung:
Starte USV initialisierten Shutdown...
im Log protokolliert.

Auf der Konsole 1 wird ebenfalls dies signalisiert:
Shutdown von USV eingeleitet...

  
 			 

Bekannte Bugs:
--------------

Sollte nach Routerstart die Kommunikation mit der USV nicht funktionieren,
so kann dies verschiedene Ursachen haben.
(wir gehen davon aus, da die Schnittstellenkonfiguration i.O. ist) 
1.) Das Kabel ist nicht geeignet. (Kein pasendes USV Kabel der Fa. Bestpower)
2.) Der COM Port arbeitet als Highspeed Port. Die USV ist mit der Geschwindigkeit
    berfordert. (Keine USV erkannt) 
3.) Es gibt unterschiedliche Kabelversionen, die mit bestimmten Comm Ports arbeiten.
(bzw. nicht arbeiten. Wir kennen bisher zwei Versionen, die nur RECHNERSPEZIFISCH/
SCHNITTSTELLENSPEZIFISCH funktionierten !!)  
Abhilfe. 
a) Tauschen Sie das Kabel.
b) verwenden Sie eine (ltere) IO Karte mit COM1 oder COM2 (3F8 an IRQ4 oder 2F8 an IRQ3).
Die Software funktioniert, wenn die Kommunikationsparameter stimmen !
Detailliertere Ausknfte holen Sie bitte beim Distributor, der Ihnen die POWERWARE USV 3110
verkauft hat, ein.
   
Hin und wieder kommt es, obwohl alles passt, dennoch zu dem Fehler, da die USV nicht
initialisiert werden konnte.     
Nach einem erneuten Start der CHECKUPSII drfte das Problem nicht mehr vorhanden sein.



***LICENSE***

You may:

  1. Use the program on a single computer.

  2. Merge other programs with the program as specified in the enclosed
     materials for your use on a computer. The program merged with another will
     continue to be subject to the terms and conditions of this agreement.
  3. Transfer the program and license to another party if the other party agrees to accept the terms and
     conditions of this agreement.

EXCEPT AS EXPRESSLY PROVIDED IN THIS LICENSE AGREEMENT, YOU MAY NOT TRANSFER,
MERGE, COPY OR MODIFY THE PROGRAM. 

***TERM***

 Terminating the license does not eliminate any prior failure on your part
to comply with any term or condition of this agreement. You agree further
upon termination todestroy the program together with any copies,
modifications and/or merged portions in any form.

***LIMITED WARRANTY***


EXCEPT FOR THE WARRANTY SET FORTH ABOVE, THE PROGRAM IS LICENSED "AS IS," AND
BEST POWER DISCLAIMS ANY AND ALL OTHER WARRANTIES, WHETHER EXPRESSED OR
IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

***LIMITATION OF REMEDIES***


In no event will Best Power be liable to you for any indirect, incidental,
consequential, special, or exemplary damages or lost profits, even if advised
of the possibility of such damages.

***OTHER***

THIS AGREEMENT WILL BE GOVERNED BY THE LAWS OF THE STATE OF WISCONSIN.

YOU ACKNOWLEDGE THAT YOU HAVE READ THIS AGREEMENT, UNDERSTAND IT AND AGREE TO
BE BOUND BY ITS TERMS AND CONDITIONS.  YOU FURTHER AGREE THAT THIS IS THE
SOLE AGREEMENT BETWEEN US AND SUPERSEDES ANY PROPOSAL OR AGREEMENT ORAL OR
WRITTEN BETWEEN US RELATING TO THE SUBJECT MATTER.

SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR
CONSEQUENTIAL OR INCIDENTAL DAMAGES, SO THE ABOVE LIMITATIONS MAY NOT APPLY
TO YOU.


U.S. GOVERNMENT RESTRICTED RIGHTS

The Software and accompanying materials are provided with RESTRICTED RIGHTS.
Use, duplication, or disclosure by the government is subject to restrictions
as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and
Computer Software clause DFARS 252.227-7013 or the Commercial Computer
Software Restricted Rights clause at FAR 52.227-19 subdivision (c)(1) and (2),
as applicable. Contractor is Best Power, P.O. Box 280, Necedah, WI 54646. 


*****Trademarks*****

CheckUPS is a registered trademark of Best Power. 
All other brand and product names are trademarks or registered trademarks of
their respective holders.
