Rsewiki - Recent changes [en]

Ricbot sensorbox

Jca — Sat, 17 Oct 2026 07:10:17 GMT

LED flash board

← Older revision		Revision as of 08:10, 17 October 2026
(2 intermediate revisions by the same user not shown)
Line 105:		Line 105:
	* Pressed once starts recording.		* Pressed once starts recording.
	* Pressing again will pause the recording.		* Pressing again will pause the recording.

			The same function is available on the gamepad (red button)

	When recording, there is an LED in the LED-band that will illuminate (orange) for every camera that is recording. If the camera is not found or has failed, the corresponding LED will not illuminate.		When recording, there is an LED in the LED-band that will illuminate (orange) for every camera that is recording. If the camera is not found or has failed, the corresponding LED will not illuminate.
Line 117:		Line 119:

	=== LED flash board ===		=== LED flash board ===

			The flash trigger time is synchronised with the 4 Basler cameras. The flash time is the same as the longest exposure time of the Basler cameras, but is limited to a maximum of 2 ms.

			The flash can be disabled with the blue button on the gamepad.

	[[file: LED_light_sch.png \| 600px]]		[[file: LED_light_sch.png \| 600px]]
Line 126:		Line 132:
	The LED takes about 2.5V at 0.7A; this requires the supply voltage to be above 16V.		The LED takes about 2.5V at 0.7A; this requires the supply voltage to be above 16V.
	Each LED uses up to 1.75W, or the entire board uses 63W in pulses. At 3 images per second and a 300us illumination time, this then requires about 0.5W from the battery.		Each LED uses up to 1.75W, or the entire board uses 63W in pulses. At 3 images per second and a 300us illumination time, this then requires about 0.5W from the battery.

			The external 0.56 Ohm 5W resistor is shared between the two boards mounted in the same 3D-printed box.

	[[file: LED-light2_pcb_top.png \| 300px]]		[[file: LED-light2_pcb_top.png \| 300px]]

File:Sensorbox photo bottom.jpg

Jca — Sat, 17 Oct 2026 06:57:31 GMT

Jca uploaded File:Sensorbox photo bottom.jpg

New page

Ricbot sensorbox

Jca — Sat, 17 Oct 2026 06:57:19 GMT

Cabling

← Older revision		Revision as of 07:57, 17 October 2026
(One intermediate revision by the same user not shown)
Line 29:		Line 29:
	Cabling overview for RIC sensorbox. A network connection can be established to RICBOT and/or to other networks or PCs.		Cabling overview for RIC sensorbox. A network connection can be established to RICBOT and/or to other networks or PCs.

	[[file: sensorbox_photo_internal.jpg \| ~~400px~~]]		[[file: sensorbox_photo_internal.jpg \| 550px]]

			[[file: sensorbox_photo_bottom.jpg \| 550px]]

	== Function ==		== Function ==

File:Sensorbox photo internal.jpg

Jca — Sat, 17 Oct 2026 06:40:49 GMT

Jca uploaded a new version of File:Sensorbox photo internal.jpg

New page

File:Sensorbox photo internal.jpg

Jca — Sat, 17 Oct 2026 06:36:25 GMT

Jca uploaded File:Sensorbox photo internal.jpg

New page

Ricbot sensorbox

Jca — Sat, 17 Oct 2026 06:36:03 GMT

Cabling

← Older revision		Revision as of 07:36, 17 October 2026
(2 intermediate revisions by the same user not shown)
Line 28:		Line 28:

	Cabling overview for RIC sensorbox. A network connection can be established to RICBOT and/or to other networks or PCs.		Cabling overview for RIC sensorbox. A network connection can be established to RICBOT and/or to other networks or PCs.

			[[file: sensorbox_photo_internal.jpg \| 400px]]

	== Function ==		== Function ==
