lagertonne/nut
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Wiki Activity

new upstream 2.8.0

Browse source
This commit is contained in:
lagertonne 2022-06-29 12:37:36 +02:00
parent fc7f4b43c1
commit b2b0c9995a
836 changed files with 137090 additions and 30018 deletions
Download patch file Download diff file Expand all files Collapse all files

47
docs/developer-guide.txt
View file

@ -73,18 +73,19 @@ This mode allows to simulate any kind of devices, even non existing ones.
Using this method, you can either replay a real life sequence,
<<dev-recording,recorded from an actual device>>, or directly interact
through upsrw or by editing the device file, to modify the variables values.
through `upsrw` or by editing the device file, to modify the variables'
values.
Here is an example to setup a device simulation:
- install NUT as usual, if not already done
- get a simulation file (.dev) or sequence (.seq), or generate one using the
<<dev-recording,device recorder>>. Sample files are provided in the 'data'
directory of the NUT source. You can also download these from the development
repository, such as the
link:http://anonscm.debian.org/viewvc/nut/trunk/data/evolution500.seq?revision=2778&view=co[evolution500.seq].
- copy the simulation file to your sysconfig directory, like /etc/nut or
/etc/ups
- get a simulation file (`.dev`) or sequence (`.seq`), or generate one using
the <<dev-recording,device recorder>>. Sample files are provided in the
`data` directory of the NUT source. You can also download these from
the development repository, such as the
link:https://github.com/networkupstools/nut/raw/master/data/evolution500.seq[evolution500.seq].
- copy the simulation file to your sysconfig directory, like `/etc/nut`
or `/etc/ups`
- configure NUT for simulation (linkman:ups.conf[5]):
+
[dummy]
@ -92,7 +93,7 @@ link:http://anonscm.debian.org/viewvc/nut/trunk/data/evolution500.seq?revision=2
port = evolution500.dev
desc = "dummy-ups in dummy mode"
+
- now start NUT, at least dummy-ups and upsd:
- now start NUT, at least `dummy-ups` and `upsd`:
+
$ upsdrvctl start dummy
$ upsd
@ -102,15 +103,15 @@ link:http://anonscm.debian.org/viewvc/nut/trunk/data/evolution500.seq?revision=2
$ upsc dummy
...
+
- you can also use upsrw to modify the data:
- you can also use `upsrw` to modify the data in memory:
+
$ upsrw -s ups.status="OB LB" -u user -p password dummy
+
- or directly edit /etc/nut/evolution500.seq. In this case, modification will
only apply according to the TIMER events and the current position in the
sequence.
- or directly edit your copy of `/etc/nut/evolution500.seq`.
In this case, modification will only apply according to the `TIMER`
events and the current position in the sequence.
For more information, refer to linkman:dummy-ups[8] manual page.
For more information, refer to linkman:dummy-ups[8] manual page.
[[dev-recording]]
@ -118,11 +119,11 @@ For more information, refer to linkman:dummy-ups[8] manual page.
Device recording
----------------
To complete dummy-ups, NUT provides a device recorder script called
'nut-recorder.sh' and located in the 'tools/' directory of the
To complete `dummy-ups`, NUT provides a device recorder script called
`nut-recorder.sh` and located in the 'tools/' directory of the
NUT source tree.
This script uses 'upsc' to record device information, and stores
This script uses `upsc` to record device information, and stores
these in a differential fashion every 5 seconds (by default).
Its usage is the following:
@ -134,8 +135,8 @@ For example, to record information from the device 'myups' every 10 seconds:
nut-recorder.sh myups@localhost myups.seq 10
During the recording, you will want to generate power events, such as power
failure and restoration. These will be tracked in the simulation files, and be
eventually be replayed by the <<dev-simu,dummy-ups>> driver.
failure and restoration. These will be tracked in the simulation files, and
be eventually be replayed by the <<dev-simu,dummy-ups>> driver.
NUT core development and maintenance
@ -159,8 +160,14 @@ Appendix A: NUT command and variable naming scheme
include::nut-names.txt[]
[[daisychain]]
Appendix B: NUT daisychain support notes
========================================
include::daisychain.txt[]
[[lib-info]]
Appendix B: NUT libraries complementary information
Appendix C: NUT libraries complementary information
===================================================
include::../lib/README[]