src/mch/SerialControl.h

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