FreeBSD Manual Pages
APCMICROLINK(8) NUT Manual APCMICROLINK(8) NAME apcmicrolink - Driver for APC Smart-UPS units using the Microlink serial protocol SYNOPSIS apcmicrolink -h apcmicrolink -a UPS_NAME [OPTIONS] Note This man page documents the hardware-specific features of the apcmi- crolink driver. For general information about NUT drivers, see nutups- drv(8). DESCRIPTION The apcmicrolink driver talks the APC Microlink protocol used by newer ser- ial-connected Smart-UPS families such as SMT and SMX units with the Mi- crolink RJ45 serial port. This driver is currently experimental. It discovers most values from the device descriptor blob at runtime and maps supported Microlink objects onto standard NUT variables where possible. Unknown descriptor fields can also be published for debugging and reverse-engineering. SUPPORTED HARDWARE This driver is intended for APC Smart-UPS models that expose the Microlink serial protocol, notably SMT and SMX units with the vendor Microlink serial cable. Tested support currently targets: * APC Smart-UPS SMT/SMX Microlink models Other APC Microlink devices may work if they expose a compatible descriptor layout. CONFIGURATION The driver is configured via ups.conf(5). A minimal configuration: [apc-microlink] driver = apcmicrolink port = /dev/ttyUSB0 Optional settings baudrate=num Set the serial line speed. The default is 9600. showinternals=yes|no Publish additional internal Microlink runtime values. By default this follows the driver debug level and is enabled automatically when debug logging is on. showunmapped=yes|no Publish descriptor values that do not currently map to a standard NUT variable. By default this follows the driver debug level and is enabled automatically when debug logging is on. cmdsrc=rj45|usb|localuser|smartslot1|internalnetwork1 Select the Microlink command source used for outgoing command writes. The default is rj45. IMPLEMENTED FEATURES The driver publishes standard identity, status, runtime and outlet-group data when these objects are present in the Microlink descriptor. Descrip- tor-backed values are interpreted as strings, hex identifiers, dates, times, fixed-point numbers, and enum or bitfield maps depending on the Mi- crolink type reported by the device. Writable descriptor-backed variables are exposed as read-write NUT vari- ables when the device reports them as modifiable. Depending on the con- nected model, this can include values such as: * ups.id * ups.display.language * ups.test.interval * battery.date * input.transfer.delay * input.transfer.high * input.transfer.low * outlet.group.N.timer.shutdown * outlet.group.N.timer.reboot * outlet.group.N.timer.start * outlet.group.N.delay.shutdown * outlet.group.N.delay.reboot * outlet.group.N.delay.start * outlet.group.N.minimumreturnruntime * outlet.group.N.lowruntimewarning * outlet.group.N.name Supported instant commands currently include: * test.battery.start * test.battery.stop * test.panel.start * test.panel.stop Driver-assisted shutdown is not yet implemented. CABLING Use the APC Microlink serial cable appropriate for the UPS. USB-to-serial adapters can work if they present a standard TTY device to the operating system. AUTHORS * Lukas Schmid <lukas.schmid@netcube.li> SEE ALSO The core driver nutupsdrv(8), ups.conf(5) Internet resources The NUT (Network UPS Tools) home page: https://www.networkupstools.org/ Network UPS Tools 2.8.5. 08/04/2026 APCMICROLINK(8)
NAME | SYNOPSIS | DESCRIPTION | SUPPORTED HARDWARE | CONFIGURATION | IMPLEMENTED FEATURES | CABLING | AUTHORS | SEE ALSO
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=apcmicrolink&sektion=8&manpath=FreeBSD+Ports+15.1.quarterly>