Beta program for V0.4.0

[ArthurMitchell42]

The beta program for V0.4.0 has started

Please only access the beta version on DockerHub if you are willing to contribute feedback

Please pull the latest_beta tag from DockerHub

New features:
Add the ability to poll servers and devices, logging events and performance.
Events recorded will be:

• Status changes
  • On-line/On-battery
  • Charge start/end
  • Replace battery
  • Low battery
  • Shutdown
  • Bypass
  • Trim/boost
• Changes in battery charge
• Changes in reported run time
• Loss of connectivity
• Issues retrieving data from a server
• Missing client machines

Added a visual flag and dialogue box to indicate that there have been problems loading the config file
Changed the default icon to make it more compatible with dark themes.
Added new icons for use with HomePage, now in the services.yaml file you can use:

    icon: http://10.0.10.9:9995/static/squirrel2-32.png

Other images available are:

• squirrel1-32.png
• squirrel1-96.png
• squirrel2-32.png
• squirrel2-96.png
• acorn1-32.png
• acorn1-96.png
• acorn2-32.png
• acorn2-96.png

IMPORTANT - Breaking changes

Changed friendly name for devices to displayname in the servers section of the configuration.
Change the way the servers and devices are represented in the servers section of the config file.

• This is necessary to implement the logging functionality.

A typical servers section will change to look like this:

servers:
  - server: "10.0.10.9"
    port: 3493
    monitor: true
    devices:
      - device: ups
        default: true
        power: 550
        displayname: 'Downstairs CyberPower'
        clients: [ '10.0.10.10', '10.0.10.183', '127.0.0.1' ]
        # username: monuser
        # password: secret
      - device: another_ups
        power: 550
        displayname: 'Another example of a second UPS on the server'
        # username: monuser
        # password: secret
  - server: "10.0.10.180"
    port: 3493
    monitor: true
    devices:
      - device: eaton3s
        power: 850
        displayname: 'Upstairs Eaton'
        clients: [ '10.0.10.178', '127.0.0.1' ]
        # username: monuser
        # password: secret

Backward compatible, non-breaking changes

Added 'auto' option to control cl-count and cl-check rework statements that picks up the expected client information from the server section rather than the rework statement control value.
For example:

rework:
  - from: eaton3s
    to: nutcase.ups.client-count
    style: cl-count
    # control: [ "2", 'Missing {d} of {c}', 'Clients OK ({c})', '{d} Extra']
    control: [ "auto", 'Missing {d} of {c}', 'Clients OK ({c})', '{d} Extra']
  - from: eaton3s
    to: nutcase.ups.client-check
    style: cl-check
    # control: [ '10.0.10.178', '127.0.0.1' ]
    control: auto

You can see that the number of clients and the list of clients are redundant, they are now collected from the servers section (See above)

[adm2k]

Just installed the beta version and I guess I broke it :)

servers:

• server: "192.168.86.32"
  port: 3493
  monitor: true
  devices:
  device: 'apcmain'
  default: true
  displayname: 'APC BE600M1

Thanks for your guidance...
al

[adm2k]

here is my nutcase.yml

servers:

• server: 'http://192.168.86.32:3493?addr=192.168.86.32&dev=apcmain'
  port: 3493
  monitor: true
  devices:
  device: 'apcmain'
  default: true
  displayname: 'APC BE600M1'

[ArthurMitchell42]

Afternoon,
Did you check the section above on breaking changes and adjust you config file accordingly please?

[adm2k]

I have tried this in the nutcase.yaml and does not work
http://192.168.86.32:4394?addr=192.168.86&dev=apcmain

[adm2k]

I am confused since the change referenced shows this as an example:
servers:

• server: "10.0.10.9"
  port: 3493
  monitor: true
  devices:
  • device: ups
    default: true
    power: 550
    displayname: 'Downstairs CyberPower'
    clients: [ '10.0.10.10', '10.0.10.183', '127.0.0.1' ]

    username: monuser

    password: secret

  • device: another_ups
    power: 550
    displayname: 'Another example of a second UPS on the server'

    username: monuser

    password: secret

And the error shows this:
The server addess and device name were not given on the URL and no default server was found in the configuration file.

