=============================
Notes on PPPHost installation
=============================

The PPPHost application is designed to establish and control a PPP connection
over RUDICS while a command executes.  The parameters for the process are
kept in PPPHost-config.xml:

callInInterval is the number of seconds between communication sessions

scpVerb is a command to be executed to retrieve the script to execute from
a remote host after establishing the PPP session

runVerb is the command to execute after executing scpVerb successfully

queueCapacity is an internal setting that should be set to 100

nextCallIntervalVerb is a command that returns the number of seconds to
wait until the next call as an override to callInInterval; if the command
is blank, it returns blank or the returned string cannot be converted to
a number of seconds, the result is ignored and callInInterval is used.

modemSerialNumberFilename is the name of the file to which the modem's
serial number (IMEI) is written during the connection process.  This
information may be useful to the script in identifying the vehicle.  If
the field is left blank, the modem serial number is not saved to a file
during connection.

modemSimcardFilename is the name of the file to which the modem's SIM card
number (CICCID) is written during the connection process.  This information
may be useful to the script in identifying the vehicle.  If the field is
left blank, the SIM card number is not saved to a file during connection

pppSettings/dialupTimeout is the number of seconds (maximum) to wait for
the PPP server to answer after starting to dial

pppSettings/modemRegistrationTimeout is the number of seconds (maximum)
to wait for the RUDICS modem to register with the Iridium network before
attempting to dial up

pppSettings/modemResponseTimeout is the number of seconds (maximum) to wait
for the RUDICS modem to respond

pppSettings/phoneNumber is the telephone number to dial before running the
PPP verb; if blank, the PPP verb will have to dial the number

pppSettings/powerOffDelay is the number of seconds to delay after switching
power to the modem off before entering the DISCONNECTED state

pppSettings/powerOnDelay is the number of seconds to delay after switching
power to the modem on before attempting to dial or execute the PPP verb

pppSettings/powerOffVerb is the the command that switches power off to the
RUDICS modem

pppSettings/powerOnVerb is the command that switches power on to the RUDICS
mdoem

pppSettings/protocolDaemonVerb is the command that establishes and holds the
PPP session; this command must not exit until the modem hangs up

pppSettings/sendTries is the number of attempts to send a command to the
RUDICS modem before giving up

pppSettings/queueCapacity is an internal setting that should be set to 100

pppSettings/spSettings/portName is the name of the tty port to use when
interacting directly with the RUDICS modem; note that octal UART ports
/dev/ttyLX0 and /dev/ttyLX1 have modem control lines, but the others do not,
so only port 0 or 1 should be used.

pppSettings/spSettings/baudRate is the bits per second at which to communicate
with the RUDICS modem (19200)

pppSettings/spSettings/parity is the parity setting to use when communicating
with the RUDICS modem (NONE)

pppSettings/spSettings/characterSize is the number if bits per character to
use when communicating with the RUDICS modem (8)

pppSettings/spSettings/flowControl is the type of flow control to use when
communicating with the RUDICS modem (HARDWARE)

pppSettings/spSettings/rts is the state of the RTS line to set when
communicating with the RUDICS modem (1)

pppSettings/spSettings/dtr is the state of the DTR line to set when
communicating with the RUDICS modem (1)

pppSettings/spSettings/breakTimeoutMultiplier is the conversion factor to use
between milliseconds and the units used by the break signal API (1)


Note that the SMC does not have ssh installed, but dropbear's dbclient
is similar (q.v.)

When using scp or ssh (dbclient), the program will prompt for a password if
a secure key pair has not been installed.  To create an RSA keypair in "mykey"
(private key) and "mykey.pub" (public key), execute the following from the
PPPHost runtime directory: 

	dropbearkey -t rsa -f mykey | grep ssh-rsa > mykey.pub

Alternatively, for a DSS key:

	dropbearkey -t dss -f mykey | grep ssh-dss > mykey.pub

The remote host should install the public key as an entry within their
~/.ssh/authorized_keys file.

When running scp or ssh (dbclient), include the the private key file in the
command line with the -i option.

