victronenergy widget

[ederstef]

here is my customapi widget for my solar power plant from victron.

• VRM-Solavolta😎:
  icon: /icons/victron.png # your own icon link
  href: https://vrm.victronenergy.com/installation/**yourInstalationnumber**/dashboard
  ping: https://vrm.victronenergy.com/installation/**yourInstalationnumber**/dashboard
  widget:
  type: customapi
  url: https://vrmapi.victronenergy.com/v2/installations/**yourInstalationnumber**/stats?interval=15mins
  refreshInterval: 60000 # 1min. - in milliseconds, defaults to 10s
  method: GET # optional, e.g. POST
  headers:
  Content-Type: application/json
  x-authorization: Bearer your_Bearertoken
  mappings:
  - field:
  totals: total_solar_yield
  label: Erzeugung
  format: number
  suffix: kWh
  - field:
  totals: total_consumption
  label: Verbrauch
  format: number
  suffix: kWh
  - field:
  totals: grid_history_to
  label: Abgabe
  format: number
  suffix: kWh
  - field:
  records:
  bs:
  95: 1
  label: Batterie
  format: percent

[DefAdm]

Hi.

nice work, but i have some issues with "Bearer TokenID".
Could you tell me, if this: https://vrm.victronenergy.com/access-tokens is the right one?

If is possible, it will be nice to get a screenschot of integration file.

[ederstef]

Hi,

i have got the Bearer Token form visiting https://vrm.victronenergy.com/installation/your_instalation_id/dashboard
there i looked in the browsertoolbox in Network for POST | vrmapi.victronenergy.com ... in the header section scroll down to X-Authorization and there you have your Token.

[DefAdm]

Many thanks for the clarification. The bearer token works perfectly.
I was able to test it successfully with the help of https://vrm-api-docs.victronenergy.com/.

But now I'm still stuck.

I must be doing something wrong.

Can you send me a screenshot of your implementation (service.yaml)?

[ederstef]

I'm getting the same error wenn i change my bearer token... make sure you have the line as follows
x-authorization: Bearer xyzxyzxyz

[DefAdm]

I have made some progress. Thank you for your help.

Can you tell me how I can fix this?

[ederstef]

Hi,
you can transform the data with remap, scale and suffix explaind on costum api hompage.
https://gethomepage.dev/v0.7.4/widgets/services/customapi/

[DefAdm]

Unfortunately I couldn't do it because I have very little knowledge of programming.
I use a 5 column design and the inserted custom api widget widens the entire column.

Did you really manage it in your example?

[ederstef]

Hi,

yeah here is my full yaml. (change 111111 to your installation id and change the bearer token)

• SOSO:
  • VRM-Solavolta😎:
    icon: /icons/victron.png
    href: https://vrm.victronenergy.com/installation/111111/dashboard
    ping: https://vrm.victronenergy.com/installation/111111/dashboard
    widget:
    type: customapi
    url: https://vrmapi.victronenergy.com/v2/installations/111111/stats?interval=15mins
    refreshInterval: 600000 # optional - in milliseconds, defaults to 10s
    method: GET # optional, e.g. POST
    headers:
    Content-Type: application/json
    x-authorization: Bearer eyJ0xyzxyzxyzxyz...
    requestBody: # optional, can be string or object, see below
    display: # optional, default to block, list
    mappings:
    - field: #success # needs to be YAML string or object
    totals: total_solar_yield
    label: Erzeugung
    format: number # optional - defaults to text
    suffix: kWh
    - field: #success # needs to be YAML string or object
    totals: total_consumption
    label: Verbrauch
    format: number # optional - defaults to text
    suffix: kWh
    - field: #success # needs to be YAML string or object
    totals: grid_history_to
    label: Abgabe
    format: number # optional - defaults to text
    suffix: kWh
    - field: #success # needs to be YAML string or object
    records:
    bs:
    95: 1
    label: Batterie
    format: percent # optional - defaults to text

VRM-yaml.txt

did you get an respond on https://vrm-api-docs.victronenergy.com/#/operations/installations/idSite/stats ?

here my homepage

[DefAdm]

Thx a lot.
The VRM-yaml.txt file was the solution for me. I had a bad file formatting of my services.yaml.

I have still one question. My Barer Token seems to change daily. Can this be fixed somehow? Is that the case with you too?

Currently i implemented it with an API access tokens. This should always be valid.

[ederstef]

Hi,
no i dont have to change my baerer token in my .yaml file.
but it changes everytime when i check on the website.

[DefAdm]

How you get this value:

        - field:
            records:
                bs:
                  95: 1
          label: Batterie
          format: percent # optional - defaults to text

[ederstef]

i also have a battery storage connected in my vrm.
if you have also abattery in your system pls check https://vrm-api-docs.victronenergy.com/#/operations/installations/idSite/stats .

[MatthiasOs]

Hey nice work!

Some feedback:
Is there a better way to convert the float to a number? 2.212345678 gets converted to 2. It would be better to have some digits after the decimal point: i.e. 2.25. (Seems like a constraint of the custom api of homepage?)

The Installtion stats are always historical data (i.e. last day), is it possible to get current data? Seems like you would have to querry different url endpoints which doesnt seem to be possible with the custom api?

Matthias

[ederstef]

Hi,

for more decimal change format: number to format: float

for current data

here is my config.

- VRM-Solavolta1😎:
    icon: /icons/victron.png
    href: https://vrm.victronenergy.com/installation/**your idSite**/dashboard
    widget:
      type: customapi
      url: https://vrmapi.victronenergy.com/v2/users/_your idUser_/installations?extended=1&idSite=**your idSite**
      #refreshInterval: 600000 # optional - in milliseconds, defaults to 10s
      method: GET # optional, e.g. POST
      headers:
        Content-Type: application/json
        x-authorization: Bearer xyz...
        requestBody: # optional, can be string or object, see below
      display: # optional, default to block, list
      mappings:
        - field: #success # needs to be YAML string or object
            records:
                0:
                    extended:
                      16: rawValue
          label: Verbrauch
          format: number # optional - defaults to text
          suffix: Watt
        - field: #success # needs to be YAML string or object
            records:
                0:
                    extended:
                      17: rawValue
          label: Erzeugung
          format: number # optional - defaults to text
          suffix: Watt
        - field: #success # needs to be YAML string or object
            records:
                0:
                    extended:
                      18: rawValue
          label: Netz
          format: number # optional - defaults to text
          suffix: Watt
        - field: #success # needs to be YAML string or object
            records:
                0:
                    extended:
                      5: rawValue
          label: Batterie
          format: percent # optional - defaults to text

you can explore your current data here https://vrm-api-docs.victronenergy.com/#/operations/users/idUser/installations
fill out the extended parameter with 1

[MatthiasOs]

Works great, thanks!

I was just wondering: 16: rawValue 16 is the index in the array, is the index always the same?
(for me its a different index)

[MatthiasOs]

Btw i just realized you can use a token generated in VRM:
Preferences -> Integrations -> Access tokens
You should propably create and use a specific token and not your login bearer token.

Don't forget to change x-authorization to x-authorization: Token <your acces token>

[github-actions[bot]]

This discussion has been automatically closed due to inactivity. See our contributing guidelines for more details.