34 CHokuyoURG::CHokuyoURG()
38 m_sensorPose(0, 0, 0),
40 m_highSensMode(false),
45 m_I_am_owner_serial_port(false),
47 m_timeStartSynchDelay(0),
48 m_disable_firmware_timestamp(false),
75 bool& outThereIsObservation,
78 outThereIsObservation =
false;
79 hardwareError =
false;
91 char rcv_status0, rcv_status1;
95 int expectedSize = nRanges * 3 + 4;
99 expectedSize += nRanges * 3;
105 (
char*)&rcv_data[0], rcv_dataLength))
112 if (rcv_status0 !=
'0' && rcv_status0 !=
'9')
114 hardwareError =
true;
123 if (expectedSize != rcv_dataLength)
126 "[CHokuyoURG::doProcess] ERROR: Expecting %u data bytes, received " 128 expectedSize, rcv_dataLength);
129 hardwareError =
true;
135 if (do_timestamp_sync &&
138 do_timestamp_sync =
false;
142 if (do_timestamp_sync)
145 uint32_t nowUI = ((rcv_data[0] - 0x30) << 18) +
146 ((rcv_data[1] - 0x30) << 12) +
147 ((rcv_data[2] - 0x30) << 6) + (rcv_data[3] - 0x30);
175 char* ptr = (
char*)&rcv_data[4];
179 for (
int i = 0; i < nRanges; i++)
181 int b1 = (*ptr++) - 0x30;
182 int b2 = (*ptr++) - 0x30;
183 int b3 = (*ptr++) - 0x30;
185 int range_mm = ((
b1 << 12) | (
b2 << 6) |
b3);
194 int b4 = (*ptr++) - 0x30;
195 int b5 = (*ptr++) - 0x30;
196 int b6 = (*ptr++) - 0x30;
207 outThereIsObservation =
true;
221 configSource.
read_int(iniSection,
"HOKUYO_motorSpeed_rpm", 0);
223 configSource.
read_float(iniSection,
"pose_x", 0),
224 configSource.
read_float(iniSection,
"pose_y", 0),
225 configSource.
read_float(iniSection,
"pose_z", 0),
233 #ifdef MRPT_OS_WINDOWS 246 "Either COM_port or IP_DIR must be defined in the configuration file!");
249 "Both COM_port and IP_DIR set! Please, define only one of them.");
254 "A TCP/IP port number `PORT_DIR` must be specified for Ethernet " 289 std::this_thread::sleep_for(10ms);
292 std::this_thread::sleep_for(10ms);
296 std::this_thread::sleep_for(10ms);
298 std::this_thread::sleep_for(10ms);
318 std::this_thread::sleep_for(10ms);
321 std::this_thread::sleep_for(10ms);
324 std::this_thread::sleep_for(10ms);
352 const int half_range =
static_cast<int>(
358 cout <<
"[HOKUYO::turnOn] Using reduced FOV: ranges [" <<
m_firstRange 360 <<
" deg. FOV" << endl;
393 char rcv_status0, rcv_status1;
401 "[CHokuyoURG::setHighBaudrate] Changing baudrate to 115200...");
411 cmd, rcv_status0, rcv_status1, rcv_data, rcv_dataLength))
413 std::cerr <<
"Error waiting for response\n";
418 if (rcv_status0 !=
'0')
420 std::cerr <<
"Error in LIDAR status: " << (int)rcv_status0 <<
"\n";
453 nRead = client->
readAsync(buf, to_read, 100, 10);
462 catch (std::exception&)
475 const char* sentCmd_forEchoVerification,
char& rcv_status0,
476 char& rcv_status1,
char* rcv_data,
int& rcv_dataLength)
480 ASSERT_(sentCmd_forEchoVerification !=
nullptr);
489 const int verifLen = strlen(sentCmd_forEchoVerification);
502 }
while (i < verifLen);
515 if (rcv_status1 != 0x0A)
533 if (nextChar != 0x0A)
return false;
543 bool lastWasLF =
false;
558 if (i == 1 && rcv_data[0] == 0x0A)
565 if (rcv_data[i - 1] == 0x0A)
591 catch (std::exception&)
608 char rcv_status0, rcv_status1;
616 "[CHokuyoURG::enableSCIP20] Changing protocol to SCIP2.0...");
626 cmd, rcv_status0, rcv_status1, rcv_data, rcv_dataLength))
628 std::cerr <<
"Error waiting for response\n";
633 if (rcv_status0 !=
'0')
635 std::cerr <<
"Error in LIDAR status: " << (int)rcv_status0 <<
"\n";
649 char rcv_status0, rcv_status1;
656 MRPT_LOG_DEBUG(
"[CHokuyoURG::switchLaserOn] Switching laser ON...");
666 cmd, rcv_status0, rcv_status1, rcv_data, rcv_dataLength))
668 std::cerr <<
"Error waiting for response\n";
673 if (rcv_status0 !=
'0')
675 std::cerr <<
"Error in LIDAR status: " << (int)rcv_status0 <<
"\n";
690 char rcv_status0, rcv_status1;
697 MRPT_LOG_DEBUG(
"[CHokuyoURG::switchLaserOff] Switching laser OFF...");
707 cmd, rcv_status0, rcv_status1, rcv_data, rcv_dataLength))
709 std::cerr <<
"Error waiting for response\n";
714 if (rcv_status0 !=
'0')
716 std::cerr <<
"Error in LIDAR status: " << (int)rcv_status0 <<
"\n";
730 char rcv_status0, rcv_status1;
738 "[CHokuyoURG::setMotorSpeed] Setting to %i rpm...", motoSpeed_rpm);
741 int motorSpeedCode = (600 - motoSpeed_rpm) / 6;
742 if (motorSpeedCode < 0 || motorSpeedCode > 10)
744 printf(
"ERROR! Motorspeed must be in the range 540-600 rpm\n");
748 os::sprintf(cmd, 20,
"CR%02i\x0A", motorSpeedCode);
755 cmd, rcv_status0, rcv_status1, rcv_data, rcv_dataLength))
757 std::cerr <<
"Error waiting for response\n";
762 if (rcv_status0 !=
'0')
764 std::cerr <<
"Error in LIDAR status: " << (int)rcv_status0 <<
"\n";
778 char rcv_status0, rcv_status1;
786 "[CHokuyoURG::setHighSensitivityMode] Setting HS mode to: %s...",
787 enabled ?
"true" :
"false");
797 cmd, rcv_status0, rcv_status1, rcv_data, rcv_dataLength))
799 std::cerr <<
"Error waiting for response\n";
804 if (rcv_status0 !=
'0')
806 std::cerr <<
"Error in LIDAR status: " << (int)rcv_status0 <<
"\n";
829 char rcv_status0, rcv_status1;
836 MRPT_LOG_DEBUG(
"[CHokuyoURG::displayVersionInfo] Asking info...");
846 cmd, rcv_status0, rcv_status1, rcv_data, rcv_dataLength))
848 std::cerr <<
"Error waiting for response\n";
853 if (rcv_status0 !=
'0')
855 std::cerr <<
"Error in LIDAR status: " << (int)rcv_status0 <<
"\n";
862 for (
int i = 0; i < rcv_dataLength; i++)
864 if (rcv_data[i] ==
';') rcv_data[i] =
'\n';
866 rcv_data[rcv_dataLength] = 0;
869 "\n------------- HOKUYO Scanner: Version Information ------\n" 871 "-------------------------------------------------------\n\n",
882 char rcv_status0, rcv_status1;
889 MRPT_LOG_DEBUG(
"[CHokuyoURG::displaySensorInfo] Asking for info...");
899 cmd, rcv_status0, rcv_status1, rcv_data, rcv_dataLength))
901 std::cerr <<
"Error waiting for response\n";
906 if (rcv_status0 !=
'0')
908 std::cerr <<
"Error in LIDAR status: " << (int)rcv_status0 <<
"\n";
915 for (
int i = 0; i < rcv_dataLength; i++)
917 if (rcv_data[i] ==
';') rcv_data[i] =
'\n';
919 rcv_data[rcv_dataLength] = 0;
922 "\n------------- HOKUYO Scanner: Product Information ------\n" 924 "-------------------------------------------------------\n\n",
932 if (
nullptr != (ptr = strstr(rcv_data,
"DMAX:")))
933 out_data->
d_max = 0.001 * atoi(ptr + 5);
935 cerr <<
"[CHokuyoURG::displayVersionInfo] Parse error: didn't find " 939 if (
nullptr != (ptr = strstr(rcv_data,
"DMIN:")))
940 out_data->
d_min = 0.001 * atoi(ptr + 5);
942 cerr <<
"[CHokuyoURG::displayVersionInfo] Parse error: didn't find " 946 if (
nullptr != (ptr = strstr(rcv_data,
"ARES:")))
949 cerr <<
"[CHokuyoURG::displayVersionInfo] Parse error: didn't find " 953 if (
nullptr != (ptr = strstr(rcv_data,
"SCAN:")))
956 cerr <<
"[CHokuyoURG::displayVersionInfo] Parse error: didn't find " 960 if (
nullptr != (ptr = strstr(rcv_data,
"AMIN:")))
963 cerr <<
"[CHokuyoURG::displayVersionInfo] Parse error: didn't find " 966 if (
nullptr != (ptr = strstr(rcv_data,
"AMAX:")))
969 cerr <<
"[CHokuyoURG::displayVersionInfo] Parse error: didn't find " 972 if (
nullptr != (ptr = strstr(rcv_data,
"AFRT:")))
975 cerr <<
"[CHokuyoURG::displayVersionInfo] Parse error: didn't find " 979 if (
nullptr != (ptr = strstr(rcv_data,
"MODL:")))
984 out_data->
model = aux;
987 cerr <<
"[CHokuyoURG::displayVersionInfo] Parse error: didn't find " 1001 char rcv_status0, rcv_status1;
1002 char rcv_data[6000];
1008 MRPT_LOG_DEBUG(
"[CHokuyoURG::startScanningMode] Starting scanning mode...");
1023 cmd, rcv_status0, rcv_status1, rcv_data, rcv_dataLength))
1025 std::cerr <<
"Error waiting for response\n";
1030 if (rcv_status0 !=
'0')
1032 std::cerr <<
"Error in LIDAR status: " << (int)rcv_status0 <<
"\n";
1060 cerr <<
"[CHokuyoURG] Socket connection lost! trying to " 1088 if (COM->
isOpen())
return true;
1091 cerr <<
"[CHokuyoURG] Serial port connection lost! Trying to " 1119 "No stream bound to the laser nor COM serial port or ip and " 1120 "port provided in 'm_com_port','m_ip_dir' and 'm_port_dir'");
1129 "[CHokuyoURG] Connecting to %s:%u...\n",
m_ip_dir.c_str(),
1135 cerr <<
"[CHokuyoURG] Cannot connect with the server '" 1154 cerr <<
"[CHokuyoURG] Cannot open serial port '" <<
m_com_port 1180 cerr <<
"[CHokuyoURG::initialize] Error initializing HOKUYO scanner" 1209 void* buf = malloc(
sizeof(
uint8_t) * to_read);
1213 if (nRead != to_read)
1215 "Error in purge buffers: read and expected number of bytes " uint64_t TTimeStamp
A system independent time type, it holds the the number of 100-nanosecond intervals since January 1...
size_t ReadBuffer(void *Buffer, size_t Count)
Reads a block of bytes from the stream into Buffer.
std::string m_com_port
If set to non-empty, the serial port will be attempted to be opened automatically when this class is ...
uint32_t m_timeStartUI
Time of the first data packet, for synchronization purposes.
virtual ~CHokuyoURG()
Destructor: turns the laser off.
bool read_bool(const std::string §ion, const std::string &name, bool defaultValue, bool failIfNotFound=false) const
Classes for serialization, sockets, ini-file manipulation, streams, list of properties-values, timewatch, extensions to STL.
int m_firstRange
The first and last ranges to consider from the scan.
std::vector< uint8_t > vector_byte
A communications serial port built as an implementation of a utils::CStream.
void connect(const std::string &remotePartAddress, unsigned short remotePartTCPPort, unsigned int timeout_ms=0)
Establishes a connection with a remote part.
utils::CStream * m_stream
The I/O channel (will be nullptr if not bound).
This namespace provides a OS-independent interface to many useful functions: filenames manipulation...
float read_float(const std::string §ion, const std::string &name, float defaultValue, bool failIfNotFound=false) const
bool m_intensity
Get intensity from lidar scan (default: false)
bool isConnected()
Returns true if this objects represents a successfully connected socket.
void setScanRange(const size_t i, const float val)
void loadConfig_sensorSpecific(const mrpt::utils::CConfigFileBase &configSource, const std::string &iniSection)
See the class documentation at the top for expected parameters.
std::string m_sensorLabel
See CGenericSensor.
size_t available() const
The maximum number of elements that can be written ("push") without rising an overflow error...
#define THROW_EXCEPTION(msg)
#define MRPT_LOG_DEBUG_FMT(_FMT_STRING,...)
size_t size() const
Return the number of elements available for read ("pop") in the buffer (this is NOT the maximum size ...
void WriteBuffer(const void *Buffer, size_t Count)
Writes a block of bytes to the stream from Buffer.
bool m_I_am_owner_serial_port
bool assureBufferHasBytes(const size_t nDesiredBytes)
Assures a minimum number of bytes in the input buffer, reading from the serial port only if required...
void open()
Open the port.
mrpt::system::TTimeStamp now()
A shortcut for system::getCurrentTime.
Contains classes for various device interfaces.
void setScanHasIntensity(bool setHasIntensityFlag)
Marks this scan as having or not intensity data.
std::string read_string(const std::string §ion, const std::string &name, const std::string &defaultValue, bool failIfNotFound=false) const
void filterByExclusionAreas(mrpt::obs::CObservation2DRangeScan &obs) const
Mark as invalid those points which (x,y) coordinates fall within the exclusion polygons.
float stdError
The "sigma" error of the device in meters, used while inserting the scan in an occupancy grid...
void setConfig(int baudRate, int parity=0, int bits=8, int nStopBits=1, bool enableFlowControl=false)
Changes the configuration of the port.
void filterByExclusionAngles(mrpt::obs::CObservation2DRangeScan &obs) const
Mark as invalid those ranges in a set of forbiden angle ranges.
bool switchLaserOn()
Switchs the laser on.
unsigned int m_port_dir
If set to non-empty and m_ip_dir too, the program will try to connect to a Hokuyo using Ethernet comm...
This class allows loading and storing values and vectors of different types from a configuration text...
std::string m_lastSentMeasCmd
The last sent measurement command (MDXXX), including the last 0x0A.
mrpt::gui::CDisplayWindow3D::Ptr m_win
bool m_disable_firmware_timestamp
float maxRange
The maximum range allowed by the device, in meters (e.g.
const int MINIMUM_PACKETS_TO_SET_TIMESTAMP_REFERENCE
int read_int(const std::string §ion, const std::string &name, int defaultValue, bool failIfNotFound=false) const
bool displaySensorInfo(CHokuyoURG::TSensorInfo *out_data=nullptr)
Ask to the device, and print to the debug stream, details about the sensor model. ...
Used in CHokuyoURG::displayVersionInfo.
void setScanIntensity(const size_t i, const int val)
bool setIntensityMode(bool enabled)
If true scans will capture intensity.
bool displayVersionInfo()
Ask to the device, and print to the debug stream, details about the firmware version,serial number,...
bool isOpen() const
Returns if port has been correctly open.
This namespace contains representation of robot actions and observations.
#define MRPT_LOG_DEBUG(_STRING)
int m_timeStartSynchDelay
Counter to discard to first few packets before setting the correspondence between device and computer...
bool enableSCIP20()
Enables the SCIP2.0 protocol (this must be called at the very begining!).
void purgeBuffers()
Purge tx and rx buffers.
void bindIO(mrpt::utils::CStream *streamIO)
Binds the object to a given I/O channel.
mrpt::system::TTimeStamp m_timeStartTT
void loadCommonParams(const mrpt::utils::CConfigFileBase &configSource, const std::string &iniSection)
Should be call by derived classes at "loadConfig" (loads exclusion areas AND exclusion angles)...
GLsizei const GLchar ** string
#define IMPLEMENTS_GENERIC_SENSOR(class_name, NameSpace)
This must be inserted in all CGenericSensor classes implementation files:
void setTimeouts(int ReadIntervalTimeout, int ReadTotalTimeoutMultiplier, int ReadTotalTimeoutConstant, int WriteTotalTimeoutMultiplier, int WriteTotalTimeoutConstant)
Changes the timeouts of the port, in milliseconds.
T pop()
Retrieve an element from the buffer.
bool switchLaserOff()
Switchs the laser off.
int m_motorSpeed_rpm
The motor speed (default=600rpm)
std::string sensorLabel
An arbitrary label that can be used to identify the sensor.
void purgeBuffers()
Empties the RX buffers of the serial port.
mrpt::system::TTimeStamp timestamp
The associated UTC time-stamp.
int scan_first
First, last, and front step of the scanner angular span.
A "CObservation"-derived class that represents a 2D range scan measurement (typically from a laser sc...
bool startScanningMode()
Start the scanning mode, using parameters stored in the object (loaded from the .ini file) After this...
bool checkCOMisOpen()
Returns true if there is a valid stream bound to the laser scanner, otherwise it first try to open th...
void resizeScan(const size_t len)
Resizes all data vectors to allocate a given number of scan rays.
void setFromValues(const double x0, const double y0, const double z0, const double yaw=0, const double pitch=0, const double roll=0)
Set the pose from a 3D position (meters) and yaw/pitch/roll angles (radians) - This method recomputes...
A TCP socket that can be connected to a TCP server, implementing MRPT's CStream interface for passing...
bool turnOn()
Enables the scanning mode (which may depend on the specific laser device); this must be called before...
void processPreview(const mrpt::obs::CObservation2DRangeScan &obs)
Must be called inside the capture method to allow optional GUI preview of scans.
bool setMotorSpeed(int motoSpeed_rpm)
Changes the motor speed in rpm's (default 600rpm)
#define MRPT_LOG_INFO_FMT(_FMT_STRING,...)
double d_min
Min/Max ranges, in meters.
The namespace for 3D scene representation and rendering.
This software driver implements the protocol SCIP-2.0 for interfacing HOKUYO URG/UTM/UXM/UST laser sc...
float aperture
The "aperture" or field-of-view of the range finder, in radians (typically M_PI = 180 degrees)...
size_t capacity() const
Return the maximum capacity of the buffer.
void initialize()
Turns the laser on.
void doProcessSimple(bool &outThereIsObservation, mrpt::obs::CObservation2DRangeScan &outObservation, bool &hardwareError)
Specific laser scanner "software drivers" must process here new data from the I/O stream...
bool setHighBaudrate()
Passes to 115200bps bitrate.
poses::CPose3D m_sensorPose
The sensor 6D pose:
TSensorInfo m_sensor_info
The information gathered when the laser is first open.
mrpt::system::TTimeStamp secondsToTimestamp(const double nSeconds)
Transform a time interval (in seconds) into TTimeStamp (e.g.
bool m_highSensMode
High sensitivity [HS] mode (default: false)
size_t getReadPendingBytes()
Return the number of bytes already in the receive queue (they can be read without waiting) ...
std::string model
The sensor model.
Serial and networking devices and utilities.
mrpt::utils::ContainerReadOnlyProxyAccessor< std::vector< float > > scan
The range values of the scan, in meters.
double m_reduced_fov
Used to reduce artificially the interval of scan ranges.
char * strcpy(char *dest, size_t destSize, const char *source) noexcept
An OS-independent version of strcpy.
mrpt::utils::circular_buffer< uint8_t > m_rx_buffer
Auxiliary buffer for readings.
int motor_speed_rpm
Standard motor speed, rpm.
size_t readAsync(void *Buffer, const size_t Count, const int timeoutStart_ms=-1, const int timeoutBetween_ms=-1)
A method for reading from the socket with an optional timeout.
void push_many(T *array_elements, size_t count)
Insert an array of elements in the buffer.
unsigned __int32 uint32_t
bool turnOff()
Disables the scanning mode (this can be used to turn the device in low energy mode, if available)
#define ASSERTMSG_(f, __ERROR_MSG)
bool setHighSensitivityMode(bool enabled)
Changes the high sensitivity mode (HS) (default: false)
mrpt::poses::CPose3D sensorPose
The 6D pose of the sensor on the robot at the moment of starting the scan.
int sprintf(char *buf, size_t bufSize, const char *format,...) noexcept MRPT_printf_format_check(3
An OS-independent version of sprintf (Notice the bufSize param, which may be ignored in some compiler...
bool receiveResponse(const char *sentCmd_forEchoVerification, char &rcv_status0, char &rcv_status1, char *rcv_data, int &rcv_dataLength)
Waits for a response from the device.
bool rightToLeft
The scanning direction: true=counterclockwise; false=clockwise.
void memcpy(void *dest, size_t destSize, const void *src, size_t copyCount) noexcept
An OS and compiler independent version of "memcpy".
std::string m_ip_dir
If set to non-empty and m_port_dir too, the program will try to connect to a Hokuyo using Ethernet co...
void setScanRangeValidity(const size_t i, const bool val)
int scans_per_360deg
Number of measuremens per 360 degrees.