Line 125:		Line 127:
	[[file: LED-light2_pcb_top.png \| 300px]]		[[file: LED-light2_pcb_top.png \| 300px]]
	[[file: LED-light2_pcb_back.png \| 300px]]		[[file: LED-light2_pcb_back.png \| 300px]]

			Front and back PCB layout.
			Find the KiCad files in: svn://repos.gbar.dtu.dk/jcan/ricbot/kicad/LED-light2.

	=== Camera trigger board ===		=== Camera trigger board ===
Line 145:		Line 150:
	Camera trigger control board and cable connections for cameras and power control for RIC sensor box.		Camera trigger control board and cable connections for cameras and power control for RIC sensor box.
	Most components are for the high voltage driver and are not mounted.		Most components are for the high voltage driver and are not mounted.

			Find the KiCad files in svn://repos.gbar.dtu.dk/jcan/ricbot/kicad/hv_gen.

	=== Power distribute ===		=== Power distribute ===

File:LED-light2 pcb top.png

Jca — Sat, 17 Oct 2026 06:16:17 GMT

Jca uploaded a new version of File:LED-light2 pcb top.png

New page

File:LED-light2 pcb back.png

Jca — Sat, 17 Oct 2026 06:15:57 GMT

Jca uploaded a new version of File:LED-light2 pcb back.png

New page

File:LED-light2 pcb back.png

Jca — Sat, 17 Oct 2026 06:11:32 GMT

Jca uploaded File:LED-light2 pcb back.png

New page

File:LED-light2 pcb top.png

Jca — Sat, 17 Oct 2026 06:11:14 GMT

Jca uploaded File:LED-light2 pcb top.png

New page

Ricbot sensorbox

Jca — Sat, 17 Oct 2026 06:10:58 GMT

LED flash board

← Older revision		Revision as of 07:10, 17 October 2026
Line 122:		Line 122:
	The LED takes about 2.5V at 0.7A; this requires the supply voltage to be above 16V.		The LED takes about 2.5V at 0.7A; this requires the supply voltage to be above 16V.
	Each LED uses up to 1.75W, or the entire board uses 63W in pulses. At 3 images per second and a 300us illumination time, this then requires about 0.5W from the battery.		Each LED uses up to 1.75W, or the entire board uses 63W in pulses. At 3 images per second and a 300us illumination time, this then requires about 0.5W from the battery.

			[[file: LED-light2_pcb_top.png \| 300px]]
			[[file: LED-light2_pcb_back.png \| 300px]]

	=== Camera trigger board ===		=== Camera trigger board ===

File:LED light sch.png

Jca — Sat, 17 Oct 2026 06:07:58 GMT

Jca uploaded a new version of File:LED light sch.png

New page

== Summary ==
Schematig flash board

Backend

Spring2026 — Tue, 13 Oct 2026 12:41:02 GMT

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 ===

Frontend

Spring2026 — Tue, 13 Oct 2026 12:32:45 GMT

@@ Line 30: / Line 30: @@
 ==== sidebar ====
-The Sidebar component consists of a TSX file and a TS file. The TSX file defines the basic structure and functionality of the sidebar, including the ability to open, close, and resize it. It also stores the sidebar's state and previous width, allowing the user's settings to be preserved during the session.
+Sidebar consists of a TSX file and a TS file. The TSX file defines the
 ==== tabbar ====
-The tabbar.tsx file contains the main functionality of the tab bar. It handles opening, closing, and switching between tabs, as well as managing which tabs are currently open. It also uses React Router for navigation and Socket.IO to notify the backend when the active tab changes.
+==== widget ====
 === Pages ===

Backend

Spring2026 — Tue, 13 Oct 2026 11:08:33 GMT

mqttClient.publish

← Older revision		Revision as of 12:08, 13 October 2026
(One intermediate revision by the same user not shown)
Line 84:		Line 84:
	* "gyroc Start" is the command that is sent to the robot.		* "gyroc Start" is the command that is sent to the robot.

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

			<code>
			mqttClient.on(title, payload)
			</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.

	~~===== mqttClient~~.~~on =====~~		If the label title is "message" it will contain a topic and a message.

	~~Explain how to configure~~ the ~~MQTT broker,~~		If the label title is "error" it will contain an error message.
	~~connection settings,~~
	~~and topics~~.

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

