Skip to content

docs(nibe): the Local REST API is enabled on the pump, not in the app - #737

Merged
frahlg merged 2 commits into
srcfl:masterfrom
HuggeK:nibe-doc-setup
Aug 4, 2026
Merged

docs(nibe): the Local REST API is enabled on the pump, not in the app#737
frahlg merged 2 commits into
srcfl:masterfrom
HuggeK:nibe-doc-setup

Conversation

@HuggeK

@HuggeK HuggeK commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Step 1 of the pump setup said to enable the Local REST API in the myUplink app. It is enabled on the pump's own screen, in the installer menu that also holds 7.5.15 — no app, no myUplink account. Confirmed on an S735.

The distinction is the point of the whole driver. A local-only integration that quietly required a cloud account to commission would not be one, and #537's whole argument for the local API over myuplink.lua rests on it.

The app still displays the certificate fingerprint, so that reference stays — next to the openssl command that does not need it.

Where this came from

It surfaced while classifying every catalog driver by how it is commissioned (srcfl/device-drivers#56, which files nibe_local as setup: [device_screen]). The pump's owner corrected the documented procedure from the hardware. This is the second correction to this file's setup story, after aidMode turned out not to be the write gate either — both times the doc described a NIBE feature by the route someone assumed, rather than the one the pump offers.

🤖 Generated with Claude Code

Step 1 said to enable the Local REST API in the myUplink app. It is enabled
on the pump's own screen, in the installer menu that also holds 7.5.15 --
no app and no myUplink account. Confirmed on an S735.

The distinction is the point of the whole driver: a local-only integration
that quietly required a cloud account to commission would not be one. The
app still displays the certificate fingerprint, so that reference stays,
next to the openssl command that does not need it.

Co-authored-by: HuggeK <48095810+HuggeK@users.noreply.github.com>
@HuggeK
HuggeK marked this pull request as ready for review July 31, 2026 12:59

@miravoss26 miravoss26 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Docs-only correction: the NIBE Local REST API is enabled from the pump's own screen (installer menu 7.5), not via the myUplink app. Confirmed on an S735, and it keeps the myUplink fingerprint value as a fallback note.

Reads correct and matches the 7.5.15 read-only line right below it. No code, nothing to screen. Safe to merge from my read. ftw isn't in my auto-merge allowlist, so a human clicks it.

@miravoss26 miravoss26 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Docs-only fix to nibe-local.md: step 1 now correctly says the Local REST API is enabled on the pump's own screen (installer menu 7.5, where 7.5.15 also lives), not in the myUplink app, with the username/password generated there. Fingerprint pinning keeps the openssl read and just notes the app shows the same value.

  • Internally consistent: the new "installer menu 7.5" in step 1 lines up with the 7.5.15 read-only reference in step 3.
  • Security screen clean: no code, secrets, deps, or network changes.
  • Matches the local-first framing the driver rests on (#537), and you confirmed it on an S735, so the factual claim holds.

Safe to merge from my read. Not on my auto-merge allowlist (ftw), so leaving the actual merge to a human.

@miravoss26 miravoss26 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Docs-only correction to docs/nibe-local.md: step 1 now enables the Local REST API on the pump's own screen (installer menu 7.5), not in the myUplink app, and step 2 leads with reading the cert fingerprint via openssl, keeping the app as an optional cross-check.

  • Accurate and self-consistent, and it's worth saying loudly: a local-only driver that quietly needed a cloud account wouldn't be one (per #537). Keeping the S735 confirmation in-text is a nice touch.
  • Security: nothing to flag. No secrets, no new network destination (the openssl s_client to the pump was already documented), and the read-only-by-default note (7.5.15) is worth keeping.

Safe to merge from my read. ftw isn't in my auto-merge allowlist, so this is a read for a human, not a merge.

@frahlg
frahlg merged commit 9324d56 into srcfl:master Aug 4, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants