Imported Upstream version 2.7.3
This commit is contained in:
Arnaud Quette
parent
a356b56d11
commit
fd413a3168
283 changed files with 14978 additions and 6511 deletions
|
|
@ -1,13 +1,13 @@
|
|||
'\" t
|
||||
.\" Title: apcsmart
|
||||
.\" Author: [see the "AUTHOR" section]
|
||||
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
||||
.\" Date: 02/25/2014
|
||||
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
|
||||
.\" Date: 04/17/2015
|
||||
.\" Manual: NUT Manual
|
||||
.\" Source: Network UPS Tools 2.7.1.5
|
||||
.\" Source: Network UPS Tools 2.7.3
|
||||
.\" Language: English
|
||||
.\"
|
||||
.TH "APCSMART" "8" "02/25/2014" "Network UPS Tools 2\&.7\&.1\&." "NUT Manual"
|
||||
.TH "APCSMART" "8" "04/17/2015" "Network UPS Tools 2\&.7\&.3" "NUT Manual"
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * Define some portability stuff
|
||||
.\" -----------------------------------------------------------------
|
||||
|
|
@ -33,7 +33,7 @@ apcsmart \- Driver for American Power Conversion Smart Protocol UPS equipment
|
|||
.sp
|
||||
\fBapcsmart\fR \-h
|
||||
.sp
|
||||
\fBapcsmart\fR \-a \*(AqUPS_NAME\*(Aq [\-x option=value \&...]
|
||||
\fBapcsmart\fR \-a \fIUPS_NAME\fR [\-x option=value \&...]
|
||||
.if n \{\
|
||||
.sp
|
||||
.\}
|
||||
|
|
@ -52,15 +52,15 @@ This man page only documents the hardware\-specific features of the apcsmart dri
|
|||
.RE
|
||||
.SH "SUPPORTED HARDWARE"
|
||||
.sp
|
||||
The apcsmart driver should recognize (or at the very least work with) majority of Smart\-UPS models \- which includes Smart\-UPS, Matrix\-UPS and Back\-UPS lineups, among few other ones\&.
|
||||
The apcsmart driver should recognize (or at the very least, work with) the majority of Smart\-UPS models \- which includes Smart\-UPS, Matrix\-UPS and Back\-UPS lineups, among few other ones\&.
|
||||
.sp
|
||||
Currently we can roughly divide APC hardware into 3 groups (note that the division isn\*(Aqt strict by any means, and the borders between those are pretty fuzzy):
|
||||
Currently, we can roughly divide APC hardware into four groups (note that the division isn\(cqt strict by any means, and the borders between those are pretty fuzzy):
|
||||
.PP
|
||||
[very] "old" models
|
||||
.RS 4
|
||||
These models usually have old APC logo, white color and
|
||||
\fIno\fR
|
||||
programmable eeprom; You won\*(Aqt find them listed anywhere on APC\(cqs site either\&. The support for those will be usually based on driver\*(Aqs compatibility tables, or if the model (firmware) is not listed in those \- the driver will try to follow the very basic subset of features, while still trying to remain useful\&. Despite "smart" tagname, they often tend to behave in pretty dumb way (see the section below about shutdown behaviour)\&.
|
||||
programmable EEPROM; you won\(cqt find them listed anywhere on APC\(cqs site either\&. The support for those will be usually based on driver\(cqs compatibility tables, or if the model (firmware) is not listed in those \- the driver will try to follow the very basic subset of features, while still trying to remain useful\&. Despite "smart" tagname, they often tend to behave in pretty dumb way (see the section below about shutdown behaviour)\&.
|
||||
.PP
|
||||
\fBExample models:\fR
|
||||
.sp
|
||||
|
|
@ -89,16 +89,52 @@ Smart\-UPS 900I
|
|||
.PP
|
||||
"new" models
|
||||
.RS 4
|
||||
These models usually come from late 1990s / pre\-2009 times\&. They are often referred as "3rd\&. gen"\&. For the most part, they have programmable eeprom, report supported commands and capabilites, and should work just fine with the apcsmart driver\&.
|
||||
These models usually come from late 1990s / pre\-2009 times\&. They are often referred as "3rd\&. gen"\&. For the most part, they have programmable EEPROM, report supported commands and capabilites, and should work just fine with the apcsmart driver\&.
|
||||
.RE
|
||||
.PP
|
||||
"microlink" models
|
||||
.RS 4
|
||||
WARNING: these are not
|
||||
\fInatively\fR
|
||||
supported by apcsmart (or apcupsd for that matter, if you\(cqre wondering)\&. Around 2007 APC (now APC Schneider) decided to go back to its proprietry roots and all the new models (SMT, SMX, SURTD) use completely different protocol and cables\&. If you purchased a new APC UPS, that uses cable with rj45 on the one end, and db\-9 on the other \- then you have such model\&. Your only option to support it through
|
||||
supported by
|
||||
\fBapcsmart\fR
|
||||
(or
|
||||
\fBapcupsd\fR, for that matter, if you\(cqre wondering)\&. Around 2007, APC (now APC Schneider) decided to go back to its proprietry roots, and all the new models (SMT, SMX, SURTD) use completely different protocol and cables\&. If you purchased a new APC UPS \- that uses cable with RJ45 on the one end, and DB\-9 on the other \- then you have such model\&. Your only option to support it through
|
||||
\fBNUT\fR
|
||||
is to purchase "legacy communications card" \- part #AP9620 (google \*(AqAP9620\*(Aq for more details)\&. Or if that\*(Aqs not an option, rely on official software\&.
|
||||
is to purchase a "legacy communications card" \- part #AP9620 (google \*(AqAP9620\*(Aq for more details)\&. Or if that\(cqs not an option, rely on official software\&.
|
||||
.RE
|
||||
.PP
|
||||
Microsol models
|
||||
.RS 4
|
||||
Several Microsol serial models sold in Brazil have been rebranded as APC Back\-UPS, and the model numbers tend to start with "BZ"\&. If you have one of these "Nobreaks", they will not work with the
|
||||
\fBapcsmart\fR
|
||||
driver \- please see the
|
||||
\fBsolis\fR(8)
|
||||
driver instead\&.
|
||||
.PP
|
||||
\fBExample models:\fR
|
||||
.sp
|
||||
.RS 4
|
||||
.ie n \{\
|
||||
\h'-04'\(bu\h'+03'\c
|
||||
.\}
|
||||
.el \{\
|
||||
.sp -1
|
||||
.IP \(bu 2.3
|
||||
.\}
|
||||
Back\-UPS BZ1200\-BR
|
||||
.RE
|
||||
.sp
|
||||
.RS 4
|
||||
.ie n \{\
|
||||
\h'-04'\(bu\h'+03'\c
|
||||
.\}
|
||||
.el \{\
|
||||
.sp -1
|
||||
.IP \(bu 2.3
|
||||
.\}
|
||||
Back\-UPS BZ2200BI\-BR
|
||||
.RE
|
||||
.RE
|
||||
.sp
|
||||
Another thing to remember is that Smart protocol is not USB protocol\&. If you have UPS with both USB and serial ports, then depending on how you connect it, you will need either apcsmart or usbhid\-ups driver\&.
|
||||
|
|
@ -135,7 +171,7 @@ Alternatively, you can also provide it on the command line using:
|
|||
\-x \fBcable\fR=940\-0095B
|
||||
.SH "TTY MODES"
|
||||
.sp
|
||||
By default the driver works in canonical mode, but it showed to be a problem in windows systems\&. Furthermore there\(cqs a possibility of some obscure serial cards or serial\-usb convertes that could cause problems as well\&. You can use \*(Aqttymode=\*(Aq option to force non\-canonical discipline in \fBups.conf\fR(5):
|
||||
By default the driver works in canonical mode, but it proved to be a problem in Windows systems\&. Furthermore there\(cqs a possibility of some obscure serial cards or serial\-USB converters that could cause problems as well\&. You can use \*(Aqttymode=\*(Aq option to force non\-canonical discipline in \fBups.conf\fR(5):
|
||||
.sp
|
||||
\fBttymode\fR=raw
|
||||
.sp
|
||||
|
|
@ -165,7 +201,7 @@ APC hardware supports a lot of shutdown methods, that themselves can differ in b
|
|||
\fBS\fR (soft hibernate)
|
||||
.RS 4
|
||||
This is most basic command present in probably all APC models\&. It will hibernate the UPS, and subsequently wake it up when the mains supply returns\&.
|
||||
\fBThe command doesn\*(Aqt work if UPS is running on mains\&.\fR
|
||||
\fBThe command doesn\(cqt work if the UPS is running on mains\&.\fR
|
||||
.PP
|
||||
"old" models
|
||||
.RS 4
|
||||
|
|
@ -174,7 +210,7 @@ The behaviour here is unfortunately pretty primitive \- when the power returns,
|
|||
.PP
|
||||
"new" models
|
||||
.RS 4
|
||||
The behaviour here is as expected \- the power is cut off after the eeprom defined grace period\&. The UPS will wake up when the power returns, after the eeprom defined delay AND if the eeprom defined min\&. battery charge level is met\&. The delay is counted from the power\*(Aqs return\&.
|
||||
The behaviour here is as expected \- the power is cut off after the EEPROM defined grace period\&. The UPS will wake up when the power returns, after the EEPROM defined delay AND if the EEPROM defined min\&. battery charge level is met\&. The delay is counted from the power\*(Aqs return\&.
|
||||
.RE
|
||||
.RE
|
||||
.PP
|
||||
|
|
@ -206,8 +242,8 @@ If nnn = 000, then UPS will do precisely nothing\&. On those models you\*(Aqre b
|
|||
.PP
|
||||
"new" models
|
||||
.RS 4
|
||||
All the usual variables defined in eeprom are respected (see
|
||||
\fBS\fR)\&. Additionally, if nnn > 0, the nnn*6 minutes are added to eeprom defined delay\&. UPS will not power up if it\*(Aqs running on batteries, contrary to what "old" models used to do \- the combined delay is counted from the moment of power return\&.
|
||||
All the usual variables defined in EEPROM are respected (see
|
||||
\fBS\fR)\&. Additionally, if nnn > 0, the nnn*6 minutes are added to EEPROM defined delay\&. UPS will not power up if it\*(Aqs running on batteries, contrary to what "old" models used to do \- the combined delay is counted from the moment of power return\&.
|
||||
.RE
|
||||
.sp
|
||||
Supposedly there exist models that take 2 digits instead of 3\&. Just in case, NUT also supports such variation\&. You have to provide exactly 2 digits to trigger it (\fBawd\fR
|
||||
|
|
@ -216,7 +252,7 @@ option, or argument to one of the supported instant commands)\&.
|
|||
.PP
|
||||
\fBK\fR (delayed poweroff)
|
||||
.RS 4
|
||||
This is permanent poweroff \- the UPS will not wake up automatically\&. On newer units, it will respect applicable eeprom variables\&.
|
||||
This is permanent poweroff \- the UPS will not wake up automatically\&. On newer units, it will respect applicable EEPROM variables\&.
|
||||
.RE
|
||||
.PP
|
||||
\fBZ\fR (instant poweroff)
|
||||
|
|
@ -366,7 +402,7 @@ Hard hibernate\*(Aqs additional wakeup delay can be provided by \fBawd\fR\&.
|
|||
.RE
|
||||
.SH "IGNORING LB STATE"
|
||||
.sp
|
||||
APC units \- even if they report LB mode \- will not go into shutdown automatically\&. This gives us even more control with reference to "when to actually shutdown psu"\&. Since version 2\&.6\&.2, NUT supports \fBignorelb\fR option in driver\*(Aqs section of \fBups.conf\fR(5)\&. When such option is in effect, the core driver will ignore LB state as reported by specific driver and start shutdown basing the decision \fIonly\fR on two conditions:
|
||||
APC units \- even if they report LB mode \- will not go into shutdown automatically\&. This gives us even more control with reference to "when to actually shutdown PSU"\&. Since version 2\&.6\&.2, NUT supports \fBignorelb\fR option in driver\(cqs section of \fBups.conf\fR(5)\&. When such option is in effect, the core driver will ignore LB state as reported by specific driver and start shutdown basing the decision \fIonly\fR on two conditions:
|
||||
.sp
|
||||
battery\&.charge < battery\&.charge\&.low
|
||||
.sp
|
||||
|
|
@ -376,7 +412,7 @@ battery\&.runtime < battery\&.runtime\&.low
|
|||
.sp
|
||||
Of course \- if any of the variables are not available, the appropriate condition is not checked\&. If you want to explicitly disable one of the conditions, simply override the right hand variable causing the condition to always evaluate to false (you can even provide negative numbers)\&.
|
||||
.sp
|
||||
APC UPSes don\*(Aqt have battery\&.charge\&.low \- you will have to define it if you want to use such condition (prefix the variable with override\&. or default\&.)\&.
|
||||
APC UPSes don\(cqt have battery\&.charge\&.low \- you will have to define it if you want to use such condition (prefix the variable with override\&. or default\&.)\&.
|
||||
.sp
|
||||
"New" units have battery\&.runtime\&.low, but depending on battery quality, firmware version, calibration and UPS load \- this variable can be underestimated quite a bit \- especially right after going into OB state\&. This in turn can cause LB to be asserted, which under normal conditions will cause \fBNUT\fR to initiate the shutdown\&. You might want to disable this condition entirely, when relying on \fBignorelb\fR option (this was actually the main motivation behind introduction of such feature)\&.
|
||||
.sp
|
||||
|
|
@ -535,7 +571,7 @@ calibrate\&.stop
|
|||
.RE
|
||||
.SH "PREVIOUS DRIVER VERSION"
|
||||
.sp
|
||||
Previous driver is still available as apcsmart\-old \- should there be any need to use earlier version (bugs, incompatiblities with new functionality, etc\&.)\&. In due time apcsmart\-old will be phased out completely, but this won\(cqt happen until the new version gets solid exposure with no pending issues\&.
|
||||
Previous driver is still available as \fBapcsmart\-old\fR, should there be any need to use earlier version (bugs, incompatiblities with new functionality, etc\&.)\&. In due time, \fBapcsmart\-old\fR will be phased out completely, but this won\(cqt happen until the new version gets solid exposure with no pending issues\&.
|
||||
.SH "BUGS"
|
||||
.sp
|
||||
Some older APC UPS models return bogus data in the status register during a front panel test\&. This is usually detected and discarded, but some other unexpected values have occasionally slipped through\&.
|
||||
|
|
@ -546,7 +582,7 @@ APC UPS models with both USB and serial ports require a power cycle when switchi
|
|||
Nigel Metheringham <Nigel\&.Metheringham@Intechnology\&.co\&.uk> (drawing heavily on the original apcsmart driver by Russell Kroll)\&. This driver was called newapc for a time and was renamed in the 1\&.5 series\&. In 2\&.6\&.2 it was renamed to apcsmart\-old, being superseded by updated version with new features, which is maintained by Michal Soltys <soltys@ziu\&.info>
|
||||
.SH "SEE ALSO"
|
||||
.sp
|
||||
\fBnutupsdrv\fR(8), \fBups.conf\fR(5)
|
||||
\fBnutupsdrv\fR(8), \fBups.conf\fR(5), \fBusbhid-ups\fR(8), \fBsolis\fR(8)
|
||||
.SS "Internet resources:"
|
||||
.sp
|
||||
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue