Finished major components of this package

Author: haozhu233

.DS_Store

@@ -5,3 +5,4 @@
 src/*.o
 src/*.so
 src/*.dll
+.DS_Store

.gitignore

@@ -1,12 +1,12 @@
-Package: arduinor
+Package: arduino
 Type: Package
 Title: What the Package Does in One 'Title Case' Line
 Version: 1.0
-Date: 2018-02-11
+Date: 2018-02-20
 Author: Your Name
 Maintainer: Your Name <[email protected]>
-Description: One paragraph description of what the package does as one or
-        more full sentences.
+Description: One paragraph description of what the package does as one or more full sentences.
 License: GPL (>= 2)
 Imports: Rcpp (>= 0.12.15)
 LinkingTo: Rcpp
+RoxygenNote: 6.0.1

DESCRIPTION

@@ -1,3 +1,9 @@
-useDynLib(arduinor, .registration=TRUE)
-exportPattern("^[[:alpha:]]+")
-importFrom(Rcpp, evalCpp)
+# Generated by roxygen2: do not edit by hand
+
+export(ar_close)
+export(ar_flush)
+export(ar_init)
+export(ar_read)
+export(ar_stream)
+importFrom(Rcpp,sourceCpp)
+useDynLib(arduino)

NAMESPACE

@@ -1,7 +1,85 @@
 # Generated by using Rcpp::compileAttributes() -> do not edit by hand
 # Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393
 
-rcpp_hello_world <- function() {
-    .Call(`_arduinor_rcpp_hello_world`)
+#' Initiate a connection to the serial port
+#' 
+#' @param serialport Name of the serial port (e.g. "/dev/tty.usbserial","COM1")
+#' @param baud Baud rate (bps) in integer. 
+#' 
+#' @description This function sets up a connection to the serial port at the 
+#' specified port name and baud rate. The port is set in 8-N-1 mode and is
+#' opened in fully raw mode so you can send binary data. 
+#' 
+#' @examples 
+#' \dontrun{
+#' # On Windows
+#' con <- ar_init("COM1") 
+#' 
+#' # On Mac
+#' con <- ar_init("/dev/cu.SLAB_USBtoUART")
+#' }
+#' 
+#' @return If connection is setup successfully, this function will return the 
+#' file descriptor. If not, it will return -1.
+#' 
+#' @export
+ar_init <- function(serialport, baud = 9600L) {
+    .Call('_arduino_ar_init', PACKAGE = 'arduino', serialport, baud)
+}
+
+#' Close Connection to a serial port
+#' 
+#' @description This function closes the connection opened by `ar_init()`.
+#' 
+#' @param fd File descriptor returned by `ar_init()`. Should be an integer.
+#' 
+#' @examples
+#' \dontrun{
+#' con <- ar_init("/dev/cu.SLAB_USBtoUART") 
+#' ar_close(con)
+#' }
+#' 
+#' @export
+ar_close <- function(fd) {
+    .Call('_arduino_ar_close', PACKAGE = 'arduino', fd)
+}
+
+#' Read one entry of input from an opened serial connection
+#' 
+#' @description This function reads one entry of input from an opened serial
+#' port. Each line of entry is identified by the end of line character 
+#' `eolchar`. 
+#' 
+#' @param fd File descriptor returned by `ar_init()`. Should be an integer.
+#' @param eolchar End of line character. Default value is `'\\n'`
+#' @param buf_max Maximum length of one line of entry. Default is 256.
+#' @param timeout Timeout for reads in millisecs. Default is 5000 ms.
+#' 
+#' @examples
+#' \dontrun{
+#' con <- ar_init("/dev/cu.SLAB_USBtoUART")
+#' ar_read(con)
+#' }
+#' 
+#' @export
+ar_read <- function(fd, eolchar = '\n', buf_max = 256L, timeout = 5000L) {
+    .Call('_arduino_ar_read', PACKAGE = 'arduino', fd, eolchar, buf_max, timeout)
+}
+
+#' Flush serial port
+#' 
+#' @description clearing the serial port's buffer
+#' 
+#' @param fd File descriptor returned by `ar_init()`. Should be an integer.
+#' 
+#' @examples
+#' \dontrun{
+#' con <- ar_init("/dev/cu.SLAB_USBtoUART")
+#' ar_flush(con)
+#' }
+#' 
+#' @export
+ar_flush <- function(fd) {
+    .Call('_arduino_ar_flush', PACKAGE = 'arduino', fd)
 }
 

R/RcppExports.R

@@ -0,0 +1,14 @@
+#' Stream serial port data into R console
+#' 
+#' @description This function wraps around `ar_read()` and will read serial
+#' port data into R console until user stop it.
+#' 
+#' @param fd File descriptor returned by `ar_init()`. Should be an integer.
+#' @param eolchar End of line character. Default value is `'\\n'`
+#' @param buf_max Maximum length of one line of entry. Default is 256.
+#' @param timeout Timeout for reads in millisecs. Default is 5000 ms.
+#' 
+#' @export
+ar_stream <- function(fd, eolchar = "\n", buf_max = 256, timeout = 5000) {
+  repeat(cat(ar_read(fd, eolchar, buf_max, timeout)))
+}

R/ar_stream.R

@@ -0,0 +1,9 @@
+#' arduino
+#' 
+#' @name arduino-package
+#' @aliases arduino
+#' @docType package
+#' @keywords package
+#' @useDynLib arduino
+#' @importFrom Rcpp sourceCpp
+NULL

R/arduino-package.R

@@ -0,0 +1,3 @@
+.onUnload <- function(libpath) {
+  library.dynam.unload("arduino", libpath)
+}

R/zzz.R

@@ -0,0 +1,22 @@
+# arduino
+> Arduino is an open source computer hardware and software company, project, and user community that designs and manufactures single-board microcontrollers and microcontroller kits for building digital devices and interactive objects that can sense and control objects in the physical world. --Wikipedia
+
+As one important piece of the fast growing ["IoT"](https://en.wikipedia.org/wiki/Internet_of_things) movement, arduino chips enable scientists and hobbyists to build customizable digital devices at will at a very inexpensive price. For the scientific community, it opens up a new way to collect various formats of data, such as accelerometer, gyroscope, thermometer and IR. Data collected by arduino can be sent to computers both wirelessly (through the WiFi kit on some recent devices such as ESP8266) or wirely through serial ports. This package handles reading arduino data from serial port into R.
+
+Current approaches in R, including the `serial` package or [this post](https://www.r-bloggers.com/connecting-the-real-world-to-r-with-an-arduino/), both have dependency requirements. This package binds the light-weight [arduino-serial](https://github.com/todbot/arduino-serial) C library to R and is both dependency-free and fast.
+
+# Installation
+```r
+devtools::install("hebrewseniorlife/arduino")
+```
+
+# Getting Started
+```r
+library(arduino)
+
+# Use the baud rate you set in `Serial.begin();` in arduino
+con <- ar_init("/dev/cu.SLAB_USBtoUART", baud = 57600)  
+
+# Start to stream arduino data into console. Press STOP to stop.
+ar_stream(con)
+```