[Issue #616] legrand usb support by blecher-at · Pull Request #1075 · networkupstools/nut

blecher-at · 2021-08-19T16:31:07Z

Revive the effort to solve (most of) issue #616

Since some devices, when communicating via USB, don't close their replies to our commands/queries with the expected (and mandated by the specs) CR, rendering the driver almost useless as protocols get one less character than they expect, update the various USB subdrivers (leaving out the ones that rely on a CR to stop reading from the device) to add the missing terminating CR in such cases (as long as we get anything usable). This is a bit of a cheat, but, at least for now, it will do -- not to mention the fact that it is way less invasive than touching all the places of the driver that expect a closing CR and all the qx2nut tables of the various protocols. Close networkupstools#441

As per protocol documentation, data is sent by the device with unsigned integers of 8, 16 or 32 bits, with errors/special values being: - for uint16: 0xFFFF and 0xFFFE, - for uint32: 0xFFFFFFFF. Alas, those values are (and, probably, have always been) actually reported in the documentation (mostly) as if their types were not unsigned (so, in decimal: -1, and -2) and the metasys driver used them like that, converting the values to non-fixed width signed types (int and long) and then expecting a value of -1 or -2 to signal a particular event, but this only happens on platforms where int is exactly 16 bits, and long 32 bits. So, leave values as unsigned types (adjusting all the printf formats accordingly), and use the right hex values, instead.

Add to the metasys driver a few new models (Meta System DHEA, and others now branded Legrand) speaking the Meta System UPS protocol.

The added command is only supported by devices with an 'id code' >= 14, while for other, older, models the command is not enabled by default, and the user has to perform a specific procedure via serial to enable it (where supported).

As per the provided protocol: see nut-website's 570c1e5e9f1fb4f82abef9359897b5159e88fc50 Also, fix name of "HF Line /2".

Also, specify that Legrand Multiplug is USB-only.

As per the provided protocol: see nut-website's 66d30c90401ff7929b25e5a87f9299b728f861ea

…pdated # Conflicts: # drivers/Makefile.am

jimklimov · 2021-09-15T10:26:36Z

Now that CI is about usable again, it has valid complaints:

This needs a NUT_UNUSED_VARIABLE(device) (and an #include "common.h" if not there yet somehow):

[2021-09-15T04:13:59.193Z] legrand-hid.c: In function 'disable_interrupt_pipe':
[2021-09-15T04:13:59.193Z] legrand-hid.c:37:50: error: unused parameter 'device' [-Werror=unused-parameter]
[2021-09-15T04:13:59.193Z]    37 | static void *disable_interrupt_pipe(USBDevice_t *device)
[2021-09-15T04:13:59.193Z]       |                                     ~~~~~~~~~~~~~^~~~~~

These need a few explicit NULLs in the end of initializer:

[2021-09-15T04:13:59.193Z] legrand-hid.c: At top level:
[2021-09-15T04:13:59.193Z] legrand-hid.c:78:2: error: missing initializer for field 'nuf' of 'info_lkp_t' [-Werror=missing-field-initializers]
[2021-09-15T04:13:59.193Z]    78 |  { 0, NULL, legrand_times10 }
[2021-09-15T04:13:59.193Z]       |  ^

[2021-09-15T04:13:59.193Z] In file included from legrand-hid.c:25:
[2021-09-15T04:13:59.193Z] usbhid-ups.h:69:11: note: 'nuf' declared here
[2021-09-15T04:13:59.193Z]    69 |  double (*nuf)(const char *nut_value);  /* optional NUT to HID mapping */
[2021-09-15T04:13:59.193Z]       |           ^~~

[2021-09-15T04:13:59.193Z] legrand-hid.c:89:2: error: missing initializer for field 'nuf' of 'info_lkp_t' [-Werror=missing-field-initializers]
[2021-09-15T04:13:59.193Z]    89 |  { 0, NULL, legrand_times100k }
[2021-09-15T04:13:59.193Z]       |  ^

[2021-09-15T04:13:59.193Z] In file included from legrand-hid.c:25:
[2021-09-15T04:13:59.193Z] usbhid-ups.h:69:11: note: 'nuf' declared here
[2021-09-15T04:13:59.193Z]    69 |  double (*nuf)(const char *nut_value);  /* optional NUT to HID mapping */
[2021-09-15T04:13:59.193Z]       |           ^~~

[2021-09-15T04:13:59.193Z] legrand-hid.c:100:2: error: missing initializer for field 'nuf' of 'info_lkp_t' [-Werror=missing-field-initializers]
[2021-09-15T04:13:59.193Z]   100 |  { 0, NULL, legrand_times1M }
[2021-09-15T04:13:59.193Z]       |  ^

[2021-09-15T04:13:59.193Z] In file included from legrand-hid.c:25:
[2021-09-15T04:13:59.193Z] usbhid-ups.h:69:11: note: 'nuf' declared here
[2021-09-15T04:13:59.193Z]    69 |  double (*nuf)(const char *nut_value);  /* optional NUT to HID mapping */
[2021-09-15T04:13:59.193Z]       |           ^~~

[2021-09-15T04:13:59.193Z] legrand-hid.c:111:2: error: missing initializer for field 'nuf' of 'info_lkp_t' [-Werror=missing-field-initializers]
[2021-09-15T04:13:59.193Z]   111 |  { 0, NULL, legrand_times10M }
[2021-09-15T04:13:59.193Z]       |  ^
[2021-09-15T04:13:59.193Z] In file included from legrand-hid.c:25:

[2021-09-15T04:13:59.193Z] usbhid-ups.h:69:11: note: 'nuf' declared here
[2021-09-15T04:13:59.193Z]    69 |  double (*nuf)(const char *nut_value);  /* optional NUT to HID mapping */
[2021-09-15T04:13:59.193Z]       |           ^~~
[2021-09-15T04:13:59.193Z] cc1: all warnings being treated as errors
[2021-09-15T04:13:59.193Z] *** Error code 1

Address build warnings from CI

… to uint16_t * *{usb,hid}.c: sentinel in a table of uint16_t can not be -1

jimklimov · 2021-12-21T17:02:05Z

Thanks, finally got back to look at this and formally seems okay - but I don't have the devices to test against.

Looking at (C) lines, seems this contribution comes (partially?) from Legrand itself; this may be worth highlighting in docs/acknowledgements.txt then.

As a reminder to myself, this PR is likely to have mild merge conflicts with #1135 and (as mentioned in original issue) possibly with libusb-1.0 branches that are converging to getting merged soonish too.

zykh and others added 15 commits July 28, 2018 22:13

nutdrv_qx: add support for some Legrand USB devices

258276a

usbhid-ups: add Legrand subdriver

8a5e87a

metasys: for bypass mode, call status_set() with "BYPASS", not "BY"

264fcb4

metasys: treat any '\0' in the serial number as a '0'

45ef769

metasys: support some newer Meta System and Legrand devices

a930788

Add to the metasys driver a few new models (Meta System DHEA, and others now branded Legrand) speaking the Meta System UPS protocol.

metasys: remove useless initialisation of vars

227e6bd

metasys: retrieve also battery charge and runtime

367eae6

The added command is only supported by devices with an 'id code' >= 14, while for other, older, models the command is not enabled by default, and the user has to perform a specific procedure via serial to enable it (where supported).

HCL: update support level of some Meta System devices

4e67581

As per the provided protocol: see nut-website's 570c1e5e9f1fb4f82abef9359897b5159e88fc50 Also, fix name of "HF Line /2".

HCL: add some Legrand devices supported by nutdrv_qx

632deb4

Also, specify that Legrand Multiplug is USB-only.

HCL: update support level of some Meta System devices

085c700

As per the provided protocol: see nut-website's 66d30c90401ff7929b25e5a87f9299b728f861ea

Merge remote-tracking branch 'origin/master' into issue-441+legrand_u…

1c02b58

…pdated # Conflicts: # drivers/Makefile.am

legrand hid rules update

ce6cff5

issue-441: rebase onto master, excluding metasys

a84ab1f

blecher-at changed the title ~~Issue 441+legrand updated 3~~ [Issue #616] legrand usb support Aug 19, 2021

blecher-at mentioned this pull request Aug 19, 2021

Support some more Legrand devices #616

Open

7 of 8 tasks

Stephan Blecher and others added 4 commits August 19, 2021 20:10

issue-616: legrand 600 fix input voltage

ac58d55

Merge branch 'master' into issue-441+legrand_updated-3

58ab0c4

Merge branch 'master' into issue-441+legrand_updated-3

a75fa8e

Merge branch 'master' into issue-441+legrand_updated-3

2d36fdd

jimklimov and others added 8 commits September 20, 2021 18:04

Merge branch 'master' into issue-441+legrand_updated-3

7d97403

Update legrand-hid.c

ba7656d

Address build warnings from CI

Merge branch 'master' into issue-441+legrand_updated-3

67a1028

Merge branch 'master' into issue-441+legrand_updated-3

59bb0c3

Merge branch 'master' into issue-441+legrand_updated-3

9747b36

Merge branch 'master' into issue-441+legrand_updated-3

d831a9a

Merge branch 'master' into issue-441+legrand_updated-3

59fc886

drivers/legrand-hid.c: fix type of usb_device_id_t vendorID/productID…

2c0f401

… to uint16_t * *{usb,hid}.c: sentinel in a table of uint16_t can not be -1

Merge branch 'master' into issue-441+legrand_updated-3

8238f74

jimklimov added Qx protocol driver Driver based on Megatec Q<number> such as new nutdrv_qx, or obsoleted blazer and some others ready / gonna merge The PR is in final cycles leading to merge unless someone logs an objection before we hit the button USB labels Dec 21, 2021

jimklimov merged commit 5a414a3 into networkupstools:master Jan 19, 2022

blecher-at deleted the issue-441+legrand_updated-3 branch February 7, 2022 23:08

jimklimov mentioned this pull request Jul 18, 2023

Problem detecting Legrand and APC UPS #1990

Open

Navigation Menu

Repository navigation

[Issue #616] legrand usb support - #1075

[Issue #616] legrand usb support#1075
jimklimov merged 28 commits into
networkupstools:masterfrom
blecher-at:issue-441+legrand_updated-3

blecher-at commented Aug 19, 2021 •

edited by jimklimov

Loading

Uh oh!

jimklimov commented Sep 15, 2021 •

edited

Loading

Uh oh!

jimklimov commented Dec 21, 2021 •

edited

Loading

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

blecher-at commented Aug 19, 2021 • edited by jimklimov Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jimklimov commented Sep 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jimklimov commented Dec 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

blecher-at commented Aug 19, 2021 •

edited by jimklimov

Loading

jimklimov commented Sep 15, 2021 •

edited

Loading

jimklimov commented Dec 21, 2021 •

edited

Loading