Add missing values for ECO Mode Eaton #2620

masterwishx · 2024-09-09T09:03:29Z

Add missing values for ECO and Bypass mode for Eaton for future work for enable ECO mode.

compiled and checked in NUT Plugin in unraid :

compiled and checked with:
input.transfer.frequency.bypass.high and input.transfer.frequency.eco.high
after changed to :
input.transfer.frequency.bypass.range input.transfer.frequency.eco.range
in values :

Reduced here text for : range also instead high for not compile again ...

battery.capacity: 7.00
battery.charge: 100
battery.charge.low: 20
battery.charge.restart: 0
battery.protection: yes
battery.runtime: 3480
battery.runtime.low: 180
battery.type: PbAc
battery.voltage: 83.0
battery.voltage.nominal: 72
device.mfr: EATON
device.model: 9E2000i
device.serial: xxxxxxxxxxxx                   #REDACTED by me # !!! serial is shown now !!!
device.type: ups
driver.debug: 0
driver.flag.allow_killpower: 0
driver.name: usbhid-ups
driver.parameter.pollfreq: 30
driver.parameter.pollinterval: 2
driver.parameter.port: auto
driver.parameter.synchronous: auto
driver.state: quiet
driver.version: 2.8.2.1
driver.version.data: MGE HID 1.48
driver.version.internal: 0.57
driver.version.usb: libusb-1.0.26 (API: 0x1000108)
input.bypass.frequency: 49.9
input.bypass.voltage: 234.0
input.frequency: 49.9
input.frequency.nominal: 50
input.transfer.bypass.high: 264
input.transfer.bypass.low: 184
input.transfer.eco.high: 241
input.transfer.eco.low: 218
input.transfer.frequency.bypass.range: 10
input.transfer.frequency.eco.range: 5
input.transfer.high: 300
input.transfer.low: 100
input.voltage: 234.0
input.voltage.nominal: 234
outlet.1.status: on
outlet.desc: Main Outlet
outlet.id: 0
outlet.switchable: no
output.current: 1.60
output.frequency: 49.9
output.frequency.nominal: 50
output.voltage: 229.0
output.voltage.nominal: 230
ups.beeper.status: enabled
ups.delay.shutdown: 20
ups.delay.start: 30
ups.firmware: 00.02.000
ups.load: 19
ups.load.high: 105
ups.mfr: EATON
ups.model: 9E2000i
ups.power: 391
ups.power.nominal: 2000
ups.productid: ffff
ups.realpower: 258
ups.realpower.nominal: 1600
ups.serial: xxxxxxxxxxxx                   #REDACTED by me # !!! serial is shown now !!!
ups.shutdown: enabled
ups.start.auto: yes
ups.start.battery: yes
ups.start.reboot: yes
ups.status: OL
ups.temperature: 24.9
ups.test.interval: 604800
ups.test.result: Done and passed
ups.timer.shutdown: -1
ups.timer.start: -1
ups.type: online
ups.vendorid: 0463


[battery.charge.low]
Remaining battery level when UPS switches to LB (percent)
Type: STRING
Maximum length: 5
Value: 20

[battery.charge.restart]
Minimum battery level for restart after power off (percent)
Type: STRING
Maximum length: 3
Value: 0

[battery.protection]
Prevent deep discharge of battery
Type: STRING
Maximum length: 5
Value: yes

[battery.runtime.low]
Remaining battery runtime when UPS switches to LB (seconds)
Type: STRING
Maximum length: 10
Value: 180

[driver.debug]
Current debug verbosity level of the driver program
Type: NUMBER
Value: 0

[driver.flag.allow_killpower]
Safety flip-switch to allow the driver daemon to send UPS shutdown command (accessible via driver.killpower)
Type: NUMBER
Value: 0

[input.transfer.bypass.high]
Description unavailable
Type: STRING
Maximum length: 5
Value: 264

[input.transfer.bypass.low]
Description unavailable
Type: STRING
Maximum length: 5
Value: 184

