bonamin/bellsystems-cp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(ApiReference): redesign network.info and network.status documentation

Browse Source 
network.info: updated description and response example to reflect new fields
(subnet, mac, hostname, ssid, connection_type). Notes it as the command to use
for console panel population.

network.status: updated to show slimmed response (connected, ap_mode, rssi,
uptime_ms, state). Notes it as the command for monitoring/polling, not display.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
bonamin
2026-07-13 00:53:42 +03:00
co-authored by Claude Sonnet 4.6
parent 65ce446e44
commit a9b3b4e9b0
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
frontend/src/pages/engineering/developer/ApiReferencePage.jsx
+4 -4
View File
@@ -779,9 +779,9 @@ const NAMESPACES = [
cmd: 'network.info', cmd: 'network.info',
handler: 'NetworkHandler', handler: 'NetworkHandler',
transports: ['All'], transports: ['All'],
description: 'Get IP address, gateway, and DNS.', description: 'Get full network addressing details. Use this to populate the network panel in the console — covers all static/configured facts about the connection.',
contents: null, contents: null,
response: '{\n "status": "SUCCESS",\n "type": "network.info",\n "data": {\n "ip": "10.0.0.3",\n "gateway": "10.0.0.1",\n "dns": "8.8.8.8"\n }\n}', response: '{\n "status": "SUCCESS",\n "type": "network.info",\n "data": {\n "ip": "10.0.0.3",\n "subnet": "255.255.255.0",\n "gateway": "10.0.0.1",\n "dns": "8.8.8.8",\n "mac": "AA:BB:CC:DD:EE:FF",\n "hostname": "vesper-lab",\n "ssid": "BellSystemsInfra",\n "connection_type": "WIFI"\n }\n}\n\n// connection_type: WIFI | ETHERNET | AP',
errors: [], errors: [],
example: '{ "v": 2, "cmd": "network.info" }', example: '{ "v": 2, "cmd": "network.info" }',
warning: null, warning: null,
@@ -790,9 +790,9 @@ const NAMESPACES = [
cmd: 'network.status', cmd: 'network.status',
handler: 'NetworkHandler', handler: 'NetworkHandler',
transports: ['All'], transports: ['All'],
description: 'Get full connection state including SSID, MAC, hostname, RSSI, and AP mode flag.', description: 'Get live runtime network state — connection health, signal strength, and uptime. Use this for monitoring and polling, not for panel display.',
contents: null, contents: null,
response: '{\n "status": "SUCCESS",\n "type": "network.status",\n "data": {\n "connected": true,\n "state": "CONNECTED_WIFI",\n "type": "WIFI",\n "ip": "10.0.0.3",\n "rssi": -62,\n "ap_mode": false,\n "ssid": "BellSystemsInfra",\n "mac": "AA:BB:CC:DD:EE:FF",\n "hostname": "vesper-lab"\n }\n}\n\n// Possible state values: DISCONNECTED | CONNECTING | CONNECTED_WIFI | CONNECTED_ETHERNET | RECONNECTING | AP_MODE\n// Possible type values: WIFI | ETHERNET | AP | NONE', response: '{\n "status": "SUCCESS",\n "type": "network.status",\n "data": {\n "connected": true,\n "ap_mode": false,\n "rssi": -62,\n "uptime_ms": 3600000,\n "state": "CONNECTED_WIFI"\n }\n}\n\n// state: DISCONNECTED | CONNECTING | CONNECTED_WIFI | CONNECTED_ETHERNET | RECONNECTING | AP_MODE',
errors: [], errors: [],
example: '{ "v": 2, "cmd": "network.status" }', example: '{ "v": 2, "cmd": "network.status" }',
warning: null, warning: null,