Repository navigation
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings the Zap Local API page in line with the released Zap firmware v2.3.27. Each change was checked against the firmware source at tag
v2.3.27.Added
zap-<id>.local(the device ID).zap.localis added as an alias only if no other device on the network has already claimed it._http._tcpon port 80 with TXT recordsid/ver/mac.GET/POST /api/system/backendswitches between mainnet, testnet and devnet. It sets the backend that OTA and registration use, replaces the broker with that network's default and reboots.PUT /api/devices/{sn}updates a device's connection config. The new config must report the same serial number.POST /api/network/scanscans the subnet for open TCP ports.han_uartconnection type and example.Fixed
GET /api/system: field names are camelCase in firmware (timeUtcSec,uptimeSeconds,temperatureCelsius,memoryKb.percentUsed,processesAverage.last1min…). The response also includesbackend,zap.platform,wifiMac, the nestedinterfacesobject and the Ethernet fields.GET /api/network: shape updated to match./api/system/mqtt: the behaviour is now spelled out:mqtts, 1883 formqtt.sourceful.dev/srcful.devhosts. For any other host, verification is turned off./spiffs/system_config.json, not NVS.GET /api/devices/types: the response is an object keyed by connection type, not an array. Parameters includedisplay_name.POST /api/devices: P1/HAN smart meters are saved immediately and detected in the background. There is at most one smart meter per Zap, and a repeat request returns 200. The meter DER starts disabled, and the response has its own shape.GET /api/devices/{sn}: returns the stored device config. The page wrongly said it returned 501.GET /api/crypto/GET /api/name: realistic example IDs and the public-key format (128 hex characters, X‖Y).Removed
POST /api/crypto(wallet signing): the handler exists but is not registered in v2.3.27, so the route does not exist.Not included
/api/control/*) are not added to the developer portal, because control content was removed from the portal on purpose earlier (6dd54e8). Insrcful-documentationthe existing control section is left unchanged./api/ota/*) are not documented: they exist in code but are not registered in v2.3.27.Checks
The MDX compiles with
@mdx-js/mdx+remark-gfm+rehype-slug. All in-page anchors resolve. I did not run a fullnext build.Companion PR (same change in the other copy of this page): https://github.com/srcfl/srcful-developer-portal-v2/pull/10