1POWERCOM(8)                       NUT Manual                       POWERCOM(8)
2
3
4

NAME

6       powercom - UPS driver for Powercom/Trust/Advice UPS equipment
7

NOTE

9       This man page only documents the hardware-specific features of the
10       powercom driver. For information about the core driver, see
11       nutupsdrv(8).
12

SUPPORTED HARDWARE

14       This driver supports many similar kinds of UPS hardware. The most
15       common ones are the Trust 425/625, Powercom, and Advice Partner/King
16       PR750. Others using the same protocol may also work.
17

EXTRA ARGUMENTS

19       This driver supports the following optional settings in the ups.conf(5)
20       file:
21
22       linevoltage=value
23           An integer specifying the line voltage. It can’t be auto detected.
24           Acceptable values are in the range of 110-120 or 220-240. The
25           default is 230.
26
27       manufacturer=name
28           Specify the manufacturer name, which also can’t be auto detected.
29           This is a user defined string, so any name is acceptable. The
30           default is PowerCom.
31
32       modelname=name
33           Specify the model name, which also can’t be auto detected. This is
34           a user defined string, so any name is acceptable. The default is
35           Unknown.
36
37       serialnumber=value
38           Like modelname above, but for the serial number. The default is
39           Unknown.
40
41       type=name
42           The exact type of the communication protocol within the powercom
43           family, that will be used to communicate with the UPS. The type is
44           named after the first modelname that was coded with that protocol.
45           The acceptable names are Trust, Egys, KP625AP, IMP, KIN, BNT, and
46           BNT-other. The default is Trust.
47
48           BNT-other is a special type for other BNT models (such as the 1500A
49           at 120V and can be used to override ALL models using ALL of the
50           following values.
51
52       shutdownArguments={{minutes,seconds},whether_minutes_should_be_used}
53           The minutes and seconds that the UPS should wait between receiving
54           the shutdown command and actually shutting off. The other argument
55           should be set to the character n only when the minutes value should
56           be skipped and not sent to the UPS. The default is type-dependent
57           and is given below. The braces and commas are mandatory. Note that
58           there should be no whitespace characters.
59
60       numOfBytesFromUPS=value
61           The number of bytes in a UPS frame: 16 is common, 11 for Trust. The
62           default is type-dependent and is given below.
63
64       methodOfFlowControl=name
65           The method of serial communication flow control that is engaged by
66           the UPS. The default is type-dependent and is given below.
67           Acceptable names are dtr0rts1, dtr1 or no_flow_control.
68
69       validationSequence={{index1,value1},{index2,value2},{index3,value3}}
70           (Only for types KP625AP, Trust, Egys.) 3 pairs to be used for
71           validating the UPS by comparing bytes of the raw data with constant
72           values. The index selects the byte from the UPS (see
73           numOfBytesFromUPS) and the value is for matching to the byte. The
74           default is type-dependent and is given below. The braces and commas
75           are mandatory, as the lack of white space characters.
76
77       frequency={A,B}
78           (Only for types KP625AP, Trust, Egys.) A pair to convert the raw
79           frequency data to a human-readable frequency reading using the
80           function 1/(A*x+B). If the raw value x IS the frequency, then set
81           A=1/(x^2) and B=0. The default is type-dependent and is given
82           below. Do note that the braces and commas are mandatory as well, as
83           the lack of whitespace characters.
84
85       loadPercentage={BatteryA,BatteryB,LineA,LineB}
86           (Only for types KP625AP, Trust, Egys.) A quad to convert the raw
87           load data to human readable load percentage reading using the
88           function A*x+B. If the raw value x IS the Load Percent, then set
89           A=1 and B=0. The default is type-dependent and is given below. Do
90           note that the braces and commas are mandatory, as the lack of white
91           space characters.
92
93       batteryPercentage={Battery1,Battery2,Battery3,Line4,Line5}
94           (Only for KP625AP, Trust, Egys.) A 5 tuple to convert the raw
95           battery and line data to a human-readable battery and line
96           percentage reading using the functions (Battery) A*x+B*y+C and
97           (Line) D*x+E. If the raw value x IS the Battery Percent, then set
98           A=1, B=0, C=0, D=1, E=0. The default is type-dependent and is given
99           below. Do note that the braces and commas are mandatory, as the
100           lack of white space characters.
101
102       voltage={240A,240B,120A,120B}
103           (Only for types KP625AP, Trust, Egys.) A quad that is used convert
104           the raw voltage data to a human-readable voltage reading using the
105           function A*x+B. If the raw value x IS HALF the Voltage, then set
106           A=2, B=0. The default is type-dependent and is given below. Do note
107           that the braces and commas are mandatory, as well as the lack of
108           whitespace characters.
109

DEFAULT VALUES FOR THE EXTRA ARGUMENTS

111           linevoltage = 230
112           manufacturer = PowerCom
113           modelname = Unknown
114           serialnumber = Unknown
115           type = Trust
116
117       The rest of the default values for the extra arguments are
118       type-dependent. However, BNT-other is a special type that can be used
119       to override ALL values for ALL models.
120
121   Trust
122           numOfBytesFromUPS = 11
123           methodOfFlowControl = dtr0rts1
124           validationSequence = {{5,0},{7,0},{8,0}}
125           shutdownArguments = {{0,10},n}
126           frequency = {0.00020997,0.00020928}
127           loadPercentage = {6.1343,-0.3808,4.3110,0.1811}
128           batteryPercentage = {5.0000,0.3268,-825.00,4.5639,-835.82}
129           voltage = {1.9216,-0.0977,0.9545,0.0000}
130
131   KP625AP
132           numOfBytesFromUPS = 16
133           methodOfFlowControl = dtr0rts1
134           validationSequence = {{5,0x80},{7,0},{8,0}}
135           shutdownArguments = {{0,10},n}
136           frequency = {0.00020997,0.00020928}
137           loadPercentage = {6.1343,-0.3808,4.3110,0.1811}
138           batteryPercentage = {5.0000,0.3268,-825.00,4.5639,-835.82}
139           voltage = {1.9216,-0.0977,0.9545,0.0000}
140
141   Egys
142           numOfBytesFromUPS = 16
143           methodOfFlowControl = no_flow_control
144           validationSequence = {{5,0x80},{7,0},{8,0}}
145           shutdownArguments = {{0,10},n}
146           frequency = {0.00020997,0.00020928}
147           loadPercentage = {6.1343,-0.3808,1.3333,0.6667}
148           batteryPercentage = {5.0000,0.3268,-825.00,2.2105,-355.37}
149           voltage = {1.9216,-0.0977,0.9545,0.0000}
150
151   IMP
152           numOfBytesFromUPS = 16
153           methodOfFlowControl = no_flow_control
154           validationSequence = {{5,0xFF},{7,0},{8,0}}
155           shutdownArguments = {{1,30},y}
156
157   KIN
158           numOfBytesFromUPS = 16
159           methodOfFlowControl = no_flow_control
160           validationSequence = {{11,0x4b},{8,0},{8,0}}
161           shutdownArguments = {{1,30},y}
162
163   BNT
164           numOfBytesFromUPS = 16
165           methodOfFlowControl = no_flow_control
166           validationSequence = {{11,0x42},{8,0},{8,0}}
167           shutdownArguments = {{1,30},y}
168
169   BNT-other
170           numOfBytesFromUPS = 16
171           methodOfFlowControl = no_flow_control
172           validationSequence = {{8,0},{8,0},{8,0}}
173           shutdownArguments = {{1,30},y}
174           frequency = {0.00027778,0.0000}
175           loadPercentage = {1.0000,0.0,1.0000,0.0}
176           batteryPercentage = {1.0000,0.0000,0.0000,1.0000,0.0000}
177           voltage = {2.0000,0.0000,2.0000,0.0000}
178

AUTHOR

180       Peter Bieringer <pb@bieringer.de>, Alexey Sidorov
181       <alexsid@altlinux.org>, Keven L. Ates <atescomp@gmail.com>
182

SEE ALSO

184   The core driver:
185       nutupsdrv(8)
186
187   Internet resources:
188       The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
189
190
191
192Network UPS Tools                 09/15/2011                       POWERCOM(8)
Impressum