Beta release for V0.2.0 is ready with a set of new features #5

ArthurMitchell42 · 2023-12-11T17:49:57Z

ArthurMitchell42
Dec 11, 2023
Maintainer

The Beta release for V0.2.0 is ready. This can be pulled from DockerHub as kronos443/nutcase:v0.2.0-beta3

New features

Added support for APC servers running apcupsd daemon
Added listing the APC log events with the end point /apclog
Added support for variable reworking to make virtual variables with changed text or numeric values [1]
Added support for a health check end point /health which returns JSON “OK”: ”True”
Added a list of NUT client machines and a count number of same to the returned JSON under: [2]
- \ clients \ list and
- \ clients \ count

[1] This feature requires a new configuration file and the options available are documented here

[2] The new information, listing the clients of each UPS, is placed under the UPS section of the JSON as follows. You can also see some reworked variables added to the list just above them.

adm2k · 2023-12-14T10:42:32Z

adm2k
Dec 14, 2023

Well I apologize but I am a bit confused...

First, the configuration file should be placed in the volume mapped to /config and it should have the file name nutcase.yml." Is that on the server running the docker instance or on my Homepage server?

Second, what change needs to be made in my Homepage service widget?

Thanks again and sorry for my misunderstanding.

al

1 reply

ArthurMitchell42 Dec 14, 2023
Maintainer Author

Good afternoon,
As this is the configuration file for NUTCase it will need to go into the directory on the machine you are running NUTCase on, in the directory which is mapped to it's /config directory.
More often than not, that would be /docker/nutcase on the host machine which runs the docker instance that has NUTCase on it.

If we follow the examples then if the config file contains:

rework:
  - from: battery.runtime
    to: nutcase.battery.runtime
    style: time
    control: "%Mm %Ss"

Then the entry in your homepage services.yaml file would change from:

  mappings:
      - field: 
          apcmain:
            battery.runtime
        label: Input
        format: text

to:

  mappings:
      - field: 
          apcmain:
            nutcase.battery.runtime
        label: Input
        format: text

The to: line in the nutcase.yml doesn't need to have the new name in this format, adding netcase. as a prefix is just a suggestion to make it easy to find it. You could call it joe.bloggs and put that in your HomePage configuration for example as long as it doesn't match an existing variable name.
To check that any new variable you make is included and the format is what you need, just load the json path into a web browser as we did when we were debugging the communications.

You can see some new variables at the bottom of this JSON example, they all start with nutcase. as an example:

Also, don't forget to try other formats if you like it to be displayed another way:

Examples of the control string and the resulting output are:

control	Displayed
"%Mm %Ss"	07m 05s
"%H:%M:%S"	00:22:05
"%-M:%S"	7m:05s

See the Python library documentation for the possibilities.

adm2k · 2023-12-14T13:42:34Z

adm2k
Dec 14, 2023

Greetings,

Thank you for the clarification, I understand now. Will be giving this a go a bit later today.

al...

0 replies

adm2k · 2023-12-15T10:58:47Z

adm2k
Dec 15, 2023

I am so sorry to bother but, am having some issues...

1 - Here is my docker run command:
docker run -d --name NUTCase -v /docker/nutcase:/config -e TZ=America/New_York -p 9995:9995 --restart always kronos443/nutcase:v0.2.0-beta3

2 - I put the configured nutcase.yaml in docker/nutcase:
rework

