serialconnectivity.h

/*
 * GearBox Project: Peer-Reviewed Open-Source Libraries for Robotics
 *               http://gearbox.sf.net/
 * Copyright (c) 2004-2010 Michael Moser
 *
 * This distribution is licensed to you under the terms described in
 * the LICENSE file included in this distribution.
 *
 */
namespace gbxserialacfr{
    class Serial;
}

// test connectivity to a [serial] device at a [baudrate];
// Assumes that you can figure out a [challenge] (command ...) to
// which the device will answer with a unique [ack] in [timeOutMsec] milliseconds.
// If [successThresh] or more [challenge]es are answered by an [ack]
//
// Limitations: amount of data expected before timeOutMsec should be
// reasonably small
//
// returns true for Success; false for failure
namespace gbxnovatelutilacfr{
bool testConnectivity(
        std::string &challenge,
        std::string &ack,
        gbxserialacfr::Serial& serial,
        int timeOutMsec,
        int numTry,
        int successThresh,
        int baudrate);

// send a [challenge] (command ...) to
// which the device will answer with a unique [ack] in [timeOutMsec] milliseconds.
//
// Limitations: amount of data expected before timeOutMsec should be
// reasonably small
//
// returns true for Success (i.e. ack received in time),
// false for failure, in case of failure errorResponse contains the reply from the receiver
bool sendCmdWaitForResponse(
        std::string &challenge,
        std::string &ack,
        std::string &errorResponse,
        gbxserialacfr::Serial& serial,
        int timeOutMsec);
}