https://github.com/qmk/xap-ws
Expose xap keyboards to a websocket
https://github.com/qmk/xap-ws
Last synced: about 1 year ago
JSON representation
Expose xap keyboards to a websocket
- Host: GitHub
- URL: https://github.com/qmk/xap-ws
- Owner: qmk
- Created: 2022-04-10T20:37:08.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-13T14:53:07.000Z (over 4 years ago)
- Last Synced: 2025-07-07T12:40:16.504Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 155 KB
- Stars: 0
- Watchers: 14
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Future Home of XAP WS
## GOALS
- provide a higher level API to functionality exposed by the XAP API. For example, low level calls expose the number of layers. XAP WS would present a higher level JSON document that contained a attribute the layers for that device.
- Take advantage of lower level APIs in XAP to provide a higher level API surface for less sophisticated clients
- listen to events of interest from XAP broadcasts and forward them to WS listeners
## ANTI GOALS
- expose XAP API in all it's glory. Use the language bindings.