from: battery.runtime
to: nutcase.battery.runtime
style: time
control: "%H %Mn"
from: ups.status
to: nutcase.ups.status
style: simple-enum
control:
from: [ "OL", "OB", "LB", "CHRG", "RB", "FSD", "BYPASS>
to: [ "On-Line", "On-Bat", "Low-Bat", "Charging", "Rep>
default: "Other"
from: ups.load
to: nutcase.ups.load.watts
style: ratio
control: ups.realpower.nominal

3 -From my Homepage service.yaml:
- field:
apcmain:
nutcase.battery.runtime
label: Runtime

4 - This is what is displayed for nutcase.battery.runtime:

5 - When I look at the json I don't see any thing prefaced with "nutcase"
http://192.168.86.24:9995/json?target=192.168.86.24:3493
{"server_version": "2.8.0", "server_address": "192.168.86.24", "server_port": 3493, "apcmain": {"description": "Description unavailable", "battery.charge": "100", "battery.charge.low": "10", "battery.charge.warning": "50", "battery.date": "2001/09/25", "battery.mfr.date": "2022/04/30", "battery.runtime": "2812", "battery.runtime.low": "120", "battery.type": "PbAc", "battery.voltage": "13.6", "battery.voltage.nominal": "12.0", "device.mfr": "American Power Conversion", "device.model": "Back-UPS ES 600M1", "device.serial": "4B2217P05773 ", "device.type": "ups", "driver.name": "usbhid-ups", "driver.parameter.bus": "002", "driver.parameter.pollfreq": "30", "driver.parameter.pollinterval": "1", "driver.parameter.port": "auto", "driver.parameter.product": "Back-UPS ES 600M1 FW:928.a9 .D USB FW:a9", "driver.parameter.productid": "0002", "driver.parameter.serial": "4B2217P05773", "driver.parameter.synchronous": "auto", "driver.parameter.vendor": "American Power Conversion", "driver.parameter.vendorid": "051D", "driver.version": "2.8.0", "driver.version.data": "APC HID 0.98", "driver.version.internal": "0.47", "driver.version.usb": "libusb-1.0.26 (API: 0x1000109)", "input.sensitivity": "medium", "input.transfer.high": "139", "input.transfer.low": "92", "input.voltage": "119.0", "input.voltage.nominal": "120", "ups.beeper.status": "enabled", "ups.delay.shutdown": "20", "ups.firmware": "928.a9 .D", "ups.firmware.aux": "a9 ", "ups.load": "17", "ups.mfr": "American Power Conversion", "ups.mfr.date": "2022/04/30", "ups.model": "Back-UPS ES 600M1", "ups.productid": "0002", "ups.realpower.nominal": "330", "ups.serial": "4B2217P05773 ", "ups.status": "OL", "ups.test.result": "No test initiated", "ups.timer.reboot": "0", "ups.timer.shutdown": "-1", "ups.vendorid": "051d", "clients": {"count": 0, "list": []}}}

What am I missing?

Thanks, al

1 reply

ArthurMitchell42 Dec 15, 2023
Maintainer Author

Hi Al,

I notice a couple of things in the nutcase.yml file, although I'm not sure if they are just copy-and-paste issues from your editor?

First, the first line seems to be missing a colon from the rework statement?

rework
  - from: battery.runtime
    to: nutcase.battery.runtime
    ....

Where as YAML format would require it to be:

rework:
  - from: battery.runtime
    to: nutcase.battery.runtime
    ......

The other thing might be GitHub truncating the lines but the lists seem to be terminated with an odd character:

Yours:
      from: [ "OL", "OB", "LB", "CHRG", "RB", "FSD", "BYPASS>
      to: [ "On-Line", "On-Bat", "Low-Bat", "Charging", "Rep>

Where as YAML would expect:
      from: [ "OL", "OB", "LB", "CHRG", "RB", "FSD", "BYPASS", "SD", "CP", "BOOST", "OFF" ]
      to: [ "On-Line", "On-Bat", "Low-Bat", "Charging", "Replace-Bat", "Force-Shutdown", "Bypass", "Shutdown", "On-Line", "Boost", "Off" ]

Closing a list should be done with a ] character, not a >

If these are just copy errors then the thing we need to do is look at your log file. If it still doesn't work with the points above could you take the file called nutcase.log from the /docker/nutcase directory and attach the whole file as a file (rather than pasting the contents into a message) and I'll look through it.

You may find a nutcase.log.1 or .2/.3 in the same directory, you can ignore them for now.
Arthur

adm2k · 2023-12-15T12:12:58Z

adm2k
Dec 15, 2023

I corrected the typos, no change. Attached is log file.

Thank you!
nutcase.log

0 replies

ArthurMitchell42 · 2023-12-15T12:17:09Z

ArthurMitchell42
Dec 15, 2023
Maintainer Author

Did you restart the container after editing the control file please?

0 replies

adm2k · 2023-12-15T12:35:19Z

adm2k
Dec 15, 2023

Restarted, no change yet...

0 replies

ArthurMitchell42 · 2023-12-15T12:36:39Z

ArthurMitchell42
Dec 15, 2023
Maintainer Author

ok, can you post the log now please after the restart.
Thanks

0 replies

adm2k · 2023-12-15T12:43:57Z

adm2k
Dec 15, 2023

attached...

nutcase.log

0 replies

adm2k · 2023-12-15T12:48:38Z

adm2k
Dec 15, 2023

By the way, the NUTCase.log has no entries from today. The log I sent you was nutcase.log.1 which has todays entries

0 replies

adm2k · 2023-12-15T12:50:38Z

adm2k
Dec 15, 2023

sorry,
nutcase.log
here is the most current log

0 replies

ArthurMitchell42 · 2023-12-15T13:14:24Z

ArthurMitchell42
Dec 15, 2023
Maintainer Author

ok, that makes sense of what you see.

The key thing I notice is:

2023-12-15 07:34:54,047 INFO     nutcase: Program starting. App version is 0.2.0 Beta 2, Logging level is DEBUG
2023-12-15 07:34:54,047 DEBUG    configuration: Config file not found /config/nutcase.yml
2023-12-15 07:34:54,048 DEBUG    nutcase: Configuration in use:
None

There are a couple of reasons that might cause this file not to be found and we should be able to fix this.

Can you log in to the system running the docker instance that is hosting nutcase and type this and post the resultant listing in full please:

cd /docker/nutcase
ls -al

Then please type:

sudo docker ps

This lists the containers running. From the line with nutcase can you take the long hexadecimal number in the first column and substitute it for xxxxxxx in the following commands:

sudo docker exec xxxxxxxx ls -al /config

This will give a listing which should look a lot like this:

total 1444
drwxr-xr-x    1 1026     users          174 Dec 15 12:20 .
drwxr-xr-x    1 root     root           152 Dec 12 09:45 ..
-rwxr-xr-x    1 1026     users       215298 Dec 15 12:29 nutcase.log
-rwxr-xr-x    1 1026     users       249754 Dec 15 12:20 nutcase.log.1
-rwxr-xr-x    1 1026     users       249966 Dec 15 12:10 nutcase.log.2
-rwxr-xr-x    1 1026     users       246103 Dec 15 11:59 nutcase.log.3
-rwxr-xr-x    1 1026     users       249438 Dec 15 11:49 nutcase.log.4
-rwxr-xr-x    1 1026     users       248793 Dec 15 11:39 nutcase.log.5
-rwxr-xr-x    1 1026     users         1104 Dec 10 18:30 nutcase.yml

Can you post the output you get in full please?

If your listing has a file called nutcase.yml please follow it up with:

sudo docker exec xxxxxx cat /config/nutcase.yml

and post the full output you get from that please.

One final question, which method did you use to install docker please and which base OS distribution are you on?

Thanks,
Arthur

0 replies

adm2k · 2023-12-15T13:24:14Z

adm2k
Dec 15, 2023

root@nut-2:/docker/nutcase# ls -al
total 1612
drwxr-xr-x 3 root root 4096 Dec 15 07:09 .
drwxr-xr-x 3 root root 4096 Dec 4 16:38 ..
drwxr-xr-x 2 root root 4096 Dec 15 05:45 config
-rw-r--r-- 1 root root 229672 Dec 15 08:05 nutcase.log
-rw-r--r-- 1 root root 155271 Dec 14 16:04 NUTCase.log
-rw-r--r-- 1 root root 245951 Dec 15 07:08 nutcase.log.1
-rw-r--r-- 1 root root 245454 Dec 15 05:37 nutcase.log.2
-rw-r--r-- 1 root root 245259 Dec 15 02:47 nutcase.log.3
-rw-r--r-- 1 root root 245259 Dec 14 21:32 nutcase.log.4
-rw-r--r-- 1 root root 249859 Dec 14 17:17 nutcase.log.5
-rw-r--r-- 1 root root 440 Dec 15 07:08 nutcase.yaml

docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
faba53c6dd79 kronos443/nutcase:v0.2.0-beta3 "python /app/nutcase…" 16 hours ago Up 46 minutes 0.0.0.0:9995->9995/tcp, :::9995->9995/tcp NUTCase

docker exec faba53c6dd79 ls -al /config
total 1620
drwxr-xr-x 3 root root 4096 Dec 15 07:09 .
drwxr-xr-x 1 root root 4096 Dec 14 16:10 ..
-rw-r--r-- 1 root root 155271 Dec 14 16:04 NUTCase.log
drwxr-xr-x 2 root root 4096 Dec 15 05:45 config
-rw-r--r-- 1 root root 241351 Dec 15 08:20 nutcase.log
-rw-r--r-- 1 root root 245951 Dec 15 07:08 nutcase.log.1
-rw-r--r-- 1 root root 245454 Dec 15 05:37 nutcase.log.2
-rw-r--r-- 1 root root 245259 Dec 15 02:47 nutcase.log.3
-rw-r--r-- 1 root root 245259 Dec 14 21:32 nutcase.log.4
-rw-r--r-- 1 root root 249859 Dec 14 17:17 nutcase.log.

Maybe this is the problem?
docker exec faba53c6dd79 cat /config/nutcase.yml
cat: can't open '/config/nutcase.yml': No such file or directory

0 replies

adm2k · 2023-12-15T13:24:50Z

adm2k
Dec 15, 2023

I need to step away for about an hour, more later...

0 replies

adm2k · 2023-12-15T13:30:32Z

adm2k
Dec 15, 2023

OS: Debian GNU/Linux 12 (bookworm)

DOCKER INSTALL:

apt install apt-transport-https ca-certificates curl software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | apt-key add -
add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable"
apt-cache policy docker-ce
apt install docker-ce

0 replies

ArthurMitchell42 · 2023-12-15T13:38:56Z

ArthurMitchell42
Dec 15, 2023
Maintainer Author

ok, I think the copy-paste on the listing was short?

-rw-r--r-- 1 root root 245259 Dec 14 21:32 nutcase.log.4
-rw-r--r-- 1 root root 249859 Dec 14 17:17 nutcase.log.

it seems to end abruptly, can you check and maybe repost? I would expect it to continue with log.5 and then list the config file on the next line?

If so the other thing to note is that you have named it .yaml where as the file needs to be .yml Could you check the listing, then change the name and restart the container please?

0 replies

adm2k · 2023-12-15T16:11:35Z

adm2k
Dec 15, 2023

OK, I renamed the file to .yml ans restarted the container, no change yet.

Attached is the log file. The other log files dated today have entries only from hours ago.
nutcase.log

0 replies

ArthurMitchell42 · 2023-12-15T17:03:40Z

ArthurMitchell42
Dec 15, 2023
Maintainer Author

Hi Al,

The log points out at line 308:

2023-12-15 11:06:29,740 ERROR    configuration: Error loading Control_YAML while parsing a block mapping
  in "/config/nutcase.yml", line 1, column 1
expected <block end>, but found '<block sequence start>'
  in "/config/nutcase.yml", line 6, column 2
2023-12-15 11:06:29,741 DEBUG    nutcase: Configuration in use:
None

and looking at your configuration there seems to be an indentation error in line 6 and 13:

rework:
  - from: battery.runtime
    to: nutcase.battery.runtime
    style: time
    control: "%H %Mn"
 - from: ups.status
    to: nutcase.ups.status
    style: simple-enum
    control: 
      from: [ "OL", "OB", "LB", "CHRG", "RB", "FSD", "BYPASS", "SD", "CP", "BOOST", "OFF" ]
      to: [ "On-Line", "On-Bat", "Low-Bat", "Charging", "Replace-Bat", "Force-Shutdown", "Bypass", "Shutdown", "On-Line", "Boost", "Off" ]
      default: "Other"
 - from: ups.load
    to: nutcase.ups.load.watts
    style: ratio
    control: ups.realpower.nominal

Try putting one more space on those lines like this:

rework:
  - from: battery.runtime
    to: nutcase.battery.runtime
    style: time
    control: "%H %Mn"
  - from: ups.status
    to: nutcase.ups.status
    style: simple-enum
    control: 
      from: [ "OL", "OB", "LB", "CHRG", "RB", "FSD", "BYPASS", "SD", "CP", "BOOST", "OFF" ]
      to: [ "On-Line", "On-Bat", "Low-Bat", "Charging", "Replace-Bat", "Force-Shutdown", "Bypass", "Shutdown", "On-Line", "Boost", "Off" ]
      default: "Other"
  - from: ups.load
    to: nutcase.ups.load.watts
    style: ratio
    control: ups.realpower.nominal

One thing that might be useful is the on-line YAML lint tool which will check any YAML and give (mostly) useful feedback, although occasionally I find the output a little miss directing.

0 replies

adm2k · 2023-12-15T18:09:54Z

adm2k
Dec 15, 2023

I think that misaligned yml was the issue. It is working now.

I am certainly sorry for all the trouble you had to go through is helping me resolve - I do appreciate it!

I am relatively new to using Docker and yaml files in general but this has certainly been a learning experience.

By the way, are you "promoting" NUTCase on the Homepage GitHub site?

Many thanks!

al

1 reply

ArthurMitchell42 Dec 15, 2023
Maintainer Author

Don't worry about it, going through the debugging steps helps me improve the documentation on the project Wiki.

I wasn't aware it was possible to promote a tool on their site, what do you suggest please?

adm2k · 2023-12-15T18:21:06Z

adm2k
Dec 15, 2023

See this link:
https://github.com/gethomepage/homepage/discussions/new/choose

Maybe the General or Show and Tell or both sections.

1 reply

ArthurMitchell42 Dec 15, 2023
Maintainer Author

Thank you, I'll look into this.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Beta release for V0.2.0 is ready with a set of new features #5

{{title}}

Replies: 19 comments 4 replies

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Beta release for V0.2.0 is ready with a set of new features #5

ArthurMitchell42 Dec 11, 2023 Maintainer

New features

Replies: 19 comments · 4 replies

ArthurMitchell42 Dec 14, 2023 Maintainer Author

ArthurMitchell42 Dec 15, 2023 Maintainer Author

ArthurMitchell42 Dec 15, 2023 Maintainer Author

ArthurMitchell42 Dec 15, 2023 Maintainer Author

ArthurMitchell42 Dec 15, 2023 Maintainer Author

ArthurMitchell42 Dec 15, 2023 Maintainer Author

ArthurMitchell42 Dec 15, 2023 Maintainer Author

ArthurMitchell42 Dec 15, 2023 Maintainer Author

ArthurMitchell42 Dec 15, 2023 Maintainer Author

ArthurMitchell42
Dec 11, 2023
Maintainer

Replies: 19 comments 4 replies

ArthurMitchell42 Dec 14, 2023
Maintainer Author

ArthurMitchell42 Dec 15, 2023
Maintainer Author

ArthurMitchell42
Dec 15, 2023
Maintainer Author

ArthurMitchell42
Dec 15, 2023
Maintainer Author

ArthurMitchell42
Dec 15, 2023
Maintainer Author

ArthurMitchell42
Dec 15, 2023
Maintainer Author

ArthurMitchell42
Dec 15, 2023
Maintainer Author

ArthurMitchell42 Dec 15, 2023
Maintainer Author

ArthurMitchell42 Dec 15, 2023
Maintainer Author