[input.transfer.eco.high]
Description unavailable
Type: STRING
Maximum length: 5
Value: 241

[input.transfer.eco.low]
Description unavailable
Type: STRING
Maximum length: 5
Value: 218

[input.transfer.frequency.bypass.range]
Description unavailable
Type: STRING
Maximum length: 5
Value: 10

[input.transfer.frequency.eco.range]
Description unavailable
Type: STRING
Maximum length: 5
Value: 5

[input.transfer.high]
High voltage transfer point (V)
Type: STRING
Maximum length: 5
Value: 300

[input.transfer.low]
Low voltage transfer point (V)
Type: STRING
Maximum length: 5
Value: 100

[outlet.desc]
Outlet description
Type: STRING
Maximum length: 20
Value: Main Outlet

[output.voltage.nominal]
Nominal output voltage (V)
Type: ENUM STRING
Maximum length: 3
Option: "200"
Option: "208"
Option: "220"
Option: "230" SELECTED
Option: "240"

[ups.delay.shutdown]
Interval to wait after shutdown with delay command (seconds)
Type: STRING
Maximum length: 10
Value: 20

[ups.delay.start]
Interval to wait before (re)starting the load (seconds)
Type: STRING
Maximum length: 10
Value: 30

[ups.load.high]
Load when UPS switches to overload condition (percent)
Type: STRING
Maximum length: 5
Value: 105

[ups.shutdown]
Description unavailable
Type: ENUM STRING
Maximum length: 10
Option: "disabled"
Option: "enabled" SELECTED

[ups.start.auto]
UPS starts when mains is (re)applied
Type: STRING
Maximum length: 5
Value: yes

[ups.start.battery]
Allow to start UPS from battery
Type: STRING
Maximum length: 5
Value: yes

[ups.start.reboot]
UPS reboots when power returns during shutdown delay
Type: STRING
Maximum length: 5
Value: yes

[ups.test.interval]
Interval between self tests (seconds)
Type: STRING
Maximum length: 8
Value: 604800

… for Eaton Signed-off-by: DaRK AnGeL <[email protected]>

…ansfer.frequency.eco) Signed-off-by: DaRK AnGeL <[email protected]>

Signed-off-by: DaRK AnGeL <[email protected]>

masterwishx · 2024-09-09T15:51:52Z

@jimklimov @arnaudquette-eaton i hope this can be the first step to way to enable ECO Mode for Eaton ?!?

jimklimov · 2024-09-10T21:04:15Z

Currently the added name patterns are missing in docs/nut-names.txt but it makes sense to add them near the existing input.transfer.boost.low et al.

Somewhat orthogonal to this PR, there seems to be no mix of "frequency" and "transfer" in the naming yet. The existing input.transfer.* values are somewhat implicitly about voltage (maybe current names should get deprecated eventually and voltage made explicit?.. probably some parsing scripts/tools would be upset about such change)

There are however input.frequency.low ("Input line frequency low (Hz)" which seems also like a "transfer" to me, just freq-based) etc. so it perhaps makes better sense to name new concepts like input.frequency.transfer.* or even input.frequency.(bypass|eco).(low|high|range) to be like the few existing entries without a "transfer" to their name, although that would be at odds with deprecation and more explicit renaming suggested above (however that aspect can wait... and be solved together some time later).

Regarding your tests, I did not understand why input.transfer.frequency.bypass.high and input.transfer.frequency.eco.high got(?) replaced by input.transfer.frequency.bypass.range and input.transfer.frequency.eco.range if the PR only adds NUT understanding of some readings and does not change/remove any, or did I misunderstand your post?

Also, an explanation (in cmdvartab and nut-names eventually) about what such range is conceptually, and how in matters in practice, and its units (Hz? %?) would be most welcome.

masterwishx · 2024-09-11T06:09:46Z

Regarding your tests, I did not understand why input.transfer.frequency.bypass.high and input.transfer.frequency.eco.high got(?) replaced by input.transfer.frequency.bypass.range and input.transfer.frequency.eco.range if the PR only adds NUT understanding of some readings and does not change/remove any, or did I misunderstand your post?

