Skip to content

Commit 96fb519

Browse files
committed
update docs with latest features
1 parent baea98f commit 96fb519

File tree

2 files changed

+29
-17
lines changed

2 files changed

+29
-17
lines changed

README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,8 @@ var serverHost = UserDefaults.standard.string(forKey: "serverHost") ?? "localhos
113113
"command": "record",
114114
"message": "Optional additional context or instructions",
115115
"duration": 5000,
116-
"autoUpload": true
116+
"autoUpload": true,
117+
"camera": "front"
117118
}
118119
```
119120

@@ -122,6 +123,7 @@ var serverHost = UserDefaults.standard.string(forKey: "serverHost") ?? "localhos
122123
- `message` (optional): Additional context to display to user
123124
- `duration` (optional): Recording duration in milliseconds (default: 30000 = 30 seconds)
124125
- `autoUpload` (optional): Whether to automatically upload after recording stops (default: false)
126+
- `camera` (optional): Camera to use (`"front"` or `"back"`). If omitted, active camera is used.
125127

126128
**App Behavior**:
127129
- Automatically starts video recording
@@ -161,36 +163,43 @@ var serverHost = UserDefaults.standard.string(forKey: "serverHost") ?? "localhos
161163

162164
Located in **SettingsView.swift**, allows users to:
163165

164-
1. **Configure Server Host**
165-
- Default: `localhost:8080`
166-
- Supports: IP addresses, hostnames, with or without protocol prefix
167-
- Automatically converts HTTP/HTTPS to WS/WSS
166+
1. **Configure Device Name** (optional)
167+
- Custom name shown on server's web interface
168+
- Useful for identifying specific devices in the test host
169+
- Defaults to the iOS device name (e.g., "iPhone")
168170

169-
2. **Select Video Format**
171+
1. **Select Video Format**
170172
- Default: `MP4`
171173
- Options: `MP4` or `MOV`
172174
- Selection applies to all future recordings
173175
- Upload metadata includes correct MIME type based on format
174176

175-
3. **Test WebSocket Connection**
177+
1. **Configure Server Host**
178+
- Default: `localhost:8080`
179+
- Supports: IP addresses, hostnames, with or without protocol prefix
180+
181+
1. **Set SSL Verfification**
182+
- Default: `true`
183+
- If testing self-signed certificates, set to `false`
184+
185+
1. **Test WebSocket Connection**
176186
- Initiates a test WebSocket connection to verify server reachability
177187
- Displays connection status (success/failure)
178188
- Shows connection protocol (ws:// or wss://) being used
179189
- Useful for diagnosing network or certificate issues
180190

181-
4. **Set Client Display Name** (optional)
182-
- Custom name shown on server's web interface
183-
- Example: "Lab Camera 1", "Front Lobby", etc.
184-
- If set, displays as "CustomName (DeviceModel)"
185-
- If not set, displays just device name
186-
- Helps identify which device is which when multiple clients connect
187-
188-
5. **Test HTTP Connection**
191+
1. **Test HTTP Connection**
189192
- Calls `/api/health` endpoint
190193
- Verifies server status and uptime
191194
- Displays health check response
192195
- Shows connection protocol (http:// or https://) being used
193196

197+
1. **Edit Permissions**
198+
- Opens Allspark's iOS app permissions settings
199+
- *Local Network*: May be required for WebSocket/HTTP connections depending on server configuration
200+
- *Microphone*: Required for audio recording
201+
- *Camera*: Required for video recording
202+
194203
## Connection Status Indicator
195204

196205
The **Camera** tab displays a WiFi icon in the top-right corner that indicates connection status:

tests/perceptor-host-test/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,8 @@ Sends a command to a specific connected WebSocket client.
127127
"command": "record",
128128
"message": "optional message content",
129129
"duration": 5000,
130-
"autoUpload": true
130+
"autoUpload": true,
131+
"camera": "front"
131132
}
132133
```
133134

@@ -144,6 +145,7 @@ Sends a command to a specific connected WebSocket client.
144145
- `message` (optional): Additional context or instructions
145146
- `duration` (optional, record command only): Recording duration in milliseconds (default: 30000)
146147
- `autoUpload` (optional, record command only): Whether to auto-upload after recording (default: false)
148+
- `camera` (optional, record command only): Camera to use (`"front"` or `"back"`). If omitted, active camera is used.
147149

148150
**Success Response:**
149151
```json
@@ -337,8 +339,9 @@ The server provides a web-based control interface at `http://localhost:8080` for
337339
2. **Send Record Command**
338340
- **Duration Input**: Set recording duration in milliseconds (default: 30000)
339341
- **Auto Upload Checkbox**: Enable/disable automatic upload after recording (default: checked/true)
342+
- **Camera Selection**: Radio buttons to choose "Front" or "Back" camera
340343
- **Send Record Command Button**: Transmit the command to the selected connection
341-
- Both fields persist across page refreshes
344+
- All fields persist across page refreshes
342345

343346
3. **Command Confirmation**
344347
- Displays alert with connection ID, duration, and auto-upload setting

0 commit comments

Comments
 (0)