Added WebSocket documentation

server/README.md

@@ -1,6 +1,7 @@
 # HapticTouch Server
 
 ## Instructions
+
 ```
 git clone https://github.com/AnujPanthri/HapticLink
 cd HapticLink/server
@@ -18,5 +19,160 @@ To run use:
 
 Both HTTP and WebSocket server are running on the same port
 
+# WORK IN PROGRESS
+
+## WebSocket API
+
+WebSockets payload will be in JSON and require atleast a `message` property
+Types can be `client -> server`, `server -> client <private | room>`.
+Private messages are sent directly to client
+Room messages are sent to everyone in a room
+
+### Test Connection
+
+**Type:** `client -> server`
+**Payload:**
+
+```typescript
+{
+    "message": "test_connection"
+}
+```
+
+**Type:** `server -> client <private>`
+**Response:**
+
+```typescript
+{
+    "message": "test_connection_response",
+    "latency": number,
+}
+```
+
+### Enter Room
+
+**Type:** `client -> server`
+**Description:** Used to enter a room. Join an existing room by including roomId.
+**Payload:**
+
+```typescript
+{
+    "message": "enter_room",
+    "roomId"?: string; // Room Id, optional
+}
+```
+
+**Type:** `server -> client <private>`
+**Payload:**
+
+```typescript
+{
+    "message": "enter_room_response"
+    "roomId": string,
+    "users": []{
+        username: string,
+        id: string,
+        online: boolean,
+        lastOnline: number, // ms epoch time
+    },
+    "status": "joined" | "created" | "failed"; // Failed likely means room doesn't exist
+}
+```
+
+### Leave Room
+
+**Type:** `client -> server`
+**Description:** Used to enter a room.
+**Payload:**
+
+```typescript
+{
+    "message": "enter_room",
+    "roomId": string; // Room Id, optional
+}
+```
+
+**Type:** `server -> client <private>`
+**Payload:**
+
+```typescript
+{
+    "message": "enter_room_response"
+    "roomId": string,
+    "users": []{
+        username: string,
+        id: string,
+        online: boolean,
+        lastOnline: number, // ms epoch time
+    },
+    "status": "joined" | "created" | "failed"; // Failed likely means room doesn't exist
+}
+```
+
+### Room Update
+
+**Type:** `server -> client <room>`
+**Description:** Server message that is sent when the room gets updated such as someone joins or leaves
+**Payload:**
+
+```typescript
+{
+    "message": "room_update",
+    "roomId": string,
+    "users": []{
+        username: string,
+        id: string,
+        online: boolean,
+        lastOnline: number, // ms epoch time
+    },
+}
+```
+
+### Send Touch
+
+**Type:** `client -> server`
+**Description:** Used to send touch/vibration data to room. Client assigns a number for an ID. That ID is then used to update the vibration. Re-use `send_touch` to update previous vibration. Use `"type": "disable"` to disable the vibration. If an update isn't sent within 1 second of creatin/last update it will automatically be disabled.
+**Payload:**
+
+```typescript
+{
+    "message": "send_touch",
+    "id": number, // Used to indentify vibrations for updating or disabling them
+    "type": "enable" | "disable", // Whether the vibration is active or not.
+    "position": {
+        x: number,
+        y: number,
+    },
+    "color"?: string, // Hex value. Default: random
+    "intensity"?: number, // Vibration intensity. Default: 1
+}
+```
+
+### Receive Touch
+
+**Type:** `server -> client <room>`
+**Description:**
+**Payload:**
+
+```typescript
+{
+    "message": "receieve_touch",
+    "id": string, // format: [userID]_[id]
+    "type": "enable" | "disable", // Whether the vibration is active or not.
+    "user": {
+        username: string,
+        id: string,
+    },
+    "position": {
+        x: number,
+        y: number,
+    },
+    "color": string, // Hex value.
+    "intensity": number, // Vibration intensity.
+}
+```
+
+## API
+
 **GET** `/`
 Responds with homepage.