I just named with high and compiled with this name but it's should be called range Becouse it's range not high

masterwishx · 2024-09-11T06:14:36Z

the PR only adds NUT understanding of some readings and does not change/remove any, or did I misunderstand your post?

Yes it's adding 6 missing values of bypass/eco

masterwishx · 2024-09-11T06:47:30Z

Also found HysteresysVoltageTransfer=10 that i have in log and from 9SX Document :

Also, an explanation (in cmdvartab and nut-names eventually) about what such range is conceptually, and how in matters in practice, and its units (Hz? %?) would be most welcome.

Yes you are right , it seems , its % of Hz and not Hz: so should be called like : (%Hz) ?

input.transfer.frequency.bypass.range: 10%
input.transfer.frequency.eco.range: 5%

There are however input.frequency.low ("Input line frequency low (Hz)" which seems also like a "transfer" to me, just freq-based) etc

i have only :

input.bypass.frequency: 49.9
input.bypass.voltage: 234.0

masterwishx · 2024-09-11T06:48:59Z

There are however input.frequency.low ("Input line frequency low (Hz)" which seems also like a "transfer" to me, just freq-based) etc. so it perhaps makes better sense to name new concepts like input.frequency.transfer.* or even input.frequency.(bypass|eco).(low|high|range) to be like the few existing entries without a "transfer" to their name, although that would be at odds with deprecation and more explicit renaming suggested above (however that aspect can wait... and be solved together some time later).

yes Maybe you right

masterwishx · 2024-09-11T07:05:33Z

Yes you are right , it seems , its % of Hz and not Hz: so should be called like : (%Hz) ?

or better (Hz[%]) ?
or (percent Hz) as found percent some values

masterwishx · 2024-09-11T07:44:51Z

@jimklimov can i add also :

input.transfer.hysteresys = 10V

HysteresysVoltageTransfer

Input Voltage Hysteresis: What’s That? Input voltage hysteresis refers to a
specific behavior related to how a UPS handles changes in input voltage.
It’s like the UPS’s way of saying, “Hey, let’s not be too trigger-happy when
switching between different voltage levels.” 🤓

Here’s the lowdown:

* Normal Operation:

When the UPS is running normally (powered by utility or generator), it
maintains a steady output voltage for your critical equipment.

But what if the input voltage wiggles a bit due to fluctuations or minor
disturbances? Well, that’s where hysteresis comes into play.

* Hysteresis Explained:

Imagine you’re at a concert, and the music volume keeps going up and
down. Annoying, right? The UPS doesn’t want to subject your sensitive
electronics to that kind of roller-coaster.

So, it sets a threshold: If the input voltage drops below a certain level
(let’s call it “Low”), the UPS won’t immediately switch to battery mode.
It waits until the voltage stays consistently low for a bit.

Similarly, if the input voltage rises above another threshold (the “High”
level), the UPS won’t rush back to normal mode. It waits for stability.

* Why Is This Important?

Rapid switching between modes (utility power to battery and vice versa)
can stress the UPS and its connected devices.

By introducing hysteresis, the UPS avoids unnecessary toggling, ensuring
smoother transitions and better protection for your gear.

Signed-off-by: DaRK AnGeL <[email protected]>

jimklimov · 2024-09-12T07:13:57Z

Well, a physicist bit of me screamed inside at the idea of "percent" (a fraction, so no measurement types as they cancel out during division) and a type (Hz) being together in one term. But lay-manly, it sort of makes sense.

Still, I think something like "10% of nominal (voltage/frequency/etc...)" is less ambiguous.

jimklimov · 2024-09-12T07:15:06Z

Knowing the Hysteresys setting sounds fun; the large description maybe fits into the nut-names paragraphs near the tables. Or into the FAQ...

masterwishx · 2024-09-12T08:10:44Z

