uniserial.hpp
Go to the documentation of this file.
00001 /*********************************************************************
00002  *
00003  * Software License Agreement (BSD License)
00004  *
00005  *  Copyright (c) 2012, Robert Bosch LLC.
00006  *  All rights reserved.
00007  *
00008  *  Redistribution and use in source and binary forms, with or without
00009  *  modification, are permitted provided that the following conditions
00010  *  are met:
00011  *
00012  *   * Redistributions of source code must retain the above copyright
00013  *     notice, this list of conditions and the following disclaimer.
00014  *   * Redistributions in binary form must reproduce the above
00015  *     copyright notice, this list of conditions and the following
00016  *     disclaimer in the documentation and/or other materials provided
00017  *     with the distribution.
00018  *   * Neither the name of the Robert Bosch nor the names of its
00019  *     contributors may be used to endorse or promote products derived
00020  *     from this software without specific prior written permission.
00021  *
00022  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00023  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00024  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00025  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00026  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00027  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00028  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00029  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030  *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00032  *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00033  *  POSSIBILITY OF SUCH DAMAGE.
00034  *
00035  *********************************************************************/
00036 
00037 //\Author Joshua Vasquez and Philip Roan, Robert Bosch LLC
00038 
00039 
00040 #ifndef UNISERIAL_H_
00041 #define UNISERIAL_H_
00042 
00043 #include <stdlib.h> 
00044 #include <stdint.h>   /* standard types */
00045 #include <string.h>   /* string function defs */
00046 #include <unistd.h>   /* UNIX's standard function defs */
00047 #include <fcntl.h>    /* file control function defs */
00048 #include <errno.h>    /* error number definitions */
00049 #include <termios.h>  /* POSIX terminal control function defs */
00050 #include <sys/ioctl.h>
00051 #include <getopt.h>
00052 #include <iostream>
00053 
00061 class uniserial
00062 {
00063 public:
00064   uniserial();
00065   ~uniserial();
00066 
00067   bool initialize(); // initialize under defaults.
00068   bool initialize( const std::string port_name, uint8_t num_bits, uint8_t parity, uint8_t num_stop_bits, uint16_t baud_rate );
00069   void setPortName( const std::string p ); // sets the name of the port
00070   uint8_t Read(); // returns the next byte. Read one byte into a temporary buffer and return the value at that buffer.
00071   bool Write( uint8_t byte ); // writes the array to the arduino.
00072   int Available(); // returns number of bytes currently on the serial buffer. 
00073   bool Flush(); // flushes input and output buffers
00074     
00075   bool Load_Byte( uint8_t byte ); // loads byte onto the next spot in the write buffer.
00076   bool Read_Bytes( uint8_t num_bytes, uint8_t* storage ); // read bytes from Serial port and output to storage.
00077   bool Write_Bytes( uint8_t num_bytes, uint8_t* bytes_to_write ); // write num_bytes from bytes_to_write
00078          
00079 private:
00080   char Buffer[256]; // for storing data from the read() method.
00081   std::string port_name_; // the name of the serial port.
00082   int file_descriptor_; // the file descripter used by the unix functions.
00083   uint8_t buffer_index_; // the buffer's current pointer.
00084   int baud_rate_; // the communication baud rate. (it must agree with the hardware device's baud rate as well!)
00085  
00086   // Hardware dependent settings. Arduino defaults to 8-bit, No parity, 1 stop-bit.
00087   uint8_t num_bits_;
00088   uint8_t parity_;
00089   uint8_t num_stop_bits_;
00090 
00091 };
00092 
00093 #endif // UNISERIAL_H_


uniserial
Author(s): Joshua Vasquez and Philip Roan. Maintained by Philip Roan
autogenerated on Sat Dec 28 2013 16:49:03