ROS index logo ROS Index
  1. Home
  2. Packages
  3. gui_interfaces
 
No version for distro humble. Known supported distros are highlighted in the buttons above.
No version for distro jazzy. Known supported distros are highlighted in the buttons above.
No version for distro rolling. Known supported distros are highlighted in the buttons above.

gui_interfaces package from roboticsacademy repo

console_interfaces gui_interfaces hal_interfaces

API Docs
Browse Code

Package Summary

Tags No category tags.
Version 0.0.1
License MIT
Build type AMENT_PYTHON
Use RECOMMENDED

Repository Summary

Checkout URI https://github.com/jderobot/roboticsacademy.git
VCS Type git
VCS Version humble-devel
Last Updated 2025-04-03
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

JdeRobot graphical user interface package

Additional Links

No additional links.

Maintainers

  • Javier Izquierdo

Authors

No additional authors.
common/gui_interfaces/README.md

Gui Interfaces

Gui interfaces is a python package that provides with base GUI classes to be inherited in the GUI of the exercises in Robotics Academy.

How to use

In order to import the specific Gui interface follow the next pattern.

Being for general interfaces:

from gui_interfaces.general.{INTERFACE} import ...

where {INTERFACE} needs to be substitued by the interface name.

And for specific interfaces:

from gui_interfaces.specific.{EXERCISE}.{INTERFACE} import ...

where {EXERCISE} is the name of exercise being worked on and {INTERFACE} needs to be substitued by the interface name.

How to add interfaces

If the interface is only specific to one exercise add it as a specific interface, if not the add it to general. Also the naming scheme that needs to be followed when naming a new interface file is snake case or lower case with underlines.

For reference, please refer to the existing interfaces.

General Interfaces

  • Inside the general directory

Specific Interfaces

  • Create a directory named after the exercise name inside of the specific directory.

How to add to an exercise

  • Import each interface as stated in the How to use section.
  • Create your exercise GUI that inherits from the chosen GUI interface
  • Check in each interface what needs to be implemented.
CHANGELOG
No CHANGELOG found.

Wiki Tutorials

This package does not provide any links to tutorials in it's rosindex metadata. You can check on the ROS Wiki Tutorials page for the package.

Package Dependencies

Deps Name
ament_copyright
ament_flake8
ament_pep257

System Dependencies

Name
python3-pytest

Dependant Packages

No known dependants.

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

No plugins found.

Recent questions tagged gui_interfaces at Robotics Stack Exchange

No version for distro noetic. Known supported distros are highlighted in the buttons above.
No version for distro ardent. Known supported distros are highlighted in the buttons above.
No version for distro bouncy. Known supported distros are highlighted in the buttons above.
No version for distro crystal. Known supported distros are highlighted in the buttons above.
No version for distro eloquent. Known supported distros are highlighted in the buttons above.
No version for distro dashing. Known supported distros are highlighted in the buttons above.
No version for distro galactic. Known supported distros are highlighted in the buttons above.
No version for distro foxy. Known supported distros are highlighted in the buttons above.
No version for distro iron. Known supported distros are highlighted in the buttons above.
No version for distro lunar. Known supported distros are highlighted in the buttons above.
No version for distro jade. Known supported distros are highlighted in the buttons above.
No version for distro indigo. Known supported distros are highlighted in the buttons above.
No version for distro hydro. Known supported distros are highlighted in the buttons above.
No version for distro kinetic. Known supported distros are highlighted in the buttons above.
No version for distro melodic. Known supported distros are highlighted in the buttons above.