Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nutdrv_qx: clean up the CLI usage/help message #2064

Open
jimklimov opened this issue Sep 18, 2023 · 1 comment
Open

nutdrv_qx: clean up the CLI usage/help message #2064

jimklimov opened this issue Sep 18, 2023 · 1 comment
Labels
documentation enhancement Qx protocol driver Driver based on Megatec Q<number> such as new nutdrv_qx, or obsoleted blazer and some others
Milestone

Comments

@jimklimov
Copy link
Member

Currently it seems the umbrella driver just posts all addvar items there are from the built-in subdrivers. It makes sense to either de-duplicate them, or clarify which configuration key words are "global", and which are defined by a particular driver by just adding a banner between subdriver lists of values.

The clumsy output seen today is:

...
Acceptable values for -x or ups.conf in this driver:

Set shutdown delay, in seconds (default=30) : -x offdelay=<value>
Set startup delay, in seconds (default=180) : -x ondelay=<value>
If invoked the UPS won't return after a shutdown when FSD arises : -x stayoff
Set polling frequency, in seconds, to reduce data flow (default=30) : -x pollfreq=<value>
Preselect communication protocol (skip autodetection) : -x protocol=<value>
 Parameters used for runtime calculation : -x runtimecal=<value>
     Nominal charge time for UPS battery : -x chargetime=<value>
Minimum load to be used for runtime calculation : -x idleload=<value>
If your device natively reports battery.voltage of a single cell/pack, multiply that into voltage of the whole battery assembly. You may need an override.battery.packs=N setting also. : -x battery_voltage_reports_one_pack
     Serial-over-USB subdriver selection : -x subdriver=<value>
Regular expression to match UPS Manufacturer string : -x vendor=<value>
Regular expression to match UPS Product string : -x product=<value>
Regular expression to match UPS Serial number : -x serial=<value>
Regular expression to match UPS Manufacturer numerical ID (4 digits hexadecimal) : -x vendorid=<value>
Regular expression to match UPS Product numerical ID (4 digits hexadecimal) : -x productid=<value>
Regular expression to match USB bus name : -x bus=<value>
Regular expression to match USB device name : -x device=<value>
Regular expression to match USB bus port name : -x busport=<value>
If you have several UPS devices which may not be uniquely identified by options above, allow each driver instance with this option to take the first match if available, or try another (association of driver to device may vary between runs) : -x allow_duplicates
Force redundant call to usb_set_altinterface() (value=bAlternateSetting; default=0) : -x usb_set_altinterface=<value>
Apply the language ID workaround to the krauler subdriver (0x409 or 0x4095) : -x langid_fix=<value>
   Don't autoscan valid range for langid : -x noscanlangid
    Set cable power for serial interface : -x cablepower=<value>
Reset capability options and their limits to safe default values : -x reset_to_default
Alarm (BEEP!) at Bypass Mode [enabled/disabled] : -x bypass_alarm=<value>
Alarm (BEEP!) at Battery Mode [enabled/disabled] : -x battery_alarm=<value>
Bypass when the UPS is Off [enabled/disabled] : -x bypass_when_off=<value>
Alarm (BEEP!) Control [enabled/disabled] : -x alarm_control=<value>
       Converter Mode [enabled/disabled] : -x converter_mode=<value>
             ECO Mode [enabled/disabled] : -x eco_mode=<value>
Battery Open Status Check [enabled/disabled] : -x battery_open_status_check=<value>
Bypass not allowed (Bypass Forbidding) [enabled/disabled] : -x bypass_forbidding=<value>
 Site fault detection [enabled/disabled] : -x site_fault_detection=<value>
    Advanced ECO Mode [enabled/disabled] : -x advanced_eco_mode=<value>
Constant Phase Angle Function (Output and input phase angles are not equal) [enabled/disabled] : -x constant_phase_angle=<value>
Limited runtime on battery mode [enabled/disabled] : -x limited_runtime_on_battery=<value>
         Maximum voltage for Bypass Mode : -x max_bypass_volt=<value>
         Minimum voltage for Bypass Mode : -x min_bypass_volt=<value>
       Maximum frequency for Bypass Mode : -x max_bypass_freq=<value>
       Minimum frequency for Bypass Mode : -x min_bypass_freq=<value>
