![]() |
rosboard_client package from rosboard_client reporosboard_client |
Package Summary
Tags | No category tags. |
Version | 0.0.0 |
License | TODO: License declaration |
Build type | AMENT_PYTHON |
Use | RECOMMENDED |
Repository Summary
Checkout URI | https://github.com/kiwicampus/rosboard_client.git |
VCS Type | git |
VCS Version | main |
Last Updated | 2024-07-09 |
Dev Status | UNMAINTAINED |
CI status | No Continuous Integration |
Released | UNRELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Package Description
Additional Links
Maintainers
- ada
Authors
Rosboard Client
This package is a graphical user interface (GUI) to be used with the rosboard utility. The graphical interface allows an user to subscribe to topics that are available in the server and stream topics to the server. By using an user interface it is possible to dynamically configure which topics will be streamed to and from the server. This guide will introduce the interface along with its functionalities. The GUI is presented in the next image. This shows how the GUI would look under normal operations. The interface is composed of four main widgets: the connection widget, the statistics widget, the server-available widget and the client-available widget.
Connection Widget
The connection widget allows an user to manage the connection from the GUI to the server. It is expected for the user to input the server address in the line editor and then click the “CONNECT” button to establish the connection to the server. A feedback is presented in the widget and it shows the connection status. Such status can have three status: “CONNECTED”, “DISCONNECTED” and “RETRYING”. The “RETYING” status is used when the connection to the server is lost and the interface is attempting to regain such connection. Clicking the “DISCONNECT” button will close the connection to the server.
Statistics Widget
It show three statistics regarding the user interface. Three statistics are shown: CPU usage percentage, roundtrip time between interface and server in milliseconds, and download speed of host computer. The CPU usage and download speed are continuously updated even if the interface is not connected to the server. The roundtrip time is updated only if the GUI is connected to the server.
Server-available Widget
It shows a list and a panel with the topics that are available in the server to be streamed to the client. If an element from the list (left side) is clicked, the streaming will start and the topic will be shown in the panel (right side). Topics in the panel will be accompanied of its measured publish frequency and latency. The frequency is measured from the time at which the messages are received in the client and the latency is the time difference between time-stamped messages and the time at which they were received. Closing a topic element in the panel will stop it from being streamed.
Client-available Widget
It also shows a list and a panel, however, it shows the topics that are available in the client. If an element of the list is clicked, it will be streamed to the server. If the “X” in the topic widget is pressed, the topic will cease to be streamed.