WS Comms Protocol

Real-time communication between the Franklyn server, Sentinels, and Proctors happens over WebSocket connections using JSON messages. Authentication is handled via an auth field in the initial register messages.

Overview

Connection Type	Role	Description
Server - Sentinel	Frame Producer	Student machines stream screen captures to the server
Server - Proctor	Frame Consumer	Teacher interface receives frames for monitored students

Documentation

Connection Lifecycle

Connection flow and sequence diagrams

Server - Sentinel

Registration and frame streaming

Server - Proctor

Registration, subscriptions, and frame receiving

Special Datatypes

Custom data structures used in messages

Last updated on May 4, 2026 • J.H.F.