You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This release introduces the Network Wrapper Server/Client Architecture
as described in #2441. This architecture enables ROS2 compatibility
which is currently developed in the yarp-ros2 repository.
Deprecation and Behaviour Changes
A few default values for the environment variables used by yarp are now
different:
YARP_DATA_DIRS defaults to %%ALLUSERSPROFILE%%\yarp
YARP_CONFIG_DIRS defaults to %%ALLUSERSPROFILE%%\yarp\config
Libraries
conf
filesystem::path_separator is deprecated in favour of environment::path_separator
yarp::conf::environment::getEnvironment is deprecated in favour of yarp::conf::environment::get_string
yarp::conf::environment::setEnvironment is deprecated in favour of yarp::conf::environment::set_string
yarp::conf::environment::unsetEnvironment is deprecated in favour of yarp::conf::environment::unset
The YARP_DEPRECATED_API and YARP_DEPRECATED_API_MSG defines are now
deprecated in favour of YARP_DEPRECATED_EXPORT, YARP_DEPRECATED_IMPORT, YARP_DEPRECATED_MSG_EXPORT, and YARP_DEPRECATED_MSG_IMPORT.
os
Bottle
BOTTLE_TAG_INT is deprecated in favour of BOTTLE_TAG_INT32
BOTTLE_TAG_DOUBLE is deprecated in favour of BOTTLE_TAG_FLOAT64
BOTTLE_TAG_VOCAB is deprecated in favour of BOTTLE_TAG_VOCAB32
addInt is deprecated in favour of addInt32
addDouble is deprecated in favour of addFloat64
yarp::os::Bottle::addVocab() is deprecated in favour of yarp::os::Bottle::addVocab32()
ConnectionReader
expectInt is deprecated in favour of expectInt32
expectDouble is deprecated in favour of expectFloat64
ConnectionWriter
appendInt is deprecated in favour of appendInt32
appendDouble is deprecated in favour of appendFloat64
LogStream
The operator<< for std::ostream and std::vector which caused conflicts
with Casadi was removed (#2067).
NetType
toHexString is deprecated in favour of yarp::conf::numeric::to_hex_string
toString is deprecated in favour of yarp::conf::numeric::to_string
toInt, toFloat32 and toFloat64 are deprecated in favour of yarp::conf::numeric::from_string
ResourceFinder
Deprecated methods with alternatives in yarp::conf::dirs.
The following methods are now deprecated:
yarp::os::ResourceFinder::getDataHome()
yarp::os::ResourceFinder::getDataHomeNoCreate()
yarp::os::ResourceFinder::getConfigHome()
yarp::os::ResourceFinder::getConfigHomeNoCreate()
yarp::os::ResourceFinder::getDataDirs()
yarp::os::ResourceFinder::getConfigDirs()
in favour of:
yarp::conf::dirs::yarpdatahome()
yarp::conf::dirs::yarpconfighome()
yarp::conf::dirs::yarpdatadirs()
Warnings:
The return value of yarpdatadirs() is different
(std::vector<std::string> instead of std::string).
The yarpdatahome() and yarpconfighome() do not create the directory,
it must be created manually (for example with yarp::os::mkdir_p()) if
required.
Stamp
Using Header instead of Stamp is now recommended.
Value
isInt() is deprecated in favour of isInt32()
isDouble() is deprecated in favour of isFloat64()
asInt() is deprecated in favour of asInt32()
asDouble() is deprecated in favour of asFloat64()
makeInt() is deprecated in favour of makeInt32()
makeDouble() is deprecated in favour of makeFloat64()
isVocab() is deprecated in favour of isVocab32()
asVocab() is deprecated in favour of asVocab32()
makeVocab() is deprecated in favour of makeVocab32()
Vocab
yarp::os::createVocab() is deprecated in favour of yarp::os::createVocab32()
yarp::os::Vocab::encode() is deprecated in favour of yarp::os::Vocab32::encode()
yarp::os::Vocab::decode() is deprecated in favour of yarp::os::Vocab32::decode()
WireReader
getIsVocab() is deprecated in favour of getIsVocab32()
readVocab() is now deprecated in favour of readVocab32()
WireWriter
writeVocab() is now deprecated in favour of writeVocab32()
sig
IntrinsicParams
YARP_PLUM_BOB is deprecated in favour of YARP_PLUMB_BOB.
dev
The yarp/dev/FrameGrabberControl2.h header file was properly marked as
deprecated (it should have been deprecated in YARP 3.0)
The yarp/dev/FrameGrabberInterfaces.h header file was deprecated.
All interfaces were moved in the corresponding header.
All classes and vocabs moved in framegrabber_protocol library were removed.
This is an API break, but nobody should be using these outside of YARP.
The flag VOCAB_NAV_CLEAR_X, defined in file ILocalization2D.h has been
renamed to VOCAB_NAV_CLEARALL_X to avoid confusion with flag VOCAB_NAV_DELETE_X. VOCAB_NAV_CLEARALL_X clears all data belonging to the same category (all
maps, all locations, all areas, etc), while VOCAB_NAV_DELETE_X, deletes a
single entity (a map with name x, a location with name x etc).
The IVisualParams.h file was deprecated in favour of IRgbVisualParams.h
and IDepthVisualParams.
All headers for the deprecated interfaces are now properly deprecated.
The interfaces IFrameGrabber and IFrameGrabberRgb are now deprecated.
IDepthVisualParams
The retificationMatrix parameter was renamed rectificationMatrix
IRgbVisualParams
The retificationMatrix parameter was renamed rectificationMatrix
robotinterface
The robotinterface library is no longer considered experimental, all
files in the experimental folder and classes in the experimental namespace
are now deprecated and will be removed in the next release.
Port Monitors
Port monitors were reorganized and renamed without keeping the back
compatibility with the old name.
The new names are:
depthimage_compression_zfp (zfp)
depthimage_to_mono (depthimage)
depthimage_to_rgb (depthimage2)
segmentationimage_to_rgb (segmentationimage)
Devices
The following devices are now deprecated:
test_grabber in favour of fakeFrameGrabber
fakeMotor in favour of fakeMotionControl
test_motor in favour of fakeMotionControl
fakebot
The following devices will be replaced by NWS/NWC in the next release, and
print a warning when opened:
controlboardwrapper2 (replaced by controlboardremapper + controlBoard_nws_yarp)
RGBDSensorWrapper (replaced by rgbdSensor_nws_yarp)
Rangefinder2DWrapper (replaced by rangefinder2D_nws_yarp)
grabberDual (replaced by frameGrabber_nws_yarp, and eventually frameGrabberCropper)
inertial (replaced by multipleanalogsensorsremapper + multipleanalogsensorsserver + IMURosPublisher)
localization2DServer (replaced by localization2D_nws_yarp)
map2DServer (replaced by map2D_nws_yarp)
transformClient (replaced by frameTransformClient)
transformServer (replaced by frameTransformServer)
New Features
Libraries
conf
Added the following functions in <yarp/conf/numeric.h>:
yarp::conf::numeric::from_string
yarp::conf::numeric::to_string
yarp::conf::numeric::to_hex_string
Added the header <yarp/conf/string.h> containing the following functions:
yarp::conf::string::split
yarp::conf::string::join
Added environment::path_separator
Added the following functions in <yarp/conf/environment.h>:
yarp::conf::environment::get_string
yarp::conf::environment::set_string
yarp::conf::environment::get_bool
yarp::conf::environment::set_bool
yarp::conf::environment::get_numeric
yarp::conf::environment::set_numeric
yarp::conf::environment::split_path
yarp::conf::environment::join_path
yarp::conf::environment::get_path
yarp::conf::environment::set_path
yarp::conf::environment::unset
yarp::conf::environment::is_set
Added the new dirs.h file with methods to retrieve the important folders
Introduced the yarp::os::Header class, intended to gradually replace the yarp::os::Stamp class to handle envelopes, maintaining backwards
compatibility.
The differences with the Stamp class:
Header has an extra field to handle the frame id, making it comparable
with ROS std_msgs/Header
message.
The counter uses unsigned int instead of int.
Stamp::getMaxCount() is replaced with Header::npos
Stamp::getCount() is replaced with Header::count()
Stamp::getTime() is replaced with Header::timeStamp()
Bottle
Added BOTTLE_TAG_VOCAB32 tag. This is the same as BOTTLE_TAG_VOCAB.
The usage of BOTTLE_TAG_VOCAB is not recommended in new code, use BOTTLE_TAG_VOCAB32 instead.
Added addVocab32() overloads accepting 4 chars and string.
DummyConnector
The getReader methods now accepts a ConnectionWriter as optional
parameter. This writer is returned by getWriter is called on the ConnectionReader returned by the writer, and it is therefore used for the
replies in Portables and in a few other cases.
Log
The YARP_FORWARD_CODEINFO_ENABLE, YARP_FORWARD_HOSTNAME_ENABLE, YARP_FORWARD_PROCESSINFO_ENABLE, and YARP_FORWARD_BACKTRACE_ENABLE are no
longer considered experimental.
PeriodicThread
The constructor now accepts a third (optional) parameter, clockAccuracy,
which enables drift compensation using an absolute time reference to ensure
all steps trigger at precise intervals, thus avoiding error accumulation over
time. Set it to PeriodicThreadClock::Absolute to enable the new behavior,
default is PeriodicThreadClock::Relative (old behavior). Beware that, in
absolute mode, starvation may occur if two busy threads share a common
resource (#2488).
Added cropRect() helper function for cropping a rectangle area out of an
image given two opposite vertices.
dev
Added the new WrapperSingle and WrapperMultiple helper classes, that
inherit from both IWrapper and IMultipleWrapper but require to implement
only one of these interfaces.
Added the template class IFrameGrabberOf<typename ImageType>.
It is now possible to implement the same interface as for IFrameGrabberImage
and IFrameGrabberImageRaw, but for different pixel types or for FlexImage.
Added the new datatypes generated by thrift:
yarp::dev::AudioRecorderStatus
yarp::dev::AudioPlayerStatus
Added the new class AudioPlayerDeviceBase, all playback device drivers now
inherit from this class.
Added the new class AudioRecorerDeviceBase, all recording device drivers now
inherit from this class.
IFrameGrabberImage
The getImageCrop method has now a working default implementation.
The IFrameGrabberImage interface is now an alias for IFrameGrabberOf<yarp::sig::ImageOf<yarp::sig::PixelRgb>>.
IFrameGrabberImageRaw
The getImageCrop method has now a working default implementation.
The IFrameGrabberImageRaw interface is now an alias for IFrameGrabberOf<yarp::sig::ImageOf<yarp::sig::PixelMono>>.
IAudioRender
Added the new methods:
bool setHWGain(double gain)
bool setSWGain(double gain)
IAudioGrabberSound
Added the new methods:
bool setHWGain(double gain)
bool setSWGain(double gain)
Lidar2DDeviceBase
The Lidar2DDeviceBase class, now implements yarp::dev::IPreciselyTimed.
All lidar devices must implement the method acquireDataFromHW() which is
pure virtual in Lidar2DDeviceBase
Lidar devices can optionally call the method Lidar2DDeviceBase::updateLidarData, which calls acquireDataFromHW() and a
few other utility functions (e.g. updateTimestamp(), etc.)
The run() method of the devices, which was previously responsible for the data
collection, now just calls updateLidarData().
Added internal lossless compression using Zlib.
The write() and read() methods handle the compression before sending data
to the network.
Added method enable_map_compression_over_network() to enables/disables data
compression over the network (default true). Compression is always disabled if
Zlib library is not available.
Improved logic to convert ros map images to ros occupancy data and viceversa.
The getRobotFromFile and getRobotFromString now accept a Searchable that
is used to replace params with the attribute extern-name.
The signatures are now:
The unix_stream carrier is no longer considered experimental.
Port Monitors
There is now a new yarppm library (similar to yarpcar and yarpmod) that
links all the portmonitors in static builds.
Added image_compression_ffmpeg port monitor to compress a video stream using
the H264, H265, or MPEG2VIDEO codec.
Added sound_compression_mp3 port monitor to decompress a mp3 bytestream to yarp::sig::Sound. Encoding not supported yet.
Added depthimage_compression_zlib port monitor which uses the Zlib library
to compress/decompress (lossless) depth images through the network.
Devices
AudioPlayerWrapper
Added RPC commands to control the volume via setHWGain() and setSWGain().
It now broadcasts its internal status on a xxx/status:o port
AudioRecorderWrapper
Added RPC commands to control the volume via setHWGain() and setSWGain().
It now broadcasts its internal status on a xxx/status:o port
fakeFrameGrabber
added RPC port, to change its mode at runtime. It is also possibile to load a
new background image at runtime.
Rpc command 'help' will display available commands.
Added --timestamp option to write the timestamp in the first bytes of the
image. This was previously automatically enabled in line mode, but it can
now be used in all modes.
Double buffering is now used to produce the image on a separate thread. This
should improve performances when generating large images.
The getImage() method no longer blocks the caller.
The --syncro option was added to restore the old behavior.
The topIsLow option and the set_topIsLow rpc command were added to produce
images with bottom to top scanlines.
Added --noise options and set_noise RPC commands to add a a white noise to
the generated image.
Added --snr option and set_snr RPC commands. to specify the signal noise
ratio if noise is enabled.
fakeLaser
Added rpc port to dynamically create obstacles in the map. Use the rpc command
'help' to get additional information.
Improved the ray tracing algorithm: laser scans are now bound to the map size.
Added map_context parameter to load a test map from a specific context.
fakeMicrophone
It now generates a fixed tone sound.
fakeNavigation
Several improvements for testing purposes.
frameTransformServer
Added a new RPC command generate_view which generates via dot (graphviz)
a pdf file, containing a diagram of the transforms tree.
map2DServer
Added enable_maps_compression <0/1> RPC command.
navigation2DClient
getNameOfCurrentTarget() logic moved from Navigation2DClient to navigation2DServer.
Tools
Added yarpdataplayer-console tool that works without without a graphic
server.
yarp
The read subcommand now accepts the trim argument to reduce the number of
characters printed for each message received.
Added the following new subcommands:
yarp latency-test: performs a latency test exchanging data between a
server and a client node.
yarp repeat: repeats in an output port all data received in an input port.
The command is useful to control stream flows on a wifi/mobile connection.
yarp stats: opens a temporary port to receive data from a remote port (at
maximum speed). It also prints basic statistics about data trasferred on the
instantiated connection.
yarp trafficgen: sends generated data over a yarp port. The tool allows to
test the communication and the available bandwidth over the network.
yarpdatadumper
The following data outputs for the --type parameter are now supported:
bottle (default)
image
image_jpg
image_png
video
depth
depth_compressed
yarprobotinterface
Arguments taken from the command line are now handled and used to replace
parameters marked with the attribute extern-name.
yarpidl_thrift
Thrift was updated to version 0.14.1.
Added support for uint8_t, uint16_t, uint32_t, uint64_t, size_t, float32_t and float64_t using annotated types.
It is now possible to use these types in thrift by defining them using a typedef, for example:
Types annotated with "yarp.type" are no longer serialized as nested.
This improves the compatibility with existing services returning Bottle
or other YARP types, and makes it possible to write a thrift file for
existing protocols.
On the other hand, this breaks compatibility with thrift services
returning Bottles or other annotated types, generated before this
commit. This is a breaking change, but should impact only a very
limited number of cases, and it can be easily fixed by regenerating the
files.
Added support for vocabs in structs (#2476).
Vocabs can be defined in this way:
Added "yarp.nested" annotation for struct fields
When defined = "true", this serialize a struct as a bottle instead of as a
flat structure.
For example, given these 2 structs:
The Bar struct will be serialized as bar1 (foo1 foo2), instead of as a
flat struct bar1 foo1 foo2.
It is now possible to specify a "const" qualifier to service methods using the yarp.qualifier annotation. For example, this code:
service Foo {
bool const_method() (yarp.qualifier = "const");
}
will generate a service Foo with this method:
boolconst_method() const
GUIs
yarpview
Added the --rightout <portname> option that enables intercepting the mouse
right button click events:
Single click (sends the current cursor coordinates to the specified output
port)
Press, drag, and release (sends the coordinates of the press point and of
the release one to the specified output port)
Added Image/Intercept right click checkable menu item to enable/disable
the right click interception (not available in minimal or compact mode or
if the --rightout option was not enabled).
yarpdataplayer
It is now possible to reproduce depth and depth_compressed data types.
The yarpdataplayer tool was refactored, several bugs fixed, and new features
added (#1144, #2140, #2151, #2400, #2401, #2442).
Bindings
Added support for std::vector<short int>.
Added support for yarp::sig::VectorOf<int>.
Added the following extensions to yarp::sig::Sound
sound2VecNonInterleaved()
vecNonInterleaved2Sound()
sound2VecInterleaved()
vecInterleaved2Sound()
New Experimental Features
EXPERIMENTAL means that the software is under development, provided with
incomplete documentation and it may be modified/renamed/removed without any
notice.
Carriers
Added new EXPERIMENTALwebsocket carrier.
It works only on the receiving side, and it works on an http request
that starts with "GET /?ws" (for example 'http://127.0.0.1:10002/?ws'
or 'ws://127.0.0.1:10002/?ws' if a read port is opened by yarp).
The websocket, on the browser side, needs to communicate using the YARP
protocol.
Devices
Added the following new EXPERIMENTAL devices:
RGBDFromRosTopic: it can be wrapped by RGBDSSensorWrapper to make RGBD
data, collected by a ROS device, available on YARP via RGBDSensorClient.
map2DStorage: store navigation data, e.g MapGrid2D,Map2DLocation etc.
It implements all the logic previously located inside device 'Map2DServer'.
audioFromFileDevice: wrapped by audioRecorderWrapper.
audioToFileDevice: wrapped by audioPlayerWrapper.
frameGrabberCropper: attaches to a frameGrabber and published part of the
image
frameTransformStorage
frameTransformSetMultiplexer
frameTransformGetMultiplexer
Several new EXPERIMENTAL devices were added in order to implement the
Network Wrapper Server/Client Architecture described in #2441.
These devices do not implement internal logic, therefore they might need to be
used together with a different device.
This architecture and all these devices are to be considered experimental,
and may be modified/renamed/removed at any time without any notice.
controlBoard_nws_ros: ROS NWS that can be used to replace controlboardwrapper2 (does not handle networks, use controlboardremapper
for that). It requires that the yarp::dev::IAxisInfo is implemented in the
device.
controlBoard_nws_yarp: YARP NWS that can be used to replace controlboardwrapper2 (does not handle networks, use controlboardremapper
for that).
frameGrabber_nws_ros: ROS NWS that can be used to replace grabberDual (does not handle image split, use frameGrabberCropper for
that)
frameGrabber_nws_yarp: YARP NWS that can be used to replace grabberDual (does not handle image split, use frameGrabberCropper for
that)
frameGrabber_nwc_yarp: YARP NWC that can be used to replace remote_grabber
localization2D_nws_ros: ROS NWS for devices which implement the ILocalization2D interface, that can be used to replace localization2DServer.
localization2D_nws_yarp: YARP NWS for devices which implement the ILocalization2D interface, that can be used to replace localization2DServer.
map2D_nws_ros: ROS NWS for a map2DStorage device.
map2D_nws_yarp: YARP NWS for a map2DStorage device.
rangefinder2D_nws_ros: ROS NWS for devices exposing IRangefinder2D interface.
rangefinder2D_nws_yarp: YARP NWS for devices exposing IRangefinder2D interface.
rgbdSensor_nws_ros: ROS NWS to replace RGBDSensorWrapper.
rgbdSensor_nws_yarp: YARP NWS to replace RGBDSensorWrapper.
rgbdToPointCloudSensor_nws_ros: enables point cloud publication from yarp
to ros. It converts RGBD data to point cloud and publishes it on a ros
topic.
frameTransformGet_nws_ros
frameTransformGet_nws_yarp
frameTransformSet_nws_ros
frameTransformSet_nws_yarp
All these interfaces have the following differences with their original
wrappers:
All deprecated parameters were removed
Periods are in seconds, and not in milliseconds.
Parameters in nws_ros devices no longer have the "ROS_" prefix".
Added new EXPERIMENTAL devices frameTransformClient and frameTransformServer.
These devices are mostly empty containers for multiple plugins that can be
combined together through a yarprobotinterface xml file.
Different configuration files can be used for different purposes, such as
publishing/subscribing transforms on YARP, ROS, ROS2 etc. Please refer to the
documentation for additional details.
Old devices with frame transform management functionality are called transformServer and transformClient. These devices should be now
considered deprecated and they must be not confused with the new devices
included in this PR. A yarp page documentation has been added to show the
different possible configurations.
The laserFromRosTopic is still considered EXPERIMENTAL, since it will
be replaced by an appropriate NWC
Bindings
Python
Introduced unofficial support to install YARP with tools like pip.
A new yarp-middleware package is now distributed in PyPI.
Bug Fixes
Libraries
sig
Image
The topIsLow flag is now properly handled, kept in sync with the internal IplImage, and forwarded through the network.
ImageFile
Fixed SavePNG() producing corrupted output files.
Carriers
portmonitor
The reply handler is now set correctly, it is therefore now possible to
monitor RPC connections.
Devices
grabberDual
The topIsLow flag is no longer changed.
Devices
RGBDSensorClient
The device no longer crashes when no image was received yet (#2349).
The timestamp is now correct.
map2DServer
Fixed issue preventing correct file save/load operations of locations data.
GUIs
yarpdataplayer
Timestamp is now interpreted correctly, dealing with locale issues (#2558).
Fixed step command in RPC exhibiting odd behaviors (#2151).
Contributors
This is a list of people that contributed to this release (generated from the
git history using git shortlog -ens --no-merges v3.4.0..v3.5.0):
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
YARP 3.5.0 was released today and is now available for download at: https://github.com/robotology/yarp/releases/v3.5.0.
A (partial) list of bug fixed and issues resolved in this release can be found
here.
Important Changes
Dependencies
Libraries
sig
Image
means that the image needs to be manually flipped after it is received.
earlier.
Devices
ovrheadset
device driver was moved tohttps://github.com/robotology/yarp-device-ovrheadset
realsense2
,realsense2withIMU
andrealsense2Tracking
device driverswere moved to https://github.com/robotology/yarp-device-realsense2
as described in #2441. This architecture enables ROS2 compatibility
which is currently developed in the
yarp-ros2 repository.
Deprecation and Behaviour Changes
different:
YARP_CONFIG_DIRS
defaults to/etc/xdg/yarp
to be compliant with theXDG Base Directory Specification
YARP_DATA_DIRS
defaults to%%ALLUSERSPROFILE%%\yarp
YARP_CONFIG_DIRS
defaults to%%ALLUSERSPROFILE%%\yarp\config
Libraries
conf
filesystem::path_separator
is deprecated in favour ofenvironment::path_separator
yarp::conf::environment::getEnvironment
is deprecated in favour ofyarp::conf::environment::get_string
yarp::conf::environment::setEnvironment
is deprecated in favour ofyarp::conf::environment::set_string
yarp::conf::environment::unsetEnvironment
is deprecated in favour ofyarp::conf::environment::unset
YARP_DEPRECATED_API
andYARP_DEPRECATED_API_MSG
defines are nowdeprecated in favour of
YARP_DEPRECATED_EXPORT
,YARP_DEPRECATED_IMPORT
,YARP_DEPRECATED_MSG_EXPORT
, andYARP_DEPRECATED_MSG_IMPORT
.os
Bottle
BOTTLE_TAG_INT
is deprecated in favour ofBOTTLE_TAG_INT32
BOTTLE_TAG_DOUBLE
is deprecated in favour ofBOTTLE_TAG_FLOAT64
BOTTLE_TAG_VOCAB
is deprecated in favour ofBOTTLE_TAG_VOCAB32
addInt
is deprecated in favour ofaddInt32
addDouble
is deprecated in favour ofaddFloat64
yarp::os::Bottle::addVocab()
is deprecated in favour ofyarp::os::Bottle::addVocab32()
ConnectionReader
expectInt
is deprecated in favour ofexpectInt32
expectDouble
is deprecated in favour ofexpectFloat64
ConnectionWriter
appendInt
is deprecated in favour ofappendInt32
appendDouble
is deprecated in favour ofappendFloat64
LogStream
operator<<
forstd::ostream
andstd::vector
which caused conflictswith Casadi was removed (#2067).
NetType
toHexString
is deprecated in favour ofyarp::conf::numeric::to_hex_string
toString
is deprecated in favour ofyarp::conf::numeric::to_string
toInt
,toFloat32
andtoFloat64
are deprecated in favour ofyarp::conf::numeric::from_string
ResourceFinder
yarp::conf::dirs
.The following methods are now deprecated:
yarp::os::ResourceFinder::getDataHome()
yarp::os::ResourceFinder::getDataHomeNoCreate()
yarp::os::ResourceFinder::getConfigHome()
yarp::os::ResourceFinder::getConfigHomeNoCreate()
yarp::os::ResourceFinder::getDataDirs()
yarp::os::ResourceFinder::getConfigDirs()
in favour of:
yarp::conf::dirs::yarpdatahome()
yarp::conf::dirs::yarpconfighome()
yarp::conf::dirs::yarpdatadirs()
Warnings:
yarpdatadirs()
is different(
std::vector<std::string>
instead ofstd::string
).yarpdatahome()
andyarpconfighome()
do not create the directory,it must be created manually (for example with
yarp::os::mkdir_p()
) ifrequired.
Stamp
Header
instead ofStamp
is now recommended.Value
isInt()
is deprecated in favour ofisInt32()
isDouble()
is deprecated in favour ofisFloat64()
asInt()
is deprecated in favour ofasInt32()
asDouble()
is deprecated in favour ofasFloat64()
makeInt()
is deprecated in favour ofmakeInt32()
makeDouble()
is deprecated in favour ofmakeFloat64()
isVocab()
is deprecated in favour ofisVocab32()
asVocab()
is deprecated in favour ofasVocab32()
makeVocab()
is deprecated in favour ofmakeVocab32()
Vocab
yarp::os::createVocab()
is deprecated in favour ofyarp::os::createVocab32()
yarp::os::Vocab::encode()
is deprecated in favour ofyarp::os::Vocab32::encode()
yarp::os::Vocab::decode()
is deprecated in favour ofyarp::os::Vocab32::decode()
WireReader
getIsVocab()
is deprecated in favour ofgetIsVocab32()
readVocab()
is now deprecated in favour ofreadVocab32()
WireWriter
writeVocab()
is now deprecated in favour ofwriteVocab32()
sig
IntrinsicParams
YARP_PLUM_BOB
is deprecated in favour ofYARP_PLUMB_BOB
.dev
yarp/dev/FrameGrabberControl2.h
header file was properly marked asdeprecated (it should have been deprecated in YARP 3.0)
yarp/dev/FrameGrabberInterfaces.h
header file was deprecated.All interfaces were moved in the corresponding header.
framegrabber_protocol
library were removed.This is an API break, but nobody should be using these outside of YARP.
VOCAB_NAV_CLEAR_X
, defined in fileILocalization2D.h
has beenrenamed to
VOCAB_NAV_CLEARALL_X
to avoid confusion with flagVOCAB_NAV_DELETE_X
.VOCAB_NAV_CLEARALL_X
clears all data belonging to the same category (allmaps, all locations, all areas, etc), while
VOCAB_NAV_DELETE_X
, deletes asingle entity (a map with name x, a location with name x etc).
IVisualParams.h
file was deprecated in favour ofIRgbVisualParams.h
and
IDepthVisualParams
.IFrameGrabber
andIFrameGrabberRgb
are now deprecated.IDepthVisualParams
retificationMatrix
parameter was renamedrectificationMatrix
IRgbVisualParams
retificationMatrix
parameter was renamedrectificationMatrix
robotinterface
robotinterface
library is no longer considered experimental, allfiles in the
experimental
folder and classes in theexperimental
namespaceare now deprecated and will be removed in the next release.
Port Monitors
compatibility with the old name.
The new names are:
depthimage_compression_zfp
(zfp
)depthimage_to_mono
(depthimage
)depthimage_to_rgb
(depthimage2
)segmentationimage_to_rgb
(segmentationimage
)Devices
The following devices are now deprecated:
test_grabber
in favour offakeFrameGrabber
fakeMotor
in favour offakeMotionControl
test_motor
in favour offakeMotionControl
fakebot
The following devices will be replaced by NWS/NWC in the next release, and
print a warning when opened:
controlboardwrapper2
(replaced bycontrolboardremapper
+controlBoard_nws_yarp
)RGBDSensorWrapper
(replaced byrgbdSensor_nws_yarp
)Rangefinder2DWrapper
(replaced byrangefinder2D_nws_yarp
)grabberDual
(replaced byframeGrabber_nws_yarp
, and eventuallyframeGrabberCropper
)inertial
(replaced bymultipleanalogsensorsremapper
+multipleanalogsensorsserver
+IMURosPublisher
)localization2DServer
(replaced bylocalization2D_nws_yarp
)map2DServer
(replaced bymap2D_nws_yarp
)transformClient
(replaced byframeTransformClient
)transformServer
(replaced byframeTransformServer
)New Features
Libraries
conf
<yarp/conf/numeric.h>
:yarp::conf::numeric::from_string
yarp::conf::numeric::to_string
yarp::conf::numeric::to_hex_string
<yarp/conf/string.h>
containing the following functions:yarp::conf::string::split
yarp::conf::string::join
environment::path_separator
<yarp/conf/environment.h>
:yarp::conf::environment::get_string
yarp::conf::environment::set_string
yarp::conf::environment::get_bool
yarp::conf::environment::set_bool
yarp::conf::environment::get_numeric
yarp::conf::environment::set_numeric
yarp::conf::environment::split_path
yarp::conf::environment::join_path
yarp::conf::environment::get_path
yarp::conf::environment::set_path
yarp::conf::environment::unset
yarp::conf::environment::is_set
dirs.h
file with methods to retrieve the important foldersstd::string yarp::conf::dirs::home()
std::string yarp::conf::dirs::tempdir()
std::string yarp::conf::dirs::datahome()
std::vector<std::string> yarp::conf::dirs::datadirs()
std::string yarp::conf::dirs::confighome()
std::vector<std::string> yarp::conf::dirs::configdirs()
std::string yarp::conf::dirs::cachehome()
std::string yarp::conf::dirs::runtimedir()
std::string yarp::conf::dirs::yarpdatahome()
std::vector<std::string> yarp::conf::dirs::yarpdatadirs()
std::string yarp::conf::dirs::yarpconfighome()
std::vector<std::string> yarp::conf::dirs::yarpconfigdirs()
std::string yarp::conf::dirs::yarpcachehome()
std::string yarp::conf::dirs::yarpruntimedir()
os
yarp::os::Header
class, intended to gradually replace theyarp::os::Stamp
class to handle envelopes, maintaining backwardscompatibility.
The differences with the
Stamp
class:Header
has an extra field to handle the frame id, making it comparablewith ROS
std_msgs/Header
message.
Stamp::getMaxCount()
is replaced withHeader::npos
Stamp::getCount()
is replaced withHeader::count()
Stamp::getTime()
is replaced withHeader::timeStamp()
Bottle
BOTTLE_TAG_VOCAB32
tag. This is the same asBOTTLE_TAG_VOCAB
.BOTTLE_TAG_VOCAB
is not recommended in new code, useBOTTLE_TAG_VOCAB32
instead.addVocab32()
overloads accepting 4 chars and string.DummyConnector
getReader
methods now accepts aConnectionWriter
as optionalparameter. This writer is returned by
getWriter
is called on theConnectionReader
returned by the writer, and it is therefore used for thereplies in
Portable
s and in a few other cases.Log
YARP_FORWARD_CODEINFO_ENABLE
,YARP_FORWARD_HOSTNAME_ENABLE
,YARP_FORWARD_PROCESSINFO_ENABLE
, andYARP_FORWARD_BACKTRACE_ENABLE
are nolonger considered experimental.
PeriodicThread
clockAccuracy
,which enables drift compensation using an absolute time reference to ensure
all steps trigger at precise intervals, thus avoiding error accumulation over
time. Set it to
PeriodicThreadClock::Absolute
to enable the new behavior,default is
PeriodicThreadClock::Relative
(old behavior). Beware that, inabsolute mode, starvation may occur if two busy threads share a common
resource (#2488).
PeriodicThread(double period, PeriodicThreadClock clockAccuracy)
.Property
.ini
configuration files can now contain the command[import <contextname> <filename>]
which includes a.ini
file from adifferent context.
Value
makeVocab32()
overload accepting 4 charsWire
yarp()
const overloadWireLink
WireReader
readVocab32
readUI8
readUI16
readUI32
readUI64
readSizeT
WireWriter
writeVocab32
writeUI8
writeUI16
writeUI32
writeUI64
writeSizeT
addVocab32()
overloads accepting 4 chars and stringsig
file
yarp::sig::file::read_bytestream(Sound& data, const char* bytestream, size_t streamsize, std::string format)
utils
depthRgbToPC
to make the pointcloudunorganized and remove zero points.
Image
move()
andswap()
methods.Sound
void amplifyChannel(size_t channel, double gain)
void amplify(double gain)
void findPeakInChannel(size_t channelId, size_t& sampleId, audio_sample& sampleValue) const
void findPeak(size_t& channelId, size_t& sampleId, audio_sample& sampleValue) const
void normalizeChannel(size_t channel)
void normalize()
utils
cropRect()
helper function for cropping a rectangle area out of animage given two opposite vertices.
dev
WrapperSingle
andWrapperMultiple
helper classes, thatinherit from both
IWrapper
andIMultipleWrapper
but require to implementonly one of these interfaces.
IFrameGrabberOf<typename ImageType>
.It is now possible to implement the same interface as for
IFrameGrabberImage
and
IFrameGrabberImageRaw
, but for different pixel types or forFlexImage
.yarp::dev::AudioRecorderStatus
yarp::dev::AudioPlayerStatus
AudioPlayerDeviceBase
, all playback device drivers nowinherit from this class.
AudioRecorerDeviceBase
, all recording device drivers nowinherit from this class.
IFrameGrabberImage
getImageCrop
method has now a working default implementation.IFrameGrabberImage
interface is now an alias forIFrameGrabberOf<yarp::sig::ImageOf<yarp::sig::PixelRgb>>
.IFrameGrabberImageRaw
getImageCrop
method has now a working default implementation.IFrameGrabberImageRaw
interface is now an alias forIFrameGrabberOf<yarp::sig::ImageOf<yarp::sig::PixelMono>>
.IAudioRender
bool setHWGain(double gain)
bool setSWGain(double gain)
IAudioGrabberSound
bool setHWGain(double gain)
bool setSWGain(double gain)
Lidar2DDeviceBase
Lidar2DDeviceBase
class, now implementsyarp::dev::IPreciselyTimed
.acquireDataFromHW()
which ispure virtual in
Lidar2DDeviceBase
Lidar2DDeviceBase::updateLidarData
, which callsacquireDataFromHW()
and afew other utility functions (e.g. updateTimestamp(), etc.)
collection, now just calls
updateLidarData()
.Nav2D::IMap2D
bool clearAllMapsTemporaryFlags()
bool clearMapTemporaryFlags(std::string map_name)
bool saveLocationsAndExtras(std::string locations_collection_file)
bool loadLocationsAndExtras(std::string locations_collection_file)
Nav2D::MapGrid2D
void clearMapTemporaryFlags()
The
write()
andread()
methods handle the compression before sending datato the network.
enable_map_compression_over_network()
to enables/disables datacompression over the network (default true). Compression is always disabled if
Zlib library is not available.
Nav2D::Map2DLocation
bool is_near_to(const Map2DLocation& other_loc, double linear_tolerance, double angular_tolerance) const
robotinterface
The robotinterface library is no longer considered experimental, files and
classes have been moved accordingly.
robotinterface DTD version is now 3.1.
It is now possible to pass the
device
parameter to theattach
action,without defining
network
ornetworks
. For example:XMLReader
getRobotFromFile
andgetRobotFromString
now accept aSearchable
thatis used to replace params with the attribute
extern-name
.The signatures are now:
Carriers
unix_stream
carrier is no longer considered experimental.Port Monitors
yarppm
library (similar toyarpcar
andyarpmod
) thatlinks all the portmonitors in static builds.
image_compression_ffmpeg
port monitor to compress a video stream usingthe H264, H265, or MPEG2VIDEO codec.
sound_compression_mp3
port monitor to decompress a mp3 bytestream toyarp::sig::Sound
. Encoding not supported yet.depthimage_compression_zlib
port monitor which uses the Zlib libraryto compress/decompress (lossless) depth images through the network.
Devices
AudioPlayerWrapper
setHWGain()
andsetSWGain()
.xxx/status:o
portAudioRecorderWrapper
setHWGain()
andsetSWGain()
.xxx/status:o
portfakeFrameGrabber
new background image at runtime.
Rpc command 'help' will display available commands.
--timestamp
option to write the timestamp in the first bytes of theimage. This was previously automatically enabled in
line
mode, but it cannow be used in all modes.
should improve performances when generating large images.
getImage()
method no longer blocks the caller.The
--syncro
option was added to restore the old behavior.topIsLow
option and theset_topIsLow
rpc command were added to produceimages with bottom to top scanlines.
--noise
options andset_noise
RPC commands to add a a white noise tothe generated image.
--snr
option andset_snr
RPC commands. to specify the signal noiseratio if
noise
is enabled.fakeLaser
'help' to get additional information.
map_context
parameter to load a test map from a specific context.fakeMicrophone
fakeNavigation
frameTransformServer
generate_view
which generates viadot (graphviz)
a pdf file, containing a diagram of the transforms tree.
map2DServer
enable_maps_compression <0/1>
RPC command.navigation2DClient
getNameOfCurrentTarget()
logic moved fromNavigation2DClient
tonavigation2DServer
.Tools
yarpdataplayer-console
tool that works without without a graphicserver.
yarp
read
subcommand now accepts thetrim
argument to reduce the number ofcharacters printed for each message received.
yarp latency-test
: performs a latency test exchanging data between aserver and a client node.
yarp repeat
: repeats in an output port all data received in an input port.The command is useful to control stream flows on a wifi/mobile connection.
yarp stats
: opens a temporary port to receive data from a remote port (atmaximum speed). It also prints basic statistics about data trasferred on the
instantiated connection.
yarp trafficgen
: sends generated data over a yarp port. The tool allows totest the communication and the available bandwidth over the network.
yarpdatadumper
--type
parameter are now supported:bottle
(default)image
image_jpg
image_png
video
depth
depth_compressed
yarprobotinterface
parameters marked with the attribute
extern-name
.yarpidl_thrift
uint8_t
,uint16_t
,uint32_t
,uint64_t
,size_t
,float32_t
andfloat64_t
using annotated types.It is now possible to use these types in thrift by defining them using a
typedef
, for example:This improves the compatibility with existing services returning Bottle
or other YARP types, and makes it possible to write a thrift file for
existing protocols.
On the other hand, this breaks compatibility with thrift services
returning Bottles or other annotated types, generated before this
commit. This is a breaking change, but should impact only a very
limited number of cases, and it can be easily fixed by regenerating the
files.
Vocabs can be defined in this way:
When defined = "true", this serialize a struct as a bottle instead of as a
flat structure.
For example, given these 2 structs:
Bar
struct will be serialized asbar1 (foo1 foo2)
, instead of as aflat struct
bar1 foo1 foo2
.yarp.qualifier
annotation. For example, this code:Foo
with this method:GUIs
yarpview
--rightout <portname>
option that enables intercepting the mouseright button click events:
port)
press
point and ofthe
release
one to the specified output port)Image/Intercept right click
checkable menu item to enable/disablethe right click interception (not available in
minimal
orcompact
mode orif the
--rightout
option was not enabled).yarpdataplayer
depth
anddepth_compressed
data types.yarpdataplayer
tool was refactored, several bugs fixed, and new featuresadded (#1144, #2140, #2151, #2400, #2401, #2442).
Bindings
std::vector<short int>
.yarp::sig::VectorOf<int>
.yarp::sig::Sound
sound2VecNonInterleaved()
vecNonInterleaved2Sound()
sound2VecInterleaved()
vecInterleaved2Sound()
New Experimental Features
EXPERIMENTAL means that the software is under development, provided with
incomplete documentation and it may be modified/renamed/removed without any
notice.
Carriers
websocket
carrier.It works only on the receiving side, and it works on an http request
that starts with
"GET /?ws"
(for example 'http://127.0.0.1:10002/?ws'or 'ws://127.0.0.1:10002/?ws' if a read port is opened by yarp).
The websocket, on the browser side, needs to communicate using the YARP
protocol.
Devices
RGBDFromRosTopic
: it can be wrapped byRGBDSSensorWrapper
to make RGBDdata, collected by a ROS device, available on YARP via
RGBDSensorClient
.map2DStorage
: store navigation data, e.gMapGrid2D
,Map2DLocation
etc.It implements all the logic previously located inside device 'Map2DServer'.
audioFromFileDevice
: wrapped byaudioRecorderWrapper
.audioToFileDevice
: wrapped byaudioPlayerWrapper
.frameGrabberCropper
: attaches to a frameGrabber and published part of theimage
frameTransformStorage
frameTransformSetMultiplexer
frameTransformGetMultiplexer
Network Wrapper Server/Client Architecture described in #2441.
These devices do not implement internal logic, therefore they might need to be
used together with a different device.
This architecture and all these devices are to be considered experimental,
and may be modified/renamed/removed at any time without any notice.
controlBoard_nws_ros
: ROS NWS that can be used to replacecontrolboardwrapper2
(does not handle networks, usecontrolboardremapper
for that). It requires that the
yarp::dev::IAxisInfo
is implemented in thedevice.
controlBoard_nws_yarp
: YARP NWS that can be used to replacecontrolboardwrapper2
(does not handle networks, usecontrolboardremapper
for that).
frameGrabber_nws_ros
: ROS NWS that can be used to replacegrabberDual
(does not handle image split, useframeGrabberCropper
forthat)
frameGrabber_nws_yarp
: YARP NWS that can be used to replacegrabberDual
(does not handle image split, useframeGrabberCropper
forthat)
frameGrabber_nwc_yarp
: YARP NWC that can be used to replaceremote_grabber
localization2D_nws_ros
: ROS NWS for devices which implement theILocalization2D
interface, that can be used to replacelocalization2DServer
.localization2D_nws_yarp
: YARP NWS for devices which implement theILocalization2D
interface, that can be used to replacelocalization2DServer
.map2D_nws_ros
: ROS NWS for amap2DStorage
device.map2D_nws_yarp
: YARP NWS for amap2DStorage
device.rangefinder2D_nws_ros
: ROS NWS for devices exposingIRangefinder2D
interface.rangefinder2D_nws_yarp
: YARP NWS for devices exposingIRangefinder2D
interface.rgbdSensor_nws_ros
: ROS NWS to replaceRGBDSensorWrapper
.rgbdSensor_nws_yarp
: YARP NWS to replaceRGBDSensorWrapper
.rgbdToPointCloudSensor_nws_ros
: enables point cloud publication from yarpto ros. It converts RGBD data to point cloud and publishes it on a ros
topic.
frameTransformGet_nws_ros
frameTransformGet_nws_yarp
frameTransformSet_nws_ros
frameTransformSet_nws_yarp
All these interfaces have the following differences with their original
wrappers:
nws_ros
devices no longer have the "ROS_" prefix".frameTransformClient
andframeTransformServer
.These devices are mostly empty containers for multiple plugins that can be
combined together through a
yarprobotinterface
xml file.Different configuration files can be used for different purposes, such as
publishing/subscribing transforms on YARP, ROS, ROS2 etc. Please refer to the
documentation for additional details.
Old devices with frame transform management functionality are called
transformServer
andtransformClient
. These devices should be nowconsidered deprecated and they must be not confused with the new devices
included in this PR. A yarp page documentation has been added to show the
different possible configurations.
laserFromRosTopic
is still considered EXPERIMENTAL, since it willbe replaced by an appropriate NWC
Bindings
Python
pip
.A new
yarp-middleware
package is now distributed in PyPI.Bug Fixes
Libraries
sig
Image
topIsLow
flag is now properly handled, kept in sync with the internalIplImage
, and forwarded through the network.ImageFile
SavePNG()
producing corrupted output files.Carriers
portmonitor
monitor RPC connections.
Devices
grabberDual
topIsLow
flag is no longer changed.Devices
RGBDSensorClient
map2DServer
GUIs
yarpdataplayer
Contributors
This is a list of people that contributed to this release (generated from the
git history using
git shortlog -ens --no-merges v3.4.0..v3.5.0
):Beta Was this translation helpful? Give feedback.
All reactions