[Documentation] [TitleIndex] [WordIndex

API review

Proposer: Melonee Wise

Present at review:


The joy/Joy msg is currently in the joy package requiring all packages to depend on the joy package. This migration would eliminate the package dependency on joy and follow the ROS guidelines for separating out general purpose msgs in to msg packages. Additionally the joy/Joy msg lacks a header which is important for synchronization and several users have requested a header be added to the joy/Joy msg.

Proposed Messages

Migration Rules

class update_joy_Joy_e3ef016fcdf22397038b36036c66f7c8(MessageUpdateRule):
        old_type = "joy/Joy"
        old_full_text = """
float32[] axes
int32[] buttons

        new_type = "sensor_msgs/Joy"
        new_full_text = """
Header header
float32[] axes
int32[] buttons

MSG: std_msgs/Header
# Standard metadata for higher-level stamped data types.
# This is generally used to communicate timestamped data
# in a particular coordinate frame.
# sequence ID: consecutively increasing ID
uint32 seq
#Two-integer timestamp that is expressed as:
# * stamp.secs: seconds (stamp_secs) since epoch
# * stamp.nsecs: nanoseconds since stamp_secs
# time-handling sugar is provided by the client library
time stamp
#Frame this data is associated with
# 0: no frame
# 1: global frame
string frame_id

        order = 0
        migrated_types = []

        valid = False

        def update(self, old_msg, new_msg):
                #No matching field name in old message
                new_msg.header = self.get_new_class('Header')()
                new_msg.axes = old_msg.axes
                new_msg.buttons = old_msg.buttons

Question / concerns / comments

Enter your thoughts on the API and any questions / concerns you have here. Please sign your name. Anything you want to address in the API review should be marked down here before the start of the meeting.

Meeting agenda

To be filled out by proposer based on comments gathered during API review period


Based on the above feedback I will move the joy msg to sensor_msgs and add the header.

2019-10-19 13:12