User Manual #238

V-SANT · 2025-05-11T20:51:13Z

No description provided.

MegaRedHand · 2025-05-28T01:49:15Z

README.md

+
+- **Play/Pause**: Start or stop the packet flow on the network.
+- **Undo/Redo**: Undo or redo the last action in case you made a mistake.
+- **Packet Speed Wheel**: Change the speed of the packets on the network. This is a slider that sets a multiplier to the speed of the packets. The default value is 1, which means that the packets will be sent at normal speed. You can set it up to 0.5 to slow down the packets or up to 4 to speed them up.


This is not only for packets:

Suggested change

- **Packet Speed Wheel**: Change the speed of the packets on the network. This is a slider that sets a multiplier to the speed of the packets. The default value is 1, which means that the packets will be sent at normal speed. You can set it up to 0.5 to slow down the packets or up to 4 to speed them up.

- **Simulation Speed Slider**: Changes the speed of the simulation. This is a slider that sets a multiplier to the passage of time inside the simulation, which affects packet and program speed, among other things. The default value is 1, which means everything will happen at normal speed. You can set it up to 0.5 to slow it down or up to 4 to speed it up.

MegaRedHand · 2025-05-28T01:53:32Z

README.md

+- **Delete Device Button**: This button allows you to delete the router from the network. This will also delete all edges connected to this router.
+- **Packet Queue Usage Bar**: This bar shows the usage of the packet queue of the router. The packet queue is used to store packets that are waiting to be processed by the router. The bar shows the percentage of the queue that is currently in use. If the queue is full, the router will drop packets until there is space in the queue.
+- **Router Parameters Dropdown**: This dropdown allows you to select the parameters of the router. The parameters are:
+  - **Packet Queue Size [bytes]**: The amount of bytes that the router can store in its queue. This is the maximum size of the queue. The default value is 1024 bytes.


The default size was changed.

Suggested change

- **Packet Queue Size [bytes]**: The amount of bytes that the router can store in its queue. This is the maximum size of the queue. The default value is 1024 bytes.

- **Packet Queue Size [bytes]**: The amount of bytes that the router can store in its queue. This is the maximum size of the queue. The default value is 4096 bytes.

MegaRedHand · 2025-05-28T01:54:28Z

README.md

+- **Packet Queue Usage Bar**: This bar shows the usage of the packet queue of the router. The packet queue is used to store packets that are waiting to be processed by the router. The bar shows the percentage of the queue that is currently in use. If the queue is full, the router will drop packets until there is space in the queue.
+- **Router Parameters Dropdown**: This dropdown allows you to select the parameters of the router. The parameters are:
+  - **Packet Queue Size [bytes]**: The amount of bytes that the router can store in its queue. This is the maximum size of the queue. The default value is 1024 bytes.
+  - **Packet Processing Speed [ms/byte]**: The time it takes for the router to process a packet. The default value is 8 miliseconds.


The units were inverted

Suggested change

- **Packet Processing Speed [ms/byte]**: The time it takes for the router to process a packet. The default value is 8 miliseconds.

- **Packet Processing Speed [bytes/second]**: The time it takes for the router to process a packet. The default value is 1024.

MegaRedHand · 2025-05-28T01:55:22Z

README.md

+  <img src="./img/13_Edge_remove_1.gif" alt="Edge Disappear" />
+</p>
+
+However, if the device that stops being visible in one layer is in the middle of two visible devices, the edges will still be visible and the device will be replaced with a **dot**. This **dot** will not be selectable and will not show any information when hovered. It is just a placeholder to show that there is a connection between the two devices. Besides, it lets you manipulate the network more easily.


We can mention the dot can be dragged

MegaRedHand · 2025-05-28T01:56:45Z

README.md

+
+#### Devices Interfaces
+
+When you select an edge that connect two devices, you will see a dropdown menu to select which interface of each device you want to use to connect those devices. Each type of device has a fixed limited amount of interfaces. Hosts have 2 interfaces, Routers have 4 and Switches have 8.


Hosts have 1 interface

Suggested change

When you select an edge that connect two devices, you will see a dropdown menu to select which interface of each device you want to use to connect those devices. Each type of device has a fixed limited amount of interfaces. Hosts have 2 interfaces, Routers have 4 and Switches have 8.

When you select an edge that connects two devices, you will see a dropdown menu to select which interface of each device you want to use to connect those devices. Each type of device has a fixed limited amount of interfaces. Hosts have 1 interface, Routers have 4 and Switches have 8.

MegaRedHand · 2025-05-28T01:58:06Z

README.md

+
+### Echo Server
+
+An echo server is a network service that receives data from a client and sends it back to the client. Just as the echo program, it is commonly used to test network connectivity and to measure the round-trip time for packets sent from the client to the server and back.


This is misleading

Suggested change

An echo server is a network service that receives data from a client and sends it back to the client. Just as the echo program, it is commonly used to test network connectivity and to measure the round-trip time for packets sent from the client to the server and back.

An echo server is a network service that sends ICMP echo packets at regular intervals. Just as the echo program, it is commonly used to test network connectivity and to measure the round-trip time for packets sent from the client to the server and back.

MegaRedHand · 2025-05-28T01:59:25Z

README.md

