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

NAME

6       powercom - UPS driver for serial 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 serial UPS hardware (as well
15       as a few USB UPS models with USB-to-serial adapters). The most common
16       ones are the Trust 425/625, Powercom, and Advice Partner/King PR750.
17       Others using the same protocol may also work. For USB connections, you
18       might need usbhid-ups(8).
19
20       For more specific guidance on which driver is applicable for a USB
21       connection, see the NUT Hardware Compatibility List (HCL).
22

EXTRA ARGUMENTS

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

DEFAULT VALUES FOR THE EXTRA ARGUMENTS

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

AUTHOR

191       Peter Bieringer <pb@bieringer.de>, Alexey Sidorov
192       <alexsid@altlinux.org>, Keven L. Ates <atescomp@gmail.com>
193

SEE ALSO

195   The core driver:
196       nutupsdrv(8)
197
198   Internet resources:
199       The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
200
201
202
203Network UPS Tools 2.7.3.          12/29/2015                       POWERCOM(8)
Impressum