First time building on RPi

mnr · Oct 9, 2023 · 27a3e9c · 27a3e9c
1 parent c71f327
commit 27a3e9c
Show file tree

Hide file tree

Showing 21 changed files with 34 additions and 47 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -8,3 +8,5 @@ export(rpi_monitor)
 export(rpi_pinToBCM)
 export(rpi_pwm)
 export(rpi_set)
+importFrom(Rcpp,sourceCpp)
+useDynLib(rpigpior, .registration = TRUE)
diff --git a/R/rpi_get.R b/R/rpi_get.R
@@ -8,7 +8,6 @@
 #' @export
 #'
 #' @examplesIf is.rpi()
-#' rpi_get(1) # produces error since pin #1 is not data
 #' rpi_get(40) # returns a named vector of the state of GPIO21. i.e. return["GPIO21"] = 1
 #' rpi_get(c(7, 40)) # returns a named vector of values from pins 7 and 40
 rpi_get <- function(pin_number) {

diff --git a/R/rpi_monitor.R b/R/rpi_monitor.R
@@ -48,9 +48,11 @@
 #'   }
 #' @export
 #'
-#' @examplesIf is.rpi()
+#' @examplesIf FALSE
+#' 
 #' rpi_monitor(21)
 #' rpi_monitor(21, numEvents=20)
+#' 
 rpi_monitor <-
   function(pin_number,
            numEvents = 0,

diff --git a/R/rpi_pinToBCM.R b/R/rpi_pinToBCM.R
@@ -13,8 +13,11 @@
 #' @export
 #'
 #' @examplesIf is.rpi()
-#' rpi_pinToBCM(1) # produces error since pin #1 is not data
+#' 
+#' # rpi_pinToBCM(1) # produces error since pin #1 is not data
+#' 
 #' rpi_pinToBCM(40) # returns a named vector where bcm_line = 21 and pin_name = GPIO21
+#' 
 
 rpi_pinToBCM <- function(pin_number) {
   # check pin number. Are all values valid data lines?

diff --git a/R/rpi_pwm.R b/R/rpi_pwm.R
@@ -26,6 +26,7 @@
 #'
 #' rpi_pwm(c(12,33), pwm_period = 50000, pwm_dutycycle = 10000) # provides 20% PWM to pin 12 (PWM0) and pin 33 (PWM1)
 #'
+#' rpi_pwm(c(12,33), pwm_dutycycle = 0) # turn PWM off
 rpi_pwm <- function(pin_number = 12, pwm_period = 50000, pwm_dutycycle = 25000, pwm_debug = FALSE ) {
   # check that pin_number == 12, 32, 33, or 35 ---------
   if (pwm_debug) {

diff --git a/R/rpi_set.R b/R/rpi_set.R
@@ -19,6 +19,7 @@
 #' rpi_set(toggleThesePins, c(0,1,0)) # turns off pins 19 and 23
 #' Sys.sleep(1)
 #' rpi_set(toggleThesePins, 0) # turns off all pins
+#' 
 rpi_set <- function(pin_number, onOff) {
 
   bcm_line <- rpigpior::rpi_pinToBCM(pin_number)

diff --git a/README.Rmd b/README.Rmd
@@ -113,3 +113,13 @@ rpi_set(toggleThese, 0)
 
 [Related mailing list:
 linux-gpio\@vger.kernal.org](https://www.spinics.net/lists/linux-gpio/)
+
+# linux_device_access
+
+C code to access linux devices
+
+Copyright 2020 Leon de Boer
+
+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.
diff --git a/README.md b/README.md
@@ -33,12 +33,11 @@ install the development version of rpigpior from
 [GitHub](https://github.com/mnr/rpigpior) with:
 
 ``` r
-library(remotes)
-remotes::install_github("mnr/rpigpior")
+library(devtools)
+devtools::install_github("mnr/rpigpior")
 ```
 
-Most documentation will tell you to use devtools, but
-`install.packages("devtools")` on a Raspberry Pi is an onerous task.
+I highly recommend you use the R install from [r4pi](https://r4pi.org/). They have already set up devtools.
 
 Once you’ve installed, use `library` just like any other R package:
 
@@ -48,7 +47,7 @@ library(rpigpior)
 
 ## Is this a Raspberry Pi?
 
-It’s helpful to check if your code is running on a Raspberry Pi.
+It’s helpful to check if your code is running on a Raspberry Pi. Do this with `is.rpi()`
 
 ``` r
 if ( is.rpi() ) {
@@ -72,7 +71,7 @@ rpi_get(c(7,40)) # reads board pins 7 and 40
         0       1
 ```
 
-That assumes the switch to board pin 40 is “pushed” or closed. By the
+This assumes the switch to board pin 40 is “pushed” or closed. By the
 way, there is a diagram of this located in the *articles* section of the
 website (as identified in the package description)
 

diff --git a/man/rpi_get.Rd b/man/rpi_get.Rd
diff --git a/man/rpi_monitor.Rd b/man/rpi_monitor.Rd
diff --git a/man/rpi_pinToBCM.Rd b/man/rpi_pinToBCM.Rd
diff --git a/man/rpi_pwm.Rd b/man/rpi_pwm.Rd
diff --git a/man/rpigpior-package.Rd b/man/rpigpior-package.Rd
diff --git a/src/README.md b/src/README.md
diff --git a/tests/testthat/test-gpiodetect.R b/tests/testthat/test-gpiodetect.R
diff --git a/tests/testthat/test-gpiofind.R b/tests/testthat/test-gpiofind.R
diff --git a/tests/testthat/test-gpioget.R b/tests/testthat/test-gpioget.R
diff --git a/tests/testthat/test-gpioinfo.R b/tests/testthat/test-gpioinfo.R
diff --git a/tests/testthat/test-gpiomon.R b/tests/testthat/test-gpiomon.R
diff --git a/tests/testthat/test-gpionotify.R b/tests/testthat/test-gpionotify.R
diff --git a/tests/testthat/test-gpioset.R b/tests/testthat/test-gpioset.R