Input Voltage Hysteresis: What’s That? Input voltage hysteresis refers to a
specific behavior related to how a UPS handles changes in input voltage.
It’s like the UPS’s way of saying, “Hey, let’s not be too trigger-happy when
switching between different voltage levels.” 🤓

Here’s the lowdown:

Normal Operation:

When the UPS is running normally (powered by utility or generator), it
maintains a steady output voltage for your critical equipment.

But what if the input voltage wiggles a bit due to fluctuations or minor
disturbances? Well, that’s where hysteresis comes into play.

Hysteresis Explained:

Imagine you’re at a concert, and the music volume keeps going up and
down. Annoying, right? The UPS doesn’t want to subject your sensitive
electronics to that kind of roller-coaster.

So, it sets a threshold: If the input voltage drops below a certain level
(let’s call it “Low”), the UPS won’t immediately switch to battery mode.
It waits until the voltage stays consistently low for a bit.

Similarly, if the input voltage rises above another threshold (the “High”
level), the UPS won’t rush back to normal mode. It waits for stability.

Why Is This Important?

Rapid switching between modes (utility power to battery and vice versa)
can stress the UPS and its connected devices.

By introducing hysteresis, the UPS avoids unnecessary toggling, ensuring
smoother transitions and better protection for your gear.

is it ok in description ?
"Hysteresys (threshold of switching to modes) Voltage Transfer point (V)"

Signed-off-by: DaRK AnGeL <[email protected]>

Signed-off-by: Jim Klimov <[email protected]>

jimklimov · 2024-09-12T08:30:46Z

I've posted a couple of commits with asciidoc fixes, gotta check how the resulting rendered files look, too. Don't overwrite them when pushing out your future changes, if any (git fetch --all; git rebase origin/master; git push) :)

FWIW, now I've also noted that you made the PR from your copy of the master branch. This is generally unwieldy and frowned upon (sometimes you can't easily resync with upstream/master changes this way, and can not work on several separate changes at once), so in the future I suggest sticking to uniquely named "feature branches" for PRs and other work.

That hysteresys article, where did it come from? (Maybe attribution is in order, at least in commit comment when/if you add it)

masterwishx · 2024-09-12T08:33:15Z

I've posted a couple of commits with asciidoc fixes, gotta check how the resulting rendered files look, too. Don't overwrite them when pushing out your future changes, if any (git fetch --all; git rebase origin/master; git push) :)

FWIW, now I've also noted that you made the PR from your copy of the master branch. This is generally unwieldy and frowned upon (sometimes you can't easily resync with upstream/master changes this way, and can not work on several separate changes at once), so in the future I suggest sticking to uniquely named "feature branches" for PRs and other work.

That hysteresys article, where did it come from? (Maybe attribution is in order, at least in commit comment when you add it)

OK sorry ,im only learning really using git : )

jimklimov · 2024-09-12T08:36:32Z

If you want to continue in this area, I can strongly suggest the Atlassian Git tutorial, it was quite a good ramp-up back in the day when I trained some colleagues on Git. Nowadays there are also quite a few "gamified" manuals/trainings, where you solve certain goals in a provided repo to find the next tasks to do, etc. Some friends reported that such approach helped them a lot.

jimklimov · 2024-09-12T08:41:05Z

Rendered doc looks ok now:

masterwishx · 2024-09-12T08:44:45Z

Я опубликовал пару коммитов с исправлениями asciidoc, надо еще проверить, как выглядят полученные файлы. Не перезаписывайте их при выкладывании будущих изменений, если таковые будут ( git fetch --all; git rebase origin/master; git push) :)

Кстати, теперь я также заметил, что вы сделали PR из своей копии ветки master. Это, как правило, громоздко и не приветствуется (иногда вы не можете легко повторно синхронизировать upstream/masterизменения таким образом, и не можете работать над несколькими отдельными изменениями одновременно), поэтому в будущем я предлагаю придерживаться уникально названных "ветвей функций" для PR и другой работы.