+| TCP             | <span style="color:white;">Hazel</span> <span style="display:inline-block;width:12px;height:12px;border-radius:50%;background-color:#d99802;"></span>    |
+| ICMP-8          | <span style="color:white;">Red</span> <span style="display:inline-block;width:12px;height:12px;border-radius:50%;background-color:#ff0000;"></span>      |
+| ICMP-0          | <span style="color:white;">Yellow</span> <span style="display:inline-block;width:12px;height:12px;border-radius:50%;background-color:#ffff00;"></span>   |
+| ARP             | <span style="color:white;">Green</span> <span style="display:inline-block;width:12px;height:12px;border-radius:50%;background-color:#00ff00;"></span>    |


This doesn't work due to GitHub removing any custom CSS before rendering markdown. We'll need to find an alternative

MegaRedHand · 2025-05-28T02:03:32Z

README.md

+  <img src="./img/23_ICMP_8_Network.gif" alt="ICMP-8 Network Layer" />
+</p>
+
+On the Link Layer, they only show the EtherType field. This field is used to specify the protocol used in the packet. For ICMP-8 packets, this is always 2048.


2048 (0x0800) is the EtherType for IPv4 in general

MegaRedHand · 2025-05-28T02:03:54Z

README.md

+  <img src="./img/25_ICMP_0_Network.gif" alt="ICMP-0 Network Layer" />
+</p>
+
+Just like ICMP-8 packets, on the Link Layer, they only show the EtherType field which is always 2048.


doc: getting started and left bar

b9d8ed2

V-SANT marked this pull request as draft May 11, 2025 20:52

V-SANT added 18 commits May 13, 2025 20:03

doc: add device gif fix

e3a8a37

doc: right bar and top bar

c034e6a

chore: lint

13438a1

Merge branch 'main' into doc/user-manual

4382b56

doc: canvas overview

2084c75

doc: host info

6b4b2eb

doc: router overview

2d2721d

chore:lint

03744d5

Merge branch 'main' into doc/user-manual

cae7be6

doc: manual basic structure

022d65e

doc: Switch overview

91edb7a

doc: edges

cba500f

doc: edges, interfaces and toc

97e846c

doc: single echo and echo server

3695a12

Merge branch 'main' into doc/user-manual

904f887

doc: packet info, icmp_8 and icmp0

38d9f22

doc: misc

3dd12b0

chore: lint

f28d7ad

V-SANT marked this pull request as ready for review May 28, 2025 01:31

MegaRedHand approved these changes May 28, 2025

View reviewed changes

V-SANT added 4 commits May 28, 2025 17:13

doc: fixes on color table and some entries

a72331f

chore: lint

1c6ea34

Merge branch 'main' into doc/user-manual

be69246

doc: change imgs of devices

040bcd2

V-SANT merged commit 4576059 into main May 28, 2025
3 checks passed

V-SANT deleted the doc/user-manual branch May 28, 2025 21:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

User Manual #238

User Manual #238

Uh oh!

V-SANT commented May 11, 2025

Uh oh!

MegaRedHand May 28, 2025

Uh oh!

MegaRedHand May 28, 2025

Uh oh!

MegaRedHand May 28, 2025 •

edited

Loading

Uh oh!

MegaRedHand May 28, 2025

Uh oh!

MegaRedHand May 28, 2025

Uh oh!

MegaRedHand May 28, 2025

Uh oh!

MegaRedHand May 28, 2025

Uh oh!

MegaRedHand May 28, 2025

Uh oh!

MegaRedHand May 28, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	- Packet Speed Wheel: Change the speed of the packets on the network. This is a slider that sets a multiplier to the speed of the packets. The default value is 1, which means that the packets will be sent at normal speed. You can set it up to 0.5 to slow down the packets or up to 4 to speed them up.
	- Simulation Speed Slider: Changes the speed of the simulation. This is a slider that sets a multiplier to the passage of time inside the simulation, which affects packet and program speed, among other things. The default value is 1, which means everything will happen at normal speed. You can set it up to 0.5 to slow it down or up to 4 to speed it up.

	- Packet Queue Size [bytes]: The amount of bytes that the router can store in its queue. This is the maximum size of the queue. The default value is 1024 bytes.
	- Packet Queue Size [bytes]: The amount of bytes that the router can store in its queue. This is the maximum size of the queue. The default value is 4096 bytes.

	- Packet Processing Speed [ms/byte]: The time it takes for the router to process a packet. The default value is 8 miliseconds.
	- Packet Processing Speed [bytes/second]: The time it takes for the router to process a packet. The default value is 1024.


		#### Devices Interfaces

		When you select an edge that connect two devices, you will see a dropdown menu to select which interface of each device you want to use to connect those devices. Each type of device has a fixed limited amount of interfaces. Hosts have 2 interfaces, Routers have 4 and Switches have 8.

	When you select an edge that connect two devices, you will see a dropdown menu to select which interface of each device you want to use to connect those devices. Each type of device has a fixed limited amount of interfaces. Hosts have 2 interfaces, Routers have 4 and Switches have 8.
	When you select an edge that connects two devices, you will see a dropdown menu to select which interface of each device you want to use to connect those devices. Each type of device has a fixed limited amount of interfaces. Hosts have 1 interface, Routers have 4 and Switches have 8.


		### Echo Server

		An echo server is a network service that receives data from a client and sends it back to the client. Just as the echo program, it is commonly used to test network connectivity and to measure the round-trip time for packets sent from the client to the server and back.

User Manual #238

User Manual #238

Uh oh!

Conversation

V-SANT commented May 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MegaRedHand May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MegaRedHand May 28, 2025 •

edited

Loading