| ▼Carriers | |
| ►Examples | Examples and tutorials about carriers |
| Configuring YARP Connections | Every YARP connection has a specific type of carrier associated with it |
| mpi carriers | The MPI carriers are supposed be a high-performance equivalent to YARPs standard carriers (Shared memory, TCP, Mcast) while also adding the possibility for using Infiniband (Highspeed node interconnect) |
| Creating carriers for new kinds of connections | In YARP, ports talk to each other via connections |
| Gstreamer carrier | If your robot has cameras with high resolution, you need to compress and to stream their images |
| Available Carriers | List of available carriers |
| ▼Devices | Dealing with devices |
| Device Creation/Configuration | Basic classes and methods related to creating and configuring devices, and network communication to and from devices |
| ►Device Implementations | Concrete device drivers that implement sets of interfaces |
| Network Servers (Wrappers - pre NWC/NWS architecture) | These devices take implementations of existing interfaces and wrap them up to work across the network |
| Network Clients (Clients - pre NWC/NWS architecture) | These devices are meant to communicate to YARP ports opened by Network Servers (Wrappers - pre NWC/NWS architecture) to provide device interfaces in a transparent way over a YARP network |
| YARP Network Wrapper Servers (NWS) | These devices take implementations of existing interfaces and wrap them up to work across the YARP network (see Network Wrapper Server and Network Wrapper Client Architecture) |
| ROS Network Wrapper Servers (NWS) | These devices take implementations of existing interfaces and wrap them up to work across the ROS network (see Network Wrapper Server and Network Wrapper Client Architecture) |
| ROS2 Network Wrapper Servers (NWS) | These devices take implementations of existing interfaces and wrap them up to work across the ROS2 network (see Network Wrapper Server and Network Wrapper Client Architecture) |
| YARP Network Wrapper Clients (NWC) | These devices connects to their NWS counterpart through YARP network and expose a yarp::dev interface (see Network Wrapper Server and Network Wrapper Client Architecture) |
| ROS Network Wrapper Clients (NWC) | These devices connects to ROS network and expose a yarp::dev interface (see Network Wrapper Server and Network Wrapper Client Architecture) |
| ROS2 Network Wrapper Clients (NWC) | These devices connects to ROS2 network and expose a yarp::dev interface (see Network Wrapper Server and Network Wrapper Client Architecture) |
| Remappers | These devices are meant expose a group of existing devices as a unique device, or to expose a subset of the resourses exposed by a device as an independent device |
| Motor Devices | These are devices useful for controlling motors |
| Media Devices | These are devices useful for getting images and sound |
| Analog Sensors | These are devices that expose sensor that can be efficiently expressed as vector of real numbers, so-called "analog" sensors, such as gyroscope, accelerometers, force-torque sensors |
| Lidar Devices | Lidars and similar range measurement devices |
| Navigation Devices | Virtual devices to perform navigation tasks |
| Fake/test Devices | Devices using for testing purposes |
| Other Device Implementations | Miscellaneous device implementations |
| Obsolete or deprecated devices | Devices marked for deprecation in the upcoming Yarp releases |
| Device invocation examples | Example configuration files |
| ►Tutorials and Examples about Devices | Tutorials and Examples about Devices |
| How to add a device to YARP | In YARP, a device driver is a class that implements one or more interfaces |
| Add a plugin to YARP | In YARP, a "plugin" is an implementation of some service for which there are many choices and alternatives |
| Device Drivers How-To | For a more up-to-date method of dealing with devices see: |
| FrameTransform: start all the required devices needed for transforming frames | |
| FrameTransform: possibile server-client configurations | |
| Getting Started with YARP Devices | For robotics, we need access to all sorts of strange devices |
| Network Wrapper Server and Network Wrapper Client Architecture | |
| Ways to compile YARP plugins | This documents an area of YARP that is in flux: runtime plugins |
| ▼Yarp tools | This page includes all command line executables |
| yarp-config: utility to check yarp configuration | The yarp-config tool inspects the system and reports information about installed configuration and data files |
| yarp: the main command-line interface | The command-line utility "yarp" performs a set of useful operations for a YARP network |
| yarpactionsplayer: an utility to replay robot movements | |
| yarpconnectionsinfo: A tool to display YARP ports and connections | |
| yarpdatadumper: the YARP data recorder | Acquires and stores Bottles or Images and Videos from a YARP port |
| yarpdatadumperAppGenerator: Generate yarpmanager applications for yarpdatadumper | |
| yarp: yarpdataplayer-console | A module that reproduces in a synchronized way, previously acquired data (using yarpdatadumper: the YARP data recorder) from a source of input |
| yarpdev: the standard YARP device utility | The command-line utility "yarpdev" can create devices and wrap them for network visibility |
| yarpDeviceParamParserGenerator: YARP code generator/compiler for parameters parsers | |
| yarphear: listen to YARP audio streams | |
| yarpidl_thrift: YARP code generator/compiler for Thrift IDL | |
| yarplogger-console: visualize log from YARP programs | |
| yarpmanager-console: run and manage multiple programs on a set of machines | |
| yarpRerun: log data of a yarp port to rerun.io | |
| yarpRobotDescriptionInfo: A tool to inspect YARP devices used by yarprobotinterface | |
| yarprobotinterface: Start multiple YARP devices as specified in an xml file. | |
| yarprun: run programs on a set of machines | The command-line utility "yarprun" provides a client-server environment that is able to run, kill and monitor applications commands on a remote machine, with the same syntax and behaviour in Windows and Linux |
| yarpserver: the YARP name server | |
| ▼Yarp GUIs | This page includes all yarp gui |
| yarpaudiocontrolgui: Controls the playback/recording of an audio device | Controls the playback/recording of an audio device |
| yarpbatterygui: Visualize battery information | Visualize battery information such as: voltage, charge, temperature etc |
| ►yarpdataplayer: replay recorded data | A module that reproduces in a synchronized way, previously acquired data (using yarpdatadumper: the YARP data recorder) from a source of input |
| yarpdataplayer example application | Re-play a recorded sequence from the robot |
| yarpdataplayer recording example | Record a sequence of data from all sensors of the robot |
| yarplaserscannergui: visualize data from a laser scanner | A simple GUI to display the distance measurements of a 2D laser scanner |
| yarpllmgui: Controls a LLM device | Controls and displays the conversation with a LLM device |
| yarplogger: visualize log from YARP programs | |
| yarpmanager: edit, run and manage multiple programs on a set of machines | The command-line utility "yarpmanager-console" and its graphical companions "yarpmanager" are tools for running and managing multiple programs on a set of machines |
| yarpmobilebasegui: Control the mobile base of the robot | |
| yarpmotorgui: move the joints of a robot | A simple graphical interface for moving all the joints of a robot with sliders |
| yarpopencvdisplay: Visualize yarp images | |
| yarpscope: visualize the numerical content of a port | |
| yarpview: visualize YARP images | |
| yarpviz: a graphical tool for profiling and visualizing YARP network | The yarpviz is a graphical tool for profiling and visualizing YARP network |
| Gstreamer plugins | |
| ▼Portmonitors | |
| ►Examples | Examples and tutorials about portmonitors |
| An example of using port monitors for arbitrating multiple connections | |
| An example of using port arbitrator with time events | |
| An example of using the portmonitor object at the both sides of a connection to encode and decode data | |
| An example which shows how to use a Lua script to modify image data | |
| An example which shows how to use C++ and DLLS to modify incoming data in an input port | |
| An example which shows how to use a Lua script to modify incoming data in an input port | |
| An example which shows how to use a Lua script to create a new data type in a port | |
| Available Portmonitors | List of available portmonitors |
| ▼yarp::dev Interfaces | |
| ►Device Interfaces | Device interfaces, specified independently of specific implementations |
| ►Motor Interfaces | Motor control and monitoring |
| Raw Motor Interfaces | Motor control and monitoring (Raw version) |
| Navigation Interfaces | Interfaces for navigation, localization and mapping |
| Media Interfaces | Images and sounds |
| Multiple Analog Sensor Interfaces | The interfaces present in this group are meant to be implemented by devices that expose sensor that can be efficiently expressed as vector of real numbers, so-called "analog" sensors |
| Frame Transform Interfaces | The interfaces in this group are to be implemented by devices who are meant to manage and/or store frame transformations |
| ►Other Device Interfaces | Sundry, miscellaneous |
| Other Device Interfaces (Raw version) | Sundry, miscellaneous |
| Tutorials | Interface tutorials |
| ▼yarp::os OS-related functionalities | Welcome to the YARP os library |
| Basic Classes | Some classes for basic services (excluding communication) |
| Communication Classes | The most important classes for getting started with communication |
| ▼yarp::sig Signal Processing | Basic classes and methods related to signal processing |
| ►Examples | Examples and tutorials about specific signal classes |
| Audio in YARP | |
| YARP PointCloud | This tutorial covers how to use the template class yarp::sig::PointCloud with pcl::PointCloud and stand alone |
| yarp::sig classes | List of signal classes |
| ▼yarp::robotinterface YARP RobotInterface library | The libYARP_robotinterface library is useful to programatically launch YARP devices from C++ code using the same xml files used with the yarprobotinterface tool, that are described in YARP robotinterface XML files |
| yarprobotinterface: Start multiple YARP devices as specified in an xml file. | |
| YARP robotinterface XML files | This tutorial covers how to write and read XML files that are used by yarprobotinterface tool and by the libYARP_robotinterface C++ library |