Corrected documentations

server/README.md

@@ -1,6 +1,8 @@
 # HapticTouch Server
 
-## Instructions
+The HapticTouch server is a NodeJS/TypeScript WebSocket and Express server used to manage HapticTouch.
+
+# Instructions
 
 ```
 git clone https://github.com/AnujPanthri/HapticLink
@@ -15,69 +17,77 @@ To build use:
 To run use:
 `npm start`
 
-## Documentation
+# Documentation
 
 Both HTTP and WebSocket server are running on the same port
 
-# WORK IN PROGRESS
-
-## WebSocket API
+# WebSocket API
 
-WebSockets payload will be in JSON and require atleast a `route` property
+WebSockets payload will be in JSON and require atleast a `route` 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
+Private messages are sent directly to the client.
+Room messages are sent to everyone in a room.
 
-## Test Connection
+## Get User Info
 
 **Type:** `client -> server`  
 **Payload:**
 
 ```typescript
 {
-    "route": "test_connection"
+    "route": "get_user_info",
 }
 ```
 
 **Type:** `server -> client <private>`  
-**Response:**
+**Payload:**
 
 ```typescript
 {
-    "message": "test_connection_response",
+    "message": "set_username_response",
+    "status": string,
+    "user": {
+        "username": string,
+        "id": string,
+        "currentRoom": string,
+    }
 }
 ```
 
-## Set Username
+## Join Room
 
 **Type:** `client -> server`  
+**Description:** Used to enter a room. Join an existing room by including roomId, or if room doesn't exist, create one with a random ID  
 **Payload:**
 
 ```typescript
 {
-    "route": "set_username",
-    "username": string,
+    "route": "join_room",
+    "roomId"?: string, // Room Id, optional
+    "username"?: string,
 }
 ```
 
 **Type:** `server -> client <private>`  
-**Payload:**
+**Payload (only sent if there's an error, else room_update is sent):**
 
 ```typescript
 {
-    "message": "set_username_response",
+    "message": "join_room_response",
     "status": string,
 }
 ```
 
-## Get User Info
+## Leave Room
 
 **Type:** `client -> server`  
+**Description:** Used to leave a room.  
 **Payload:**
 
 ```typescript
 {
-    "route": "get_user_info",
+    "route": "leave_room",
+    "roomId": string; // Room Id, optional
 }
 ```
 
@@ -86,50 +96,52 @@ Room messages are sent to everyone in a room
 
 ```typescript
 {
-    "message": "set_username_response",
-    "status": string,
-    "user": {
-        "username": string,
-        "id": string,
-        "currentRoom": string,
-    }
+	"route": "leave_room_response",
+	"status": string,
 }
 ```
 
-## Join Room
+## Receive Touch
 
-**Type:** `client -> server`  
-**Description:** Used to enter a room. Join an existing room by including roomId, or if room doesn't exist, create one with that roomId  
+**Type:** `server -> client <room>`  
+**Description:** Broadcasted to all members of a room when any user sends a successful send_touch request  
 **Payload:**
 
 ```typescript
 {
-    "route": "join_room",
-    "roomId"?: string, // Room Id, optional
-    "username"?: string,
-}
-```
-
-**Type:** `server -> client <private>`  
-**Payload (If error):**
-
-```typescript
-{
-    "message": "enter_room_response",
-    "status": string,
+    "message": "receive_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.
 }
 ```
 
-## Leave Room
+## Send Touch
 
 **Type:** `client -> server`  
-**Description:** Used to enter a room.  
+**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 creation/last update it should automatically be disabled.  
 **Payload:**
 
 ```typescript
 {
-    "route": "leave_room",
-    "roomId": string; // Room Id, optional
+    "route": "send_touch",
+    "id": number, // Used to indentify vibrations for updating or disabling them, generated by client. Doesn't need to be secure.
+    "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
 }
 ```
 
@@ -138,33 +150,32 @@ Room messages are sent to everyone in a room
 
 ```typescript
 {
-	"route": "leave_room_response",
-	"status": string,
+    "message": "set_username_response",
+    "status": string,
 }
-```
 
-## Get Rooms
+```
+## Test Connection
 
 **Type:** `client -> server`  
-**Description:** Used to get list of joined rooms  
 **Payload:**
 
 ```typescript
 {
-    "route": "get_rooms"
+    "route": "test_connection"
 }
 ```
 
 **Type:** `server -> client <private>`  
-**Payload:**
+**Response:**
 
 ```typescript
 {
-    "message": "get_rooms_response",
-    "rooms": [{id: string, userCount: number}]
+    "message": "test_connection_response",
 }
 ```
 
+
 ## Room Update
 
 **Type:** `server -> client <room>`  
@@ -204,27 +215,39 @@ Room messages are sent to everyone in a room
 }
 ```
 
-## Receive Touch
+## Set Username
 
-**Type:** `server -> client <room>`  
-**Description:**  
+**Type:** `client -> server`  
+**Description**: Used to set username.
 **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.
+    "route": "set_username",
+    "username": string,
+}
+```
+
+## Get Rooms
+*WARNING: not implemented yet*
+
+**Type:** `client -> server`  
+**Description:** Used to get list of joined rooms  
+**Payload:**
+
+```typescript
+{
+    "route": "get_rooms"
+}
+```
+
+**Type:** `server -> client <private>`  
+**Payload:**
+
+```typescript
+{
+    "message": "get_rooms_response",
+    "rooms": [{id: string, userCount: number}]
 }
 ```