diku_mch/Mote.h

   1 #ifndef REMOTE_MCH_MOTE_H
   2 #define REMOTE_MCH_MOTE_H
   3
   4 #include "libutil/File.h"
   5 #include "SerialControl.h"
   6
   7 namespace remote { namespace diku_mch {
   8
   9 /** MCH Mote
  10  *
  11  * This class is used for keeping track of information from the mote
  12  * device directory and whether a mote is valid. A mote object is
  13  * created for each mote attached to a mote host.
  14  *
  15  * All the lowlevel control of the serial connection to the mote is
  16  * done via the subclassed #SerialControl class.
  17  */
  18 class Mote : public SerialControl
  19 {
  20 public:
  21         /** Create a new mote.
  22          *
  23          * A newly created will automatically be validated using
  24          * #validate().
  25          *
  26          * @param mac           The mote's MAC address.
  27          * @param directory     The mote device directory.
  28          */
  29         Mote(std::string& mac, std::string& directory);
  30
  31         /** Is the mote valid?
  32          *
  33          * @return      True if the mote is valid.
  34          */
  35         bool isValid();
  36
  37         /** Mark the mote invalid. */
  38         void invalidate();
  39
  40         /** Validate mote.
  41          *
  42          * When validating a mote, information from files in the mote
  43          * device directory are reread in order to check if the mote is
  44          * still operational.
  45          */
  46         void validate();
  47
  48         /** Get MAC address.
  49          *
  50          * @return      The MAC address.
  51          */
  52         const std::string& getMac();
  53
  54         /** Get the physical device path.
  55          *
  56          * The physical device path contains information about where on
  57          * the mote host the mote is attached. This includes information
  58          * such as which PCI bus it uses, which USB interface etc, for
  59          * example: "/devices/pci0000:00/0000:00:1d.0/usb1/1-1".
  60          *
  61          * This information is read from the "path" file in the mote
  62          * device directory.
  63          *
  64          * @return      The physical device path.
  65          */
  66         const std::string& getDevicePath();
  67
  68         /** Get platform name.
  69          *
  70          * Contains the name of the mote platform, for example "MicaZ"
  71          * or "dig528-2".
  72          *
  73          * This information is read from the "platform" file in the mote
  74          * device directory.
  75          *
  76          * @return      The name of the mote's platform.
  77          */
  78         const std::string& getPlatform();
  79
  80         /** Get mote programmer path.
  81          *
  82          * When programming the mote this path should be used.
  83          *
  84          * The programmer path is derived "programmer" file in the mote
  85          * device directory. It is a symlink pointing to a binary or
  86          * script on the system capable of programming the mote.
  87          *
  88          * @return      The path to the mote programmer binary.
  89          */
  90         std::string getProgrammerPath();
  91
  92         /** Get path to flash image file.
  93          *
  94          * This path can be used to temporarily save flash images when a
  95          * mote is being reprogrammed.
  96          *
  97          * @return      Path to flash image file.
  98          */
  99         std::string getImagePath();
 100
 101 private:
 102         std::string mac;        /**< MAC address. */
 103         std::string directory;  /**< Device directory path. */
 104         std::string path;       /**< Physical device path. */
 105         std::string platform;   /**< Platform name. */
 106         bool isvalid;           /**< Valid flag. */
 107 };
 108
 109 }}
 110
 111 #endif