To specify a server on the URL you need to use both the parameters addr and dev e.g.

http://nutcase-ip:nutcase-port?addr=x.x.x.x&dev=ups-name

[adm2k]

All appears to be working now! See below.

I do get a warning icon on the page showing this:
There was an issue loading the configuration file nutcase.yml.
Please check the log for details.
To see information on the config file format please see

Updated as follows:
servers:

• server: "192.168.86.32"
  port: 3493
  monitor: true
  devices:
  • device: apcmain
    default: true

power: 550

    displayname: 'AMC BE600M1'

[ArthurMitchell42]

That's good news, it is worth pursuing what other issues might exist in the file.
I suggest that to catch the starting messages you might want to stop the container, delete all the log files and restart NUTCase. This will make sure you capture all the staring messages easily. You can then open a new issue and attach that file to it.

One thing that will make it easier to look at your configuration though, if you use the markdown trigger then GitHub then your settings will be displayed in mono-space and colour coded for ease of reading.

You can do this by starting a line with 3 tick marks (not single quote) but the tick key in the very top left of your keyboard. This is usually left of the '1' numeral and above the tab key.
Then follow that immediately with YAML to set the language. Then paste the config YAML and close it with 3 more tick marks.
So for example, (putting only 2 ticks in to avoid triggering the code mode):-

``YAML
some_code:

• Mode_code

''

Which displays as follows if you add the third tick:

some_code:
   - Mode_code

Check it with the preview tab on the editor window

[adm2k]

I stopped the container, deleted all logs files and restarted. Attached is the log file.
NUTCase log file.txt

[adm2k]

Config file...

servers:
  - server: "192.168.86.32"
    port: 3493
    monitor: true
    devices:
      - device: apcmain
        default: true
        displayname: 'APC BE600M1'

[adm2k]

and the config from Homepage

    - NUT Network UPS Tool:
        href: http://192.168.86.32:9995 # points to NUTCase GUI
        siteMonitor: http://192.168.86.32:9995
        statusStyle: dot
        description: APC BE600M1
        id: nutcase
        icon: ups.png
        widget:
            type: customapi
            url: http://192.168.86.32:9995/json?target=192.168.86.32:3493
            refreshInterval: 900000 # In milliseconds, set to ~60s
            method: GET
            #display: list
            mappings:
            - field: 
                apcmain: 
                   nutcase.ups.status.composite
                   #nutcase.ups.status
              label: Status
            - field: 
                apcmain:
                   battery.charge
              label: Battery
              format: text
              suffix: "%"
            - field:
                apcmain: 
                   #nutcase.ups.load.watts
                   ups.load
              label: Load
              format: text
              suffix: "%" 
            - field: 
                apcmain: 
                   nutcase.battery.runtime
              label: Runtime

[ArthurMitchell42]

I'll have a look at this at the weekend, I've just started a new job and it's a bit hectic.

[adm2k]

No problem. Good luck on the new job!
al...

[ArthurMitchell42]

Hmmm, the logs don't have any of the warnings that would reveal issues of the config, they look fine.
I have corrected one error with the log download button. That should now work again.
I have made a small tweak to log reporting so I suggest you re-pull the latest_beta tag which is now V0.4.0.1_beta and delete the logs again before re-running it.
If you still see the warning then hopefully the logs should show something, if so please attach them all to an issue case.
If you still have errors, please also attach your full nutcase.yaml file.
Arthur

[adm2k]

OK, just updated and still see the error:

Log attached:
nutcase.log

[ArthurMitchell42]

could you attach you whole nutcase.yaml file as an attachment please Al?
Thanks

[adm2k]

Had to add the .txt my browser is acting up :)

nutcase.yml.txt

[ArthurMitchell42]

I've identified that the warning was being over sensitive. It was caused by an optional feature, the web hooks, not being set. This should only be a warning in the log and not an alert on the UI.
I've released V0.4.0.2_beta which fixes this, as usual the latest_beta tag points to the new image.
Thanks for you patience.
Arthur

[adm2k]

Thanks for the update, installed and all is working!

The events detail is great information!

Have a good week!

Al...