doc/remote-mch.1

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