Backend - Revision history

Spring2026: /* Socket.IO Configuration */

2026-10-13T12:41:02Z

Socket.IO Configuration

← Older revision		Revision as of 13:41, 13 October 2026
Line 118:		Line 118:

	==== Socket.IO Configuration ====		==== Socket.IO Configuration ====
	~~Explain real~~-~~time communication settings~~.		Sockets is the primary method of communication between the front-end and the back-end. There are two primary functions:
			* socket.on (used in socket.js)
			* io.emit (used in mqttConnection.js)
			===== socket.on =====
			"socket.on" listens for any commands that have been sent with a specific topic from the front end.

			===== io.emit =====
			"io.emit" sends commands to the front-end with a package.

	=== Authentication and Session Configuration ===		=== Authentication and Session Configuration ===

Spring2026: /* mqttClient.publish */

2026-10-13T11:08:33Z

mqttClient.publish

← Older revision		Revision as of 12:08, 13 October 2026
Line 83:		Line 83:
	* "T0" is dependent on the number of Teensy Boards and is zero-indexed. It mentions which Teensy board it will listen to.		* "T0" is dependent on the number of Teensy Boards and is zero-indexed. It mentions which Teensy board it will listen to.
	* "gyroc Start" is the command that is sent to the robot.		* "gyroc Start" is the command that is sent to the robot.


	===== mqttClient.on =====		===== mqttClient.on =====

Spring2026: /* MQTT Configuration */

2026-10-13T11:08:11Z

MQTT Configuration

← Older revision		Revision as of 12:08, 13 October 2026
Line 86:		Line 86:

	===== mqttClient.on =====		===== mqttClient.on =====
			This function listens to certain MQTT messages from the protocol. The syntax of such message is:

	~~Explain how to configure~~ the MQTT ~~broker,~~		<code>
	~~connection settings,~~		mqttClient.on(title, payload)
	and ~~topics~~.		</code>

			The MQTT has different label titles i.e ("message" or "error") and payload is the content that follows that title. These determines what kind of output the MQTT protocol has sent.

			If the label title is "message" it will contain a topic and a message.

			If the label title is "error" it will contain an error message.

	==== Service filles Configuration ====		==== Service filles Configuration ====

Spring2026: /* Backend */

2026-10-13T10:59:54Z

Backend

← Older revision		Revision as of 11:59, 13 October 2026
Line 1:		Line 1:
	== Backend ==		== Backend documentation ==

	__TOC__		__TOC__

Spring2026: /* MQTT Configuration */

2026-10-13T10:57:35Z

MQTT Configuration

← Older revision		Revision as of 11:57, 13 October 2026
Line 52:		Line 52:

	<code>		<code>
	mqttClient.subscribe("dtubot/drive/T0/gyroo");		mqttClient.subscribe("dtubot/drive/T0/gyroo");
	</code>		</code>

Line 64:		Line 64:

	<code>		<code>
	mqttClient.unsubscribe("dtubot/drive/T0/gyroo");		mqttClient.unsubscribe("dtubot/drive/T0/gyroo");
	</code>		</code>

Spring2026: /* Backend Architecutre */

2026-10-13T10:57:07Z

Backend Architecutre

← Older revision		Revision as of 11:57, 13 October 2026
Line 2:		Line 2:

	__TOC__		__TOC__

	~~== Backend Architecutre ==~~


	~~The backend of the Robot Dashboard is built using Node.js and Express and acts as a communication layer between the Robobot and the frontend application.~~

	~~The architecture consists of three main components:~~

	~~# '''Express:''' Handles HTTP requests, including user authentication and session management.~~
	~~#'''MQTT:''' Enables communication between the backend and the Tuype robot through a publish-subscribe messaging system.~~
	~~# '''Socket.IO:''' Establishes real-time, bidirectional communication between the backend and frontend, allowing robot data to be displayed without manually refreshing the page.~~

	~~=== Communication Flow ===~~

	~~The backend acts as an intermediary between the frontend and Robobot.~~

	~~# The Robobot publishes data to specific MQTT topics through an MQTT broker.~~
	~~# The backend subscribes to relevant topics and receives incoming robot data.~~
	~~# The backend processes the received messages and forwards relevant information to the frontend using Socket.IO.~~
	~~# The frontend receives these updates and displays them in the corresponding dashboard widgets.~~

	For interactions that require sending information or commands to the robot, the communication can also work in the opposite direction, with the backend publishing messages to the appropriate MQTT topics.

	~~=== Model-View-Controller===~~

	~~The Robot Dashboard was designed using the Model–View–Controller (MVC) architectural pattern to separate the application's user interface, application logic, and communication handling.~~

	~~The architecture consists of three main components:~~

	*'''Model:''' Represents the backend logic and is responsible for processing data and managing the application's functionality.
	*'''View:''' Represents the frontend user interface, where users can interact with the dashboard and visualize real-time robot data.
	*'''Controller:''' Acts as an intermediary between the Model, View, and Tuype robot. It handles communication through REST APIs, Socket.IO, and MQTT, as well as session management.

	~~[[file: ModelViewController.png \| 700px]]~~

	When a user interacts with the dashboard, the input is sent from the View to the Controller. The Controller processes the request and communicates with the Model when application logic or data processing is required.

	For robot-related interactions, the Controller communicates with the Tuype robot through MQTT. The robot publishes data to MQTT topics, which the backend subscribes to and forwards to the frontend through Socket.IO.

	~~The Controller is also responsible for sending updates back to the View, allowing the dashboard to display real-time information without requiring the user to refresh the page.~~

	~~=== Authentication and Session Management ===~~

	~~The backend implements a password-based authentication system to restrict access to the Robot Dashboard.~~

	~~User authentication is handled through Express, where the provided password is verified against a stored password hash using bcrypt. Upon successful authentication, a session is established using~~
	~~<code>~~
	~~express-session~~
	~~</code>~~

	~~The session is maintained through a cookie, allowing the backend to recognize authenticated users across subsequent requests without requiring them to log in repeatedly.~~

	~~The current implementation uses a single shared password rather than individual user accounts.~~

	== Backend Codebase Overview ==		== Backend Codebase Overview ==

Spring2026: /* Introduction */

2026-10-13T10:57:01Z

Introduction

← Older revision		Revision as of 11:57, 13 October 2026
Line 2:		Line 2:

	__TOC__		__TOC__

	~~=== Introduction ===~~

	The backend of the Robot Dashboard is responsible for managing communication between the frontend and the Robobot. It is developed using Node.js and Express, with MQTT handling communication with the robot and Socket.IO providing real-time updates to the frontend.

	~~The backend acts as an intermediary between the robot and the web application, processing incoming robot data and forwarding relevant information to the dashboard.~~

	The backend consists of several files and components, each serving a specific purpose. '''Some files can be modified to customize the dashboard's functionality, while others contain core functionality and should generally remain unchanged''' to ensure the system operates correctly.

	~~This section provides an overview of the backend architecture, its file structure, and guidelines for configuring and modifying the system.~~

	== Backend Architecutre ==		== Backend Architecutre ==

Spring2026: /* MQTT Configuration */

2026-10-13T10:55:12Z

MQTT Configuration

@@ Line 105: / Line 105: @@
 ====  MQTT Configuration ====
 Explain how to configure the MQTT broker,
-connection settings, and topics.
+connection settings,
 ====  Service filles Configuration ====

Spring2026: /* Service filles Configuration */

2026-10-13T10:44:29Z

Service filles Configuration

@@ Line 109: / Line 109: @@
 ====  Service filles Configuration ====
-The service files acts as the logic in the code and the ones that can and should be modifcied is <code> tabService </code>
 ==== Socket.IO Configuration ====

Spring2026: /* Core files and Restrictions */

2026-10-13T10:42:04Z

Core files and Restrictions

← Older revision		Revision as of 11:42, 13 October 2026
Line 162:		Line 162:
	If a new session needs to be generated, type from the root directory		If a new session needs to be generated, type from the root directory
	<code> node -e "console.log(require('crypto').randomBytes(32).toString('hex'))" </code>		<code> node -e "console.log(require('crypto').randomBytes(32).toString('hex'))" </code>

	~~== Core files and Restrictions ==~~