Skip to content

docs(iobroker): clarify rest-api adapter requires webInstance config - #33088

Closed
github-actions[bot] wants to merge 1 commit into
masterfrom
fix/issue-33087
Closed

docs(iobroker): clarify rest-api adapter requires webInstance config#33088
github-actions[bot] wants to merge 1 commit into
masterfrom
fix/issue-33087

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

fixes #33087

The IOBROKER meter template always builds requests as /rest-api/v1/state/<state>/plain. This path only exists when the ioBroker rest-api adapter is configured with a webInstance (e.g. web.0) and is thereby served through the ioBroker Web Adapter. Without that, the rest-api adapter's own port serves /v1/state/... directly (no /rest-api/ prefix), so evcc's requests return 404 while the endpoint itself works fine outside evcc.

This adds a note to the German and English template descriptions clarifying that webInstance must be set and that the Web Adapter's host/port must be used as the evcc URI.

🤖 Generated with Claude Code

@andig
andig marked this pull request as ready for review August 23, 2026 10:08

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@andig

andig commented Aug 23, 2026

Copy link
Copy Markdown
Member

@kscholty I would have expected this to have been resolved by now, but apparently it isn't?

@andig

andig commented Aug 23, 2026

Copy link
Copy Markdown
Member

@kscholty I would have expected this to have been resolved by now, but apparently it isn't? Worse, this is apparently

  • confusing and unexpected for users and
  • inconsistent since the BMW integration does it directly

We can either

  • do it consistently everywhere
  • and/or drop BMW since we have a nice EUDA solution meanwhile
  • drop ioBroker alltogether if there's no working generic config

Which would you prefer? Happy to take a PR.

@andig andig added the infrastructure Basic functionality label Aug 23, 2026
@kscholty

Copy link
Copy Markdown
Contributor

I'm happy to help, but I don't get the point. I recently created 2 PRs to change the documentation to make this point clear. #32816 was not merged, while #32817 was. So the charger has been corrected, while the meter has not.

What does BMW have to do with that and what do you mean with "directly"? Can you point me to a resource that explains that point?

There are two ways to set up the rest adapter. Either stand-alone or as an extension to the Web adapter.
Depending on that decision the urls are slightly different. Current implementation assumes the second (in my mind more common) setup.
We can certainly implement something that works with both setups, but that would complicate the temple significantly. Let me know if that's what you want.

@andig

andig commented Aug 23, 2026

Copy link
Copy Markdown
Member

Ah, thought this was a duplicate: #32816 (comment). Never got a response after that.

What does BMW have to do with that and what do you mean with "directly"? Can you point me to a resource that explains that point?

Sure: https://github.com/evcc-io/evcc/blob/master/templates/definition/vehicle/ioBroker.bmw.yaml

This has existed for a long time and never got any issues regarding the URL.

There are two ways to set up the rest adapter. Either stand-alone or as an extension to the Web adapter.
Depending on that decision the urls are slightly different. Current implementation assumes the second (in my mind more common) setup.

I get that. It does however seem as if the "web adapter extension" is more surprising than the other variant?

@andig andig closed this Aug 24, 2026
@andig
andig deleted the fix/issue-33087 branch August 24, 2026 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

infrastructure Basic functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ioBroker IOBROKER meter requires undocumented Web Adapter configuration

2 participants