📝 docs: Modbus endpoint group (devices.md) #124

Merged
mat merged 1 commit from docs/modbus-group into main 2026-10-11 11:12:21 +00:00
Owner

Summary

Consolidate the Modbus endpoint group into one section of devices.md (roadmap §2.4, issue #69):

 devices.md
 ## Single device
-  POST /api/devices/v2/modbus + sub-API line
+  POST /api/devices/v2/modbus → see Modbus group
 ## Connected objects
-  GET .../modbus-expert
+  GET .../modbus-expert → see Modbus group
 ## Gateways
-  GET .../scan-modbus-ip?port={port}
+  GET .../scan-modbus-ip → see Modbus group
+## Modbus group        (new, at end of file)
+  POST /api/devices/v2/modbus           (bundle only)
+  GET  /api/gateways/modbus-configurations  (200, 4 entries, shape)
+  GET  /api/gateways/{gatewayUid}/scan-modbus-ip  (504 after ~60 s)
+  GET|POST .../modbus-expert ; GET .../state-history
+    → 404 + bare array on non-Modbus objects (every AZUREIOT)

Closes #69.

Evidence

Live probe 2026-10-11 (END_USER session, reads only):

  • GET /api/gateways/modbus-configurations → 200, 4 entries, keys exactly {id, name, label, port, slave, device_kinds} — matches the issue's field list; sample entry (vendor catalogue) included.
  • GET /api/connectedobjects/{id}/modbus-expert / state-history → 404, content-type application/json, body = bare Spring array "No Modbus configuration associated with ConnectedObject id: {id}" — refines "404 on AZUREIOT": the trigger is no Modbus configuration, and the body is the #68 format with an extra field key.
  • scan-modbus-ip / POST endpoints: documented from the 2026-08-15 recon (scan + writes not re-probed — avoids mutating the live install).

Docs-only change, no code touched. Test suite: 139 passed (unchanged baseline).

Merge Danger

Door: two-way (docs-only, trivially revertible)

Blast Radius: none — documentation only.

## Summary Consolidate the Modbus endpoint group into one section of `devices.md` (roadmap §2.4, issue #69): ```diff devices.md ## Single device - POST /api/devices/v2/modbus + sub-API line + POST /api/devices/v2/modbus → see Modbus group ## Connected objects - GET .../modbus-expert + GET .../modbus-expert → see Modbus group ## Gateways - GET .../scan-modbus-ip?port={port} + GET .../scan-modbus-ip → see Modbus group +## Modbus group (new, at end of file) + POST /api/devices/v2/modbus (bundle only) + GET /api/gateways/modbus-configurations (200, 4 entries, shape) + GET /api/gateways/{gatewayUid}/scan-modbus-ip (504 after ~60 s) + GET|POST .../modbus-expert ; GET .../state-history + → 404 + bare array on non-Modbus objects (every AZUREIOT) ``` Closes #69. ## Evidence Live probe 2026-10-11 (END_USER session, reads only): - **`GET /api/gateways/modbus-configurations`** → `200`, 4 entries, keys exactly `{id, name, label, port, slave, device_kinds}` — matches the issue's field list; sample entry (vendor catalogue) included. - **`GET /api/connectedobjects/{id}/modbus-expert` / `state-history`** → `404`, content-type `application/json`, body = bare Spring array `"No Modbus configuration associated with ConnectedObject id: {id}"` — refines "404 on AZUREIOT": the trigger is *no Modbus configuration*, and the body is the #68 format with an extra `field` key. - `scan-modbus-ip` / `POST` endpoints: documented from the 2026-08-15 recon (scan + writes not re-probed — avoids mutating the live install). Docs-only change, no code touched. Test suite: 139 passed (unchanged baseline). ## Merge Danger **Door:** two-way (docs-only, trivially revertible) **Blast Radius:** none — documentation only.
📝 docs: Modbus endpoint group (devices.md)
All checks were successful
Tests / forgejo-pytest (pull_request) Successful in 42s
Tests / forgejo-pytest (push) Successful in 42s
bf02cd2a33
mat changed title from WIP: 📝 docs: Modbus endpoint group (devices.md) to 📝 docs: Modbus endpoint group (devices.md) 2026-10-11 11:12:16 +00:00
mat merged commit e3db53ab05 into main 2026-10-11 11:12:21 +00:00
mat deleted branch docs/modbus-group 2026-10-11 11:12:21 +00:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
mat/python-comwatt-client!124
No description provided.