|
| 1 | +RAGTECH(8) |
| 2 | +========== |
| 3 | + |
| 4 | +NAME |
| 5 | +---- |
| 6 | + |
| 7 | +ragtech - Driver for Ragtech UPS units (USB CDC-ACM) |
| 8 | + |
| 9 | +SYNOPSIS |
| 10 | +-------- |
| 11 | + |
| 12 | +*ragtech* -h |
| 13 | + |
| 14 | +*ragtech* -a 'UPS_NAME' ['OPTIONS'] |
| 15 | + |
| 16 | +NOTE: This man page only documents the hardware-specific features of |
| 17 | +the ragtech driver. For information about the core driver, see |
| 18 | +linkman:nutupsdrv[8]. |
| 19 | + |
| 20 | + |
| 21 | +SUPPORTED HARDWARE |
| 22 | +------------------ |
| 23 | + |
| 24 | +Targets Ragtech UPSes that expose a USB CDC-ACM serial interface |
| 25 | +(USB VID 0x04D8, PID 0x000A -- Microchip PIC with CDC firmware). |
| 26 | +The device shows up under Linux as `/dev/ttyACM*`. |
| 27 | + |
| 28 | +Validated end-to-end against the Ragtech Easy 2000 TI (model id 16 in |
| 29 | +the family-10 device table). The other 19 models in the same table -- |
| 30 | +Easy 600/700/900/1200/1300/1400/1600/1800/2000/2200 in both TI (115 V) |
| 31 | +and M2 (220 V) variants, also sold under the NEP, TORO, INNERGIE and |
| 32 | +OneUP brands in Brazil -- share the same wire protocol and register |
| 33 | +layout and are expected to work; please report results. |
| 34 | + |
| 35 | +This driver is *experimental*. Polling, status decoding and the |
| 36 | +`shutdown.stayoff` / `shutdown.stop` instant commands have been |
| 37 | +verified on hardware; `shutdown.return` and `test.battery.start.deep` |
| 38 | +are implemented but not yet verified end-to-end (see the |
| 39 | +*allow_shutdown* note below). The beeper-control wire encoding has |
| 40 | +not been reverse-engineered yet. |
| 41 | + |
| 42 | + |
| 43 | +EXTRA ARGUMENTS |
| 44 | +--------------- |
| 45 | + |
| 46 | +This driver supports the following options in the *ups.conf*: |
| 47 | + |
| 48 | +*iout_calib*='number';; |
| 49 | +Per-unit output current calibration constant. If omitted (default), |
| 50 | +the driver reads the value from register `0xF3` at startup. Set this |
| 51 | +only to override a wrong factory-stored calibration. |
| 52 | + |
| 53 | +*allow_shutdown*;; |
| 54 | +Enable the `shutdown.return`, `shutdown.stayoff`, `shutdown.stop` and |
| 55 | +`test.battery.start.deep` instant commands. Disabled by default for |
| 56 | +safety: the Easy 2000 TI firmware does **not** auto-restart after a |
| 57 | +coordinated shutdown, so an `upsmon`-driven shutdown on low battery |
| 58 | +will leave the UPS (and everything plugged into it) powered off until |
| 59 | +someone presses the physical power button. Only set this flag if you |
| 60 | +have an out-of-band way to power the UPS back up, or if you are |
| 61 | +deliberately running a UPS that should stay off after a critical- |
| 62 | +battery event. With this flag unset, `upsdrv_shutdown` logs the |
| 63 | +refusal and exits with failure instead of cutting the output. |
| 64 | + |
| 65 | + |
| 66 | +CAVEATS |
| 67 | +------- |
| 68 | + |
| 69 | +The serial control lines DTR and RTS are forced low by the driver |
| 70 | +immediately after opening the port. Non-zero levels on either line |
| 71 | +are interpreted by the UPS as a remote shutdown signal -- never run |
| 72 | +this driver alongside other software that toggles those lines on the |
| 73 | +same device node. |
| 74 | + |
| 75 | +Replies are framed by a 0xAA start byte and have no checksum; the |
| 76 | +driver re-synchronizes by scanning for the start byte after any |
| 77 | +short read. |
| 78 | + |
| 79 | + |
| 80 | +AUTHOR |
| 81 | +------ |
| 82 | + |
| 83 | +juslex |
| 84 | + |
| 85 | + |
| 86 | +SEE ALSO |
| 87 | +-------- |
| 88 | + |
| 89 | +linkman:nutupsdrv[8], |
| 90 | +linkman:ups.conf[5] |
| 91 | + |
| 92 | +Internet resources: |
| 93 | +~~~~~~~~~~~~~~~~~~~ |
| 94 | + |
| 95 | +* The NUT (Network UPS Tools) home page: https://www.networkupstools.org/ |
| 96 | + |
| 97 | +* Reverse-engineering reference: |
| 98 | + https://github.com/antunesls/UPS_ESP32_tinySrv |
0 commit comments