https://github.com/lucemans/com
https://github.com/lucemans/com
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/lucemans/com
- Owner: lucemans
- Created: 2020-11-18T15:11:11.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-18T16:36:45.000Z (over 5 years ago)
- Last Synced: 2025-06-26T23:58:41.699Z (about 1 year ago)
- Language: TypeScript
- Size: 7.81 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Control Oriented Management (COM)
Used for websocket registration and keep-alive of lvk-vendored IoT devices.
## Common Endpoint
com.lvk.sh/
## Summary
Devices should connect to the websocket endpoint,
Authorize using their ``secret``.
Assign themselves ``label``s
Send Keep-Alive messages on a regular basis
## FLOW
IoT Device performs the following registration workflow
```LCOM
> AUTH
< 200 OK
> ID
< 200 OK
> LABEL
< 200 OK
```
End user Device performs the following registration workflow
```LCOM
> AUTH
< 200 OK
```
The End user Device can now send commands to any device by referencing it by its label like so
```LCOM
> FORWARD
```
to which the device receives
```LCOM
< CMD
```
In order for the End User to list devices they can use
```LCOM
> devices
< DEVICE |
```