doc/remote-mch.1.txt

   1 REMOTE-MCH(1)
   2 =============
   3
   4 NAME
   5 ----
   6 remote-mch - Re-Mote mote control host
   7
   8 SYNOPSIS
   9 --------
  10 remote-mch [options]
  11
  12 DESCRIPTION
  13 -----------
  14 The mote control host manages mote devices and provides remote access to them
  15 through a mote control server. On startup the mote host connects to the server
  16 and listens for incoming requests. Requests allows motes to be programmed,
  17 started, stopped, and reset. All console output from motes are forwarded to
  18 the server.
  19
  20 The mote control host may be run both in the foreground and as a daemon.
  21
  22 OPTIONS
  23 -------
  24 The following options are only usable on the command line.
  25
  26 --config=<path>::
  27
  28         Path to the configuration file. Defaults to "/etc/remote-mch.cfg".
  29
  30 --help::
  31
  32         Print usage help and exit.
  33
  34 --version::
  35
  36         Print version info and exit.
  37
  38 Configuration options
  39 ~~~~~~~~~~~~~~~~~~~~~
  40 In addition, to the above options the mote host accepts the following
  41 configuration options that can be specified either on the command line or in
  42 the configuration file. An option set in the configuration file overrides
  43 any option set on the command line.
  44
  45 On the command line use: '--' <name> '=' <value>, e.g. '--devicePath=/here'.
  46 In the config file use: <name> '=' <value>, e.g. 'devicePath=/here'. For
  47 boolean options the '=' and value may be left out to set the value to true.
  48 See the example sections for more information.
  49
  50 devicePath <string>::
  51
  52         Path to the mote device hierarchy.
  53         When not specified "/dev/remote/" is used.
  54
  55 eventPipe <string>::
  56
  57         Path to the fifo notifying the mote host of mote hotplug events.
  58         By default the daemon listens on "/var/run/motehost.events".
  59
  60 serverHost <string>::
  61
  62         DNS or IP address of the mote server.
  63         Default is localhost.
  64
  65 serverPort <number>::
  66
  67         Port number to use for connecting to the mote server.
  68         The default port is 10001.
  69
  70 retryInterval <number>::
  71
  72         Number of seconds to wait between server connection retries.
  73         Default is 30 seconds.
  74
  75 daemonize <boolean>::
  76
  77         Whether or not to run in the background as a daemon.
  78         The default is to not run as a daemon.
  79
  80 FILES
  81 -----
  82 The mote host uses the following configurable files.
  83
  84 /etc/remote-mch.cfg::
  85
  86         Default configuration file read on startup.
  87
  88 /var/run/motehost.events::
  89
  90         Default file for listening on mote events.
  91
  92 Mote device files
  93 ~~~~~~~~~~~~~~~~~
  94
  95 For each mote managed by the mote host, the following device specific files
  96 are used. The device path is configurable (default: "/dev/remote"). MOTEMAC
  97 represents the MAC address of a mote.
  98
  99 /dev/remote/MOTEMAC/programmer::
 100
 101         Symbolic link to the mote programmer. The programmer is called
 102         with the TTY as the first argument and path to the image file
 103         as the second argument.
 104
 105 /dev/remote/MOTEMAC/controller::
 106
 107         Symbolic link to the mote control program.
 108
 109 /dev/remote/MOTEMAC/tty/control::
 110
 111         Symbolic link to the mote control TTY.
 112
 113 /dev/remote/MOTEMAC/tty/data::
 114
 115         Symbolic link to the mote data TTY.
 116
 117 /dev/remote/MOTEMAC/image::
 118
 119         Temporary image file used when programming.
 120
 121 /dev/remote/MOTEMAC/path::
 122
 123         File containing the mote device path in the form of a path specifying
 124         the bus ID. E.g. "/devices/pci0000:00/0000:00:10.0/usb2/2-1".
 125
 126 /dev/remote/MOTEMAC/platform::
 127
 128         File containing the name of the mote platform. E.g. "dig528-2".
 129
 130 ENVIRONMENT VARIABLES
 131 ---------------------
 132 The mote host does not use any externally defined environment variables. When
 133 invoking the programmer and controller commands the mote host sets the
 134 following environment variables.
 135
 136 platform::
 137
 138         The mote platform, e.g. "MicaZ".
 139
 140 macaddress::
 141
 142         The mote MAC address.
 143
 144 tosaddress::
 145
 146         The mote TOS address.
 147
 148 EXAMPLES
 149 --------
 150
 151 Using configuration options on the command line::
 152
 153         If you only need to override the default values for the server host
 154         and port and don't want to use a configuration file, specify all
 155         option on the command line.
 156
 157         $ remote-mch --serverHost=my.server.tld --serverPort=10001 --daemonize
 158
 159 A simple configuration file::
 160
 161         The following configuration file sets the same values as the above
 162         example.
 163
 164         # MCS location
 165         serverHost=my.server.tld
 166         serverPort=10001
 167         # Run in the background
 168         daemonize
 169
 170 COPYRIGHT
 171 ---------
 172 [verse]
 173 Copyright (c) 2005-2006 Esben Zeuthen <zept@diku.dk>
 174 Copyright (c) 2006-2008 Jonas Fonseca <fonseca@diku.dk>
 175 Copyright (c) 2007-2008 Rosta Spinarr <rostislav.spinar@cit.ie>
 176
 177 This program is free software; you can redistribute it and/or modify
 178 it under the terms of the GNU General Public License as published by
 179 the Free Software Foundation; either version 2 of the License, or
 180 (at your option) any later version.
 181
 182 SEE ALSO
 183 --------
 184 remote-mcs(1),
 185 remote-device-add(7),
 186 remote-device-remove(7),
 187 remote-device-name(7)
 188
 189 This program is part of http://remote-testbed.googlecode.com/[the Re-Mote Testbed Framework].