Frontend

Spring2026 — Tue, 13 Oct 2026 11:01:54 GMT

← Older revision		Revision as of 12:01, 13 October 2026
(One intermediate revision by the same user not shown)
Line 64:		Line 64:

	This structure allows developers to reuse existing layouts and widgets without having to recreate the tab system for each new tab.		This structure allows developers to reuse existing layouts and widgets without having to recreate the tab system for each new tab.


	==== widget ====		==== widget ====

			The widget.tsx file acts as a central placeholder for the different widgets. It determines which widget should be displayed based on the provided widget name.
			The widgets folder contains the individual widget components, where their specific content, functionality, and styling are developed.
			When creating a new widget, developers should create a new component in the widgets folder and register it in widget.tsx so it can be displayed in the application.

			Each widget is developed as an individual TSX component inside the widgets folder, containing its own functionality and styling. For example, TiltGraphWidget.tsx receives data from the backend using Socket.IO and displays it in a graph using Recharts.
			A tab can contain from one and up to four individual widgets, depending on the selected layout. The widgets displayed in each tab are defined in tabs.tsx, while tabLayout.tsx determines how they are arranged on the screen.
			This structure allows developers to create and modify individual widgets independently and reuse them across different tabs without changing their internal functionality.

	=== Pages ===		=== Pages ===

Backend

Spring2026 — Tue, 13 Oct 2026 10:59:54 GMT

Backend

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

	__TOC__		__TOC__

Robot dashboard

Spring2026 — Tue, 13 Oct 2026 10:59:41 GMT

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 ==

Backend

Spring2026 — Tue, 13 Oct 2026 10:57:35 GMT

MQTT Configuration

@@ Line 2: / Line 2: @@
 __TOC__
 == Backend Codebase Overview ==
@@ Line 115: / Line 52: @@
 <code>
- mqttClient.subscribe("dtubot/drive/T0/gyroo");
+mqttClient.subscribe("dtubot/drive/T0/gyroo");
 </code>
@@ Line 127: / Line 64: @@
 <code>
- mqttClient.unsubscribe("dtubot/drive/T0/gyroo");
+mqttClient.unsubscribe("dtubot/drive/T0/gyroo");
 </code>

Robot dashboard

Spring2026 — Tue, 13 Oct 2026 10:56:46 GMT

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 ==

Backend

Spring2026 — Tue, 13 Oct 2026 10:55:12 GMT

MQTT Configuration

@@ Line 105: / Line 105: @@
 ====  MQTT Configuration ====
 Explain how to configure the MQTT broker,
-connection settings, and topics.
+connection settings,
-====  API Configuration ====
+===== Tab Service =====
-Explain configurable API settings and endpoints.
 ==== Socket.IO Configuration ====
@@ Line 162: / Line 225: @@
 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>

Frontend

Spring2026 — Tue, 13 Oct 2026 10:37:35 GMT

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

	The reason for this structure is to separate the basic structure and styling from the specific content of each sidebar. This allows developers to reuse the existing Sidebar component when creating new sidebars, while customizing their content and functionality as needed.		The reason for this structure is to separate the basic structure and styling from the specific content of each sidebar. This allows developers to reuse the existing Sidebar component when creating new sidebars, while customizing their content and functionality as needed.


	==== tabbar ====		==== tabbar ====

Backend

Spring2026 — Tue, 13 Oct 2026 10:34:44 GMT

Authentication and Session Configuration

← Older revision		Revision as of 11:34, 13 October 2026
(6 intermediate revisions by the same user not shown)
Line 114:		Line 114:
	Explain real-time communication settings.		Explain real-time communication settings.

	~~==== Authentication and Session Configuration ====~~
	~~Explain which authentication and session settings~~
	~~can be modified.~~
	=== Authentication and Session Configuration ===		=== Authentication and Session Configuration ===

	This section explains how to modify the authentication settings used by the Robot Dashboard.		This section explains how to modify the authentication settings used by the Robot Dashboard.

			The \<code>security/\</code> directory contains the script responsible for handling authentication. This script should remain unchanged.

	==== Changing the Administrator Password ====		==== Changing the Administrator Password ====
