Topics

The following topics are expected to be common to many devices. Note that some of these topics are published by support libraries.

Parameters

Devices should access as many of these parameters as are relevant. For example, older devices connect via serial while newer often connect over ethernet. In this case, newer devices would use ip_address/ip_port, while older devices would use serial_port/serial_baud. If a parameter is not supported by hardware, it is not necessary to read/write to that parameter.

• ~ip_address (string)
  • Location of the device on the network (only valid for ethernet devices).
• ~ip_port (int)
  • IP port number. (1 to 65535)
• ~serial_port (string)
  • This represents the serial port device (COM4, /dev/tty/USB0).
• ~serial_baud (int)
  • Data transfer rate for a serial device (9600, 115200, and so on)
• ~frame_id (string)
  • The frame in which laser scans will be returned. This frame should be at the optical center of the laser, with the x-axis along the zero degree ray, and the y-axis along the 90 degree ray.
• ~calibrate_time (boolean)
  • Whether the node should calibrate the device's time offset on startup. If true, the node will exchange of series of messages with the device in order to determine the time delay in the connection. This calibration step is necessary to produce accurate timestamps on scans.
• ~time_offset (double)
  • A manually calibrated offset (in seconds) to add to the timestamp before publication of a message.
• ~publish_intensity (boolean)
  • If true, the laser will publish intensity. If false, the laser will not publish intensity to save bandwidth. Should be implemented in hardware if possible, but otherwise may be implemented in software.
• ~publish_multiecho (boolean)
  • If true, a multiecho laserscanner will publish sensor_msgs/MultiEchoLaserScan. If false, the laser will publish sensor_msgs/LaserScan. (If supported by the hardware; otherwise, please use a support library to convert MultiEchoLaserScans to LaserScans.) This parameter is only valid for multiecho laserscanners.
• ~angle_min (double)
  • Controls the angle of the first range measurement in radians. (If supported by the hardware; it is not recommended to implement this feature in software.)
• ~angle_max (double)
  • Controls the angle of the last range measurement in radians. (If supported by the hardware; it is not recommended to implement this feature in software.)
• ~cluster (int)
  • The number of adjacent range measurements to cluster into a single reading; the shortest reading from the cluster is reported. (If supported by the hardware; it is not recommended to implement this feature in software.)
• ~skip (int)
  • The number of input messages to skip between each output message. The device will publish 1 message for every N skipped messages. Example: if skip is set to '2', the device will publish 1 message and then 'drop' the following 2 message - a 66.7% reduction in output rate. (If supported by the hardware; it is not recommended to implement this feature in software.)

Diagnostic Keys

Devices should publish as many of the following keys that are easy to assume or read from hardware. These key/value pairs are common among devices of this type. This list is not considered to be exhaustive and drivers are encouraged to add key/value pairs specific to the hardware.

• "IP Address"
  • Location of the device on the network ex (192.168.1.10) (only valid for ethernet devices).
• "IP Port"
  • IP port number. ex (1 to 65535) (only valid for ethernet devices)
• "Serial Port"
  • This represents the serial port device ex (COM4, /dev/tty/USB0).
• "Serial Baud"
  • Data transfer rate for a serial device ex (9600, 115200)
• "Vendor Name"
  • Name of the device vendor. ex (Hokuyo Automatic Co, Ltd)
• "Product Name"
  • Name of the product or model. ex (UTM-30LX-EW)
• "Firmware Version"
  • Description of the current Firmware version if the hardware has programmable features. ex (3.3.01)
• "Firmware Date"
  • Date that the last Firmware version was compiled. ex (23 June 2008)
• "Protocol Version"
  • Description of the communication protocol used. ex (SCIP 2.0), (LMS COLA-B UDP)
• "Device ID"
  • Serial number or other unique identifier ex (H0906091).'
• "Computed Latency"
  • Offset added to header timestamp to reflect latency in data stream. ex (-0.013 s)
• "User Time Offset"
  • Offset added to the header timestamp from the parameter '~time_offset'. ex (-0.551 s)