Merge pull request #2629 from goodspeed34/gxe_driver

Support for Liebert GXE 1-3KVA series
networkupstools · Sep 23, 2024 · 0f36765 · 0f36765
2 parents 967cb54 + 3c24b6a
commit 0f36765
Show file tree

Hide file tree

Showing 8 changed files with 948 additions and 4 deletions.
diff --git a/NEWS.adoc b/NEWS.adoc
@@ -22,7 +22,6 @@ https://github.com/networkupstools/nut/milestone/9
    the driver binaries to be built once and data mappings to be loaded
    and modernized on the fly [Ported from 42ITy project]
 
-
 PLANNED: Release notes for NUT 2.8.3 - what's new since 2.8.2
 -------------------------------------------------------------
 
@@ -133,6 +132,9 @@ https://github.com/networkupstools/nut/milestone/11
    communication protocol, which supports any UPS shipped with the PSZ-1053
    extension module. [PR #2448]
 
+ - liebert-gxe: added new driver with support for Liebert GXE Series UPS
+   (serial or USB posing as a serial port). [#2629]
+
  - usbhid-ups updates:
    * Support of the `onlinedischarge_log_throttle_hovercharge` in the NUT
      v2.8.2 release was found to be incomplete. [#2423, follow-up to #2215]

diff --git a/data/driver.list.in b/data/driver.list.in
@@ -656,6 +656,7 @@
 
 "Liebert"	"ups"	"2"	"ITON 600VA"	""	"blazer_ser"
 "Liebert"	"ups"	"5"	"UPStation GXT2"	"contact-closure cable"	"liebert"
+"Liebert"	"ups"	"4"	"GXE 1-3kVA"   		"Serial"	"liebert-gxe (experimental)"
 "Liebert"	"ups"	"1"	"GXT2-3000RT230"	""	"liebert-esp2 (experimental)"
 "Liebert"	"ups"	"3"	"PowerSure Personal XT"	"USB"	"usbhid-ups"
 "Liebert"	"ups"	"3"	"PowerSure PSA"	"USB"	"usbhid-ups"

diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am
@@ -497,6 +497,7 @@ SRC_SERIAL_PAGES = \
 	isbmex.txt	\
 	ivtscd.txt	\
 	liebert.txt	\
+	liebert-gxe.txt	\
 	liebert-esp2.txt	\
 	masterguard.txt	\
 	metasys.txt	\
@@ -545,6 +546,7 @@ MAN_SERIAL_PAGES = \
 	isbmex.8	\
 	ivtscd.8	\
 	liebert.8	\
+	liebert-gxe.8	\
 	liebert-esp2.8	\
 	masterguard.8	\
 	metasys.8	\
@@ -596,6 +598,7 @@ HTML_SERIAL_MANS = \
 	isbmex.html	\
 	ivtscd.html	\
 	liebert.html	\
+	liebert-gxe.html\
 	liebert-esp2.html	\
 	masterguard.html	\
 	metasys.html	\

diff --git a/docs/man/liebert-gxe.txt b/docs/man/liebert-gxe.txt
@@ -0,0 +1,63 @@
+LIEBERT-GXE(8)
+===============
+
+NAME
+----
+
+liebert-gxe - Driver for Liebert GXE series UPS, using the YDN23 serial protocol
+
+SYNOPSIS
+--------
+
+*liebert-gxe* -h
+
+*liebert-gxe* -a 'UPS_NAME' ['OPTIONS']
+
+NOTE: This man page only documents the hardware-specific features of the
+liebert-gxe driver.  For information about the core driver, see
+linkman:nutupsdrv[8].
+
+SUPPORTED HARDWARE
+------------------
+
+Tested to work on the following units:
+
+* Liebert GXE 01k00TS1101C00
++
+NOTE: This UPS has an RS-232 port and a USB port. The USB port has an
+ACM interface which functions as a serial port for the host operating
+system. Both ports can be used managing the device.
+
+This is an experimental driver.  You have been warned.
+
+EXTRA ARGUMENTS
+---------------
+
+This driver supports the following optional settings in linkman:ups.conf[5]:
+
+*addr=*'num'::
+Set the address of the UPS -- 01 (default) ~ 99.
+
+*retry=*'num'::
+Set the max times of read failures. (UPS sometimes ignores the incoming
+command and causes driver stales. The driver will ignore *retry* failures if
+occurred in a row. However, this does increase the latency if a real stale
+happened. Default to 3)
+
+AUTHORS
+-------
+
+* Gong Zhile <goodspeed at mailo.cat>
+
+SEE ALSO
+--------
+
+The core driver:
+~~~~~~~~~~~~~~~~
+
+linkman:nutupsdrv[8]
+
+Internet resources:
+~~~~~~~~~~~~~~~~~~~
+
+The NUT (Network UPS Tools) home page: https://www.networkupstools.org/
diff --git a/docs/nut.dict b/docs/nut.dict
@@ -1,4 +1,4 @@
-personal_ws-1.1 en 3215 utf-8
+personal_ws-1.1 en 3220 utf-8
 AAC
 AAS
 ABI
@@ -1391,6 +1391,7 @@ Xfer
 Xlinker
 Xpert
 Xups
+YDN
 YQ
 YV
 YY
@@ -1407,6 +1408,7 @@ Zaika
 Zampieri
 Zawadzki
 ZeroMQ
+Zhile
 abandonware
 abcd
 ablerex
@@ -1967,6 +1969,7 @@ gmake
 gmtime
 gnuplot
 gnutls
+goodspeed
 google
 goto
 gotos
@@ -1984,6 +1987,7 @@ guesstimation
 guez
 gufw
 gui
+gxe
 gz
 gzip
 hal
@@ -2280,6 +2284,7 @@ mDNS
 mS
 macaddr
 macosx
+mailo
 mailx
 mainFrame
 maintainer's

diff --git a/drivers/Makefile.am b/drivers/Makefile.am
@@ -54,7 +54,7 @@ endif
 NUTSW_DRIVERLIST = dummy-ups clone clone-outlet apcupsd-ups skel
 SERIAL_DRIVERLIST = al175 bcmxcp belkin belkinunv bestfcom	\
  bestfortress bestuferrups bestups etapro everups 	\
- gamatronic genericups isbmex liebert liebert-esp2 masterguard metasys	\
+ gamatronic genericups isbmex liebert liebert-esp2 liebert-gxe masterguard metasys	\
  mge-utalk microdowell microsol-apc mge-shut oneac optiups powercom rhino 	\
  safenet nutdrv_siemens-sitop solis tripplite tripplitesu upscode2 victronups powerpanel \
  blazer_ser ivtscd apcsmart apcsmart-old riello_ser sms_ser bicker_ser
@@ -157,6 +157,7 @@ isbmex_LDADD = $(LDADD) -lm
 ivtscd_SOURCES = ivtscd.c
 liebert_SOURCES = liebert.c
 liebert_esp2_SOURCES = liebert-esp2.c
+liebert_gxe_SOURCES = liebert-gxe.c
 masterguard_SOURCES = masterguard.c
 metasys_SOURCES = metasys.c
 metasys_LDADD = $(LDADD) -lm
@@ -399,7 +400,7 @@ dist_noinst_HEADERS = \
  xppc-mib.h huawei-mib.h eaton-ats16-nmc-mib.h eaton-ats16-nm2-mib.h apc-ats-mib.h raritan-px2-mib.h eaton-ats30-mib.h \
  apc-pdu-mib.h apc-epdu-mib.h ever-hid.h eaton-pdu-genesis2-mib.h eaton-pdu-marlin-mib.h eaton-pdu-marlin-helpers.h \
  eaton-pdu-pulizzi-mib.h eaton-pdu-revelation-mib.h emerson-avocent-pdu-mib.h eaton-ups-pwnm2-mib.h eaton-ups-pxg-mib.h legrand-hid.h \
- hpe-pdu-mib.h hpe-pdu3-cis-mib.h powervar-hid.h delta_ups-hid.h generic_modbus.h salicru-hid.h adelsystem_cbi.h eaton-pdu-nlogic-mib.h
+ hpe-pdu-mib.h hpe-pdu3-cis-mib.h powervar-hid.h delta_ups-hid.h generic_modbus.h salicru-hid.h adelsystem_cbi.h eaton-pdu-nlogic-mib.h ydn23.h
 
 # Define a dummy library so that Automake builds rules for the
 # corresponding object files.  This library is not actually built,