Line 160:		Line 159:

	If the secret needs to be rotated, replace it with a new, securely generated random value. Changing the secret may invalidate existing sessions, requiring users to log in again.		If the secret needs to be rotated, replace it with a new, securely generated random value. Changing the secret may invalidate existing sessions, requiring users to log in again.

			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>

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

	== Running the backend ==		== Running the backend ==

Frontend

Spring2026 — Tue, 13 Oct 2026 10:25:32 GMT

← Older revision		Revision as of 11:25, 13 October 2026
(2 intermediate revisions by the same user not shown)
Line 29:		Line 29:

	==== sidebar ====		==== sidebar ====

			The Sidebar component consists of a TSX file and a TS file. The TSX file defines the basic structure and functionality of the sidebar, including the ability to open, close, and resize it. It also stores the sidebar's state and previous width, allowing the user's settings to be preserved during the session.

			The TS file defines the styling using Tailwind CSS. This includes the sidebar colors, the positioning of the toggle button and resize bar, and the rotation of the arrow when the sidebar is opened or closed.

			The `SidebarContent` folder contains the left and right sidebar components. This is where developers can modify the content and functionality of each individual sidebar without changing the general Sidebar component.

			The reason for this structure is to separate the basic structure and styling from the specific content of each sidebar. This allows developers to reuse the existing Sidebar component when creating new sidebars, while customizing their content and functionality as needed.


	==== tabbar ====		==== tabbar ====

			The Tabbar is structured into four TSX files, each responsible for a specific part of the tab system. This structure separates the management of tabs from their content and layouts, making it easier for developers to maintain and extend the system.

			The tabbar.tsx file contains the main functionality of the tab bar. It handles opening, closing, and switching between tabs, as well as managing which tabs are currently open. It also uses React Router for navigation and Socket.IO to notify the backend when the active tab changes.

			The tabs.tsx file contains the predefined tabs available in the dashboard. Each tab defines which widgets should be displayed and which layout should be used.

			If a developer wants to modify the widgets displayed in an existing tab or create a new tab, this is where its content and layout are defined.

			The tabLayout.tsx file contains the different layout templates used by the tabs. Each layout determines how the widgets are arranged on the screen, including their positions and sizes.

			The layouts use resizable panels, allowing users to adjust the size of individual widgets. The styling is defined directly within the TSX file using Tailwind CSS.

			If a developer wants to create a new layout, modify an existing one, or change the styling of the layouts, changes should be made in this file.

			The tabMap.tsx file maps tab names to their corresponding React components. This allows the application to identify the correct component based on the tab name.


			When creating a new tab, developers should first define the tab in `tabs.tsx`, where they select the required layout and widgets.

			If the desired layout does not already exist, a new layout can be created in `tabLayout.tsx`.

			The new tab must then be registered in the tab mapping and management logic in `tabbar.tsx` so that it can be opened and displayed through the tab bar. If `tabMap.tsx` is used elsewhere in the application, the new tab should also be added there.

			This structure allows developers to reuse existing layouts and widgets without having to recreate the tab system for each new tab.

Backend

Spring2026 — Tue, 13 Oct 2026 10:22:47 GMT

Step 2: Update the Environment Variable

@@ Line 123: / Line 123: @@
 ==== Changing the Administrator Password ====
-The administrator password is stored as a bcrypt hash in the <code>.env</code> file.
+The administrator password is stored as a bcrypt hash in the <code>.env</code> file located in the backend root directory.
-To change the password:
+To change the administrator password, follow these steps:
-# Open <code> back-end-node-js/scripts/generateHash.js/<\code>
+===== Step 1: Generate a New Password Hash =====
-'''Note:''' The password must be hashed using bcrypt. Do not store the password in plaintext.
+# Open <code>back-end-node-js/scripts/generateHash.js</code>.
 ==== Session Secret ====