Skip to content

gecko-robotics/serialcomm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub

Serial Communications

A simple serial communications library, that mimic most of the Arduino serial syntax. The goal is to use drivers between Arduino and C++ on linux easier with little to no rewrite.

Example

#include <serialcomm/serial.hpp>
#include <string>
#include <iostream>

using namespace std;

int main() {
    SerialPort ser;
    bool ok = ser.open("/dev/serial", B9600);

    uint8_t buffer[3] = {1,2,3,4};
    int num = ser.write(buffer, sizeof(buffer)); // -1 for error
    if (num < 0) cout << "error" << endl;
    std::string msg("hello");
    ser.write(msg);

    ser.close();

    return 0
}

Todo

  • fix the timeout and blocking
  • determine either: return errors w/error string OR stay with catch/throw on error
  • toggle DTR/RTS pins
  • move i2c code to different library

Reference

MIT License

Copyright (c) 2019 Kevin J. Walchko

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.