william/th7
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

README

Browse Source
This commit is contained in:
William Clark 2023-12-13 20:05:04 +00:00
parent 90b6c6d1ee
commit fb6e644e8a
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -77,7 +77,7 @@ In this case, the `[DB]` field in `config.toml` can be left empty except for `ty
## API
The TH7 implements a simple REST API along with a websocket endpoint that periodically dumps data probably relevant to user logging applications.
The TH7 implements a simple REST API along with a websocket service that periodically dumps data, probably relevant to user logging applications.
#### REST API
@ -162,12 +162,13 @@ POST v1/config/device
POST v1/config/channel/:id
--- Modify or add a field in the database config map object ---
--- This endpoint must be explicitly enabled ---
POST v1/config/db
```
#### WebSocket
The WebSocket endpoint requires no configuration, and will dump data at a regular interval to any active client connection. The data is functionally identical to `GET v1/data`. Example:
The WebSocket endpoint is available on `/ws` and requires no configuration to use. It will dump data at a regular interval to any active client connection. The data is functionally identical to `GET v1/data`. Example:
```json
{