Эта статья на гистерезисе, откуда она взялась? (Возможно, стоит указать авторство, по крайней мере, в комментарии к коммиту, когда/если вы ее добавите)

maybe better ?

| input.transfer.hysteresys   | Threshold of switching modes
                              | voltage transfer point (V)        | 10

masterwishx · 2024-09-12T09:06:18Z

That hysteresys article, where did it come from? (Maybe attribution is in order, at least in commit comment when/if you add it)

This is from Copilot Win 11

jimklimov · 2024-09-12T09:16:55Z

Maybe better. Note the extra | (leftmost on your second line) - it is not needed, would start a new table column.

jimklimov · 2024-09-12T11:39:59Z

Ah, it got us: "hysteresis" not "hysteresys" :D

jimklimov · 2024-09-12T11:52:58Z

I'll post the fixes in a minute

masterwishx · 2024-09-12T11:53:44Z

Ah, it got us: "hysteres_i_s" not "hysteres_y_s" :D

thats becouse i have this in log :

masterwishx · 2024-09-12T11:55:27Z

I'll post the fixes in a minute

im moved to another branch and now confused with pr tom merge it :(

Signed-off-by: Jim Klimov <[email protected]>

…etworkupstools#2620] Signed-off-by: Jim Klimov <[email protected]>

…tion [networkupstools#2620] Signed-off-by: Jim Klimov <[email protected]>

…tworkupstools#2620] Signed-off-by: Jim Klimov <[email protected]>

jimklimov · 2024-09-12T12:01:13Z

So, we are not the first to make that typo :)

:; git blame drivers/mge-hid.c | grep -i hysteresys
afed402855 (Arnaud Quette      2012-05-14 08:14:06 +0000  998)  { "HysteresysVoltageTransfer",  0xffff009c },

afed402855

jimklimov · 2024-09-12T12:06:53Z

I'll post the fixes in a minute

im moved to another branch and now confused with pr tom merge it :(

I think with this particular PR, we can finish here. Seems almost done.

AppVeyorBot · 2024-09-12T13:34:55Z

✅ Build nut 2.8.2.2142-master completed (commit 95fcc5ec79 by @jimklimov)

masterwishx · 2024-09-13T06:07:53Z

@jimklimov Cool, can be merged now;)

Another question for the future work is what values we should have to enable Bypass/ECO
Mode with NUT ?
It's more related to #2495 offcourse...
As I know my 9E is basic model but with snmp
It can be enabled that's what eaton support told me, so maybe we can enable it with usb also by NUT ?

masterwishx added 3 commits September 9, 2024 10:55

Add Bypass and ECO Transfer values for future work on enable Eco mode…

ce4b431

… for Eaton Signed-off-by: DaRK AnGeL <[email protected]>

change high to range in (input.transfer.frequency.bypass and input.tr…

7445612

…ansfer.frequency.eco) Signed-off-by: DaRK AnGeL <[email protected]>

add values description

bdf0406

Signed-off-by: DaRK AnGeL <[email protected]>

jimklimov added enhancement Eaton USB ECO mode labels Sep 10, 2024

jimklimov added this to the 2.8.3 milestone Sep 10, 2024

add missing values to nut vars + 'percent Hz' in cmdvartab

8a96f52

Signed-off-by: DaRK AnGeL <[email protected]>

masterwishx and others added 3 commits September 12, 2024 11:16

add hysteresys value + add nominal to freq range

b10801b

Signed-off-by: DaRK AnGeL <[email protected]>

docs/nut-names.txt: fix asciidoc table markup and a bit of wording

92635de

Signed-off-by: Jim Klimov <[email protected]>

data/cmdvartab: fix a bit of wording for "percent of nominal"

873963b

Signed-off-by: Jim Klimov <[email protected]>

masterwishx and others added 5 commits September 12, 2024 14:57

Merge branch 'networkupstools:master' into master

4a22d24

Typo fix (hysteresYs => hysteresIs) [networkupstools#2620]

4961a94

Signed-off-by: Jim Klimov <[email protected]>

drivers/mge-hid.c: bump sub-driver version due to added data points [n…

7342897

…etworkupstools#2620] Signed-off-by: Jim Klimov <[email protected]>

docs/nut-names.txt: re-phrase input.transfer.hysteresis table descrip…

e1080d6

…tion [networkupstools#2620] Signed-off-by: Jim Klimov <[email protected]>

docs/nut-names.txt: document the Input Voltage Hysteresis concept [ne…

c9884ca

…tworkupstools#2620] Signed-off-by: Jim Klimov <[email protected]>

jimklimov added the DDL label Sep 12, 2024

Update cmdvartab

b8abfc1

jimklimov merged commit 501bbdc into networkupstools:master Sep 13, 2024
30 checks passed

jimklimov mentioned this pull request Sep 13, 2024

Introduce NUT handling for "ECO Mode" (status, commands) #2495

Open

masterwishx mentioned this pull request Sep 30, 2024

EATON HID: add missing usages and paths #2637

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add missing values for ECO Mode Eaton #2620

Add missing values for ECO Mode Eaton #2620

masterwishx commented Sep 9, 2024

masterwishx commented Sep 9, 2024

jimklimov commented Sep 10, 2024

masterwishx commented Sep 11, 2024

masterwishx commented Sep 11, 2024

masterwishx commented Sep 11, 2024

masterwishx commented Sep 11, 2024

masterwishx commented Sep 11, 2024 •

edited

Loading

masterwishx commented Sep 11, 2024 •

edited by jimklimov

Loading

jimklimov commented Sep 12, 2024

jimklimov commented Sep 12, 2024

masterwishx commented Sep 12, 2024

jimklimov commented Sep 12, 2024 •

edited

Loading

masterwishx commented Sep 12, 2024

jimklimov commented Sep 12, 2024

jimklimov commented Sep 12, 2024

masterwishx commented Sep 12, 2024

masterwishx commented Sep 12, 2024

jimklimov commented Sep 12, 2024

jimklimov commented Sep 12, 2024

jimklimov commented Sep 12, 2024

masterwishx commented Sep 12, 2024

masterwishx commented Sep 12, 2024

jimklimov commented Sep 12, 2024 •

edited

Loading

jimklimov commented Sep 12, 2024

AppVeyorBot commented Sep 12, 2024

masterwishx commented Sep 13, 2024

Add missing values for ECO Mode Eaton #2620

Add missing values for ECO Mode Eaton #2620

Conversation

masterwishx commented Sep 9, 2024

masterwishx commented Sep 9, 2024

jimklimov commented Sep 10, 2024

masterwishx commented Sep 11, 2024

masterwishx commented Sep 11, 2024

masterwishx commented Sep 11, 2024

masterwishx commented Sep 11, 2024

masterwishx commented Sep 11, 2024 • edited Loading

masterwishx commented Sep 11, 2024 • edited by jimklimov Loading

jimklimov commented Sep 12, 2024

jimklimov commented Sep 12, 2024

masterwishx commented Sep 12, 2024

jimklimov commented Sep 12, 2024 • edited Loading

masterwishx commented Sep 12, 2024

jimklimov commented Sep 12, 2024

jimklimov commented Sep 12, 2024

masterwishx commented Sep 12, 2024

masterwishx commented Sep 12, 2024

jimklimov commented Sep 12, 2024

jimklimov commented Sep 12, 2024

jimklimov commented Sep 12, 2024

masterwishx commented Sep 12, 2024

masterwishx commented Sep 12, 2024

jimklimov commented Sep 12, 2024 • edited Loading

jimklimov commented Sep 12, 2024

AppVeyorBot commented Sep 12, 2024

masterwishx commented Sep 13, 2024

masterwishx commented Sep 11, 2024 •

edited

Loading

masterwishx commented Sep 11, 2024 •

edited by jimklimov

Loading

jimklimov commented Sep 12, 2024 •

edited

Loading

jimklimov commented Sep 12, 2024 •

edited

Loading