phoenixcontact_modbus(8)

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

NAME

6       phoenixcontact_modbus - Driver for Phoenix Contact
7

SYNOPSIS

9       phoenixcontact_modbus -h
10
11       phoenixcontact_modbus -a DEVICE_NAME [OPTIONS]
12
13           Note
14           This man page only documents the hardware-specific features of the
15           phoenixcontact_modbus driver. For information about the core
16           driver, see nutupsdrv(8).
17

SUPPORTED HARDWARE

19       This driver should support the PhoenixContact QUINT-UPS industrial DC
20       UPS, model 2320461 and all compatible models. More information about
21       this UPS can be found here:
22       https://www.phoenixcontact.com/online/portal/us?uri=pxc-oc-itemdetail:pid=2320461
23
24       phoenixcontact_modbus uses the libmodbus project, for Modbus
25       implementation.
26

HOW TO CONFIGURE THE UPS

28       Note: this UPS and its manual refers to Low-Batt as "Shutdown Event".
29
30       You need the "IFS-RS232-DATACABLE" to communicate with the UPS in Linux
31       as the IFS-USB cable doesn’t seem to be supported. FYI communication
32       parameters are: 115200,E,8,1.
33
34       You also need the UPS-CONF Windows software (free; download from their
35       site), to configure the UPS signals and timers.
36
37        1. Run the UPS-CONF
38
39        2. Go to Settings→Time Setting
40
41        3. Choose "state of charge shutdown delay"
42
43        4. Choose Remote starts PC-Shutdown in Mains and Battery mode
44
45        5. On the PC-Shutdown enter the maximum value (5 minutes)
46
47        6. On the PC-Restart delay enter the time you want the UPS to leave
48           the output power off before restarting (e.g. 60 seconds), after
49           mains power is restored.
50
51        7. On the UPS, turn the screw to the "PC-MODE" position
52
53       Configuring the above way ensures that:
54
55       •   When power is lost, UPS constantly calculates remaining battery
56           time
57
58       •   When remaining battery time is less than 5 minutes (PC-Shutdown
59           setting), it will raise the "Shutdown" event (seen as LOW-BATT in
60           NUT)
61
62       •   From that moment even if input power is restored, the UPS will cut
63           the output power to its load after 5 minutes
64
65       •   When the input power is restored, the UPS will restore output power
66           after 60 seconds (PC-RESTART delay setting).
67
68       Meaning of settings:
69
70       •   PC-Shutdown: How long before output cutoff the UPS will raise the
71           "shutdown event" signal. Max value for this is 5 minutes. So PC
72           should be able to shutdown within 5 minutes.
73
74       •   PC-Restart: How long to delay output power after power is restored.
75           Max is 60 seconds.
76

EXTRA ARGUMENTS

78       This driver doesn’t support any optional settings.
79

INSTALLATION

81       This driver is not built by default. You can build it by installing
82       libmodbus and running configure --with-modbus=yes.
83
84       You also need to give proper permissions on the local serial device
85       file (/dev/ttyS0 for example) to allow the NUT user to access it.
86

INSTANT COMMANDS

88       This driver doesn’t support any instant commands.
89

AUTHOR

91       Spiros Ioannou <sivann@gmail.com>
92