Skip to content

apc_modbus: decode RunTimeCalibrationStatus_BF#3416

Open
EchterAgo wants to merge 1 commit intonetworkupstools:masterfrom
EchterAgo:apc_modbus_decode_calib_status
Open

apc_modbus: decode RunTimeCalibrationStatus_BF#3416
EchterAgo wants to merge 1 commit intonetworkupstools:masterfrom
EchterAgo:apc_modbus_decode_calib_status

Conversation

@EchterAgo
Copy link
Copy Markdown
Contributor

@EchterAgo EchterAgo commented Apr 14, 2026

RunTimeCalibrationStatus_BF is explained in MPAO-98KJ7F_R1_EN Appendix B.

This adds defines for the bitfield and decodes it into experimental.ups.calibration.result using a string join converter.

Depends on #3413

General points

  • Described the changes in the PR submission or a separate issue, e.g.
    known published or discovered protocols, applicable hardware (expected
    compatible and actually tested/developed against), limitations, etc.

  • There may be multiple commits in the PR, aligned and commented with
    a functional change. Notably, coding style changes better belong in a
    separate PR, but certainly in a dedicated commit to simplify reviews
    of "real" changes in the other commits. Similarly for typo fixes in
    comments or text documents.

  • Use of coding helper tools and AI should be disclosed in the commit
    or PR comments (it is interesting to know which ones do a decent job).
    As with other contributions, a human is responsible and thanked for the
    quality and content of the change, and is presumed to have the right to
    post that code to be published further under the project's license terms.

  • Please star NUT on GitHub, this helps with sponsorships! ;)

Frequent "underwater rocks" for driver addition/update PRs

  • Revised existing driver families and added a sub-driver if applicable
    (nutdrv_qx, usbhid-ups...) or added a brand new driver in the other
    case.

  • Did not extend obsoleted drivers with new hardware support features
    (notably blazer and other single-device family drivers for Qx protocols,
    except the new nutdrv_qx which should cover them all).

  • For updated existing device drivers, bumped the DRIVER_VERSION macro
    or its equivalent.

  • For USB devices (HID or not), revised that the driver uses unique
    VID/PID combinations, or raised discussions when this is not the case
    (several vendors do use same interface chips for unrelated protocols).

  • For new USB devices, built and committed the changes for the
    scripts/upower/95-upower-hid.hwdb file

  • Proposed NUT data mapping is aligned with existing docs/nut-names.txt
    file. If the device exposes useful data points not listed in the file, the
    experimental.* namespace can be used as documented there, and discussion
    should be raised on the NUT Developers mailing list to standardize the new
    concept.

  • Updated data/driver.list.in if applicable (new tested device info)

Frequent "underwater rocks" for general C code PRs

  • Did not "blindly assume" default integer type sizes and value ranges,
    structure layout and alignment in memory, endianness (layout of bytes and
    bits in memory for multi-byte numeric types), or use of generic int where
    language or libraries dictate the use of size_t (or ssize_t sometimes).
  • Progress and errors are handled with upsdebugx(), upslogx(),
    fatalx() and related methods, not with direct printf() or exit().
    Similarly, NUT helpers are used for error-checked memory allocation and
    string operations (except where customized error handling is needed,
    such as unlocking device ports, etc.)

  • Coding style (including whitespace for indentations) follows precedent
    in the code of the file, and examples/guide in docs/developers.txt file.

  • For newly added files, the Makefile.am recipes were updated and the
    make distcheck target passes.

General documentation updates

  • Added a bullet point into NEWS.adoc, possibly also UPGRADING.adoc
    if there is something packagers or custom-build users should take into
    account (new driver categories, configuration options, dependencies...)

  • Updated docs/acknowledgements.txt (for vendor-backed device support)

  • Added or updated manual page information in docs/man/*.txt files
    and corresponding recipe lists in docs/man/Makefile.am for new pages

  • Passed make spellcheck, updated spell-checking dictionary in the
    docs/nut.dict file if needed (did not remove any words -- the make
    rule printout in case of changes suggests how to maintain it).

Additional work may be needed after posting this PR

  • Propose a PR for NUT DDL with detailed device data dumps from tests
    against real hardware (the more models, the better).

  • Address NUT CI farm build failures for the PR: testing on numerous
    platforms and toolkits can expose issues not seen on just one system.

  • Revise suggestions from LGTM.COM analysis about "new issues" with
    the changed codebase.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 14, 2026

A ZIP file with standard source tarball and another tarball with pre-built docs for commit 7341b41 is temporarily available: NUT-tarballs-PR-3416.zip.

@EchterAgo EchterAgo force-pushed the apc_modbus_decode_calib_status branch 4 times, most recently from d96336c to aa73b9f Compare April 14, 2026 09:13
@EchterAgo
Copy link
Copy Markdown
Contributor Author

This is ready if CI goes through. I want to rebase after #3413 is merged.

@EchterAgo EchterAgo marked this pull request as draft April 14, 2026 09:17
@EchterAgo EchterAgo mentioned this pull request Apr 14, 2026
22 tasks
@jimklimov jimklimov added enhancement APC modbus impacts-release-2.8.5 Issues reported against NUT release 2.8.5 (maybe vanilla or with minor packaging tweaks) labels Apr 14, 2026
@jimklimov jimklimov added this to the 2.8.6 milestone Apr 14, 2026
`RunTimeCalibrationStatus_BF` is explained in `MPAO-98KJ7F_R1_EN`
Appendix B.

This adds defines for the bitfield and decodes it into
`experimental.ups.calibration.result` using a string join converter.

Signed-off-by: Axel Gembe <axel@gembe.net>
@EchterAgo EchterAgo force-pushed the apc_modbus_decode_calib_status branch from aa73b9f to 7341b41 Compare April 14, 2026 11:29
@EchterAgo EchterAgo marked this pull request as ready for review April 14, 2026 11:29
@EchterAgo
Copy link
Copy Markdown
Contributor Author

Rebased, ready for merge after CI.

@AppVeyorBot
Copy link
Copy Markdown

@AppVeyorBot
Copy link
Copy Markdown

@AppVeyorBot
Copy link
Copy Markdown

@AppVeyorBot
Copy link
Copy Markdown

@AppVeyorBot
Copy link
Copy Markdown

@AppVeyorBot
Copy link
Copy Markdown

Build nut 2.8.5.4567-master completed (commit b1f83fb317 by @EchterAgo)

@AppVeyorBot
Copy link
Copy Markdown

@AppVeyorBot
Copy link
Copy Markdown

Build nut 2.8.5.4569-master completed (commit b2843c09f5 by @EchterAgo)

@AppVeyorBot
Copy link
Copy Markdown

@AppVeyorBot
Copy link
Copy Markdown

Build nut 2.8.5.4573-master completed (commit 5dc5477312 by @EchterAgo)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

APC enhancement impacts-release-2.8.5 Issues reported against NUT release 2.8.5 (maybe vanilla or with minor packaging tweaks) modbus

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants