Robot dashboard - Revision history

Spring2026: /* Back-end */

2026-10-13T10:59:41Z

Back-end

← Older revision		Revision as of 11:59, 13 October 2026
Line 167:		Line 167:
	This section provides an overview of the backend architecture, its file structure, and guidelines for configuring and modifying the system.		This section provides an overview of the backend architecture, its file structure, and guidelines for configuring and modifying the system.

	[[Backend]]		For detailed information about the backend structure and configuration, see [[Backend\|Backend Documentation]].

	== Front-end ==		== Front-end ==

2026-10-13T10:56:46Z

Back-end

← Older revision		Revision as of 11:56, 13 October 2026
Line 158:		Line 158:

	== Back-end ==		== Back-end ==
	[[Backend]]
			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]]

	== Front-end ==		== Front-end ==

2026-10-13T09:55:28Z

Requirements

← Older revision		Revision as of 10:55, 13 October 2026
Line 31:		Line 31:
	* Have installed npm		* Have installed npm
	* Have a code editor (VScode or other)		* Have a code editor (VScode or other)
			* Have Downloaded Type-Script

	== Set up ==		== Set up ==

2026-10-13T09:40:21Z

Requirements

← Older revision		Revision as of 10:40, 13 October 2026
Line 27:		Line 27:

	== Requirements ==		== Requirements ==
			For further development of the dashboard these are the requirements to have.
			* Have installed Node.js
			* Have installed npm
			* Have a code editor (VScode or other)

	== Set up ==		== Set up ==

2026-10-13T09:19:47Z

Making the software start when the system boots

← Older revision		Revision as of 10:19, 13 October 2026
Line 149:		Line 149:
	journalctl -u webapp.service -f		journalctl -u webapp.service -f
	</pre>		</pre>

			With this you should be able to access the dashboard at http://<IP ADRESS>:9090

	== Back-end ==		== Back-end ==

2026-10-13T09:18:12Z

File placement

← Older revision		Revision as of 10:18, 13 October 2026
Line 71:		Line 71:

	In this folder we will transfer the back-end and the front-end. It is important that the back-end folder is called "back-end-node-js" as this name is used for the software to start when the system boots. Otherwise you will need to change the work directory in the upcomming service file.		In this folder we will transfer the back-end and the front-end. It is important that the back-end folder is called "back-end-node-js" as this name is used for the software to start when the system boots. Otherwise you will need to change the work directory in the upcomming service file.

			When the back-end and front-end have been transferred to the robot in the "Browser-based-dashboard-for-autonomous-robots" folder, the following commands will be needed for each folder.

			==== back-end ====
			In the back-end run the following commands to make sure every needed package is installed.

			<pre>
			npm install
			npm install socket.io-client
			npm audit fix
			</pre>

			==== front-end ====
			In the front-end run the following commands to make sure every needed package is installed.

			<pre>
			npm install
			npm audit fix
			</pre>

	=== Making the software start when the system boots ===		=== Making the software start when the system boots ===

2026-10-13T09:12:03Z

File placement

← Older revision		Revision as of 10:12, 13 October 2026
Line 70:		Line 70:
	</code>		</code>

	In this folder we will transfer the back-end and the front-end. It is important that the back-end folder is called "back-end-node-js" as this name is used for the software to start when the system boots.		In this folder we will transfer the back-end and the front-end. It is important that the back-end folder is called "back-end-node-js" as this name is used for the software to start when the system boots. Otherwise you will need to change the work directory in the upcomming service file.

	=== Making the software start when the system boots ===		=== Making the software start when the system boots ===

2026-10-13T09:11:02Z

Making the software start when the system boots

← Older revision		Revision as of 10:11, 13 October 2026
Line 92:		Line 92:
	Type=simple		Type=simple
	User=local		User=local
			#Change to the backend folder path
	WorkingDirectory=/home/local/svn/robobot/Browser-based-dashboard-for-autonomous-robots/back-end-node-js		WorkingDirectory=/home/local/svn/robobot/Browser-based-dashboard-for-autonomous-robots/back-end-node-js
	Environment=NODE_ENV=production		Environment=NODE_ENV=production

2026-10-13T09:08:55Z

Set up

← Older revision		Revision as of 10:08, 13 October 2026
Line 35:		Line 35:
	# A file editing software (Windows: PuTTY, Mac: Terminal)		# A file editing software (Windows: PuTTY, Mac: Terminal)

	=== ~~Downloads~~ and ~~File Placement~~ ===		=== Installing nodejs and npm on the robot ===
	For the dashboard software to function it is important to make sure that node.js and npm is installed on the robot. To check this run the following code in the terminal		For the dashboard software to function it is important to make sure that node.js and npm is installed on the robot. To check this run the following code in the terminal

Line 53:		Line 53:
	sudo apt install -y nodejs npm		sudo apt install -y nodejs npm
	</code>		</code>

			=== File placement ===

	To make the dashboard software functional we need to transfer the necessary files. It is important that the files are in the correct placement with the correct names for the software to start when the system boots.		To make the dashboard software functional we need to transfer the necessary files. It is important that the files are in the correct placement with the correct names for the software to start when the system boots.

2026-10-13T09:07:57Z

Downloads and File Placement

← Older revision		Revision as of 10:07, 13 October 2026
Line 36:		Line 36:

	=== Downloads and File Placement ===		=== Downloads and File Placement ===
			For the dashboard software to function it is important to make sure that node.js and npm is installed on the robot. To check this run the following code in the terminal

			<code>
			npm -v
			</code>

			and

			<code>
			node -v
			</code>

			If npm and node is not installed, install them using the command:

			<code>
			sudo apt install -y nodejs npm
			</code>

	To make the dashboard software functional we need to transfer the necessary files. It is important that the files are in the correct placement with the correct names for the software to start when the system boots.		To make the dashboard software functional we need to transfer the necessary files. It is important that the files are in the correct placement with the correct names for the software to start when the system boots.