Homepage Widget for NUTify

[drewstopherlee]

If anyone else runs Homepage and is interested in adding a widget to display some data about the UPS, I'll post my config here. Add everything from widget: down to your existing entry for NUTify in your homepage services.yaml file.

Don't forget to update the url: IP address and port to match your installation!

- Example Section:
    - NUTify:
        href: http://10.0.0.91:5050/
        widget:
          type: customapi # Defines widget type per https://gethomepage.dev/widgets/services/customapi/
          url: http://10.0.0.91:5050/api/data/all # API endpoint for NUTify (change this to match your NUTify instance)
          refreshInterval: 5000 # Refresh every 5 seconds
          method: GET
          mappings:
            - field: # Get UPS status from NUTify (see https://networkupstools.org/docs/developer-guide.chunked/new-drivers.html#_status_data for an explanation of what these mean)
                data: ups_status
              label: UPS Status
              format: text #Display the API data as text
            - field:
                data: battery_charge # Get battery percentage from NUTify
              label: Battery Charge
              format: percent # and display it as a percent
            - field:
                data: ups_load # Get system load
              label: System Load
              format: percent # Also displayed as a percent
            - field: 
                data: ups_realpower # Get the power usage of the UPS
              label: Power Usage
              format: number # Display it as a number
              suffix: "W" # And add a W at the end to signify Watts

And here's what it should look like:

If anyone has suggestions or is interested in other stats being displayed, please let me know and I can rework this config. Thanks! :D
EDIT: Also if anyone is more familiar with React/JS than I am and would like to tackle a custom widget to be integrated into Homepage, I'm sure @DartSteven wouldn't mind ;)

[DartSteven]

Great job, thank you very much!

[drewstopherlee]

@cisxxc did you get a working widget config that you can share?

[cisxxc]

@drewstopherlee Yes, however the fix that I pull requested has not been implemented in the main docker image, instead I had to switch to the docker image dartsteven/nutify-internal-testing:0.2.1-amd64

I'll look to find the time to create a pull request to include it in the Wiki along with how to get all the variables that can be mapped.

Edit your Homepage services.yaml

Edit the values:
href
url:5050/api/data/all

- Nutify:
    icon: /icons/ups.svg
    href: https://nutify.domain.com
    widget:
      type: customapi
      url: http://containername:5050/api/data/all
      refreshInterval: 5000
      mappings:
        - field: # Get UPS status from NUTify
            data: ups_status
          label: UPS Status
          format: text #Display the API data as text
          remap:
            - value: OL
              to: Online
        - field:
            data: battery_charge # Get battery percentage from NUTify
          label: Battery Charge
          format: percent # and display it as a percent
        - field:
            data: ups_load # Get system load
          label: System Load
          format: percent # Also displayed as a percent
        - field: 
            data: ups_realpower # Get the power usage of the UPS
          label: Power Usage
          format: number # Display it as a number
          suffix: "W" # And add a W at the end to signify Watts

@DartSteven any chance the change gets merged into the main docker image or are you working on other things to include in the next version?

[DartSteven]

Pls try

docker pull dartsteven/nutify-internal-testing:0.2.1-amd64
docker pull dartsteven/nutify-internal-testing:0.2.1-raspberrypi5-arm64
docker pull dartsteven/nutify-internal-testing:0.2.1-raspberrypi4-armv7
docker pull dartsteven/nutify-internal-testing:0.2.1-mac-arm64

[cisxxc]

@DartSteven Thanks I've been running that image the last 4-5 days. No issues besides the top bar when signed in which I'm running behind Traefik, I see another post is already open on this.

With the gethomepage.dev config in my last message I was able to get that widget working without further issue after the merge of my pull request.

Thank you for your continued efforts!

[weedaz]

working nicely with " dartsteven/nutify-internal-testing:0.2.1-raspberrypi5-arm64"

many thanks for the efforts

[yeeahnick]

Great work and thanks for sharing. Does anyone know where to get the Nutify icon?

[drewstopherlee]

https://raw.githubusercontent.com/DartSteven/Nutify/refs/heads/main/nutify/static/img/favicon.ico should work!

[yeeahnick]

Thanks, it's a bit pixelated but it works.

[DartSteven]

https://github.com/DartSteven/Nutify/wiki/API-Quick-Reference

[Ryland0]

I'm receiving a permission issue through homepage. I have a SECRET_KEY but adding both key: and secret_key: in the widget did not work. I've also added everything from the example compose. user: root, privilagted: true and so on. I do not see a place inside the application to create integration credentials. Any assistance would be appreciated. Everything is working great otherwise. Both Homepage and Nutify are running under the same user:group in Docker.

Thank you for this!

API Error: HTTP Error
URL: http://10.19.82.16:5050/api/data/all
Response Data:
"{\n "error": "Authentication required"\n}\n"

[weedaz]

You do not need a SECRET_KEY
Use one of those internal images

docker pull dartsteven/nutify-internal-testing:0.2.1-amd64
docker pull dartsteven/nutify-internal-testing:0.2.1-raspberrypi5-arm64
docker pull dartsteven/nutify-internal-testing:0.2.1-raspberrypi4-armv7
docker pull dartsteven/nutify-internal-testing:0.2.1-mac-arm64

[Ryland0]

You are the wind beneath my wings friend, thank you.