serial_client.h

// Copyright 2009-2018 Toby Schneider (http://gobysoft.org/index.wt/people/toby)
//                     GobySoft, LLC (2013-)
//                     Massachusetts Institute of Technology (2007-2014)
//                     Community contributors (see AUTHORS file)
//
//
// This file is part of the Goby Underwater Autonomy Project Libraries
// ("The Goby Libraries").
//
// The Goby Libraries are free software: you can redistribute them and/or modify
// them under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 2.1 of the License, or
// (at your option) any later version.
//
// The Goby Libraries are distributed in the hope that they will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Goby.  If not, see <http://www.gnu.org/licenses/>.

// credit for much of this goes to Jeff Gray-3 (http://www.nabble.com/Simple-serial-port-demonstration-with-boost-asio-asynchronous-I-O-p19849520.html)

#ifndef SerialClient20091211H
#define SerialClient20091211H

#include "client_base.h"

namespace goby
{
namespace util
{
class SerialClient : public LineBasedClient<boost::asio::serial_port>
{
  public:
    SerialClient(const std::string& name = "", unsigned baud = 9600,
                 const std::string& delimiter = "\r\n");

    ~SerialClient() {}

    void set_name(const std::string& name) { name_ = name; }
    void set_baud(unsigned baud) { baud_ = baud; }

    std::string name() const { return name_; }

    unsigned baud() const { return baud_; }

    boost::asio::serial_port& socket() { return serial_port_; }
    std::string local_endpoint() { return name_; }
    std::string remote_endpoint() { return ""; }

  private:
    bool start_specific();

  private:
    boost::asio::serial_port serial_port_; // the serial port this instance is connected to
    std::string name_;
    unsigned baud_;
};
} // namespace util
} // namespace goby
#endif