src/hokuyo/lib/serial_utils.h

   1 #ifndef QRK_SERIAL_UTILS_H
   2 #define QRK_SERIAL_UTILS_H
   3
   4 /*!
   5   \file
   6   \brief \83V\83\8a\83A\83\8b\91\97\8eó\90M\82Ì\95â\8f\95
   7
   8   \author Satofumi KAMIMURA
   9
  10   $Id: serial_utils.h 783 2009-05-05 08:56:26Z satofumi $
  11
  12   \todo \93ü\97Í\82·\82é\88ø\90\94\82É\82Í\81Aconst \82ð\95t\89Á\82·\82é
  13 */
  14
  15 #include "serial_t.h"
  16
  17
  18 /*!
  19   \brief \89ü\8ds\83R\81[\83h\82©\82ð\95Ô\82·
  20
  21   \retval true LF, CR \82Ì\82Æ\82«
  22   \retval false \8fã\8bL\88È\8aO\82Ì\82Æ\82«
  23 */
  24 extern int serial_isLF(const char ch);
  25
  26
  27 /*!
  28   \brief \8eó\90M\83f\81[\83^\82ð\93Ç\82Ý\94ò\82Î\82·
  29
  30   ConnectionInterface::clear() \82Æ\82Í\81A\83^\83C\83\80\83A\83E\83g\8e\9e\8aÔ\82ð\8ew\92è\82µ\82Ä\93Ç\82Ý\94ò\82Î\82¹\82é\93_\82ª\88Ù\82È\82é
  31
  32   \param[in,out] serial \83V\83\8a\83A\83\8b\90§\8cä\82Ì\8d\\91¢\91Ì
  33   \param[in] total_timeout \83^\83C\83\80\83A\83E\83g\8e\9e\8aÔ\82Ì\8fã\8cÀ [msec]
  34   \param[in] each_timeout \8eó\90M\83f\81[\83^\8aÔ\82É\82¨\82¯\82é\83^\83C\83\80\83A\83E\83g\8e\9e\8aÔ\82Ì\8fã\8cÀ [msec]
  35 */
  36 extern void serial_skip(serial_t *serial, int total_timeout,
  37                         int each_timeout);
  38
  39
  40 /*!
  41   \brief \89ü\8ds\82Ü\82Å\82Ì\93Ç\82Ý\82¾\82µ
  42
  43   \95¶\8e\9a\97ñ\8fI\92[\82É '\\0' \82ð\95t\89Á\82µ\82Ä\95Ô\82·
  44
  45   \param[in,out] serial \83V\83\8a\83A\83\8b\90§\8cä\82Ì\8d\\91¢\91Ì
  46   \param[in] data \8eó\90M\83f\81[\83^\8ai\94[\83o\83b\83t\83@
  47   \param[in] data_size_max \8eó\90M\83o\83b\83t\83@\82Ì\8dÅ\91å\83T\83C\83Y
  48   \param[in] timeout \83^\83C\83\80\83A\83E\83g [msec]
  49
  50   \return \8eó\90M\95¶\8e\9a\90\94
  51 */
  52 extern int serial_getLine(serial_t *serial,
  53                           char *data, int data_size_max, int timeout);
  54
  55 #endif /* !QRK_SERIAL_UTILS_H */