mch/SerialControl.h

   1 #ifndef _SERIALCONTROL_H_
   2 #define _SERIALCONTROL_H_
   3
   4 #include <string>
   5 #include <errno.h>
   6 #include <termios.h>
   7 #include <stdio.h>
   8 #include <stdlib.h>
   9 #include <unistd.h>
  10 #include <fcntl.h>
  11 #include <sys/signal.h>
  12 #include <sys/types.h>
  13 #include <sys/wait.h>
  14 #include <sys/ioctl.h>
  15
  16 #include "libutil/Log.h"
  17 #include "types.h"
  18
  19 namespace remote { namespace mch {
  20
  21 using namespace util;
  22
  23 /** Serial Connection Control
  24  *
  25  * This class provides a low-level interface for managing a serial
  26  * connection to a mote, such as opening and closing TTYs as well
  27  * as starting and ending child processes operating on the mote TTYs.
  28  */
  29 class SerialControl
  30 {
  31 public:
  32         /** Create serial control. */
  33         SerialControl();
  34
  35         /** Destroy serial control. */
  36         ~SerialControl();
  37
  38         /** Create and run child process.
  39          *
  40          * @param args          The program and args.
  41          * @param envp          The process environment.
  42          * @return              True if the start was created.
  43          */
  44         bool runChild(char * const args[], char * const envp[]);
  45
  46         /** Read buffer from the serial port.
  47          *
  48          * @param buf           The buffer start position.
  49          * @param len           The buffer maximum length.
  50          * @return              The number of read bytes.
  51          */
  52         ssize_t readBuf(char *buf, size_t len);
  53
  54         /** Write buffer to the serial port.
  55          *
  56          * @param buf           The buffer start position.
  57          * @param len           The buffer length.
  58          * @return              The number of written bytes.
  59          */
  60         ssize_t writeBuf(const char *buf, size_t len);
  61
  62         /** Get the file descriptor for the serial port.
  63          *
  64          * @return              The serial port being controlled.
  65          */
  66         int getFd();
  67
  68 protected:
  69         /** Does any children exist?
  70          *
  71          * @return              True if the mote has a child.
  72          */
  73         bool hasChild();
  74
  75         /** Is the serial control port open?
  76          *
  77          * @return              True if the port is open.
  78          */
  79         bool isOpen();
  80
  81         /** Open serial control for TTY
  82          *
  83          * This method opens the request TTY. The platform string is used
  84          * for determining the proper baud rate.
  85          *
  86          * @param platform      The platform of the mote.
  87          * @param tty           The path to the TTY device.
  88          * @return              True if the TTY was successfully opened.
  89          */
  90         bool openTty(const std::string platform, const std::string tty);
  91
  92         /** Close serial control for opened TTY. */
  93         void closeTty();
  94
  95         /** Get exit result of child.
  96          *
  97          * @param killChild     Force the child to end by killing it.
  98          * @return              True if the child exited successfully.
  99          */
 100         bool endChild(bool killChild);
 101
 102         /** Enable or disable DTR.
 103          *
 104          * The DTR channel is wired to the RESET pin on the dig528-2 motes.
 105          * Using this hardware configuration motes can be stopped and started
 106          * by enabling/disabling it respectively.
 107          *
 108          * @param enable        Set the DTR pin high.
 109          * @return              True if the operation succeeded.
 110          */
 111         bool controlDTR(bool enable);
 112
 113         int port;                       /**< Serial file descriptor (or -1). */
 114         pid_t childPid;                 /**< Process ID of child (or -1). */
 115         struct termios oldsertio;       /**< Saved terminal settings. */
 116 };
 117
 118 }}
 119
 120 #endif