https://github.com/virtualbrainlab/vbl-proxy-server
Proxy server for Pinpoint
https://github.com/virtualbrainlab/vbl-proxy-server
Last synced: 10 months ago
JSON representation
Proxy server for Pinpoint
- Host: GitHub
- URL: https://github.com/virtualbrainlab/vbl-proxy-server
- Owner: VirtualBrainLab
- Created: 2023-07-11T17:44:18.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T18:43:45.000Z (over 1 year ago)
- Last Synced: 2024-05-22T19:51:49.007Z (over 1 year ago)
- Language: JavaScript
- Size: 17.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VirtualBrainLab Proxy Server
This server runs both a Socket.IO (port 5000) and WebSocket (port 5001) server on the same Node.JS application.
## Connect as sender
To connect as a sender send the `ID` message with a list of strings `["your-id-string", "send"]`. Your client will be registered as a sender.
## Connect as receiver
To connect as a sender send the `ID` message with a list of strings `["your-id-string", "receive"]`. Your client will be registered as a sender.
## Messages (Sender -> Receiver)
By default, all messages from senders except the restricted messages (see below) are automatically forwarded to all senders with a matching ID.
### Reverse messages (Receiver -> Sender)
Some message headers are restricted and will not be forwarded from senders to receivers. These are used only to send data back to the sender from the receiver.
| Message | Data | Purpose |
|--------------|-----------|------------|
| ID | [string, string] | Register a receiver with the server |
| log | string | Send logging data |
| log-warning | string | Send warning data |
| log-error | string | Send error data |
| ReceiveCameraImgMeta | ... | custom |
| ReceiveCameraImg | ... | custom |