Device grid working range for P31 UPSes [Appliance/UPS] : -x work_range_type=<value>
Change output phase angle to the provided value [000, 120, 180, 240]° : -x output_phase_angle=<value>
Set number of batteries that make a pack to n (integer, 1-9) : -x battery_number=<value>
If invoked the driver will exec also commands that still need testing : -x testing
Ignore 'Shutdown Active' bit in UPS status : -x ignoresab
Ignore 'Shutdown Active' bit in UPS status : -x ignoresab
Skip reading rating information from UPS : -x norating
Skip reading vendor information from UPS : -x novendor
Ignore 'Shutdown Active' bit in UPS status : -x ignoresab
Skip reading rating information from UPS : -x norating
Skip reading vendor information from UPS : -x novendor
Ignore 'Shutdown Active' bit in UPS status : -x ignoresab
Set shutdown mode functionality of Pin 1 and Pin 7 on the UPS DB9 communication port (Per Best Power's EPS-0059) to n (integer, 0-6) : -x pins_shutdown_mode=<value>
Ignore 'Shutdown Active' bit in UPS status : -x ignoresab
Skip reading rating information from UPS : -x norating
Skip reading vendor information from UPS : -x novendor
Ignore 'Shutdown Active' bit in UPS status : -x ignoresab
Skip reading rating information from UPS : -x norating
Skip reading vendor information from UPS : -x novendor
Ignore 'Shutdown Active' bit in UPS status : -x ignoresab
Skip reading rating information from UPS : -x norating
Skip reading vendor information from UPS : -x novendor
Ignore 'Shutdown Active' bit in UPS status : -x ignoresab
                            Series (A/E) : -x series=<value>
         Slave address (UPS id) to match : -x slave_address=<value>
Input fault voltage (whatever that means) : -x input_fault_voltage=<value>
       Number of battery cells in series : -x number_of_battery_cells=<value>
            Nominal battery cell voltage : -x nominal_cell_voltage=<value>
Nominal battery run time at 50% load (seconds) : -x runtime_half=<value>
Nominal battery run time at 100% load (seconds) : -x runtime_full=<value>
Nominal battery recharge time to 95% capacity (seconds) : -x recharge_time=<value>
        Possible output voltages (volts) : -x output_voltages=<value>
                 Fault record 1 (newest) : -x fault_1=<value>
                          Fault record 2 : -x fault_2=<value>
                          Fault record 3 : -x fault_3=<value>
                          Fault record 4 : -x fault_4=<value>
                 Fault record 5 (oldest) : -x fault_5=<value>
Skip reading rating information from UPS : -x norating
Skip reading vendor information from UPS : -x novendor
Ignore 'Shutdown Active' bit in UPS status : -x ignoresab
Skip reading rating information from UPS : -x norating
Skip reading vendor information from UPS : -x novendor
Ignore 'Shutdown Active' bit in UPS status : -x ignoresab
Ignore 'Shutdown Active' bit in UPS status : -x ignoresab

Acceptable values for 'subdriver' via -x or ups.conf in this driver: cypress, phoenixtec, phoenix, ippon, krauler, fabula, hunnox, fuji, sgs, snr, ablerex, armac

Read The Fine Manual ('man 8 nutdrv_qx')
@jimklimov jimklimov added enhancement documentation Qx protocol driver Driver based on Megatec Q<number> such as new nutdrv_qx, or obsoleted blazer and some others labels Sep 18, 2023
@jimklimov jimklimov added this to the 2.8.2 milestone Sep 18, 2023
@jimklimov
Copy link
Member Author

Note: recent changes to upsdrv_help() in #2058 are NOT the solution to this issue ;)

@jimklimov jimklimov modified the milestones: 2.8.2, 2.8.3 Apr 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement Qx protocol driver Driver based on Megatec Q<number> such as new nutdrv_qx, or obsoleted blazer and some others
Projects
None yet
Development

No branches or pull requests

1 participant