diff options
| author | Rafael Laboissière <rafael@debian.org> | 2023-07-21 12:03:01 -0300 |
|---|---|---|
| committer | Rafael Laboissière <rafael@debian.org> | 2023-07-21 12:03:01 -0300 |
| commit | d6d7e9066885158c9534cb307d89168b620ac760 (patch) | |
| tree | c0eef24e2bfd0348d1cac6dbefeeb55acfb991e2 | |
| parent | 9ff57de88b4590ebe32be678884a79e81c2afe7a (diff) | |
New upstream version 0.11.0
| -rw-r--r-- | .hgignore | 39 | ||||
| -rw-r--r-- | DESCRIPTION | 4 | ||||
| -rw-r--r-- | INDEX | 2 | ||||
| -rw-r--r-- | NEWS | 9 | ||||
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | doc/arduino.html | 7006 | ||||
| -rw-r--r-- | doc/arduino.pdf | bin | 396859 -> 401506 bytes | |||
| -rw-r--r-- | doc/arduino.qch | bin | 155648 -> 143360 bytes | |||
| -rw-r--r-- | doc/arduino.qhc | bin | 131072 -> 118784 bytes | |||
| -rw-r--r-- | doc/arduino.texi | 8 | ||||
| -rw-r--r-- | doc/functions.texi | 4492 | ||||
| -rw-r--r-- | doc/version.texi | 4 | ||||
| -rw-r--r-- | inst/+arduinoio/+config/config_uno_minima_r4.m | 38 | ||||
| -rw-r--r-- | inst/+arduinoio/+config/config_uno_wifi_r4.m | 66 | ||||
| -rw-r--r-- | inst/+arduinoio/boardTypeString.m | 4 | ||||
| -rw-r--r-- | inst/+arduinoio/lib/LibraryBase.cpp | 2 | ||||
| -rw-r--r-- | inst/+arduinoio/lib/LibraryBase.h | 2 | ||||
| -rw-r--r-- | inst/+arduinoio/lib/OctaveCoreLibrary.cpp | 6 | ||||
| -rw-r--r-- | inst/+arduinoio/lib/OctaveI2CLibrary.cpp | 6 |
19 files changed, 5935 insertions, 5757 deletions
diff --git a/.hgignore b/.hgignore new file mode 100644 index 0000000..2f19810 --- /dev/null +++ b/.hgignore @@ -0,0 +1,39 @@ +syntax: regexp +# The recurrent (^|/) idiom in the regexps below should be understood +# to mean "at any directory" while the ^ idiom means "from the +# project's top-level directory". + +(^|/).*\.dvi$ +(^|/).*\.pdf$ +(^|/).*\.o$ +(^|/).*\.log$ +(^|/).*\.oct$ +(^|/).*\.octlink$ +(^|/)octave-core$ +(^|/).*\.tar\.gz$ + +## Our Makefile target +^release/ + +## Files generated automatically by autoconf and the configure script +(^|/)aclocal\.m4$ +(^|/)configure$ +(^|/)autom4te\.cache($|/) +^src/config\.log$ +^src/config\.h\.in$ +^src/config\.status$ +^src/Makefile$ + +# e.g. doc/faq/OctaveFAQ.info +# doc/interpreter/octave.info-4 +^doc/.*\.info(-\d)?$ + +^doc/\w*/stamp-vti$ +^doc/\w*/version\.texi$ + +# Emacs tools create these +(^|/)TAGS$ +(^|/)semantic.cache$ + +# Other text editors often create these +(^|/)~.* diff --git a/DESCRIPTION b/DESCRIPTION index 4630e8f..676412b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Name: arduino -Version: 0.10.0 -Date: 2022-09-13 +Version: 0.11.0 +Date: 2023-07-19 Author: John Donoghue <john.donoghue@ieee.org> Maintainer: John Donoghue <john.donoghue@ieee.org> Title: Octave Arduino Toolkit @@ -141,7 +141,7 @@ Arduino I/O package arduinoio.LibFiles arduinoio.LibraryBase arduinoio.getBoardConfig -Matlab Compatability Classes +Matlab Compatibility Classes matlabshared.addon.LibraryBase Sensors bme280 @@ -1,3 +1,12 @@ +Summary of important user-visible changes for arduino 0.11.0: +------------------------------------------------------------------- + + ** New board configurations: + - Arduino Uno WIFI r4 + - Arduino Uno Minima r4 + + ** Minor doc updates + Summary of important user-visible changes for arduino 0.10.0: ------------------------------------------------------------------- @@ -96,8 +96,12 @@ Currently the toolkit recognizes these boards: * sparkfunsamd21 +* uno minima r4 + * uno wifi rev2 +* uno wifi r4 + * uno Additional boards can usually be added with minimal code changes. diff --git a/doc/arduino.html b/doc/arduino.html index eb2cf80..4d374ee 100644 --- a/doc/arduino.html +++ b/doc/arduino.html @@ -1,6 +1,6 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!DOCTYPE html> <html> -<!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ --> +<!-- Created by GNU Texinfo 7.0.2, https://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Arduino Toolkit - a somewhat Matlab compatible arduino toolkit for GNU octave.</title> @@ -18,21 +18,20 @@ <link href="#Installing-and-loading" rel="next" title="Installing and loading"> <style type="text/css"> <!-- -a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} +a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em} +a.summary-letter-printindex {text-decoration: none} +div.center {text-align:center} div.display {margin-left: 3.2em} div.example {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -span:hover a.copiable-anchor {visibility: visible} -ul.no-bullet {list-style: none} +pre.display-preformatted {font-family: inherit} +span:hover a.copiable-link {visibility: visible} +strong.def-name {font-family: monospace; font-weight: bold; font-size: larger} +td.printindex-index-entry {vertical-align: top} +td.printindex-index-section {vertical-align: top} +th.entries-header-printindex {text-align:left} +th.sections-header-printindex {text-align:left} +ul.mark-bullet {list-style-type: disc} +ul.toc-numbered-mark {list-style: none} --> </style> <link rel="stylesheet" type="text/css" href="arduino.css"> @@ -41,7 +40,6 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<h1 class="settitle" align="center">Arduino Toolkit - a somewhat Matlab compatible arduino toolkit for GNU octave.</h1> @@ -59,45 +57,45 @@ ul.no-bullet {list-style: none} -<div class="top" id="Top"> -<div class="header"> +<div class="top-level-extent" id="Top"> +<div class="nav-panel"> <p> Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and loading</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Introduction"></span><h1 class="top">Introduction</h1> +<h1 class="top" id="Introduction">Introduction</h1> <p>The Arduino toolkit is a somewhat Matlab compatible arduino toolkit for GNU octave. </p> -<div class="Contents_element" id="SEC_Contents"> +<div class="element-contents" id="SEC_Contents"> <h2 class="contents-heading">Table of Contents</h2> <div class="contents"> -<ul class="no-bullet"> +<ul class="toc-numbered-mark"> <li><a id="toc-Installing-and-loading-1" href="#Installing-and-loading">1 Installing and loading</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-Online-Direct-install" href="#Online-Direct-install">1.1 Online Direct install</a></li> <li><a id="toc-Off_002dline-install" href="#Off_002dline-install">1.2 Off-line install</a></li> <li><a id="toc-Loading" href="#Loading">1.3 Loading</a></li> </ul></li> <li><a id="toc-Hardware-setup-1" href="#Hardware-setup">2 Hardware setup</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-Programming-the-Arduino" href="#Programming-the-Arduino">2.1 Programming the Arduino</a></li> <li><a id="toc-Known-Arduino-Board-Types" href="#Known-Arduino-Board-Types">2.2 Known Arduino Board Types</a></li> </ul></li> <li><a id="toc-Connecting-to-an-arduino-1" href="#Connecting-to-an-arduino">3 Connecting to an arduino</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-Connecting-to-a-single-arduino" href="#Connecting-to-a-single-arduino">3.1 Connecting to a single arduino</a></li> <li><a id="toc-Connecting-to-a-specific-arduino" href="#Connecting-to-a-specific-arduino">3.2 Connecting to a specific arduino</a></li> <li><a id="toc-Querying-available-arduinos" href="#Querying-available-arduinos">3.3 Querying available arduinos</a></li> </ul></li> <li><a id="toc-Basic-Input-and-Output-Overview-1" href="#Basic-Input-and-Output-Overview">4 Basic Input and Output Overview</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-Performing-Digital-I_002fO" href="#Performing-Digital-I_002fO">4.1 Performing Digital I/O</a></li> <li><a id="toc-Performing-Analog-Input" href="#Performing-Analog-Input">4.2 Performing Analog Input</a></li> </ul></li> <li><a id="toc-Protocol-based-I_002fO-Overview-1" href="#Protocol-based-I_002fO-Overview">5 Protocol based I/O Overview</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-SPI-communication" href="#SPI-communication">5.1 SPI communication</a></li> <li><a id="toc-I2C-communication" href="#I2C-communication">5.2 I2C communication</a></li> <li><a id="toc-Servo-communication" href="#Servo-communication">5.3 Servo communication</a></li> @@ -107,51 +105,51 @@ Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and <li><a id="toc-Serial-communication" href="#Serial-communication">5.7 Serial communication</a></li> </ul></li> <li><a id="toc-Addons-Overview-1" href="#Addons-Overview">6 Addons Overview</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-Addon-Introduction" href="#Addon-Introduction">6.1 Addon Introduction</a></li> <li><a id="toc-Creating-an-addon" href="#Creating-an-addon">6.2 Creating an addon</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-Addon-package-directory" href="#Addon-package-directory">6.2.1 Addon package directory</a></li> <li><a id="toc-Addon-package-_002em-file" href="#Addon-package-_002em-file">6.2.2 Addon package .m file</a></li> <li><a id="toc-Addon-package-header-file" href="#Addon-package-header-file">6.2.3 Addon package header file</a></li> <li><a id="toc-Verify-octave-can-see-the-addon" href="#Verify-octave-can-see-the-addon">6.2.4 Verify octave can see the addon</a></li> </ul></li> <li><a id="toc-Using-addons" href="#Using-addons">6.3 Using addons</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-Programming-the-arduino-with-the-addon" href="#Programming-the-arduino-with-the-addon">6.3.1 Programming the arduino with the addon</a></li> <li><a id="toc-Creating-a-addon-object" href="#Creating-a-addon-object">6.3.2 Creating a addon object</a></li> </ul></li> </ul></li> <li><a id="toc-Sensors-Overview-1" href="#Sensors-Overview">7 Sensors Overview</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-Matlab-Compatible-Sensors" href="#Matlab-Compatible-Sensors">7.1 Matlab Compatible Sensors</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-Overview" href="#Overview">7.1.1 Overview</a></li> <li><a id="toc-Available-Sensors" href="#Available-Sensors">7.1.2 Available Sensors</a></li> </ul></li> <li><a id="toc-Lightweight-Arduino-Sensors" href="#Lightweight-Arduino-Sensors">7.2 Lightweight Arduino Sensors</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-Overview-1" href="#Overview-1">7.2.1 Overview</a></li> <li><a id="toc-Available-Sensors-1" href="#Available-Sensors-1">7.2.2 Available Sensors</a></li> </ul></li> </ul></li> <li><a id="toc-Examples-1" href="#Examples">8 Examples</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-Blinking-an-LED" href="#Blinking-an-LED">8.1 Blinking an LED</a></li> <li><a id="toc-Using-I2C-to-communicate-with-an-EEPROM" href="#Using-I2C-to-communicate-with-an-EEPROM">8.2 Using I2C to communicate with an EEPROM</a></li> <li><a id="toc-Using-SPI-to-communicate-with-a-mcp3002-10-bit-ADC" href="#Using-SPI-to-communicate-with-a-mcp3002-10-bit-ADC">8.3 Using SPI to communicate with a mcp3002 10 bit ADC</a></li> </ul></li> <li><a id="toc-Function-Reference-1" href="#Function-Reference">9 Function Reference</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-General-Functions-1" href="#General-Functions">9.1 General Functions</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-arduinosetup" href="#arduinosetup">9.1.1 arduinosetup</a></li> <li><a id="toc-isarduino" href="#isarduino">9.1.2 isarduino</a></li> <li><a id="toc-listArduinoLibraries" href="#listArduinoLibraries">9.1.3 listArduinoLibraries</a></li> <li><a id="toc-scanForArduinos" href="#scanForArduinos">9.1.4 scanForArduinos</a></li> </ul></li> <li><a id="toc-Arduino-Functions-1" href="#Arduino-Functions">9.2 Arduino Functions</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-_0040arduino_002farduino" href="#g_t_0040arduino_002farduino">9.2.1 @arduino/arduino</a></li> <li><a id="toc-_0040arduino_002fcheckI2CAddress" href="#g_t_0040arduino_002fcheckI2CAddress">9.2.2 @arduino/checkI2CAddress</a></li> <li><a id="toc-_0040arduino_002fconfigurePin" href="#g_t_0040arduino_002fconfigurePin">9.2.3 @arduino/configurePin</a></li> @@ -193,7 +191,7 @@ Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and <li><a id="toc-_0040arduino_002fwritePWMVoltage" href="#g_t_0040arduino_002fwritePWMVoltage">9.2.39 @arduino/writePWMVoltage</a></li> </ul></li> <li><a id="toc-Arduino-I2C-Functions-1" href="#Arduino-I2C-Functions">9.3 Arduino I2C Functions</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-_0040device_002fdelete" href="#g_t_0040device_002fdelete">9.3.1 @device/delete</a></li> <li><a id="toc-_0040device_002fdisplay" href="#g_t_0040device_002fdisplay">9.3.2 @device/display</a></li> <li><a id="toc-_0040device_002fread" href="#g_t_0040device_002fread">9.3.3 @device/read</a></li> @@ -212,7 +210,7 @@ Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and <li><a id="toc-scanI2Cbus" href="#scanI2Cbus">9.3.16 scanI2Cbus</a></li> </ul></li> <li><a id="toc-Arduino-Rotary-Encoder-Functions-1" href="#Arduino-Rotary-Encoder-Functions">9.4 Arduino Rotary Encoder Functions</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-_0040rotaryEncoder_002fdelete" href="#g_t_0040rotaryEncoder_002fdelete">9.4.1 @rotaryEncoder/delete</a></li> <li><a id="toc-_0040rotaryEncoder_002fdisplay" href="#g_t_0040rotaryEncoder_002fdisplay">9.4.2 @rotaryEncoder/display</a></li> <li><a id="toc-_0040rotaryEncoder_002freadCount" href="#g_t_0040rotaryEncoder_002freadCount">9.4.3 @rotaryEncoder/readCount</a></li> @@ -222,7 +220,7 @@ Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and <li><a id="toc-_0040rotaryEncoder_002fsubsref" href="#g_t_0040rotaryEncoder_002fsubsref">9.4.7 @rotaryEncoder/subsref</a></li> </ul></li> <li><a id="toc-Arduino-Servo-Functions-1" href="#Arduino-Servo-Functions">9.5 Arduino Servo Functions</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-_0040servo_002fdelete" href="#g_t_0040servo_002fdelete">9.5.1 @servo/delete</a></li> <li><a id="toc-_0040servo_002fdisplay" href="#g_t_0040servo_002fdisplay">9.5.2 @servo/display</a></li> <li><a id="toc-_0040servo_002freadPosition" href="#g_t_0040servo_002freadPosition">9.5.3 @servo/readPosition</a></li> @@ -231,7 +229,7 @@ Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and <li><a id="toc-_0040servo_002fwritePosition" href="#g_t_0040servo_002fwritePosition">9.5.6 @servo/writePosition</a></li> </ul></li> <li><a id="toc-Arduino-Shiftregister-Functions-1" href="#Arduino-Shiftregister-Functions">9.6 Arduino Shiftregister Functions</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-_0040shiftRegister_002fdelete" href="#g_t_0040shiftRegister_002fdelete">9.6.1 @shiftRegister/delete</a></li> <li><a id="toc-_0040shiftRegister_002fdisplay" href="#g_t_0040shiftRegister_002fdisplay">9.6.2 @shiftRegister/display</a></li> <li><a id="toc-_0040shiftRegister_002fread" href="#g_t_0040shiftRegister_002fread">9.6.3 @shiftRegister/read</a></li> @@ -241,7 +239,7 @@ Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and <li><a id="toc-_0040shiftRegister_002fwrite" href="#g_t_0040shiftRegister_002fwrite">9.6.7 @shiftRegister/write</a></li> </ul></li> <li><a id="toc-Arduino-SPI-Functions-1" href="#Arduino-SPI-Functions">9.7 Arduino SPI Functions</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-_0040device_002fdelete-1" href="#g_t_0040device_002fdelete-1">9.7.1 @device/delete</a></li> <li><a id="toc-_0040device_002fdisplay-1" href="#g_t_0040device_002fdisplay-1">9.7.2 @device/display</a></li> <li><a id="toc-_0040device_002fsubsref-1" href="#g_t_0040device_002fsubsref-1">9.7.3 @device/subsref</a></li> @@ -253,7 +251,7 @@ Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and <li><a id="toc-_0040spidev_002fwriteRead" href="#g_t_0040spidev_002fwriteRead">9.7.9 @spidev/writeRead</a></li> </ul></li> <li><a id="toc-Arduino-Serial-Functions-1" href="#Arduino-Serial-Functions">9.8 Arduino Serial Functions</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-_0040device_002fdelete-2" href="#g_t_0040device_002fdelete-2">9.8.1 @device/delete</a></li> <li><a id="toc-_0040device_002fdevice" href="#g_t_0040device_002fdevice">9.8.2 @device/device</a></li> <li><a id="toc-_0040device_002fdisplay-2" href="#g_t_0040device_002fdisplay-2">9.8.3 @device/display</a></li> @@ -263,7 +261,7 @@ Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and <li><a id="toc-_0040device_002fwrite-1" href="#g_t_0040device_002fwrite-1">9.8.7 @device/write</a></li> </ul></li> <li><a id="toc-Arduino-Device-Functions-1" href="#Arduino-Device-Functions">9.9 Arduino Device Functions</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-_0040device_002fdelete-3" href="#g_t_0040device_002fdelete-3">9.9.1 @device/delete</a></li> <li><a id="toc-_0040device_002fdevice-1" href="#g_t_0040device_002fdevice-1">9.9.2 @device/device</a></li> <li><a id="toc-_0040device_002fdisplay-3" href="#g_t_0040device_002fdisplay-3">9.9.3 @device/display</a></li> @@ -276,7 +274,7 @@ Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and <li><a id="toc-_0040device_002fwriteRegister-1" href="#g_t_0040device_002fwriteRegister-1">9.9.10 @device/writeRegister</a></li> </ul></li> <li><a id="toc-Arduino-Ultrasonic-Functions-1" href="#Arduino-Ultrasonic-Functions">9.10 Arduino Ultrasonic Functions</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-_0040ultrasonic_002fdelete" href="#g_t_0040ultrasonic_002fdelete">9.10.1 @ultrasonic/delete</a></li> <li><a id="toc-_0040ultrasonic_002fdisplay" href="#g_t_0040ultrasonic_002fdisplay">9.10.2 @ultrasonic/display</a></li> <li><a id="toc-_0040ultrasonic_002freadDistance" href="#g_t_0040ultrasonic_002freadDistance">9.10.3 @ultrasonic/readDistance</a></li> @@ -285,7 +283,7 @@ Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and <li><a id="toc-_0040ultrasonic_002fultrasonic" href="#g_t_0040ultrasonic_002fultrasonic">9.10.6 @ultrasonic/ultrasonic</a></li> </ul></li> <li><a id="toc-Arduino-Addons-1" href="#Arduino-Addons">9.11 Arduino Addons</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-addon" href="#addon">9.11.1 addon</a></li> <li><a id="toc-arduinoioaddons_002eEEPRomAddon_002eEEPRom" href="#arduinoioaddons_002eEEPRomAddon_002eEEPRom">9.11.2 arduinoioaddons.EEPRomAddon.EEPRom</a></li> <li><a id="toc-arduinoioaddons_002eExampleAddon_002eEcho" href="#arduinoioaddons_002eExampleAddon_002eEcho">9.11.3 arduinoioaddons.ExampleAddon.Echo</a></li> @@ -297,26 +295,26 @@ Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and <li><a id="toc-arduinoioaddons_002eadafruit_002estepper" href="#arduinoioaddons_002eadafruit_002estepper">9.11.9 arduinoioaddons.adafruit.stepper</a></li> </ul></li> <li><a id="toc-Arduino-Sensors-1" href="#Arduino-Sensors">9.12 Arduino Sensors</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-arduinosensor_002eDS1307" href="#arduinosensor_002eDS1307">9.12.1 arduinosensor.DS1307</a></li> <li><a id="toc-arduinosensor_002eGUVAS12SD" href="#arduinosensor_002eGUVAS12SD">9.12.2 arduinosensor.GUVAS12SD</a></li> <li><a id="toc-arduinosensor_002eMPC3002" href="#arduinosensor_002eMPC3002">9.12.3 arduinosensor.MPC3002</a></li> <li><a id="toc-arduinosensor_002eSI7021" href="#arduinosensor_002eSI7021">9.12.4 arduinosensor.SI7021</a></li> </ul></li> <li><a id="toc-Arduino-I_002fO-package-1" href="#Arduino-I_002fO-package">9.13 Arduino I/O package</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-arduinoio_002eAddonBase" href="#arduinoio_002eAddonBase">9.13.1 arduinoio.AddonBase</a></li> <li><a id="toc-arduinoio_002eFilePath" href="#arduinoio_002eFilePath">9.13.2 arduinoio.FilePath</a></li> <li><a id="toc-arduinoio_002eLibFiles" href="#arduinoio_002eLibFiles">9.13.3 arduinoio.LibFiles</a></li> <li><a id="toc-arduinoio_002eLibraryBase" href="#arduinoio_002eLibraryBase">9.13.4 arduinoio.LibraryBase</a></li> <li><a id="toc-arduinoio_002egetBoardConfig" href="#arduinoio_002egetBoardConfig">9.13.5 arduinoio.getBoardConfig</a></li> </ul></li> - <li><a id="toc-Matlab-Compatability-Classes-1" href="#Matlab-Compatability-Classes">9.14 Matlab Compatability Classes</a> - <ul class="no-bullet"> + <li><a id="toc-Matlab-Compatibility-Classes-1" href="#Matlab-Compatibility-Classes">9.14 Matlab Compatibility Classes</a> + <ul class="toc-numbered-mark"> <li><a id="toc-matlabshared_002eaddon_002eLibraryBase" href="#matlabshared_002eaddon_002eLibraryBase">9.14.1 matlabshared.addon.LibraryBase</a></li> </ul></li> <li><a id="toc-Sensors-1" href="#Sensors">9.15 Sensors</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-bme280" href="#bme280">9.15.1 bme280</a></li> <li><a id="toc-bno055" href="#bno055">9.15.2 bno055</a></li> <li><a id="toc-lis3dh" href="#lis3dh">9.15.3 lis3dh</a></li> @@ -326,7 +324,7 @@ Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and <li><a id="toc-si7021" href="#si7021">9.15.7 si7021</a></li> </ul></li> <li><a id="toc-Test-Functions-1" href="#Test-Functions">9.16 Test Functions</a> - <ul class="no-bullet"> + <ul class="toc-numbered-mark"> <li><a id="toc-arduino_005fbistsetup" href="#arduino_005fbistsetup">9.16.1 arduino_bistsetup</a></li> </ul></li> </ul></li> @@ -336,100 +334,100 @@ Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and </div> </div> <hr> -<div class="chapter" id="Installing-and-loading"> -<div class="header"> +<div class="chapter-level-extent" id="Installing-and-loading"> +<div class="nav-panel"> <p> Next: <a href="#Hardware-setup" accesskey="n" rel="next">Hardware setup</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Introduction</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Installing-and-loading-1"></span><h2 class="chapter">1 Installing and loading</h2> -<span id="index-Installing-and-loading"></span> +<h2 class="chapter" id="Installing-and-loading-1">1 Installing and loading</h2> +<a class="index-entry-id" id="index-Installing-and-loading"></a> <p>The Arduino toolkit must be installed and then loaded to be used. </p> -<p>It can be installed in <acronym>GNU</acronym> Octave directly from octave-forge, +<p>It can be installed in <abbr class="acronym">GNU</abbr> Octave directly from octave-forge, or can be installed in an off-line mode via a downloaded tarball. </p> <table class="cartouche" border="1"><tr><td> -<p><strong>NOTE</strong> +<p><strong class="strong">NOTE</strong> </p> -<p>The toolkit requires the <a href="https://www.arduino.cc/en/software">Arduino IDE</a> in order to program Arduino devices. +<p>The toolkit requires the <a class="url" href="https://www.arduino.cc/en/software">Arduino IDE</a> in order to program Arduino devices. </p></td></tr></table> <table class="cartouche" border="1"><tr><td> -<p><strong>NOTE</strong> +<p><strong class="strong">NOTE</strong> </p> <p>The toolkit has a dependency on the instrument-control package, so it must be installed in order to successfully install the Arduino toolkit </p></td></tr></table> -<p>The toolkit must be then be loaded once per each <acronym>GNU</acronym> Octave session in order to use its functionality. +<p>The toolkit must be then be loaded once per each <abbr class="acronym">GNU</abbr> Octave session in order to use its functionality. </p> -<ul class="section-toc"> +<ul class="mini-toc"> <li><a href="#Online-Direct-install" accesskey="1">Online Direct install</a></li> <li><a href="#Off_002dline-install" accesskey="2">Off-line install</a></li> <li><a href="#Loading" accesskey="3">Loading</a></li> </ul> -<div class="section" id="Online-Direct-install"> +<div class="section-level-extent" id="Online-Direct-install"> <h3 class="section">1.1 Online Direct install</h3> -<span id="index-Online-install"></span> +<a class="index-entry-id" id="index-Online-install"></a> <p>With an internet connection available, the Arduino package can be installed from -octave-forge using the following command within <acronym>GNU</acronym> Octave: +octave-forge using the following command within <abbr class="acronym">GNU</abbr> Octave: </p> <div class="example"> -<pre class="example">pkg install -forge arduino +<pre class="example-preformatted">pkg install -forge arduino </pre></div> <p>The latest released version of the toolkit will be downloaded and installed. </p> </div> -<div class="section" id="Off_002dline-install"> +<div class="section-level-extent" id="Off_002dline-install"> <h3 class="section">1.2 Off-line install</h3> -<span id="index-Off_002dline-install"></span> +<a class="index-entry-id" id="index-Off_002dline-install"></a> <p>With the arduino toolkit package already downloaded, and in the current directory when running -<acronym>GNU</acronym> Octave, the package can be installed using the following command within <acronym>GNU</acronym> Octave: +<abbr class="acronym">GNU</abbr> Octave, the package can be installed using the following command within <abbr class="acronym">GNU</abbr> Octave: </p> <div class="example"> -<pre class="example">pkg install arduino-0.10.0.tar.gz +<pre class="example-preformatted">pkg install arduino-0.11.0.tar.gz </pre></div> </div> -<div class="section" id="Loading"> +<div class="section-level-extent" id="Loading"> <h3 class="section">1.3 Loading</h3> -<span id="index-Loading"></span> +<a class="index-entry-id" id="index-Loading"></a> <p>Regardless of the method of installing the Arduino toolkit, in order to use its functions, the toolkit must be loaded using the pkg load command: </p> <div class="example"> -<pre class="example">pkg load arduino +<pre class="example-preformatted">pkg load arduino </pre></div> -<p>The toolkit must be loaded on each <acronym>GNU</acronym> Octave session. +<p>The toolkit must be loaded on each <abbr class="acronym">GNU</abbr> Octave session. </p> <hr> </div> </div> -<div class="chapter" id="Hardware-setup"> -<div class="header"> +<div class="chapter-level-extent" id="Hardware-setup"> +<div class="nav-panel"> <p> Next: <a href="#Connecting-to-an-arduino" accesskey="n" rel="next">Connecting to an arduino</a>, Previous: <a href="#Installing-and-loading" accesskey="p" rel="prev">Installing and loading</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Hardware-setup-1"></span><h2 class="chapter">2 Hardware setup</h2> -<span id="index-Hardware-setup"></span> +<h2 class="chapter" id="Hardware-setup-1">2 Hardware setup</h2> +<a class="index-entry-id" id="index-Hardware-setup"></a> <p>In order to use the arduino hardware with the toolkit, it must be programmed with special firmware. </p> -<ul class="section-toc"> +<ul class="mini-toc"> <li><a href="#Programming-the-Arduino" accesskey="1">Programming the Arduino</a></li> <li><a href="#Known-Arduino-Board-Types" accesskey="2">Known Arduino Board Types</a></li> </ul> -<div class="section" id="Programming-the-Arduino"> +<div class="section-level-extent" id="Programming-the-Arduino"> <h3 class="section">2.1 Programming the Arduino</h3> -<span id="index-Programming-the-Arduino"></span> +<a class="index-entry-id" id="index-Programming-the-Arduino"></a> <p>To program the hardware, using a default configuration, run the arduinosetup command: </p> <div class="example"> -<pre class="example">arduinosetup +<pre class="example-preformatted">arduinosetup </pre></div> <p>A temporary Arduino project will be created, with the Arduino toolkit files copied to it and the Arduino IDE will open. @@ -441,16 +439,16 @@ special firmware. <p>After successful upload the Arduino IDE should be closed. </p> <table class="cartouche" border="1"><tr><td> -<p><strong>NOTE</strong> +<p><strong class="strong">NOTE</strong> </p> <p>The arduino programming is not compatible with the Matlab arduino library, so must be programmed by the Octave Arduino toolkit to communicate to the arduino, even if it was previously used to work with Matlab. </p></td></tr></table> <table class="cartouche" border="1"><tr><td> -<p><strong>NOTE</strong> +<p><strong class="strong">NOTE</strong> </p> -<p>The toolkit requires the <a href="https://www.arduino.cc/en/software">Arduino IDE</a> in order to program the Arduino device. +<p>The toolkit requires the <a class="url" href="https://www.arduino.cc/en/software">Arduino IDE</a> in order to program the Arduino device. </p> <p>The binary can set using the ’arduinobinary’ property when running setup. </p> @@ -459,37 +457,39 @@ the Arduino. Otherwise, use the ’arduino’ binary property. </p></td></tr></table> </div> -<div class="section" id="Known-Arduino-Board-Types"> +<div class="section-level-extent" id="Known-Arduino-Board-Types"> <h3 class="section">2.2 Known Arduino Board Types</h3> -<span id="index-Known-Arduino-Board-Types"></span> +<a class="index-entry-id" id="index-Known-Arduino-Board-Types"></a> <p>The board type must be known in order to successfully detect and connect to the Arduino board after programming. </p> <p>Currently, known boards are: -</p><ul> -<li> Arduino Due -</li><li> Arduino UNO -</li><li> Arduino Mega 2560 -</li><li> Arduino Nano -</li><li> Arduino Nano Every -</li><li> Arduino Nano 33 BLE -</li><li> Arduino Nano RP2040 Connect -</li><li> Arduino Pro/Pro Mini -</li><li> Arduino Pro Micro -</li><li> Arduino Leonardo -</li><li> Arduino Micro -</li><li> Arduino MKR1000 -</li><li> Arduino MKRZero -</li><li> Sparkfun SAMD21 -</li><li> Arduino Lilypad -</li><li> Arduino UNO WiFi rev2 +</p><ul class="itemize mark-bullet"> +<li>Arduino Due +</li><li>Arduino UNO +</li><li>Arduino Mega 2560 +</li><li>Arduino Nano +</li><li>Arduino Nano Every +</li><li>Arduino Nano 33 BLE +</li><li>Arduino Nano RP2040 Connect +</li><li>Arduino Pro/Pro Mini +</li><li>Arduino Pro Micro +</li><li>Arduino Leonardo +</li><li>Arduino Micro +</li><li>Arduino MKR1000 +</li><li>Arduino MKRZero +</li><li>Sparkfun SAMD21 +</li><li>Arduino Lilypad +</li><li>Arduino UNO WiFi rev2 <table class="cartouche" border="1"><tr><td> -<p><strong>NOTE</strong> +<p><strong class="strong">NOTE</strong> </p> <p>The Arduino servo library code may require modifications to eliminate conflicts between servos and the tone library </p></td></tr></table> -</li><li> Raspberry Pi Pico -</li><li> EPS32 Dev +</li><li>Arduino UNO WiFi r4 +</li><li>Arduino UNO Minima r4 +</li><li>Raspberry Pi Pico +</li><li>EPS32 Dev </li></ul> <p>Additional boards can be added easily, however require minor code changes. @@ -497,58 +497,58 @@ the Arduino. Otherwise, use the ’arduino’ binary property. <hr> </div> </div> -<div class="chapter" id="Connecting-to-an-arduino"> -<div class="header"> +<div class="chapter-level-extent" id="Connecting-to-an-arduino"> +<div class="nav-panel"> <p> Next: <a href="#Basic-Input-and-Output-Overview" accesskey="n" rel="next">Basic Input and Output Overview</a>, Previous: <a href="#Hardware-setup" accesskey="p" rel="prev">Hardware setup</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Connecting-to-an-arduino-1"></span><h2 class="chapter">3 Connecting to an arduino</h2> -<span id="index-Connecting-to-an-arduino"></span> +<h2 class="chapter" id="Connecting-to-an-arduino-1">3 Connecting to an arduino</h2> +<a class="index-entry-id" id="index-Connecting-to-an-arduino"></a> <p>To control an arduino device, a connection must be made to it by creating an arduino object. </p> -<ul class="section-toc"> +<ul class="mini-toc"> <li><a href="#Connecting-to-a-single-arduino" accesskey="1">Connecting to a single arduino</a></li> <li><a href="#Connecting-to-a-specific-arduino" accesskey="2">Connecting to a specific arduino</a></li> <li><a href="#Querying-available-arduinos" accesskey="3">Querying available arduinos</a></li> </ul> -<div class="section" id="Connecting-to-a-single-arduino"> +<div class="section-level-extent" id="Connecting-to-a-single-arduino"> <h3 class="section">3.1 Connecting to a single arduino</h3> -<span id="index-Connecting-to-a-single-arduino"></span> +<a class="index-entry-id" id="index-Connecting-to-a-single-arduino"></a> <p>Assuming a single arduino device is connected to the computer, creating an arduino object with no arguments will find the connected arduino and connect to it: </p> <div class="example"> -<pre class="example">ar = arduino() +<pre class="example-preformatted">ar = arduino() </pre></div> </div> -<div class="section" id="Connecting-to-a-specific-arduino"> +<div class="section-level-extent" id="Connecting-to-a-specific-arduino"> <h3 class="section">3.2 Connecting to a specific arduino</h3> -<span id="index-Connecting-to-a-specific-arduino"></span> +<a class="index-entry-id" id="index-Connecting-to-a-specific-arduino"></a> <p>Where multiple arduinos may be connected to the computer, a specific board can be connected by specifying the name of the port it is connected to: </p> <div class="example"> -<pre class="example">ar = arduino("/dev/ttyACM0") +<pre class="example-preformatted">ar = arduino("/dev/ttyACM0") </pre></div> <p>The port name will be operating system dependent. </p> </div> -<div class="section" id="Querying-available-arduinos"> +<div class="section-level-extent" id="Querying-available-arduinos"> <h3 class="section">3.3 Querying available arduinos</h3> -<span id="index-Querying-available-arduinos"></span> -<p>To list the ports of all <em>programmed</em> available arduinos, the scanForArduinos function can be used: +<a class="index-entry-id" id="index-Querying-available-arduinos"></a> +<p>To list the ports of all <em class="emph">programmed</em> available arduinos, the scanForArduinos function can be used: </p> <div class="example"> -<pre class="example">scanForArduinos +<pre class="example-preformatted">scanForArduinos </pre></div> <p>It will provide a list of all available boards it can find with the port they are connected to. </p> <table class="cartouche" border="1"><tr><td> -<p><strong>NOTE</strong> +<p><strong class="strong">NOTE</strong> </p> <p>The scanForArduinos function will only detect boards that have been programmed using the arduinosetup command </p></td></tr></table> @@ -556,13 +556,13 @@ specifying the name of the port it is connected to: <hr> </div> </div> -<div class="chapter" id="Basic-Input-and-Output-Overview"> -<div class="header"> +<div class="chapter-level-extent" id="Basic-Input-and-Output-Overview"> +<div class="nav-panel"> <p> Next: <a href="#Protocol-based-I_002fO-Overview" accesskey="n" rel="next">Protocol based I/O Overview</a>, Previous: <a href="#Connecting-to-an-arduino" accesskey="p" rel="prev">Connecting to an arduino</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Basic-Input-and-Output-Overview-1"></span><h2 class="chapter">4 Basic Input and Output Overview</h2> -<span id="index-Basic-Input-and-Output-Overview"></span> +<h2 class="chapter" id="Basic-Input-and-Output-Overview-1">4 Basic Input and Output Overview</h2> +<a class="index-entry-id" id="index-Basic-Input-and-Output-Overview"></a> <p>Basic input and output can be performed on a connected arduino device using by calling the read and write functions for a specific named pin on the arduino. @@ -571,7 +571,7 @@ for a specific named pin on the arduino. as part of the default shown properties: </p> <div class="example"> -<pre class="example">ar = arduino(); +<pre class="example-preformatted">ar = arduino(); % get the pin names pins = ar.availablepins </pre></div> @@ -581,13 +581,13 @@ pins = ar.availablepins <p>Digital pins can be used to read and write digital data, but can not read analog voltages. Analog pins can perform digital I/O as well as reading voltages. </p> -<ul class="section-toc"> +<ul class="mini-toc"> <li><a href="#Performing-Digital-I_002fO" accesskey="1">Performing Digital I/O</a></li> <li><a href="#Performing-Analog-Input" accesskey="2">Performing Analog Input</a></li> </ul> -<div class="section" id="Performing-Digital-I_002fO"> +<div class="section-level-extent" id="Performing-Digital-I_002fO"> <h3 class="section">4.1 Performing Digital I/O</h3> -<span id="index-Performing-Digital-I_002fO"></span> +<a class="index-entry-id" id="index-Performing-Digital-I_002fO"></a> <p>A pin’s digital logic value can be true (1) or false (0) and can be set using the writeDigitalPin function. </p> @@ -595,7 +595,7 @@ Analog pins can perform digital I/O as well as reading voltages. then sets it to false: </p> <div class="example"> -<pre class="example">writeDigitalPin (ar, "d2", true); +<pre class="example-preformatted">writeDigitalPin (ar, "d2", true); pause 5 writeDigitalPin (ar, "d2", false); </pre></div> @@ -604,19 +604,19 @@ writeDigitalPin (ar, "d2", false); <p>Using the readDigitalPin will read the current logic state of the pin. </p> <div class="example"> -<pre class="example">value = readDigitalPin (ar, "d2"); +<pre class="example-preformatted">value = readDigitalPin (ar, "d2"); </pre></div> </div> -<div class="section" id="Performing-Analog-Input"> +<div class="section-level-extent" id="Performing-Analog-Input"> <h3 class="section">4.2 Performing Analog Input</h3> -<span id="index-Performing-Analog-Input"></span> +<a class="index-entry-id" id="index-Performing-Analog-Input"></a> <p>For analog pins, the voltage level can be read using a analog to digital conversion and will return a voltage level between 0 and the boards voltage (nominally 5V): </p> <div class="example"> -<pre class="example">value = readVoltage (ar, "a0"); +<pre class="example-preformatted">value = readVoltage (ar, "a0"); </pre></div> @@ -624,24 +624,24 @@ between 0 and the boards voltage (nominally 5V): the number of bits used by the analog to digital converter. </p> <div class="example"> -<pre class="example">value = readAnalogPin (ar, "a0"); +<pre class="example-preformatted">value = readAnalogPin (ar, "a0"); </pre></div> <hr> </div> </div> -<div class="chapter" id="Protocol-based-I_002fO-Overview"> -<div class="header"> +<div class="chapter-level-extent" id="Protocol-based-I_002fO-Overview"> +<div class="nav-panel"> <p> Next: <a href="#Addons-Overview" accesskey="n" rel="next">Addons Overview</a>, Previous: <a href="#Basic-Input-and-Output-Overview" accesskey="p" rel="prev">Basic Input and Output Overview</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Protocol-based-I_002fO-Overview-1"></span><h2 class="chapter">5 Protocol based I/O Overview</h2> -<span id="index-Protocol-based-I_002fO-Overview"></span> +<h2 class="chapter" id="Protocol-based-I_002fO-Overview-1">5 Protocol based I/O Overview</h2> +<a class="index-entry-id" id="index-Protocol-based-I_002fO-Overview"></a> <p>The arduino toolkit supports more complex I/O for SPI, I2C, Servo control and more. </p> -<ul class="section-toc"> +<ul class="mini-toc"> <li><a href="#SPI-communication" accesskey="1">SPI communication</a></li> <li><a href="#I2C-communication" accesskey="2">I2C communication</a></li> <li><a href="#Servo-communication" accesskey="3">Servo communication</a></li> @@ -650,14 +650,14 @@ Next: <a href="#Addons-Overview" accesskey="n" rel="next">Addons Overview</a>, P <li><a href="#Ultrasonic-Sensors" accesskey="6">Ultrasonic Sensors</a></li> <li><a href="#Serial-communication" accesskey="7">Serial communication</a></li> </ul> -<div class="section" id="SPI-communication"> +<div class="section-level-extent" id="SPI-communication"> <h3 class="section">5.1 SPI communication</h3> -<span id="index-SPI-communication"></span> +<a class="index-entry-id" id="index-SPI-communication"></a> <p>SPI communication can be performed by creating a SPI device object and then calling the writeRead function: </p> <div class="example"> -<pre class="example">spi = device (ar, "spichipselectpin", "d2"); +<pre class="example-preformatted">spi = device (ar, "spichipselectpin", "d2"); </pre></div> <p>The function call expects a connected arduino object as the first argument, followed by the chip select pin of the SPI device. @@ -665,35 +665,35 @@ Next: <a href="#Addons-Overview" accesskey="n" rel="next">Addons Overview</a>, P <p>After a device is created, a write to device followed by read can can be made using the writeRead function: </p> <div class="example"> -<pre class="example">spi = device (ar, "spichipselectpin", "d2"); +<pre class="example-preformatted">spi = device (ar, "spichipselectpin", "d2"); data = writeRead (spi, 100); </pre></div> </div> -<div class="section" id="I2C-communication"> +<div class="section-level-extent" id="I2C-communication"> <h3 class="section">5.2 I2C communication</h3> -<span id="index-I2C-communication"></span> +<a class="index-entry-id" id="index-I2C-communication"></a> <p>I2C communication can be performed by creating an I2C device object for a specific I2C address. </p> <p>The following example creates an I2C device that will communicate with a I2C device at address 100" </p><div class="example"> -<pre class="example">i2c = device (ar, "i2caddress", 100); +<pre class="example-preformatted">i2c = device (ar, "i2caddress", 100); </pre></div> <p>After creating an I2C device, data can be read and written using read, write, readRegister and writeRegister. The data to send and receive will be device dependent. </p> </div> -<div class="section" id="Servo-communication"> +<div class="section-level-extent" id="Servo-communication"> <h3 class="section">5.3 Servo communication</h3> -<span id="index-Servo-communication"></span> +<a class="index-entry-id" id="index-Servo-communication"></a> <p>Servo communication can be performed after creating a servo device object to operate on a PWM pin: </p> <div class="example"> -<pre class="example">servoobj = servo(ar, "d9", "minpulseduration", 1.0e-3, ... +<pre class="example-preformatted">servoobj = servo(ar, "d9", "minpulseduration", 1.0e-3, ... "maxpulseduration", 2e-3); </pre></div> @@ -709,7 +709,7 @@ pulse width and 1 being the maximum. <p>The following example sets the servo to its middle position. </p> <div class="example"> -<pre class="example">servoobj = servo(ar, "d9", "minpulseduration", 1.0e-3, ... +<pre class="example-preformatted">servoobj = servo(ar, "d9", "minpulseduration", 1.0e-3, ... "maxpulseduration", 2e-3); writePosition (servoobj, 0.5); @@ -717,14 +717,14 @@ writePosition (servoobj, 0.5); </div> -<div class="section" id="Shift-Registers"> +<div class="section-level-extent" id="Shift-Registers"> <h3 class="section">5.4 Shift Registers</h3> -<span id="index-Shift-Registers"></span> +<a class="index-entry-id" id="index-Shift-Registers"></a> <p>A shift register can be controlled by creating a shiftRegister object: </p> <div class="example"> -<pre class="example">registerobj = shiftRegister(ar, '74hc164', "d2", "d3"); +<pre class="example-preformatted">registerobj = shiftRegister(ar, '74hc164', "d2", "d3"); </pre></div> <p>The parameters required are dependent on the type of shift register created. @@ -732,35 +732,35 @@ writePosition (servoobj, 0.5); <p>Once a register object has been created, it can be read and written to using the read and write functions. </p> </div> -<div class="section" id="Rotary-Encoders"> +<div class="section-level-extent" id="Rotary-Encoders"> <h3 class="section">5.5 Rotary Encoders</h3> -<span id="index-Rotary-Encoder"></span> +<a class="index-entry-id" id="index-Rotary-Encoder"></a> <p>A rotary encoder can be created by creating a rotaryEncoder object. </p> <div class="example"> -<pre class="example">encoder = rotaryEncoder(ar, "d2", "d3", 180); +<pre class="example-preformatted">encoder = rotaryEncoder(ar, "d2", "d3", 180); </pre></div> <p>Using the created object, the rotary encoder value and speed can be read. </p> </div> -<div class="section" id="Ultrasonic-Sensors"> +<div class="section-level-extent" id="Ultrasonic-Sensors"> <h3 class="section">5.6 Ultrasonic Sensors</h3> -<span id="index-Ultrasonic-Sensors"></span> +<a class="index-entry-id" id="index-Ultrasonic-Sensors"></a> <p>An ultrasonic sensor can be read by creating an ultrasonic object. </p> <div class="example"> -<pre class="example">sensor = ultrasonic(ar, "d9", "d10"); +<pre class="example-preformatted">sensor = ultrasonic(ar, "d9", "d10"); </pre></div> <p>Using the created object, the sensor distance and echo time and be read. </p> </div> -<div class="section" id="Serial-communication"> +<div class="section-level-extent" id="Serial-communication"> <h3 class="section">5.7 Serial communication</h3> -<span id="index-Serial-communication"></span> +<a class="index-entry-id" id="index-Serial-communication"></a> <p>Serial communication can be performed on devices that support multiple serial devices such as the leonardo and mega2560 boards. The communications port to Octave is reserved and can not be used as a user controlled communications port. @@ -769,7 +769,7 @@ The communications port to Octave is reserved and can not be used as a user cont <p>Serial communication can be performed by creating a serial device object and then calling the read and write functions: </p> <div class="example"> -<pre class="example">ser = device (ar, "serial", 1); +<pre class="example-preformatted">ser = device (ar, "serial", 1); </pre></div> <p>The function call expects a connected arduino object as the first argument, followed "serial" and serial id. @@ -777,7 +777,7 @@ The communications port to Octave is reserved and can not be used as a user cont <p>After a device is created, the device can be read and written: </p> <div class="example"> -<pre class="example">ser = device (ar, "serial", 1); +<pre class="example-preformatted">ser = device (ar, "serial", 1); write(ser, "hello"); data = read(ser, 100); </pre></div> @@ -785,31 +785,31 @@ data = read(ser, 100); <hr> </div> </div> -<div class="chapter" id="Addons-Overview"> -<div class="header"> +<div class="chapter-level-extent" id="Addons-Overview"> +<div class="nav-panel"> <p> Next: <a href="#Sensors-Overview" accesskey="n" rel="next">Sensors Overview</a>, Previous: <a href="#Protocol-based-I_002fO-Overview" accesskey="p" rel="prev">Protocol based I/O Overview</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Addons-Overview-1"></span><h2 class="chapter">6 Addons Overview</h2> -<span id="index-Addons-Overview"></span> +<h2 class="chapter" id="Addons-Overview-1">6 Addons Overview</h2> +<a class="index-entry-id" id="index-Addons-Overview"></a> <p>This chapter provides an overview of the arduino package addon functionality for adding additional addons to arduino. </p> -<ul class="section-toc"> +<ul class="mini-toc"> <li><a href="#Addon-Introduction" accesskey="1">Addon Introduction</a></li> <li><a href="#Creating-an-addon" accesskey="2">Creating an addon</a></li> <li><a href="#Using-addons" accesskey="3">Using addons</a></li> </ul> -<div class="section" id="Addon-Introduction"> +<div class="section-level-extent" id="Addon-Introduction"> <h3 class="section">6.1 Addon Introduction</h3> -<span id="index-Addon-Introduction"></span> +<a class="index-entry-id" id="index-Addon-Introduction"></a> <p>Addons provide a way of adding additional functionality to the arduino toolkit that provides Matlab access directly to the arduino hardware. </p> <p>Addons are implemented in two parts. -</p><ol> +</p><ol class="enumerate"> <li> code running on the arduino that implements the required functionality </li><li> a octave wrapper class that provides the Matlab interface and communication to the code. </li></ol> @@ -820,7 +820,7 @@ that provides Matlab access directly to the arduino hardware. the following command: </p> <div class="example"> -<pre class="example"><code> +<pre class="example-preformatted"><code class="code"> listArduinoLibraries </code> </pre></div> @@ -829,15 +829,15 @@ listArduinoLibraries addons typically use a "foldername/classname" for this naming. </p> -<p><strong>See also:</strong> listArduinoLibraries. +<p><strong class="strong">See also:</strong> listArduinoLibraries. </p> </div> -<div class="section" id="Creating-an-addon"> +<div class="section-level-extent" id="Creating-an-addon"> <h3 class="section">6.2 Creating an addon</h3> -<span id="index-Creating-an-addon"></span> +<a class="index-entry-id" id="index-Creating-an-addon"></a> <p>An addon requires at minimum 3 things: -</p><ol> +</p><ol class="enumerate"> <li> A addon package directory that will contain the addon files </li><li> A Matlab file within that directory that is a subclass of arduinoio.LibraryBase </li><li> A arduino source/header file that contains the arduino code to load, sub-classed for LibraryBase @@ -845,7 +845,7 @@ addons typically use a "foldername/classname" for this naming. <p>So the addon directory structure at a minimum will be: </p><div class="example"> -<pre class="example"><code> +<pre class="example-preformatted"><code class="code"> +arduinoioaddons (dir) [somewhere in the octave load path] +MyAddons (dir) MyAddon1.m @@ -853,15 +853,15 @@ addons typically use a "foldername/classname" for this naming. </code> </pre></div> -<ul class="section-toc"> +<ul class="mini-toc"> <li><a href="#Addon-package-directory" accesskey="1">Addon package directory</a></li> <li><a href="#Addon-package-_002em-file" accesskey="2">Addon package .m file</a></li> <li><a href="#Addon-package-header-file" accesskey="3">Addon package header file</a></li> <li><a href="#Verify-octave-can-see-the-addon" accesskey="4">Verify octave can see the addon</a></li> </ul> -<div class="subsection" id="Addon-package-directory"> +<div class="subsection-level-extent" id="Addon-package-directory"> <h4 class="subsection">6.2.1 Addon package directory</h4> -<span id="index-Addon-package-directory"></span> +<a class="index-entry-id" id="index-Addon-package-directory"></a> <p>The addon architecture looks for plugins in the octave load path in a package directory called +arduinoioaddons @@ -875,19 +875,19 @@ the +arduinoioaddons folder. The subdirectory must begin with a ’+’. <p>Multiple plugin .m files can be within the same sub directory. </p> </div> -<div class="subsection" id="Addon-package-_002em-file"> +<div class="subsection-level-extent" id="Addon-package-_002em-file"> <h4 class="subsection">6.2.2 Addon package .m file</h4> -<span id="index-Addon-package-_002em-file"></span> +<a class="index-entry-id" id="index-Addon-package-_002em-file"></a> <p>The Matlab interface file within the addon directory provides the Matlab interface for the arduino code as well as provides information about the addon. </p> -<span id="Class-inheritance-and-required-properties"></span><h4 class="subsubheading">Class inheritance and required properties</h4> +<h4 class="subsubheading" id="Class-inheritance-and-required-properties">Class inheritance and required properties</h4> <p>The interface file must be a subclass of arduinoio.LibraryBase and must contain some constant properties values that provide the information. </p> <p>A minimum example of required is below: </p><div class="example"> -<pre class="example"><code> +<pre class="example-preformatted"><code class="code"> classdef MyAddon1 < arduinoio.LibraryBase properties(Access = protected, Constant = true) LibraryName = 'MyAddons/MyAddon1'; @@ -902,33 +902,33 @@ endclassdef </pre></div> <p>The following constant properties can be set within the addon: -</p><dl compact="compact"> -<dt><span>LibraryName</span></dt> +</p><dl class="table"> +<dt>LibraryName</dt> <dd><p>(Required) The name of the addon. My convention this is usually the directoryname / theclassname </p></dd> -<dt><span>CppHeaderFile</span></dt> +<dt>CppHeaderFile</dt> <dd><p>(Required) The header file for the arduino code </p></dd> -<dt><span>CppSourceFile</span></dt> +<dt>CppSourceFile</dt> <dd><p>(Optional) The source file (if any) for the arduino code </p></dd> -<dt><span>CppClassName</span></dt> +<dt>CppClassName</dt> <dd><p>(Required) The classname used within the cppheaderfile for the arduino library </p></dd> -<dt><span>DependantLibraries</span></dt> +<dt>DependantLibraries</dt> <dd><p>(Optional) Any additional addons or cores that are needed for this library to be used </p></dd> -<dt><span>ArduinoLibraryHeaderFiles</span></dt> +<dt>ArduinoLibraryHeaderFiles</dt> <dd><p>(Optional) Any additional header files that need to be included </p></dd> </dl> -<span id="Class-constructor"></span><h4 class="subsubheading">Class constructor</h4> +<h4 class="subsubheading" id="Class-constructor">Class constructor</h4> <p>The Matlab class constructor will be called from the addon function when creating a instance of the addon and should initialize at least two properties in inherited from arduinoio.LibraryBase: </p> -<ol> +<ol class="enumerate"> <li> Parent should be set to the first input argument (the arduino class) </li><li> Pins @@ -936,7 +936,7 @@ should be set to a list of pins that are used for the plugin </li></ol> <div class="example"> -<pre class="example"><code> +<pre class="example-preformatted"><code class="code"> classdef MyAddon1 < arduinoio.LibraryBase . . @@ -954,14 +954,14 @@ endclassdef </code> </pre></div> -<span id="Class-functions"></span><h4 class="subsubheading">Class functions</h4> +<h4 class="subsubheading" id="Class-functions">Class functions</h4> <p>The class functions will usually communicate to the arduino and use the response for what is returned to the user. </p> <p>By convention, the commands sent to the arduino are defined as constants in the class file but do not have to be. </p><div class="example"> -<pre class="example"><code> +<pre class="example-preformatted"><code class="code"> classdef MyAddon1 < arduinoio.LibraryBase properties(Access = private, Constant = true) INIT_COMMAND = hex2dec('00'); @@ -990,24 +990,24 @@ endclassdef </pre></div> <table class="cartouche" border="1"><tr><td> -<p><strong>NOTE</strong> +<p><strong class="strong">NOTE</strong> </p> <p>the sendCommand uses the objects parent for the arduino, the objects library name and the command id </p></td></tr></table> -<p><strong>See also:</strong> sendCommand. +<p><strong class="strong">See also:</strong> sendCommand. </p> </div> -<div class="subsection" id="Addon-package-header-file"> +<div class="subsection-level-extent" id="Addon-package-header-file"> <h4 class="subsection">6.2.3 Addon package header file</h4> -<span id="index-Addon-package-header-file"></span> +<a class="index-entry-id" id="index-Addon-package-header-file"></a> <p>The header file should contain a class that matches the functionally and information of the matlab file and provides the ability to register the code on the arduino. </p> <p>The following things should occur in the arduino class files: -</p><ol> +</p><ol class="enumerate"> <li> The class name within the file must be the same as the one set in the .m file CppClassName property. @@ -1024,7 +1024,7 @@ CppClassName property. <p>An example, matching the previous .m file code is below: </p><div class="example"> -<pre class="example"><code> +<pre class="example-preformatted"><code class="code"> #include "LibraryBase.h" #define MYADDON1_INIT 0x00 @@ -1070,9 +1070,9 @@ public: <p>The body of functions can be in the CppSourceFile file is it is defined or within the header file as illustrated above. </p> </div> -<div class="subsection" id="Verify-octave-can-see-the-addon"> +<div class="subsection-level-extent" id="Verify-octave-can-see-the-addon"> <h4 class="subsection">6.2.4 Verify octave can see the addon</h4> -<span id="index-Verify-octave-can-see-the-addon"></span> +<a class="index-entry-id" id="index-Verify-octave-can-see-the-addon"></a> <p>Use the listArduinoLibaries command to verify that the new addon appears in the list of known libraries. </p> @@ -1081,17 +1081,17 @@ structure and inheritance requirements have been met. </p> </div> </div> -<div class="section" id="Using-addons"> +<div class="section-level-extent" id="Using-addons"> <h3 class="section">6.3 Using addons</h3> -<span id="index-Using-Addons"></span> +<a class="index-entry-id" id="index-Using-Addons"></a> -<ul class="section-toc"> +<ul class="mini-toc"> <li><a href="#Programming-the-arduino-with-the-addon" accesskey="1">Programming the arduino with the addon</a></li> <li><a href="#Creating-a-addon-object" accesskey="2">Creating a addon object</a></li> </ul> -<div class="subsection" id="Programming-the-arduino-with-the-addon"> +<div class="subsection-level-extent" id="Programming-the-arduino-with-the-addon"> <h4 class="subsection">6.3.1 Programming the arduino with the addon</h4> -<span id="index-Programming-the-arduino-with-the-addon"></span> +<a class="index-entry-id" id="index-Programming-the-arduino-with-the-addon"></a> <p>To use a addon, the code must be programmed onto the arduino. </p> @@ -1099,7 +1099,7 @@ structure and inheritance requirements have been met. exist on the arduino. </p> <div class="example"> -<pre class="example"><code> +<pre class="example-preformatted"><code class="code"> ar = arduino([],[], 'libraries', 'MyAddons/MyAddon1', 'forcebuild', true) </code> </pre></div> @@ -1109,17 +1109,17 @@ exist on the arduino. <p>Alternatively, the library can be added using the libraries property and arduinosetup </p> -<p><strong>See also:</strong> arduino, arduinosetup. +<p><strong class="strong">See also:</strong> arduino, arduinosetup. </p> </div> -<div class="subsection" id="Creating-a-addon-object"> +<div class="subsection-level-extent" id="Creating-a-addon-object"> <h4 class="subsection">6.3.2 Creating a addon object</h4> -<span id="index-Creating-a-addon-object"></span> +<a class="index-entry-id" id="index-Creating-a-addon-object"></a> <p>An object of the addon type can be created using the addon command. </p> <div class="example"> -<pre class="example"><code> +<pre class="example-preformatted"><code class="code"> ar = arduino([],[], 'libraries', 'MyAddons/MyAddon1', 'forcebuild', true) obj = addon(ar, "MyAddons/MyAddon1"); </code> @@ -1129,64 +1129,64 @@ exist on the arduino. </div> </div> </div> -<div class="chapter" id="Sensors-Overview"> -<div class="header"> +<div class="chapter-level-extent" id="Sensors-Overview"> +<div class="nav-panel"> <p> Next: <a href="#Examples" accesskey="n" rel="next">Examples</a>, Previous: <a href="#Addons-Overview" accesskey="p" rel="prev">Addons Overview</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Sensors-Overview-1"></span><h2 class="chapter">7 Sensors Overview</h2> -<span id="index-Sensors-Overview"></span> +<h2 class="chapter" id="Sensors-Overview-1">7 Sensors Overview</h2> +<a class="index-entry-id" id="index-Sensors-Overview"></a> <p>There are two types of sensors available: -</p><ol> +</p><ol class="enumerate"> <li> Matlab compatible(ish) sensors for environment and IMU. </li><li> Additional lightweight wrappers for some chips in a arduinosensor namespace. </li></ol> -<ul class="section-toc"> +<ul class="mini-toc"> <li><a href="#Matlab-Compatible-Sensors" accesskey="1">Matlab Compatible Sensors</a></li> <li><a href="#Lightweight-Arduino-Sensors" accesskey="2">Lightweight Arduino Sensors</a></li> </ul> -<div class="section" id="Matlab-Compatible-Sensors"> +<div class="section-level-extent" id="Matlab-Compatible-Sensors"> <h3 class="section">7.1 Matlab Compatible Sensors</h3> -<span id="index-Matlab-Compatible-Sensor"></span> +<a class="index-entry-id" id="index-Matlab-Compatible-Sensor"></a> -<ul class="section-toc"> +<ul class="mini-toc"> <li><a href="#Overview" accesskey="1">Overview</a></li> <li><a href="#Available-Sensors" accesskey="2">Available Sensors</a></li> </ul> -<div class="subsection" id="Overview"> +<div class="subsection-level-extent" id="Overview"> <h4 class="subsection">7.1.1 Overview</h4> <p>Matlab compatible functions are provided for a number of sensors, using a similar function naming as provided by the Matlab arduino package. </p> </div> -<div class="subsection" id="Available-Sensors"> +<div class="subsection-level-extent" id="Available-Sensors"> <h4 class="subsection">7.1.2 Available Sensors</h4> -<span id="index-Available-Sensors"></span> +<a class="index-entry-id" id="index-Available-Sensors"></a> -<p>The functions for each sensor is listed in the function reference, <a href="#Sensors">Sensors</a> and provides for: +<p>The functions for each sensor is listed in the function reference, <a class="ref" href="#Sensors">Sensors</a> and provides for: </p> -<dl compact="compact"> -<dt><span>bme280</span></dt> +<dl class="table"> +<dt>bme280</dt> <dd><p>BME280 temperature, pressure and humidity sensor </p></dd> -<dt><span>bno005</span></dt> +<dt>bno005</dt> <dd><p>BNO055 acceleration, angular velocity, orientation and magnetic field sensor </p></dd> -<dt><span>lis3dh</span></dt> +<dt>lis3dh</dt> <dd><p>LIS3DH acceleration sensor </p></dd> -<dt><span>lps22hb</span></dt> +<dt>lps22hb</dt> <dd><p>LPS22HB temperature and pressure sensor </p></dd> -<dt><span>lsm6dso</span></dt> +<dt>lsm6dso</dt> <dd><p>LSM6DSO acceleration, angular velocity sensor </p></dd> -<dt><span>mpu6050</span></dt> +<dt>mpu6050</dt> <dd><p>MPU-6050 acceleration, angular velocity sensor </p></dd> -<dt><span>SI7021</span></dt> +<dt>SI7021</dt> <dd><p>SI7021 temperature and humidity sensor </p></dd> </dl> @@ -1194,15 +1194,15 @@ provided by the Matlab arduino package. </div> </div> -<div class="section" id="Lightweight-Arduino-Sensors"> +<div class="section-level-extent" id="Lightweight-Arduino-Sensors"> <h3 class="section">7.2 Lightweight Arduino Sensors</h3> -<span id="index-Arduino-Sensor"></span> +<a class="index-entry-id" id="index-Arduino-Sensor"></a> -<ul class="section-toc"> +<ul class="mini-toc"> <li><a href="#Overview-1" accesskey="1">Overview</a></li> <li><a href="#Available-Sensors-1" accesskey="2">Available Sensors</a></li> </ul> -<div class="subsection" id="Overview-1"> +<div class="subsection-level-extent" id="Overview-1"> <h4 class="subsection">7.2.1 Overview</h4> <p>Arduino sensors are a collection of lightweight wrappers around other underlying protocols for providing specific sensor functionality. @@ -1212,7 +1212,7 @@ provides the conversion/commands in order to communicate to the chip. </p> <p>Using the class, providing the functionality is very easy: </p><div class="example"> -<pre class="example"><code> +<pre class="example-preformatted"><code class="code"> a = arduino() rtc = arduinosensor.DS1307(a) # get and display rtc time as a date string @@ -1226,23 +1226,23 @@ however it is limited to then using available addon and core codes rather than c <p>Currently the are only a small number of sensors available, however this will be built upon in future versions. </p> </div> -<div class="subsection" id="Available-Sensors-1"> +<div class="subsection-level-extent" id="Available-Sensors-1"> <h4 class="subsection">7.2.2 Available Sensors</h4> -<span id="index-Available-Sensors-1"></span> +<a class="index-entry-id" id="index-Available-Sensors-1"></a> -<p>The functions for each sensor is listed in the function reference, <a href="#Arduino-Sensors">Arduino Sensors</a> and provides for: +<p>The functions for each sensor is listed in the function reference, <a class="ref" href="#Arduino-Sensors">Arduino Sensors</a> and provides for: </p> -<dl compact="compact"> -<dt><span>DS1307</span></dt> +<dl class="table"> +<dt>DS1307</dt> <dd><p>DS1307 RTC clock using i2c. </p></dd> -<dt><span>MPC3002</span></dt> +<dt>MPC3002</dt> <dd><p>MPC3002 ADC using SPI </p></dd> -<dt><span>SI7021</span></dt> +<dt>SI7021</dt> <dd><p>SI7021 temperature and humidity sensor </p></dd> -<dt><span>GUVAS12SD</span></dt> +<dt>GUVAS12SD</dt> <dd><p>GUVAS12SD analog UV-B sensor </p></dd> </dl> @@ -1251,53 +1251,53 @@ however it is limited to then using available addon and core codes rather than c </div> </div> </div> -<div class="chapter" id="Examples"> -<div class="header"> +<div class="chapter-level-extent" id="Examples"> +<div class="nav-panel"> <p> Next: <a href="#Function-Reference" accesskey="n" rel="next">Function Reference</a>, Previous: <a href="#Sensors-Overview" accesskey="p" rel="prev">Sensors Overview</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Examples-1"></span><h2 class="chapter">8 Examples</h2> -<span id="index-Examples"></span> +<h2 class="chapter" id="Examples-1">8 Examples</h2> +<a class="index-entry-id" id="index-Examples"></a> -<ul class="section-toc"> +<ul class="mini-toc"> <li><a href="#Blinking-an-LED" accesskey="1">Blinking an LED</a></li> <li><a href="#Using-I2C-to-communicate-with-an-EEPROM" accesskey="2">Using I2C to communicate with an EEPROM</a></li> <li><a href="#Using-SPI-to-communicate-with-a-mcp3002-10-bit-ADC" accesskey="3">Using SPI to communicate with a mcp3002 10 bit ADC</a></li> </ul> -<div class="section" id="Blinking-an-LED"> +<div class="section-level-extent" id="Blinking-an-LED"> <h3 class="section">8.1 Blinking an LED</h3> -<span id="index-Blinking-an-LED"></span> +<a class="index-entry-id" id="index-Blinking-an-LED"></a> <p>This example shows blinking the inbuilt LED on the Arduino board. Code is available by running: </p><div class="example"> -<pre class="example">edit examples/example_blink +<pre class="example-preformatted">edit examples/example_blink </pre></div> -<span id="Hardware-setup-2"></span><h3 class="heading">Hardware setup</h3> +<h3 class="heading" id="Hardware-setup-2">Hardware setup</h3> <p>This example uses in the builtin LED, so requires only a connection of the Arduino board to computer for communication. </p> -<span id="Create-an-Arduino-object"></span><h3 class="heading">Create an Arduino object</h3> +<h3 class="heading" id="Create-an-Arduino-object">Create an Arduino object</h3> <div class="example"> -<pre class="example">ar = arduino (); +<pre class="example-preformatted">ar = arduino (); </pre></div> <p>If you have more than one Arduino board connected, you may need to specify the port in order to connect to the correct device. </p> -<span id="Query-Device-for-pins-connected-to-builtin-LED"></span><h3 class="heading">Query Device for pins connected to builtin LED</h3> +<h3 class="heading" id="Query-Device-for-pins-connected-to-builtin-LED">Query Device for pins connected to builtin LED</h3> <p>The pin connected to the Arduino UNO built in led if D13. </p> <div class="example"> -<pre class="example">led_pin = "d13"; +<pre class="example-preformatted">led_pin = "d13"; </pre></div> <p>The connected pins can be queried programatically if desired. </p> <div class="example"> -<pre class="example">pins = getLEDTerminals (ar); +<pre class="example-preformatted">pins = getLEDTerminals (ar); </pre></div> <p>Connected to a Arduino UNO would return a list pins containing only one item ’13’. @@ -1305,32 +1305,32 @@ connect to the correct device. <p>The terminal number can be converted to a pin using getPinsFromTerminals: </p> <div class="example"> -<pre class="example">led_pin = getPinsFromTerminals (ar, pins{1}); +<pre class="example-preformatted">led_pin = getPinsFromTerminals (ar, pins{1}); </pre></div> -<span id="Turn-the-LED-off"></span><h3 class="heading">Turn the LED off</h3> +<h3 class="heading" id="Turn-the-LED-off">Turn the LED off</h3> <p>Write a 0 value to the pin to turn it off. </p> <div class="example"> -<pre class="example">writeDigitalPin (ar, led_pin, 0); +<pre class="example-preformatted">writeDigitalPin (ar, led_pin, 0); </pre></div> -<span id="Turn-the-LED-on"></span><h3 class="heading">Turn the LED on</h3> +<h3 class="heading" id="Turn-the-LED-on">Turn the LED on</h3> <p>Write a 1 value to the pin to turn it on </p> <div class="example"> -<pre class="example">writeDigitalPin (ar, led_pin, 1); +<pre class="example-preformatted">writeDigitalPin (ar, led_pin, 1); </pre></div> -<span id="Making-the-LED-blink"></span><h3 class="heading">Making the LED blink</h3> +<h3 class="heading" id="Making-the-LED-blink">Making the LED blink</h3> <p>Add a while loop with a pause between the changes in the pin state to blink. </p> <div class="example"> -<pre class="example">while true +<pre class="example-preformatted">while true writeDigitalPin (ar, led_pin, 0); pause (0.5) writeDigitalPin (ar, led_pin, 1); @@ -1339,146 +1339,146 @@ endwhile </pre></div> </div> -<div class="section" id="Using-I2C-to-communicate-with-an-EEPROM"> +<div class="section-level-extent" id="Using-I2C-to-communicate-with-an-EEPROM"> <h3 class="section">8.2 Using I2C to communicate with an EEPROM</h3> -<span id="index-Using-I2C-to-communicate-with-an-EEPROM"></span> +<a class="index-entry-id" id="index-Using-I2C-to-communicate-with-an-EEPROM"></a> <p>This example shows using I2C to communicate with a EEPROM chip. Code is available by running: </p><div class="example"> -<pre class="example">edit examples/example_i2c_eeprom +<pre class="example-preformatted">edit examples/example_i2c_eeprom </pre></div> -<span id="Hardware-setup-3"></span><h3 class="heading">Hardware setup</h3> +<h3 class="heading" id="Hardware-setup-3">Hardware setup</h3> <p>Using an Arduino UNO, the board should be configured with the following connections between the board and a 24XX256 EEPROM chip: </p> -<dl compact="compact"> -<dt><span>A4</span></dt> +<dl class="table"> +<dt>A4</dt> <dd><p>Connected to pin 5 of EEPROM </p></dd> -<dt><span>A5</span></dt> +<dt>A5</dt> <dd><p>Connected to pin 6 of EEPROM </p></dd> -<dt><span>5V</span></dt> +<dt>5V</dt> <dd><p>Connected to pin 8 of EEPROM </p></dd> -<dt><span>GND</span></dt> +<dt>GND</dt> <dd><p>Connected to pin 1,2,3,4 of EEPROM </p></dd> </dl> -<span id="Create-an-Arduino-object-1"></span><h3 class="heading">Create an Arduino object</h3> +<h3 class="heading" id="Create-an-Arduino-object-1">Create an Arduino object</h3> <div class="example"> -<pre class="example">ar = arduino (); +<pre class="example-preformatted">ar = arduino (); </pre></div> <p>If you have more than one Arduino board connected, you may need to specify the port in order to connect to the correct device. </p> -<span id="Query-I2C-pins"></span><h3 class="heading">Query I2C pins</h3> +<h3 class="heading" id="Query-I2C-pins">Query I2C pins</h3> <p>Display the I2C terminals of the board: </p> <div class="example"> -<pre class="example">getI2CTerminals(ar) +<pre class="example-preformatted">getI2CTerminals(ar) </pre></div> -<span id="Scan-the-arduino-for-the-connected-device"></span><h3 class="heading">Scan the arduino for the connected device</h3> +<h3 class="heading" id="Scan-the-arduino-for-the-connected-device">Scan the arduino for the connected device</h3> <div class="example"> -<pre class="example">scanI2Cbus(ar) +<pre class="example-preformatted">scanI2Cbus(ar) </pre></div> <p>The devices listed should contain 0x50, the address of the EEPROM chip. </p> -<span id="Create-an-I2C-object-to-communicate-to-the-EEPROM"></span><h3 class="heading">Create an I2C object to communicate to the EEPROM</h3> +<h3 class="heading" id="Create-an-I2C-object-to-communicate-to-the-EEPROM">Create an I2C object to communicate to the EEPROM</h3> <div class="example"> -<pre class="example">eeprom = device (ar, "i2caddress", 0x50) +<pre class="example-preformatted">eeprom = device (ar, "i2caddress", 0x50) </pre></div> -<span id="Write-data-to-the-EEPROM"></span><h3 class="heading">Write data to the EEPROM</h3> +<h3 class="heading" id="Write-data-to-the-EEPROM">Write data to the EEPROM</h3> <p>The EEPROM expects the first byte to be the page number, the second the offset, followed by data, so to write 1 2 3 4, starting address 0 (page 0, offset 0): </p> <div class="example"> -<pre class="example">write(eeprom, [0 0 1 2 3 4]) +<pre class="example-preformatted">write(eeprom, [0 0 1 2 3 4]) </pre></div> -<span id="Reading-from-the-EEPROM"></span><h3 class="heading">Reading from the EEPROM</h3> +<h3 class="heading" id="Reading-from-the-EEPROM">Reading from the EEPROM</h3> <p>Reading from the EEPROM requires first writing the address to read from, in this case, if we want to read the 3, 4, this would be page 0, offset 2: </p> <div class="example"> -<pre class="example">write(eeprom, [0 2]) +<pre class="example-preformatted">write(eeprom, [0 2]) </pre></div> <p>Next read the 2 bytes: </p> <div class="example"> -<pre class="example">data = read(eeprom, 2) +<pre class="example-preformatted">data = read(eeprom, 2) </pre></div> </div> -<div class="section" id="Using-SPI-to-communicate-with-a-mcp3002-10-bit-ADC"> +<div class="section-level-extent" id="Using-SPI-to-communicate-with-a-mcp3002-10-bit-ADC"> <h3 class="section">8.3 Using SPI to communicate with a mcp3002 10 bit ADC</h3> -<span id="index-Using-SPI-to-communicate-with-a-mcp3002-10-bit-ADC"></span> +<a class="index-entry-id" id="index-Using-SPI-to-communicate-with-a-mcp3002-10-bit-ADC"></a> <p>This example shows using SPI to communicate with an mcp3002 10 bit ADC. Code is available by running: </p><div class="example"> -<pre class="example">edit examples/example_spi_mcp3002 +<pre class="example-preformatted">edit examples/example_spi_mcp3002 </pre></div> -<span id="Hardware-setup-4"></span><h3 class="heading">Hardware setup</h3> +<h3 class="heading" id="Hardware-setup-4">Hardware setup</h3> <p>Using an Arduino UNO, the board should be configured with the following connections between the board and a mcp3002 chip: </p> -<dl compact="compact"> -<dt><span>D10</span></dt> +<dl class="table"> +<dt>D10</dt> <dd><p>Connected to pin 1 (CS) of MCP3002 </p></dd> -<dt><span>D11</span></dt> +<dt>D11</dt> <dd><p>Connected to pin 5 (DI) of MCP3002 </p></dd> -<dt><span>D12</span></dt> +<dt>D12</dt> <dd><p>Connected to pin 6 (DO) of MCP3002 </p></dd> -<dt><span>D13</span></dt> +<dt>D13</dt> <dd><p>Connected to pin 7 (CLK) MCP3002 </p></dd> -<dt><span>VCC</span></dt> +<dt>VCC</dt> <dd><p>Connected to pin 8 (VDD) MCP3002 </p></dd> -<dt><span>GND</span></dt> +<dt>GND</dt> <dd><p>Connected to pin 4 (VSS) MCP3002 </p></dd> -<dt><span>Analog input</span></dt> +<dt>Analog input</dt> <dd><p>Connected from pin 2 of the MCP3002 to a LOW (< 5V) voltage to measure </p></dd> </dl> -<span id="Create-an-Arduino-object-2"></span><h3 class="heading">Create an Arduino object</h3> +<h3 class="heading" id="Create-an-Arduino-object-2">Create an Arduino object</h3> <div class="example"> -<pre class="example">ar = arduino (); +<pre class="example-preformatted">ar = arduino (); </pre></div> <p>If you have more than one Arduino board connected, you may need to specify the port in order to connect to the correct device. </p> -<span id="Create-an-SPI-object-to-communicate-to-the-MCP3002"></span><h3 class="heading">Create an SPI object to communicate to the MCP3002</h3> +<h3 class="heading" id="Create-an-SPI-object-to-communicate-to-the-MCP3002">Create an SPI object to communicate to the MCP3002</h3> <div class="example"> -<pre class="example">adc = device(ar, "spichipselectpin", "d10") +<pre class="example-preformatted">adc = device(ar, "spichipselectpin", "d10") </pre></div> <p>The d10 is the chip select pin connected from the Arduino to the MCP3002. </p> -<span id="Read-the-ADC"></span><h3 class="heading">Read the ADC</h3> +<h3 class="heading" id="Read-the-ADC">Read the ADC</h3> <p>The MCP3002 expects specific commands in order to read a channel. </p> <p>For illustration for the command to read chan 0 in single ended mode: </p><div class="example"> -<pre class="example">command (bits) in MSB mode to device: +<pre class="example-preformatted">command (bits) in MSB mode to device: [START SGL ODN MSBF X X X X] [ X X X X X X X X ] 1 1 0 1 1 1 1 1 1 1 1 1 1 1 1 1 [chan 0 ] MSB @@ -1496,38 +1496,38 @@ the rest of the ADC data. <p>In hex, this corresponds to 0xDF 0xFF, </p> <div class="example"> -<pre class="example">data = writeRead(adc, [hex2dec("DF") hex2dec("FF")]) +<pre class="example-preformatted">data = writeRead(adc, [hex2dec("DF") hex2dec("FF")]) </pre></div> <p>Of the data returned, the last 10 bits is the actual data, so convert data to a 16 bit value: </p><div class="example"> -<pre class="example">val = uint16(data(1))*256 + uint16(data(2)) +<pre class="example-preformatted">val = uint16(data(1))*256 + uint16(data(2)) </pre></div> <p>Then bitand it to remove the non value parts, to get the ADC value: </p><div class="example"> -<pre class="example">val = bitand (val, hex2dec('3FF')) +<pre class="example-preformatted">val = bitand (val, hex2dec('3FF')) </pre></div> <p>To make the value correspond to a voltage it needs to be scaled as 0 will be 0 Volts, 1023 will be 5 Volts. </p><div class="example"> -<pre class="example">volts = double(val) * 5.0 / 1023.0; +<pre class="example-preformatted">volts = double(val) * 5.0 / 1023.0; </pre></div> <hr> </div> </div> -<div class="chapter" id="Function-Reference"> -<div class="header"> +<div class="chapter-level-extent" id="Function-Reference"> +<div class="nav-panel"> <p> Next: <a href="#Copying" accesskey="n" rel="next">GNU General Public License</a>, Previous: <a href="#Examples" accesskey="p" rel="prev">Examples</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Function-Reference-1"></span><h2 class="chapter">9 Function Reference</h2> -<span id="index-Function-Reference"></span> +<h2 class="chapter" id="Function-Reference-1">9 Function Reference</h2> +<a class="index-entry-id" id="index-Function-Reference"></a> <p>The functions currently available in the Arduino toolkit are described below; </p> -<ul class="section-toc"> +<ul class="mini-toc"> <li><a href="#General-Functions" accesskey="1">General Functions</a></li> <li><a href="#Arduino-Functions" accesskey="2">Arduino Functions</a></li> <li><a href="#Arduino-I2C-Functions" accesskey="3">Arduino I2C Functions</a></li> @@ -1541,170 +1541,170 @@ Next: <a href="#Copying" accesskey="n" rel="next">GNU General Public License</a> <li><a href="#Arduino-Addons">Arduino Addons</a></li> <li><a href="#Arduino-Sensors">Arduino Sensors</a></li> <li><a href="#Arduino-I_002fO-package">Arduino I/O package</a></li> -<li><a href="#Matlab-Compatability-Classes">Matlab Compatability Classes</a></li> +<li><a href="#Matlab-Compatibility-Classes">Matlab Compatibility Classes</a></li> <li><a href="#Sensors">Sensors</a></li> <li><a href="#Test-Functions">Test Functions</a></li> </ul> <hr> -<div class="section" id="General-Functions"> -<div class="header"> +<div class="section-level-extent" id="General-Functions"> +<div class="nav-panel"> <p> Next: <a href="#Arduino-Functions" accesskey="n" rel="next">Arduino Functions</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="General-Functions-1"></span><h3 class="section">9.1 General Functions</h3> -<span id="index-General-Functions"></span> -<ul class="section-toc"> +<h3 class="section" id="General-Functions-1">9.1 General Functions</h3> +<a class="index-entry-id" id="index-General-Functions"></a> +<ul class="mini-toc"> <li><a href="#arduinosetup" accesskey="1">arduinosetup</a></li> <li><a href="#isarduino" accesskey="2">isarduino</a></li> <li><a href="#listArduinoLibraries" accesskey="3">listArduinoLibraries</a></li> <li><a href="#scanForArduinos" accesskey="4">scanForArduinos</a></li> </ul> -<div class="subsection" id="arduinosetup"> +<div class="subsection-level-extent" id="arduinosetup"> <h4 class="subsection">9.1.1 arduinosetup</h4> -<span id="index-arduinosetup"></span> -<dl class="def"> -<dt id="index-arduinosetup-1"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>arduinosetup</strong> <em>()</em><a href='#index-arduinosetup-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-arduinosetup-2"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>arduinosetup</strong> <em>(<var>propertyname</var>, <var>propertyvalue</var>)</em><a href='#index-arduinosetup-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-arduinosetup"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinosetup-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">arduinosetup</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-arduinosetup-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-arduinosetup-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">arduinosetup</strong> <code class="def-code-arguments">(<var class="var">propertyname</var>, <var class="var">propertyvalue</var>)</code><a class="copiable-link" href='#index-arduinosetup-2'> ¶</a></span></dt> <dd><p>Open the arduino config / programming tool to program the arduino hardware for usage with the Octave arduino functions. </p> <p>arduinosetup will create a temporary project using the arduino IDE and allow compiling and programming of the code to an arduino. </p> -<span id="Inputs"></span><h4 class="subsubheading">Inputs</h4> +<h4 class="subsubheading" id="Inputs">Inputs</h4> -<p><var>propertyname</var>, <var>propertyvalue</var> - A sequence of property name/value pairs can be given +<p><var class="var">propertyname</var>, <var class="var">propertyvalue</var> - A sequence of property name/value pairs can be given to set defaults while programming. </p> <p>Currently the following properties can be set: - </p><dl compact="compact"> -<dt><span>libraries</span></dt> +</p><dl class="table"> +<dt>libraries</dt> <dd><p>The value should be the name of a library, or string array of libraries to program on the arduino board. - </p></dd> -<dt><span>arduinobinary</span></dt> +</p></dd> +<dt>arduinobinary</dt> <dd><p>The value should be the name/path of the arduino IDE binary for programming. If not specified, the function will use getpref preferences of arduino.arduino_binary, and if not found, the function will attempt to find the binary itself. </p> <p>If provided, the value will be saved to preferences for future calls. - </p></dd> +</p></dd> </dl> -<span id="Outputs"></span><h4 class="subsubheading">Outputs</h4> -<p><var>retval</var> - return 1 if arduino IDE returned without an error +<h4 class="subsubheading" id="Outputs">Outputs</h4> +<p><var class="var">retval</var> - return 1 if arduino IDE returned without an error </p> -<p><strong>See also:</strong> arduino, __arduino_binary__. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, __arduino_binary__. +</p></dd></dl> </div> -<div class="subsection" id="isarduino"> +<div class="subsection-level-extent" id="isarduino"> <h4 class="subsection">9.1.2 isarduino</h4> -<span id="index-isarduino"></span> -<dl class="def"> -<dt id="index-isarduino-1"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>isarduino</strong> <em>(<var>obj</var>)</em><a href='#index-isarduino-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-isarduino"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-isarduino-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">isarduino</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-isarduino-1'> ¶</a></span></dt> <dd><p>Check if input value is an arduino object </p> <p>Function is essentially just a call of - <code> +<code class="code"> retval = isa(obj, "arduino"); </code> </p> -<span id="Inputs-1"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - The object to check +<h4 class="subsubheading" id="Inputs-1">Inputs</h4> +<p><var class="var">obj</var> - The object to check </p> -<span id="Outputs-1"></span><h4 class="subsubheading">Outputs</h4> -<p><var>retval</var> is true, if obj is an arduino object, false otherwise. +<h4 class="subsubheading" id="Outputs-1">Outputs</h4> +<p><var class="var">retval</var> is true, if obj is an arduino object, false otherwise. </p> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="listArduinoLibraries"> +<div class="subsection-level-extent" id="listArduinoLibraries"> <h4 class="subsection">9.1.3 listArduinoLibraries</h4> -<span id="index-listArduinoLibraries"></span> -<dl class="def"> -<dt id="index-listArduinoLibraries-1"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>listArduinoLibraries</strong> <em>()</em><a href='#index-listArduinoLibraries-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-listArduinoLibraries-2"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>listArduinoLibraries</strong> <em>(<var>libtypes</var>)</em><a href='#index-listArduinoLibraries-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-listArduinoLibraries"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-listArduinoLibraries-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">listArduinoLibraries</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-listArduinoLibraries-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-listArduinoLibraries-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">listArduinoLibraries</strong> <code class="def-code-arguments">(<var class="var">libtypes</var>)</code><a class="copiable-link" href='#index-listArduinoLibraries-2'> ¶</a></span></dt> <dd><p>Retrieve list of all known arduino library modules that are available. </p> -<span id="Inputs-2"></span><h4 class="subsubheading">Inputs</h4> -<p><var>libtypes</var> - optional specifier for type of libraries to list. +<h4 class="subsubheading" id="Inputs-2">Inputs</h4> +<p><var class="var">libtypes</var> - optional specifier for type of libraries to list. </p> <p>Options are: - </p><dl compact="compact"> -<dt><span>all</span></dt> +</p><dl class="table"> +<dt>all</dt> <dd><p>List core and addons - </p></dd> -<dt><span>core</span></dt> +</p></dd> +<dt>core</dt> <dd><p>List core only libraries - </p></dd> -<dt><span>addons</span></dt> +</p></dd> +<dt>addons</dt> <dd><p>List addons only - </p></dd> +</p></dd> </dl> <p>When no libtypes is specified, all libraries are shown. </p> -<span id="Outputs-2"></span><h4 class="subsubheading">Outputs</h4> -<p><var>retval</var> is an cell array of string library names that are +<h4 class="subsubheading" id="Outputs-2">Outputs</h4> +<p><var class="var">retval</var> is an cell array of string library names that are available for programming to the arduino. </p> -<p><strong>See also:</strong> arduino, arduinosetup. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, arduinosetup. +</p></dd></dl> </div> -<div class="subsection" id="scanForArduinos"> +<div class="subsection-level-extent" id="scanForArduinos"> <h4 class="subsection">9.1.4 scanForArduinos</h4> -<span id="index-scanForArduinos"></span> -<dl class="def"> -<dt id="index-scanForArduinos-1"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>scanForArduinos</strong> <em>(<var>maxCount</var>)</em><a href='#index-scanForArduinos-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-scanForArduinos-2"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>scanForArduinos</strong> <em>(<var>"debug"</var>)</em><a href='#index-scanForArduinos-2' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-scanForArduinos-3"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>scanForArduinos</strong> <em>(<var>maxCount</var>, <var>type</var>)</em><a href='#index-scanForArduinos-3' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-scanForArduinos"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-scanForArduinos-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">scanForArduinos</strong> <code class="def-code-arguments">(<var class="var">maxCount</var>)</code><a class="copiable-link" href='#index-scanForArduinos-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-scanForArduinos-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">scanForArduinos</strong> <code class="def-code-arguments">(<var class="var">"debug"</var>)</code><a class="copiable-link" href='#index-scanForArduinos-2'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-scanForArduinos-3"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">scanForArduinos</strong> <code class="def-code-arguments">(<var class="var">maxCount</var>, <var class="var">type</var>)</code><a class="copiable-link" href='#index-scanForArduinos-3'> ¶</a></span></dt> <dd><p>Scan system for programmed arduino boards. </p> <p>scanForArduinos will scan the system for programmed arduino boards - and return at most <var>maxCount</var> of them as a cell array - in <var>retval</var>. + and return at most <var class="var">maxCount</var> of them as a cell array + in <var class="var">retval</var>. </p> -<span id="Inputs-3"></span><h4 class="subsubheading">Inputs</h4> -<p><var>maxCount</var> - max number of arduino boards to detect. - if <var>maxCount</var> is not specified, or is a less than 1, the +<h4 class="subsubheading" id="Inputs-3">Inputs</h4> +<p><var class="var">maxCount</var> - max number of arduino boards to detect. + if <var class="var">maxCount</var> is not specified, or is a less than 1, the function will return as many arduino boards as it can detect. </p> -<p><var>type</var> - optional board type to match. If specified, the board +<p><var class="var">type</var> - optional board type to match. If specified, the board type must match for the arduino to be added to the return list. </p> -<p><var>"debug"</var> - if single input parameter is "debug", the +<p><var class="var">"debug"</var> - if single input parameter is "debug", the scanForArduinos will display debug information as it scans all available ports for arduinos. </p> -<span id="Outputs-3"></span><h4 class="subsubheading">Outputs</h4> -<p><var>retval</var> structure cell array of matching detected arduino boards. +<h4 class="subsubheading" id="Outputs-3">Outputs</h4> +<p><var class="var">retval</var> structure cell array of matching detected arduino boards. </p> <p>Each cell value of the cell array will contain a structure with values of: - </p><dl compact="compact"> -<dt><span>port</span></dt> +</p><dl class="table"> +<dt>port</dt> <dd><p>the serial port the arduino is connected to - </p></dd> -<dt><span>board</span></dt> +</p></dd> +<dt>board</dt> <dd><p>the board type of the arduino - </p></dd> +</p></dd> </dl> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Arduino-Functions"> -<div class="header"> +<div class="section-level-extent" id="Arduino-Functions"> +<div class="nav-panel"> <p> Next: <a href="#Arduino-I2C-Functions" accesskey="n" rel="next">Arduino I2C Functions</a>, Previous: <a href="#General-Functions" accesskey="p" rel="prev">General Functions</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Arduino-Functions-1"></span><h3 class="section">9.2 Arduino Functions</h3> -<span id="index-Arduino-Functions"></span> -<ul class="section-toc"> +<h3 class="section" id="Arduino-Functions-1">9.2 Arduino Functions</h3> +<a class="index-entry-id" id="index-Arduino-Functions"></a> +<ul class="mini-toc"> <li><a href="#g_t_0040arduino_002farduino" accesskey="1">@arduino/arduino</a></li> <li><a href="#g_t_0040arduino_002fcheckI2CAddress" accesskey="2">@arduino/checkI2CAddress</a></li> <li><a href="#g_t_0040arduino_002fconfigurePin" accesskey="3">@arduino/configurePin</a></li> @@ -1745,25 +1745,25 @@ Next: <a href="#Arduino-I2C-Functions" accesskey="n" rel="next">Arduino I2C Func <li><a href="#g_t_0040arduino_002fwritePWMDutyCycle">@arduino/writePWMDutyCycle</a></li> <li><a href="#g_t_0040arduino_002fwritePWMVoltage">@arduino/writePWMVoltage</a></li> </ul> -<div class="subsection" id="g_t_0040arduino_002farduino"> +<div class="subsection-level-extent" id="g_t_0040arduino_002farduino"> <h4 class="subsection">9.2.1 @arduino/arduino</h4> -<span id="index-arduino"></span> -<dl class="def"> -<dt id="index-arduino-1"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>arduino</strong> <em>()</em><a href='#index-arduino-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-arduino-2"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>arduino</strong> <em>(<var>port</var>)</em><a href='#index-arduino-2' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-arduino-3"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>arduino</strong> <em>(<var>port</var>, <var>board</var>)</em><a href='#index-arduino-3' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-arduino-4"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>arduino</strong> <em>(<var>port</var>, <var>board</var>[, [<var>propname</var>, <var>propvalue</var>]*)</em><a href='#index-arduino-4' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-arduino-5"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>arduino</strong> <em>(<var>iaddress</var>)</em><a href='#index-arduino-5' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-arduino-6"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>arduino</strong> <em>(<var>ipaddress</var>, <var>board</var>)</em><a href='#index-arduino-6' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-arduino"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduino-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">arduino</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-arduino-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-arduino-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">arduino</strong> <code class="def-code-arguments">(<var class="var">port</var>)</code><a class="copiable-link" href='#index-arduino-2'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-arduino-3"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">arduino</strong> <code class="def-code-arguments">(<var class="var">port</var>, <var class="var">board</var>)</code><a class="copiable-link" href='#index-arduino-3'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-arduino-4"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">arduino</strong> <code class="def-code-arguments">(<var class="var">port</var>, <var class="var">board</var>[, [<var class="var">propname</var>, <var class="var">propvalue</var>]*)</code><a class="copiable-link" href='#index-arduino-4'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-arduino-5"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">arduino</strong> <code class="def-code-arguments">(<var class="var">iaddress</var>)</code><a class="copiable-link" href='#index-arduino-5'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-arduino-6"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">arduino</strong> <code class="def-code-arguments">(<var class="var">ipaddress</var>, <var class="var">board</var>)</code><a class="copiable-link" href='#index-arduino-6'> ¶</a></span></dt> <dd><p>Create a arduino object with a connection to an arduino board. </p> -<span id="Inputs-4"></span><h4 class="subsubheading">Inputs</h4> -<p><var>port</var> - full path of serial port to connect to. For Linux, +<h4 class="subsubheading" id="Inputs-4">Inputs</h4> +<p><var class="var">port</var> - full path of serial port to connect to. For Linux, usually /dev/ttySXXX, for windows COMXX. </p> -<p><var>board</var> - name of board to connect (default is ’uno’). +<p><var class="var">board</var> - name of board to connect (default is ’uno’). </p> -<p><var>propname</var>, <var>propvalue</var> - property name and value pair +<p><var class="var">propname</var>, <var class="var">propvalue</var> - property name and value pair for additional properties to pass to the creation of the arduino object. </p> @@ -1772,64 +1772,64 @@ Next: <a href="#Arduino-I2C-Functions" accesskey="n" rel="next">Arduino I2C Func <p>if the arduino function is called without parameters, it will scan for the first available arduino it can find and connect to it. </p> -<span id="Outputs-4"></span><h4 class="subsubheading">Outputs</h4> -<p><var>retval</var> - a successfully connected arduino object. +<h4 class="subsubheading" id="Outputs-4">Outputs</h4> +<p><var class="var">retval</var> - a successfully connected arduino object. </p> -<span id="Properties"></span><h4 class="subsubheading">Properties</h4> +<h4 class="subsubheading" id="Properties">Properties</h4> <p>The arduino object has the following public properties: - </p><dl compact="compact"> -<dt><span>name</span></dt> +</p><dl class="table"> +<dt>name</dt> <dd><p>name assigned to the arduino object - </p></dd> -<dt><span>debug</span></dt> +</p></dd> +<dt>debug</dt> <dd><p>true / false flag for whether debug in turned on - </p></dd> -<dt><span>forcebuildon</span></dt> +</p></dd> +<dt>forcebuildon</dt> <dd><p>true / false flag for whether to force show of the arduino IDE to reprogram the arduino - </p></dd> -<dt><span>port (read only)</span></dt> +</p></dd> +<dt>port (read only)</dt> <dd><p>the communications port the board is connected to. - </p></dd> -<dt><span>board (read only)</span></dt> +</p></dd> +<dt>board (read only)</dt> <dd><p>The name of the board type that the arduino connected to - </p></dd> -<dt><span>libraries (read only)</span></dt> +</p></dd> +<dt>libraries (read only)</dt> <dd><p>The libraries currently programmed onto the board - </p></dd> -<dt><span>availablepins</span></dt> +</p></dd> +<dt>availablepins</dt> <dd><p>The pins available for use on the board - </p></dd> -<dt><span>analogreference</span></dt> +</p></dd> +<dt>analogreference</dt> <dd><p>The analog voltage reference - </p></dd> +</p></dd> </dl> -<p><strong>See also:</strong> scanForArduinos, arduinosetup. - </p></dd></dl> +<p><strong class="strong">See also:</strong> scanForArduinos, arduinosetup. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fcheckI2CAddress"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fcheckI2CAddress"> <h4 class="subsection">9.2.2 @arduino/checkI2CAddress</h4> -<span id="index-checkI2CAddress"></span> -<dl class="def"> -<dt id="index-checkI2CAddress-1"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>checkI2CAddress</strong> <em>(<var>ar</var>, <var>address</var>)</em><a href='#index-checkI2CAddress-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-checkI2CAddress-2"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>checkI2CAddress</strong> <em>(<var>ar</var>, <var>address</var>, <var>bus</var>)</em><a href='#index-checkI2CAddress-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-checkI2CAddress"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-checkI2CAddress-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">checkI2CAddress</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">address</var>)</code><a class="copiable-link" href='#index-checkI2CAddress-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-checkI2CAddress-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">checkI2CAddress</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">address</var>, <var class="var">bus</var>)</code><a class="copiable-link" href='#index-checkI2CAddress-2'> ¶</a></span></dt> <dd><p>Check that an address of given address responds on the I2C bus </p> -<span id="Inputs-5"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - arduino object connected to a arduino board. +<h4 class="subsubheading" id="Inputs-5">Inputs</h4> +<p><var class="var">ar</var> - arduino object connected to a arduino board. </p> -<p><var>address</var> - I2C address number to check +<p><var class="var">address</var> - I2C address number to check </p> -<p><var>bus</var> - bus number to check for I2C device, when multiple buses are available. +<p><var class="var">bus</var> - bus number to check for I2C device, when multiple buses are available. If the bus is not specified, it will default to 0. </p> -<span id="Outputs-5"></span><h4 class="subsubheading">Outputs</h4> -<p><var>retval</var> - boolean value of true if address responds on the I2C bus +<h4 class="subsubheading" id="Outputs-5">Outputs</h4> +<p><var class="var">retval</var> - boolean value of true if address responds on the I2C bus </p> -<span id="Example"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> # create arduino connection. ar = arduino(); # scan for devices on the I2C bus @@ -1838,905 +1838,905 @@ Next: <a href="#Arduino-I2C-Functions" accesskey="n" rel="next">Arduino I2C Func ans = 1 </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> arduino, scanI2Cbus. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, scanI2Cbus. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fconfigurePin"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fconfigurePin"> <h4 class="subsection">9.2.3 @arduino/configurePin</h4> -<span id="index-configurePin"></span> -<dl class="def"> -<dt id="index-configurePin-1"><span class="category">: </span><span><em><var>currmode</var> =</em> <strong>configurePin</strong> <em>(<var>ar</var>, <var>pin</var>)</em><a href='#index-configurePin-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-configurePin-2"><span class="category">: </span><span><em></em> <strong>configurePin</strong> <em>(<var>ar</var>, <var>pin</var>, <var>mode</var>)</em><a href='#index-configurePin-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-configurePin"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-configurePin-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">currmode</var> =</code> <strong class="def-name">configurePin</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>)</code><a class="copiable-link" href='#index-configurePin-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-configurePin-2"><span class="category-def">: </span><span><strong class="def-name">configurePin</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>, <var class="var">mode</var>)</code><a class="copiable-link" href='#index-configurePin-2'> ¶</a></span></dt> <dd><p>Set/Get pin mode for a specified pin on arduino connection. </p> -<p>configurePin (<var>ar</var>, <var>pin</var>) will get the current mode of the specified pin. +<p>configurePin (<var class="var">ar</var>, <var class="var">pin</var>) will get the current mode of the specified pin. </p> -<p>configurePin (<var>ar</var>, <var>pin</var>, <var>mode</var>) will attempt set the pin to the specified +<p>configurePin (<var class="var">ar</var>, <var class="var">pin</var>, <var class="var">mode</var>) will attempt set the pin to the specified mode if the mode is unset. </p> -<span id="Inputs-6"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the arduino object of the connection to an arduino board. +<h4 class="subsubheading" id="Inputs-6">Inputs</h4> +<p><var class="var">ar</var> - the arduino object of the connection to an arduino board. </p> -<p><var>pin</var> - string name of the pin to set/get the mode of. +<p><var class="var">pin</var> - string name of the pin to set/get the mode of. </p> -<p><var>mode</var> - string mode to set the pin to. +<p><var class="var">mode</var> - string mode to set the pin to. </p> -<span id="Outputs-6"></span><h4 class="subsubheading">Outputs</h4> -<p><var>mode</var> - string current mode of the pin. +<h4 class="subsubheading" id="Outputs-6">Outputs</h4> +<p><var class="var">mode</var> - string current mode of the pin. </p> <p>Valid modes can be: - </p><ul> -<li> AnalogInput +</p><ul class="itemize mark-bullet"> +<li>AnalogInput - Acquire analog signals from pin - </li><li> DigitalInput +</li><li>DigitalInput - Acquire digital signals from pin - </li><li> DigitalOutput +</li><li>DigitalOutput - Generate digital signals from pin - </li><li> I2C +</li><li>I2C - Specify a pin to use with I2C protocol - </li><li> Pullup +</li><li>Pullup - Specify pin to use a pullup switch - </li><li> PWM +</li><li>PWM - Specify pin to use a pulse width modulator - </li><li> Servo +</li><li>Servo - Specify pin to use a servo - </li><li> SPI +</li><li>SPI - Specify a pin to use with SPI protocol - </li><li> Interrupt +</li><li>Interrupt - Specify a pin to use for with interrupts - </li><li> Reserved +</li><li>Reserved - Specify a pin to be reserved - </li><li> Unset +</li><li>Unset - Clears pin designation. The pin is no longer reserved and can be automatically set at the next operation. - </li></ul> +</li></ul> -<p><strong>See also:</strong> arduino. +<p><strong class="strong">See also:</strong> arduino. </p> </dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fconfigurePinResource"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fconfigurePinResource"> <h4 class="subsection">9.2.4 @arduino/configurePinResource</h4> -<span id="index-configurePinResource"></span> -<dl class="def"> -<dt id="index-configurePinResource-1"><span class="category">: </span><span><em><var>currmode</var> =</em> <strong>configurePinResource</strong> <em>(<var>ar</var>, <var>pin</var>)</em><a href='#index-configurePinResource-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-configurePinResource-2"><span class="category">: </span><span><em></em> <strong>configurePinResource</strong> <em>(<var>ar</var>, <var>pin</var>, <var>owner</var>, <var>mode</var>)</em><a href='#index-configurePinResource-2' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-configurePinResource-3"><span class="category">: </span><span><em></em> <strong>configurePinResource</strong> <em>(<var>ar</var>, <var>pin</var>, <var>owner</var>, <var>mode</var>, <var>force</var>)</em><a href='#index-configurePinResource-3' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-configurePinResource"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-configurePinResource-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">currmode</var> =</code> <strong class="def-name">configurePinResource</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>)</code><a class="copiable-link" href='#index-configurePinResource-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-configurePinResource-2"><span class="category-def">: </span><span><strong class="def-name">configurePinResource</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>, <var class="var">owner</var>, <var class="var">mode</var>)</code><a class="copiable-link" href='#index-configurePinResource-2'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-configurePinResource-3"><span class="category-def">: </span><span><strong class="def-name">configurePinResource</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>, <var class="var">owner</var>, <var class="var">mode</var>, <var class="var">force</var>)</code><a class="copiable-link" href='#index-configurePinResource-3'> ¶</a></span></dt> <dd><p>Set/Get pin mode for a specified pin on arduino connection. </p> -<p>configurePinResource (<var>ar</var>, <var>pin</var>) will get the current mode of the specified pin. +<p>configurePinResource (<var class="var">ar</var>, <var class="var">pin</var>) will get the current mode of the specified pin. </p> -<p>configurePinResource (<var>ar</var>, <var>pin</var>, <var>owner</var>, <var>mode</var>) will attempt set the pin to the specified +<p>configurePinResource (<var class="var">ar</var>, <var class="var">pin</var>, <var class="var">owner</var>, <var class="var">mode</var>) will attempt set the pin to the specified mode and owner. </p> <p>If the pin is already owned by another owner, the configure will fail unless the force option is used. If the mode is already set, configure will fail unless force is used. </p> -<span id="Inputs-7"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the arduino object of the connection to an arduino board. +<h4 class="subsubheading" id="Inputs-7">Inputs</h4> +<p><var class="var">ar</var> - the arduino object of the connection to an arduino board. </p> -<p><var>pin</var> - string name of the pin to set/get the mode of. +<p><var class="var">pin</var> - string name of the pin to set/get the mode of. </p> -<p><var>mode</var> - string mode to set the pin to. +<p><var class="var">mode</var> - string mode to set the pin to. </p> -<p><var>owner</var> - string name to use as the pin owner. +<p><var class="var">owner</var> - string name to use as the pin owner. </p> -<p><var>force</var> - boolean to force mode change. If not set, it will be false. +<p><var class="var">force</var> - boolean to force mode change. If not set, it will be false. </p> -<span id="Outputs-7"></span><h4 class="subsubheading">Outputs</h4> -<p><var>currmode</var> - current string mode of the pin. +<h4 class="subsubheading" id="Outputs-7">Outputs</h4> +<p><var class="var">currmode</var> - current string mode of the pin. </p> <p>Valid modes can be: - </p><ul> -<li> AnalogInput +</p><ul class="itemize mark-bullet"> +<li>AnalogInput - Acquire analog signals from pin - </li><li> DigitalInput +</li><li>DigitalInput - Acquire digital signals from pin - </li><li> DigitalOutput +</li><li>DigitalOutput - Generate digital signals from pin - </li><li> I2C +</li><li>I2C - Specify a pin to use with I2C protocol - </li><li> Pullup +</li><li>Pullup - Specify pin to use a pullup switch - </li><li> PWM +</li><li>PWM - Specify pin to use a pulse width modulator - </li><li> Servo +</li><li>Servo - Specify pin to use a servo - </li><li> SPI +</li><li>SPI - Specify a pin to use with SPI protocol - </li><li> Interrupt +</li><li>Interrupt - Specify a pin to use with interrupts - </li><li> Reserved +</li><li>Reserved - Pin marked reserved, but not for of any particular mode - </li><li> Unset +</li><li>Unset - Clears pin designation. The pin is no longer reserved and can be automatically set at the next operation. - </li></ul> +</li></ul> -<p><strong>See also:</strong> arduino, configurePin. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, configurePin. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fdecrementResourceCount"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fdecrementResourceCount"> <h4 class="subsection">9.2.5 @arduino/decrementResourceCount</h4> -<span id="index-decrementResourceCount"></span> -<dl class="def"> -<dt id="index-decrementResourceCount-1"><span class="category">: </span><span><em><var>count</var> =</em> <strong>decrementResourceCount</strong> <em>(<var>ar</var>, <var>resource</var>)</em><a href='#index-decrementResourceCount-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-decrementResourceCount"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-decrementResourceCount-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">count</var> =</code> <strong class="def-name">decrementResourceCount</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">resource</var>)</code><a class="copiable-link" href='#index-decrementResourceCount-1'> ¶</a></span></dt> <dd><p>Decrement the count of a named resource by 1 and return the new count. </p> -<span id="Inputs-8"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-8">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>resource</var> - name of resource to decrement count. +<p><var class="var">resource</var> - name of resource to decrement count. </p> -<span id="Outputs-8"></span><h4 class="subsubheading">Outputs</h4> -<p><var>count</var> = count of uses registered to resource. +<h4 class="subsubheading" id="Outputs-8">Outputs</h4> +<p><var class="var">count</var> = count of uses registered to resource. </p> -<p><strong>See also:</strong> getResourceCount. incrementResourceCount. - </p></dd></dl> +<p><strong class="strong">See also:</strong> getResourceCount. incrementResourceCount. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fdelete"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fdelete"> <h4 class="subsection">9.2.6 @arduino/delete</h4> -<span id="index-delete"></span> -<dl class="def"> -<dt id="index-delete-11"><span class="category">: </span><span><em></em> <strong>delete</strong> <em>(<var>dev</var>)</em><a href='#index-delete-11' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-delete"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-delete-11"><span class="category-def">: </span><span><strong class="def-name">delete</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-delete-11'> ¶</a></span></dt> <dd><p>Free resources of an arduino object. </p> -<span id="Inputs-9"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - object to free +<h4 class="subsubheading" id="Inputs-9">Inputs</h4> +<p><var class="var">dev</var> - object to free </p> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fdisplay"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fdisplay"> <h4 class="subsection">9.2.7 @arduino/display</h4> -<span id="index-display"></span> -<dl class="def"> -<dt id="index-display-11"><span class="category">: </span><span><em></em> <strong>display</strong> <em>(<var>ar</var>)</em><a href='#index-display-11' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-display"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-11"><span class="category-def">: </span><span><strong class="def-name">display</strong> <code class="def-code-arguments">(<var class="var">ar</var>)</code><a class="copiable-link" href='#index-display-11'> ¶</a></span></dt> <dd><p>Display the arduino object in a verbose way, showing the board and available pins. </p> -<span id="Inputs-10"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the arduino object. +<h4 class="subsubheading" id="Inputs-10">Inputs</h4> +<p><var class="var">ar</var> - the arduino object. </p> <p>If the arduino object has debug mode set, additional information will be displayed. </p> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetEndian"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetEndian"> <h4 class="subsection">9.2.8 @arduino/getEndian</h4> -<span id="index-getEndian"></span> -<dl class="def"> -<dt id="index-getEndian-1"><span class="category">: </span><span><em><var>mcu</var> =</em> <strong>getEndian</strong> <em>(<var>ar</var>)</em><a href='#index-getEndian-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getEndian"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getEndian-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">mcu</var> =</code> <strong class="def-name">getEndian</strong> <code class="def-code-arguments">(<var class="var">ar</var>)</code><a class="copiable-link" href='#index-getEndian-1'> ¶</a></span></dt> <dd><p>Get the endian used by the connected arduino. </p> -<span id="Inputs-11"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - arduino object connected to a arduino board. +<h4 class="subsubheading" id="Inputs-11">Inputs</h4> +<p><var class="var">ar</var> - arduino object connected to a arduino board. </p> -<span id="Outputs-9"></span><h4 class="subsubheading">Outputs</h4> -<p><var>endian</var> - string representing the endian used by the arduino board. +<h4 class="subsubheading" id="Outputs-9">Outputs</h4> +<p><var class="var">endian</var> - string representing the endian used by the arduino board. </p> <p>’L’ means little endian, ’B’ means big endian </p> -<p><strong>See also:</strong> arduino, getMCU. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, getMCU. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetI2CTerminals"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetI2CTerminals"> <h4 class="subsection">9.2.9 @arduino/getI2CTerminals</h4> -<span id="index-getI2CTerminals"></span> -<dl class="def"> -<dt id="index-getI2CTerminals-1"><span class="category">: </span><span><em><var>pinlist</var> =</em> <strong>getI2CTerminals</strong> <em>(<var>ar</var>)</em><a href='#index-getI2CTerminals-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-getI2CTerminals-2"><span class="category">: </span><span><em><var>pinlist</var> =</em> <strong>getI2CTerminals</strong> <em>(<var>ar</var>, <var>bus</var>)</em><a href='#index-getI2CTerminals-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getI2CTerminals"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getI2CTerminals-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">pinlist</var> =</code> <strong class="def-name">getI2CTerminals</strong> <code class="def-code-arguments">(<var class="var">ar</var>)</code><a class="copiable-link" href='#index-getI2CTerminals-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-getI2CTerminals-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">pinlist</var> =</code> <strong class="def-name">getI2CTerminals</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">bus</var>)</code><a class="copiable-link" href='#index-getI2CTerminals-2'> ¶</a></span></dt> <dd><p>Get a cell list of pin Ids available are used for I2C mode. </p> -<span id="Inputs-12"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the arduino object. +<h4 class="subsubheading" id="Inputs-12">Inputs</h4> +<p><var class="var">ar</var> - the arduino object. </p> -<p><var>bus</var> - optional bus number 0 or 1 for boards that support more than 1 bus. +<p><var class="var">bus</var> - optional bus number 0 or 1 for boards that support more than 1 bus. </p> -<span id="Outputs-10"></span><h4 class="subsubheading">Outputs</h4> -<p><var>pinlist</var> - cell list of pin numbers available for I2C use. +<h4 class="subsubheading" id="Outputs-10">Outputs</h4> +<p><var class="var">pinlist</var> - cell list of pin numbers available for I2C use. </p> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetInterruptTerminals"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetInterruptTerminals"> <h4 class="subsection">9.2.10 @arduino/getInterruptTerminals</h4> -<span id="index-getInterruptTerminals"></span> -<dl class="def"> -<dt id="index-getInterruptTerminals-1"><span class="category">: </span><span><em><var>pinlist</var> =</em> <strong>getInterruptTerminals</strong> <em>(<var>ar</var>)</em><a href='#index-getInterruptTerminals-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getInterruptTerminals"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getInterruptTerminals-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">pinlist</var> =</code> <strong class="def-name">getInterruptTerminals</strong> <code class="def-code-arguments">(<var class="var">ar</var>)</code><a class="copiable-link" href='#index-getInterruptTerminals-1'> ¶</a></span></dt> <dd><p>Get a cell list of pin Ids available have interrupt functionality </p> -<span id="Inputs-13"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the arduino object. +<h4 class="subsubheading" id="Inputs-13">Inputs</h4> +<p><var class="var">ar</var> - the arduino object. </p> -<span id="Outputs-11"></span><h4 class="subsubheading">Outputs</h4> -<p><var>pinlist</var> - cell list of pin numbers available for interrupt use. +<h4 class="subsubheading" id="Outputs-11">Outputs</h4> +<p><var class="var">pinlist</var> - cell list of pin numbers available for interrupt use. </p> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetLEDTerminals"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetLEDTerminals"> <h4 class="subsection">9.2.11 @arduino/getLEDTerminals</h4> -<span id="index-getLEDTerminals"></span> -<dl class="def"> -<dt id="index-getLEDTerminals-1"><span class="category">: </span><span><em><var>pinlist</var> =</em> <strong>getLEDTerminals</strong> <em>(<var>ar</var>)</em><a href='#index-getLEDTerminals-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getLEDTerminals"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getLEDTerminals-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">pinlist</var> =</code> <strong class="def-name">getLEDTerminals</strong> <code class="def-code-arguments">(<var class="var">ar</var>)</code><a class="copiable-link" href='#index-getLEDTerminals-1'> ¶</a></span></dt> <dd><p>Get a cell list of pin Ids available are connected natively to LEDs. </p> -<span id="Inputs-14"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the arduino object. +<h4 class="subsubheading" id="Inputs-14">Inputs</h4> +<p><var class="var">ar</var> - the arduino object. </p> -<span id="Outputs-12"></span><h4 class="subsubheading">Outputs</h4> -<p><var>pinlist</var> - cell list of pin numbers available for LED use. +<h4 class="subsubheading" id="Outputs-12">Outputs</h4> +<p><var class="var">pinlist</var> - cell list of pin numbers available for LED use. </p> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetMCU"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetMCU"> <h4 class="subsection">9.2.12 @arduino/getMCU</h4> -<span id="index-getMCU"></span> -<dl class="def"> -<dt id="index-getMCU-1"><span class="category">: </span><span><em><var>mcu</var> =</em> <strong>getMCU</strong> <em>(<var>ar</var>)</em><a href='#index-getMCU-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getMCU"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getMCU-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">mcu</var> =</code> <strong class="def-name">getMCU</strong> <code class="def-code-arguments">(<var class="var">ar</var>)</code><a class="copiable-link" href='#index-getMCU-1'> ¶</a></span></dt> <dd><p>Get the MCU used by the connected arduino. </p> -<span id="Inputs-15"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - arduino object connected to a arduino board. +<h4 class="subsubheading" id="Inputs-15">Inputs</h4> +<p><var class="var">ar</var> - arduino object connected to a arduino board. </p> -<span id="Outputs-13"></span><h4 class="subsubheading">Outputs</h4> -<p><var>mcu</var> - string representing the mcu used by the arduino board. +<h4 class="subsubheading" id="Outputs-13">Outputs</h4> +<p><var class="var">mcu</var> - string representing the mcu used by the arduino board. </p> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetPWMTerminals"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetPWMTerminals"> <h4 class="subsection">9.2.13 @arduino/getPWMTerminals</h4> -<span id="index-getPWMTerminals"></span> -<dl class="def"> -<dt id="index-getPWMTerminals-1"><span class="category">: </span><span><em><var>pinlist</var> =</em> <strong>getPWMTerminals</strong> <em>(<var>ar</var>)</em><a href='#index-getPWMTerminals-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getPWMTerminals"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getPWMTerminals-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">pinlist</var> =</code> <strong class="def-name">getPWMTerminals</strong> <code class="def-code-arguments">(<var class="var">ar</var>)</code><a class="copiable-link" href='#index-getPWMTerminals-1'> ¶</a></span></dt> <dd><p>Get a cell list of pin Ids available for PWM use. </p> -<span id="Inputs-16"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the arduino object. +<h4 class="subsubheading" id="Inputs-16">Inputs</h4> +<p><var class="var">ar</var> - the arduino object. </p> -<span id="Outputs-14"></span><h4 class="subsubheading">Outputs</h4> -<p><var>pinlist</var> - cell list of pin numbers available for PWM use. +<h4 class="subsubheading" id="Outputs-14">Outputs</h4> +<p><var class="var">pinlist</var> - cell list of pin numbers available for PWM use. </p> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetPinAlias"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetPinAlias"> <h4 class="subsection">9.2.14 @arduino/getPinAlias</h4> -<span id="index-getPinAlias"></span> -<dl class="def"> -<dt id="index-getPinAlias-1"><span class="category">: </span><span><em><var>ouy</var> =</em> <strong>getPinAlias</strong> <em>(<var>ar</var>, <var>pin</var>)</em><a href='#index-getPinAlias-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getPinAlias"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getPinAlias-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">ouy</var> =</code> <strong class="def-name">getPinAlias</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>)</code><a class="copiable-link" href='#index-getPinAlias-1'> ¶</a></span></dt> <dd><p>Get the pin actual pin name from a pin alias. </p> <p>For example, the arduino Leonardo, pin "D4" is also "A6". </p> -<span id="Inputs-17"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the connected arduino object. +<h4 class="subsubheading" id="Inputs-17">Inputs</h4> +<p><var class="var">ar</var> - the connected arduino object. </p> -<p><var>pin</var> - a pin name. +<p><var class="var">pin</var> - a pin name. </p> -<span id="Outputs-15"></span><h4 class="subsubheading">Outputs</h4> -<p><var>out</var> - alias pin name, or same as <var>pin</var> if the pin doesnt have any alias names. +<h4 class="subsubheading" id="Outputs-15">Outputs</h4> +<p><var class="var">out</var> - alias pin name, or same as <var class="var">pin</var> if the pin doesnt have any alias names. </p> -<p><strong>See also:</strong> arduino, configurePinResource, getResourceOwner. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, configurePinResource, getResourceOwner. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetPinInfo"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetPinInfo"> <h4 class="subsection">9.2.15 @arduino/getPinInfo</h4> -<span id="index-getPinInfo"></span> -<dl class="def"> -<dt id="index-getPinInfo-1"><span class="category">: </span><span><em><var>pininfo</var> =</em> <strong>getPinInfo</strong> <em>(<var>ar</var>, <var>pin</var>)</em><a href='#index-getPinInfo-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-getPinInfo-2"><span class="category">: </span><span><em><var>pininfoarray</var> =</em> <strong>getPinInfo</strong> <em>(<var>ar</var>, <var>pinarray</var>)</em><a href='#index-getPinInfo-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getPinInfo"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getPinInfo-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">pininfo</var> =</code> <strong class="def-name">getPinInfo</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>)</code><a class="copiable-link" href='#index-getPinInfo-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-getPinInfo-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">pininfoarray</var> =</code> <strong class="def-name">getPinInfo</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pinarray</var>)</code><a class="copiable-link" href='#index-getPinInfo-2'> ¶</a></span></dt> <dd><p>Get the pin information from the input pins values. </p> -<p>getPinInfo (<var>ar</var>, <var>pin</var>) will get information for a single pin. +<p>getPinInfo (<var class="var">ar</var>, <var class="var">pin</var>) will get information for a single pin. </p> -<p>getPinInfo (<var>ar</var>, <var>pinarray</var>) will get a cell array of pin information +<p>getPinInfo (<var class="var">ar</var>, <var class="var">pinarray</var>) will get a cell array of pin information </p> -<span id="Inputs-18"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the connected arduino object. +<h4 class="subsubheading" id="Inputs-18">Inputs</h4> +<p><var class="var">ar</var> - the connected arduino object. </p> -<p><var>pin</var> - a pin number or pin name. +<p><var class="var">pin</var> - a pin number or pin name. </p> -<p><var>pinarray</var> - the array of pin numbers or names +<p><var class="var">pinarray</var> - the array of pin numbers or names </p> <p>The pininfo struct contains the following fields: - </p><dl compact="compact"> -<dt><span>terminal</span></dt> +</p><dl class="table"> +<dt>terminal</dt> <dd><p>Terminal number of the pin - </p></dd> -<dt><span>name</span></dt> +</p></dd> +<dt>name</dt> <dd><p>String name of the pin - </p></dd> -<dt><span>owner</span></dt> +</p></dd> +<dt>owner</dt> <dd><p>Current item owner of the pin - </p></dd> -<dt><span>mode</span></dt> +</p></dd> +<dt>mode</dt> <dd><p>Current configured mode for the pin - </p></dd> +</p></dd> </dl> -<span id="Outputs-16"></span><h4 class="subsubheading">Outputs</h4> -<p><var>pininfo</var> - struct on pin information. +<h4 class="subsubheading" id="Outputs-16">Outputs</h4> +<p><var class="var">pininfo</var> - struct on pin information. </p> -<p><var>pininfolist</var> - cell array of pin info +<p><var class="var">pininfolist</var> - cell array of pin info </p> -<p><strong>See also:</strong> arduino, configurePinResource, getResourceOwner. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, configurePinResource, getResourceOwner. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetPinsFromTerminals"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetPinsFromTerminals"> <h4 class="subsection">9.2.16 @arduino/getPinsFromTerminals</h4> -<span id="index-getPinsFromTerminals"></span> -<dl class="def"> -<dt id="index-getPinsFromTerminals-1"><span class="category">: </span><span><em><var>pinnames</var> =</em> <strong>getPinsFromTerminals</strong> <em>(<var>ar</var>, <var>terminals</var>)</em><a href='#index-getPinsFromTerminals-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getPinsFromTerminals"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getPinsFromTerminals-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">pinnames</var> =</code> <strong class="def-name">getPinsFromTerminals</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">terminals</var>)</code><a class="copiable-link" href='#index-getPinsFromTerminals-1'> ¶</a></span></dt> <dd><p>Get the pin names from the input terminal values. </p> -<span id="Inputs-19"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the connected arduino object. +<h4 class="subsubheading" id="Inputs-19">Inputs</h4> +<p><var class="var">ar</var> - the connected arduino object. </p> -<p><var>terminals</var> - the numeric pin number, or array of pin numbers to get pin names. +<p><var class="var">terminals</var> - the numeric pin number, or array of pin numbers to get pin names. </p> -<span id="Outputs-17"></span><h4 class="subsubheading">Outputs</h4> -<p><var>pinnames</var> - the string names of each input pin. If terminals was a single value, the return +<h4 class="subsubheading" id="Outputs-17">Outputs</h4> +<p><var class="var">pinnames</var> - the string names of each input pin. If terminals was a single value, the return will be a single string, otherwise it will return a cell array of each pin name. </p> -<p><strong>See also:</strong> arduino, getTerminalsFromPins. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, getTerminalsFromPins. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetResourceCount"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetResourceCount"> <h4 class="subsection">9.2.17 @arduino/getResourceCount</h4> -<span id="index-getResourceCount"></span> -<dl class="def"> -<dt id="index-getResourceCount-1"><span class="category">: </span><span><em><var>count</var> =</em> <strong>getResourceCount</strong> <em>(<var>ar</var>, <var>resource</var>)</em><a href='#index-getResourceCount-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getResourceCount"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getResourceCount-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">count</var> =</code> <strong class="def-name">getResourceCount</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">resource</var>)</code><a class="copiable-link" href='#index-getResourceCount-1'> ¶</a></span></dt> <dd><p>Get the count of uses of a given resource. </p> -<span id="Inputs-20"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-20">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>resource</var> - name of resource to get count for. +<p><var class="var">resource</var> - name of resource to get count for. </p> -<span id="Outputs-18"></span><h4 class="subsubheading">Outputs</h4> -<p><var>count</var> = count of uses registered to resource. +<h4 class="subsubheading" id="Outputs-18">Outputs</h4> +<p><var class="var">count</var> = count of uses registered to resource. </p> -<p><strong>See also:</strong> incrementResourceCount. decrementResourceCount. - </p></dd></dl> +<p><strong class="strong">See also:</strong> incrementResourceCount. decrementResourceCount. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetResourceOwner"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetResourceOwner"> <h4 class="subsection">9.2.18 @arduino/getResourceOwner</h4> -<span id="index-getResourceOwner"></span> -<dl class="def"> -<dt id="index-getResourceOwner-1"><span class="category">: </span><span><em><var>owner</var> =</em> <strong>getResourceOwner</strong> <em>(<var>ar</var>, <var>terminal</var>)</em><a href='#index-getResourceOwner-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getResourceOwner"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getResourceOwner-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">owner</var> =</code> <strong class="def-name">getResourceOwner</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">terminal</var>)</code><a class="copiable-link" href='#index-getResourceOwner-1'> ¶</a></span></dt> <dd><p>Get the owner of pin allocated previously by configurePinResource. </p> -<span id="Inputs-21"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-21">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>terminal</var> - terminal number to get owner of. +<p><var class="var">terminal</var> - terminal number to get owner of. </p> -<span id="Outputs-19"></span><h4 class="subsubheading">Outputs</h4> -<p><var>owner</var> = owner of the terminal pin, or "" if not owned. +<h4 class="subsubheading" id="Outputs-19">Outputs</h4> +<p><var class="var">owner</var> = owner of the terminal pin, or "" if not owned. </p> -<p><strong>See also:</strong> configurePinResource. - </p></dd></dl> +<p><strong class="strong">See also:</strong> configurePinResource. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetSPITerminals"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetSPITerminals"> <h4 class="subsection">9.2.19 @arduino/getSPITerminals</h4> -<span id="index-getSPITerminals"></span> -<dl class="def"> -<dt id="index-getSPITerminals-1"><span class="category">: </span><span><em><var>pinlist</var> =</em> <strong>getSPITerminals</strong> <em>(<var>ar</var>)</em><a href='#index-getSPITerminals-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getSPITerminals"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getSPITerminals-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">pinlist</var> =</code> <strong class="def-name">getSPITerminals</strong> <code class="def-code-arguments">(<var class="var">ar</var>)</code><a class="copiable-link" href='#index-getSPITerminals-1'> ¶</a></span></dt> <dd><p>Get a cell list of pin Ids available for SPI mode. </p> -<span id="Inputs-22"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the arduino object. +<h4 class="subsubheading" id="Inputs-22">Inputs</h4> +<p><var class="var">ar</var> - the arduino object. </p> -<span id="Outputs-20"></span><h4 class="subsubheading">Outputs</h4> -<p><var>pinlist</var> - cell list of pin numbers available for SPI use. +<h4 class="subsubheading" id="Outputs-20">Outputs</h4> +<p><var class="var">pinlist</var> - cell list of pin numbers available for SPI use. </p> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetServoTerminals"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetServoTerminals"> <h4 class="subsection">9.2.20 @arduino/getServoTerminals</h4> -<span id="index-getServoTerminals"></span> -<dl class="def"> -<dt id="index-getServoTerminals-1"><span class="category">: </span><span><em><var>pinlist</var> =</em> <strong>getServoTerminals</strong> <em>(<var>ar</var>)</em><a href='#index-getServoTerminals-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getServoTerminals"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getServoTerminals-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">pinlist</var> =</code> <strong class="def-name">getServoTerminals</strong> <code class="def-code-arguments">(<var class="var">ar</var>)</code><a class="copiable-link" href='#index-getServoTerminals-1'> ¶</a></span></dt> <dd><p>Get a cell list of pin Ids available for servo use. </p> -<span id="Inputs-23"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the arduino object. +<h4 class="subsubheading" id="Inputs-23">Inputs</h4> +<p><var class="var">ar</var> - the arduino object. </p> -<span id="Outputs-21"></span><h4 class="subsubheading">Outputs</h4> -<p><var>pinlist</var> - cell list of pin numbers available for servo use. +<h4 class="subsubheading" id="Outputs-21">Outputs</h4> +<p><var class="var">pinlist</var> - cell list of pin numbers available for servo use. </p> -<p><strong>See also:</strong> arduino, getPWMTerminals. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, getPWMTerminals. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetSharedResourceProperty"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetSharedResourceProperty"> <h4 class="subsection">9.2.21 @arduino/getSharedResourceProperty</h4> -<span id="index-getSharedResourceProperty"></span> -<dl class="def"> -<dt id="index-getSharedResourceProperty-1"><span class="category">: </span><span><em><var>count</var> =</em> <strong>getSharedResourceProperty</strong> <em>(<var>ar</var>, <var>resource</var>, <var>property</var>)</em><a href='#index-getSharedResourceProperty-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getSharedResourceProperty"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getSharedResourceProperty-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">count</var> =</code> <strong class="def-name">getSharedResourceProperty</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">resource</var>, <var class="var">property</var>)</code><a class="copiable-link" href='#index-getSharedResourceProperty-1'> ¶</a></span></dt> <dd><p>Get the value of a property from a given resource. </p> -<span id="Inputs-24"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-24">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>resource</var> - name of resource to get property for. +<p><var class="var">resource</var> - name of resource to get property for. </p> -<p><var>property</var> - name of property from the resource. +<p><var class="var">property</var> - name of property from the resource. </p> -<span id="Outputs-22"></span><h4 class="subsubheading">Outputs</h4> -<p><var>propvalue</var> - value of the property +<h4 class="subsubheading" id="Outputs-22">Outputs</h4> +<p><var class="var">propvalue</var> - value of the property </p> -<p><strong>See also:</strong> getResourceCount, setSharedResourceProperty. - </p></dd></dl> +<p><strong class="strong">See also:</strong> getResourceCount, setSharedResourceProperty. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetTerminalMode"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetTerminalMode"> <h4 class="subsection">9.2.22 @arduino/getTerminalMode</h4> -<span id="index-getTerminalMode"></span> -<dl class="def"> -<dt id="index-getTerminalMode-1"><span class="category">: </span><span><em><var>mode</var> =</em> <strong>getTerminalMode</strong> <em>(<var>ar</var>, <var>terminal</var>)</em><a href='#index-getTerminalMode-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getTerminalMode"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getTerminalMode-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">mode</var> =</code> <strong class="def-name">getTerminalMode</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">terminal</var>)</code><a class="copiable-link" href='#index-getTerminalMode-1'> ¶</a></span></dt> <dd><p>Get the mode of a pin allocated previously by configurePinResource. </p> -<span id="Inputs-25"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-25">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>terminal</var> - terminal number to get owner of. +<p><var class="var">terminal</var> - terminal number to get owner of. </p> -<span id="Outputs-23"></span><h4 class="subsubheading">Outputs</h4> -<p><var>mode</var> - mode of the terminal pin, or "not_set" if not owned. +<h4 class="subsubheading" id="Outputs-23">Outputs</h4> +<p><var class="var">mode</var> - mode of the terminal pin, or "not_set" if not owned. </p> -<p><strong>See also:</strong> configurePinResource, getResourceOwner. - </p></dd></dl> +<p><strong class="strong">See also:</strong> configurePinResource, getResourceOwner. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fgetTerminalsFromPins"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fgetTerminalsFromPins"> <h4 class="subsection">9.2.23 @arduino/getTerminalsFromPins</h4> -<span id="index-getTerminalsFromPins"></span> -<dl class="def"> -<dt id="index-getTerminalsFromPins-1"><span class="category">: </span><span><em><var>pinnums</var> =</em> <strong>getTerminalsFromPins</strong> <em>(<var>ar</var>, <var>pins</var>)</em><a href='#index-getTerminalsFromPins-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getTerminalsFromPins"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-getTerminalsFromPins-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">pinnums</var> =</code> <strong class="def-name">getTerminalsFromPins</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pins</var>)</code><a class="copiable-link" href='#index-getTerminalsFromPins-1'> ¶</a></span></dt> <dd><p>Get the terminal number for each pin. </p> -<span id="Inputs-26"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-26">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>pins</var> - single pin name or cell or vector array of pin names. +<p><var class="var">pins</var> - single pin name or cell or vector array of pin names. </p> -<span id="Outputs-24"></span><h4 class="subsubheading">Outputs</h4> -<p><var>pinnums</var> - pin number of each named pin. If the input was a single string, returns a number. +<h4 class="subsubheading" id="Outputs-24">Outputs</h4> +<p><var class="var">pinnums</var> - pin number of each named pin. If the input was a single string, returns a number. if the input pins was a vector or cell array, return a cell array of pin numbers corresponding to each input pin name. </p> -<p><strong>See also:</strong> arduino, getPinsFromTerminals. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, getPinsFromTerminals. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fincrementResourceCount"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fincrementResourceCount"> <h4 class="subsection">9.2.24 @arduino/incrementResourceCount</h4> -<span id="index-incrementResourceCount"></span> -<dl class="def"> -<dt id="index-incrementResourceCount-1"><span class="category">: </span><span><em><var>count</var> =</em> <strong>incrementResourceCount</strong> <em>(<var>ar</var>, <var>resource</var>)</em><a href='#index-incrementResourceCount-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-incrementResourceCount"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-incrementResourceCount-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">count</var> =</code> <strong class="def-name">incrementResourceCount</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">resource</var>)</code><a class="copiable-link" href='#index-incrementResourceCount-1'> ¶</a></span></dt> <dd><p>Increment the count value of a named resource by 1 and return the new count </p> -<span id="Inputs-27"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-27">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>resource</var> - name of resource to increment count. +<p><var class="var">resource</var> - name of resource to increment count. </p> -<span id="Outputs-25"></span><h4 class="subsubheading">Outputs</h4> -<p><var>count</var> = count of uses registered to resource. +<h4 class="subsubheading" id="Outputs-25">Outputs</h4> +<p><var class="var">count</var> = count of uses registered to resource. </p> -<p><strong>See also:</strong> getResourceCount. decrementResourceCount. - </p></dd></dl> +<p><strong class="strong">See also:</strong> getResourceCount. decrementResourceCount. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fisTerminalAnalog"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fisTerminalAnalog"> <h4 class="subsection">9.2.25 @arduino/isTerminalAnalog</h4> -<span id="index-isTerminalAnalog"></span> -<dl class="def"> -<dt id="index-isTerminalAnalog-1"><span class="category">: </span><span><em><var>ret</var> =</em> <strong>isTerminalAnalog</strong> <em>(<var>obj</var>, <var>terminal</var>)</em><a href='#index-isTerminalAnalog-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-isTerminalAnalog"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-isTerminalAnalog-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">ret</var> =</code> <strong class="def-name">isTerminalAnalog</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">terminal</var>)</code><a class="copiable-link" href='#index-isTerminalAnalog-1'> ¶</a></span></dt> <dd><p>Return true if pin is capable of analog input </p> -<span id="Inputs-28"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the connected arduino object +<h4 class="subsubheading" id="Inputs-28">Inputs</h4> +<p><var class="var">ar</var> - the connected arduino object </p> -<p><var>terminal</var> is a terminal number to check +<p><var class="var">terminal</var> is a terminal number to check </p> -<span id="Outputs-26"></span><h4 class="subsubheading">Outputs</h4> -<p><var>ret</var> return 1 if terminal is a analog pin, 0 otherwise +<h4 class="subsubheading" id="Outputs-26">Outputs</h4> +<p><var class="var">ret</var> return 1 if terminal is a analog pin, 0 otherwise </p> </dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fisTerminalDigital"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fisTerminalDigital"> <h4 class="subsection">9.2.26 @arduino/isTerminalDigital</h4> -<span id="index-isTerminalDigital"></span> -<dl class="def"> -<dt id="index-isTerminalDigital_0028obj_002c"><span class="category">: </span><span><em><var>ret</var> =</em> <strong>isTerminalDigital(<var>obj</var>,</strong> <em><var>terminal</var>)</em><a href='#index-isTerminalDigital_0028obj_002c' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-isTerminalDigital"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-isTerminalDigital_0028obj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">ret</var> =</code> <strong class="def-name">isTerminalDigital(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">terminal</var>)</code><a class="copiable-link" href='#index-isTerminalDigital_0028obj_002c'> ¶</a></span></dt> <dd><p>Return true if pin is capable of digital functions </p> -<span id="Inputs-29"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the connected arduino object +<h4 class="subsubheading" id="Inputs-29">Inputs</h4> +<p><var class="var">ar</var> - the connected arduino object </p> -<p><var>terminal</var> is a terminal number to check +<p><var class="var">terminal</var> is a terminal number to check </p> -<span id="Outputs-27"></span><h4 class="subsubheading">Outputs</h4> -<p><var>ret</var> return 1 if terminal is a digital pin, 0 otherwise - </p></dd></dl> +<h4 class="subsubheading" id="Outputs-27">Outputs</h4> +<p><var class="var">ret</var> return 1 if terminal is a digital pin, 0 otherwise +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fplayTone"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fplayTone"> <h4 class="subsection">9.2.27 @arduino/playTone</h4> -<span id="index-playTone"></span> -<dl class="def"> -<dt id="index-playTone-1"><span class="category">: </span><span><em></em> <strong>playTone</strong> <em>(<var>ar</var>, <var>pin</var>, <var>freq</var>, <var>duration</var>)</em><a href='#index-playTone-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-playTone"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-playTone-1"><span class="category-def">: </span><span><strong class="def-name">playTone</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>, <var class="var">freq</var>, <var class="var">duration</var>)</code><a class="copiable-link" href='#index-playTone-1'> ¶</a></span></dt> <dd><p>Play a tone of a given frequency on a specified pin. </p> -<span id="Inputs-30"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-30">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>pin</var> - digital pin to play tone on +<p><var class="var">pin</var> - digital pin to play tone on </p> -<p><var>freq</var> - frequency in hertz to play between 0 and 32767Hz. +<p><var class="var">freq</var> - frequency in hertz to play between 0 and 32767Hz. </p> -<p><var>duration</var> duration in seconds to play tone between 0 and 30 seconds +<p><var class="var">duration</var> duration in seconds to play tone between 0 and 30 seconds </p> <p>If duration is 0 or not specified, tone will continue to play until next tone is commanded. If frequency is 0, tone will stop playing </p> -<p><strong>NOTE:</strong> use of playTone can interfere with PWM output. - </p></dd></dl> +<p><strong class="strong">NOTE:</strong> use of playTone can interfere with PWM output. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002freadAnalogPin"> +<div class="subsection-level-extent" id="g_t_0040arduino_002freadAnalogPin"> <h4 class="subsection">9.2.28 @arduino/readAnalogPin</h4> -<span id="index-readAnalogPin"></span> -<dl class="def"> -<dt id="index-readAnalogPin-1"><span class="category">: </span><span><em><var>value</var> =</em> <strong>readAnalogPin</strong> <em>(<var>ar</var>, <var>pin</var>)</em><a href='#index-readAnalogPin-1' class='copiable-anchor'> ¶</a></span></dt> -<dd><p>Read analog voltage of <var>pin</var>. +<a class="index-entry-id" id="index-readAnalogPin"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readAnalogPin-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">value</var> =</code> <strong class="def-name">readAnalogPin</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>)</code><a class="copiable-link" href='#index-readAnalogPin-1'> ¶</a></span></dt> +<dd><p>Read analog voltage of <var class="var">pin</var>. </p> -<span id="Inputs-31"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object. +<h4 class="subsubheading" id="Inputs-31">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object. </p> -<p><var>pin</var> - string name of the pin to read. +<p><var class="var">pin</var> - string name of the pin to read. </p> -<span id="Outputs-28"></span><h4 class="subsubheading">Outputs</h4> -<p><var>value</var> - analog value of the pin +<h4 class="subsubheading" id="Outputs-28">Outputs</h4> +<p><var class="var">value</var> - analog value of the pin </p> -<span id="Example-1"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-1">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> ar = arduino (); readAnalogPin(ar, "A4"); ans = 87 </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> arduino, readVoltage. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, readVoltage. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002freadDigitalPin"> +<div class="subsection-level-extent" id="g_t_0040arduino_002freadDigitalPin"> <h4 class="subsection">9.2.29 @arduino/readDigitalPin</h4> -<span id="index-readDigitalPin"></span> -<dl class="def"> -<dt id="index-readDigitalPin-1"><span class="category">: </span><span><em><var>value</var> =</em> <strong>readDigitalPin</strong> <em>(<var>obj</var>, <var>pin</var>)</em><a href='#index-readDigitalPin-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-readDigitalPin"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readDigitalPin-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">value</var> =</code> <strong class="def-name">readDigitalPin</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">pin</var>)</code><a class="copiable-link" href='#index-readDigitalPin-1'> ¶</a></span></dt> <dd><p>Read digital value from a digital I/O pin. </p> -<span id="Inputs-32"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object. +<h4 class="subsubheading" id="Inputs-32">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object. </p> -<p><var>pin</var> - string name of the pin to read. +<p><var class="var">pin</var> - string name of the pin to read. </p> -<span id="Outputs-29"></span><h4 class="subsubheading">Outputs</h4> -<p><var>value</var> - the logical value (0, 1, true false) of the current pin state. +<h4 class="subsubheading" id="Outputs-29">Outputs</h4> +<p><var class="var">value</var> - the logical value (0, 1, true false) of the current pin state. </p> -<span id="Example-2"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-2">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino (); pinvalue = readDigitalPin (a, 'D5'); </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> arduino, writeDigitalPin. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, writeDigitalPin. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002freadVoltage"> +<div class="subsection-level-extent" id="g_t_0040arduino_002freadVoltage"> <h4 class="subsection">9.2.30 @arduino/readVoltage</h4> -<span id="index-readVoltage"></span> -<dl class="def"> -<dt id="index-readVoltage-1"><span class="category">: </span><span><em><var>voltage</var> =</em> <strong>readVoltage</strong> <em>(<var>ar</var>, <var>pin</var>)</em><a href='#index-readVoltage-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-readVoltage"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readVoltage-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">voltage</var> =</code> <strong class="def-name">readVoltage</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>)</code><a class="copiable-link" href='#index-readVoltage-1'> ¶</a></span></dt> <dd><p>Read analog voltage of a pin. </p> -<span id="Inputs-33"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino. +<h4 class="subsubheading" id="Inputs-33">Inputs</h4> +<p><var class="var">ar</var> - connected arduino. </p> -<p><var>pin</var> - pin name or number to query for voltage +<p><var class="var">pin</var> - pin name or number to query for voltage </p> -<span id="Outputs-30"></span><h4 class="subsubheading">Outputs</h4> -<p><var>voltage</var> - scaled pin value as a voltage +<h4 class="subsubheading" id="Outputs-30">Outputs</h4> +<p><var class="var">voltage</var> - scaled pin value as a voltage </p> -<span id="Example-3"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-3">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> ar = arduino (); readVoltage(ar, "A4"); ans = 1.401 </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> arduino, readAnalogPin. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, readAnalogPin. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002freset"> +<div class="subsection-level-extent" id="g_t_0040arduino_002freset"> <h4 class="subsection">9.2.31 @arduino/reset</h4> -<span id="index-reset"></span> -<dl class="def"> -<dt id="index-reset-2"><span class="category">: </span><span><em></em> <strong>reset</strong> <em>(<var>ar</var>)</em><a href='#index-reset-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-reset"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-reset-2"><span class="category-def">: </span><span><strong class="def-name">reset</strong> <code class="def-code-arguments">(<var class="var">ar</var>)</code><a class="copiable-link" href='#index-reset-2'> ¶</a></span></dt> <dd><p>Send reset command to arduino hardware to force a hardware reset. </p> -<span id="Inputs-34"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object. +<h4 class="subsubheading" id="Inputs-34">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object. </p> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fsendCommand"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fsendCommand"> <h4 class="subsection">9.2.32 @arduino/sendCommand</h4> -<span id="index-sendCommand"></span> -<dl class="def"> -<dt id="index-sendCommand-1"><span class="category">: </span><span><em><var>outdata, outsize</var> =</em> <strong>sendCommand</strong> <em>(<var>ar</var>, <var>libname</var>, <var>commandid</var>)</em><a href='#index-sendCommand-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-sendCommand-2"><span class="category">: </span><span><em><var>outdata, outsize</var> =</em> <strong>sendCommand</strong> <em>(<var>ar</var>, <var>libname</var>, <var>commandid</var>, <var>data</var>)</em><a href='#index-sendCommand-2' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-sendCommand-3"><span class="category">: </span><span><em><var>outdata, outsize</var> =</em> <strong>sendCommand</strong> <em>(<var>ar</var>, <var>libname</var>, <var>commandid</var>, <var>data</var>, <var>timeout</var>)</em><a href='#index-sendCommand-3' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-sendCommand"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-sendCommand-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">outdata, outsize</var> =</code> <strong class="def-name">sendCommand</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">libname</var>, <var class="var">commandid</var>)</code><a class="copiable-link" href='#index-sendCommand-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-sendCommand-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">outdata, outsize</var> =</code> <strong class="def-name">sendCommand</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">libname</var>, <var class="var">commandid</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-sendCommand-2'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-sendCommand-3"><span class="category-def">: </span><span><code class="def-type"><var class="var">outdata, outsize</var> =</code> <strong class="def-name">sendCommand</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">libname</var>, <var class="var">commandid</var>, <var class="var">data</var>, <var class="var">timeout</var>)</code><a class="copiable-link" href='#index-sendCommand-3'> ¶</a></span></dt> <dd><p>Send a command with option data to the connected arduino, waiting up to a specified number of seconds for a response. </p> -<span id="Inputs-35"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object. +<h4 class="subsubheading" id="Inputs-35">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object. </p> -<p><var>libname</var> - library sending the command. The name should match a programmed +<p><var class="var">libname</var> - library sending the command. The name should match a programmed library of the arduino, or an error will be displayed. </p> -<p><var>commandid</var> - integer value for the command being sent to the arduino. +<p><var class="var">commandid</var> - integer value for the command being sent to the arduino. </p> -<p><var>data</var> - optional data sent with the command. +<p><var class="var">data</var> - optional data sent with the command. </p> -<p><var>timeout</var> - optional timeout to wait for data +<p><var class="var">timeout</var> - optional timeout to wait for data </p> -<span id="Outputs-31"></span><h4 class="subsubheading">Outputs</h4> -<p><var>outdata</var> - data returned back from the arduino in response to command +<h4 class="subsubheading" id="Outputs-31">Outputs</h4> +<p><var class="var">outdata</var> - data returned back from the arduino in response to command </p> -<p><var>outsize</var> - size of data received +<p><var class="var">outsize</var> - size of data received </p> <p>If the arduino fails to respond with a valid reply, sendCommand will error. </p> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fsetSharedResourceProperty"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fsetSharedResourceProperty"> <h4 class="subsection">9.2.33 @arduino/setSharedResourceProperty</h4> -<span id="index-setSharedResourceProperty"></span> -<dl class="def"> -<dt id="index-setSharedResourceProperty-1"><span class="category">: </span><span><em></em> <strong>setSharedResourceProperty</strong> <em>(<var>ar</var>, <var>resource</var>, <var>propname</var>, <var>propvalue</var>)</em><a href='#index-setSharedResourceProperty-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-setSharedResourceProperty-2"><span class="category">: </span><span><em></em> <strong>setSharedResourceProperty</strong> <em>(<var>ar</var>, <var>resource</var>, <var>propname</var>, <var>propvalue</var>, ___)</em><a href='#index-setSharedResourceProperty-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-setSharedResourceProperty"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-setSharedResourceProperty-1"><span class="category-def">: </span><span><strong class="def-name">setSharedResourceProperty</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">resource</var>, <var class="var">propname</var>, <var class="var">propvalue</var>)</code><a class="copiable-link" href='#index-setSharedResourceProperty-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-setSharedResourceProperty-2"><span class="category-def">: </span><span><strong class="def-name">setSharedResourceProperty</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">resource</var>, <var class="var">propname</var>, <var class="var">propvalue</var>, ___)</code><a class="copiable-link" href='#index-setSharedResourceProperty-2'> ¶</a></span></dt> <dd><p>Set property values for a given resource. </p> -<span id="Inputs-36"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-36">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>resource</var> - name of resource to get property for. +<p><var class="var">resource</var> - name of resource to get property for. </p> -<p><var>propname</var> - name of property from the resource. +<p><var class="var">propname</var> - name of property from the resource. </p> -<p><var>propvalue</var> - value of property from the resource. +<p><var class="var">propvalue</var> - value of property from the resource. </p> -<p>Multiple <var>propname</var>, <var>propvalue</var> pairs can be given. +<p>Multiple <var class="var">propname</var>, <var class="var">propvalue</var> pairs can be given. </p> -<span id="Outputs-32"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-32">Outputs</h4> <p>None </p> -<span id="Example-4"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-4">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> ar = arduino(); setSharedResourceProperty(ar, "myresource", "myproperty", [1 2 3]) </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> getSharedResourceProperty. - </p></dd></dl> +<p><strong class="strong">See also:</strong> getSharedResourceProperty. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fuptime"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fuptime"> <h4 class="subsection">9.2.34 @arduino/uptime</h4> -<span id="index-uptime"></span> -<dl class="def"> -<dt id="index-uptime-1"><span class="category">: </span><span><em><var>sec</var> =</em> <strong>uptime</strong> <em>(<var>ar</var>)</em><a href='#index-uptime-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-uptime"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-uptime-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">sec</var> =</code> <strong class="def-name">uptime</strong> <code class="def-code-arguments">(<var class="var">ar</var>)</code><a class="copiable-link" href='#index-uptime-1'> ¶</a></span></dt> <dd><p>Get the number of seconds the arduino board has been running concurrently. </p> -<span id="Inputs-37"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the arduino object of the connection to an arduino board. +<h4 class="subsubheading" id="Inputs-37">Inputs</h4> +<p><var class="var">ar</var> - the arduino object of the connection to an arduino board. </p> -<span id="Outputs-33"></span><h4 class="subsubheading">Outputs</h4> -<p><var>sec</var> - the number seconds the board has been running. Note that the count will wrap around after +<h4 class="subsubheading" id="Outputs-33">Outputs</h4> +<p><var class="var">sec</var> - the number seconds the board has been running. Note that the count will wrap around after approximately 50 days. </p> -<p><strong>See also:</strong> arduino. +<p><strong class="strong">See also:</strong> arduino. </p> </dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fvalidatePin"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fvalidatePin"> <h4 class="subsection">9.2.35 @arduino/validatePin</h4> -<span id="index-validatePin"></span> -<dl class="def"> -<dt id="index-validatePin-1"><span class="category">: </span><span><em></em> <strong>validatePin</strong> <em>(<var>ar</var>, <var>pin</var>, <var>type</var>)</em><a href='#index-validatePin-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-validatePin"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-validatePin-1"><span class="category-def">: </span><span><strong class="def-name">validatePin</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>, <var class="var">type</var>)</code><a class="copiable-link" href='#index-validatePin-1'> ¶</a></span></dt> <dd><p>Validate that the mode is allowed for specified pin </p> <p>If the mode is not valid, and error will be thrown. </p> -<span id="Inputs-38"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-38">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>pin</var> - name of pin to query mode validity of +<p><var class="var">pin</var> - name of pin to query mode validity of </p> -<p><var>mode</var> - mode to query +<p><var class="var">mode</var> - mode to query </p> <p>Known modes are: - </p><ul> -<li> ’I2C’ - </li><li> ’SPI’ - </li><li> ’PWM’ - </li><li> ’Servo’ - </li><li> ’analog’ - </li><li> ’digital’ +</p><ul class="itemize mark-bullet"> +<li>’I2C’ +</li><li>’SPI’ +</li><li>’PWM’ +</li><li>’Servo’ +</li><li>’analog’ +</li><li>’digital’ </li></ul> -<p><strong>See also:</strong> arduino, configurePin. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, configurePin. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fversion"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fversion"> <h4 class="subsection">9.2.36 @arduino/version</h4> -<span id="index-version"></span> -<dl class="def"> -<dt id="index-version-1"><span class="category">: </span><span><em><var>ver</var> =</em> <strong>version</strong> <em>(<var>ar</var>)</em><a href='#index-version-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-version"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-version-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">ver</var> =</code> <strong class="def-name">version</strong> <code class="def-code-arguments">(<var class="var">ar</var>)</code><a class="copiable-link" href='#index-version-1'> ¶</a></span></dt> <dd><p>Get version of library code installed on arduino board </p> -<span id="Inputs-39"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - the arduino object of the connection to an arduino board. +<h4 class="subsubheading" id="Inputs-39">Inputs</h4> +<p><var class="var">ar</var> - the arduino object of the connection to an arduino board. </p> -<span id="Outputs-34"></span><h4 class="subsubheading">Outputs</h4> -<p><var>ver</var> - version string in format of X.Y.Z. +<h4 class="subsubheading" id="Outputs-34">Outputs</h4> +<p><var class="var">ver</var> - version string in format of X.Y.Z. </p> -<p><strong>See also:</strong> arduino. +<p><strong class="strong">See also:</strong> arduino. </p> </dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fwriteDigitalPin"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fwriteDigitalPin"> <h4 class="subsection">9.2.37 @arduino/writeDigitalPin</h4> -<span id="index-writeDigitalPin"></span> -<dl class="def"> -<dt id="index-writeDigitalPin-1"><span class="category">: </span><span><em></em> <strong>writeDigitalPin</strong> <em>(<var>ar</var>, <var>pin</var>, <var>value</var>)</em><a href='#index-writeDigitalPin-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-writeDigitalPin"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-writeDigitalPin-1"><span class="category-def">: </span><span><strong class="def-name">writeDigitalPin</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>, <var class="var">value</var>)</code><a class="copiable-link" href='#index-writeDigitalPin-1'> ¶</a></span></dt> <dd><p>Write digital value to a digital I/O pin. </p> -<span id="Inputs-40"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object. +<h4 class="subsubheading" id="Inputs-40">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object. </p> -<p><var>pin</var> - string name of the pin to write to. +<p><var class="var">pin</var> - string name of the pin to write to. </p> -<p><var>value</var> - the logical value (0, 1, true false) to write to the pin. +<p><var class="var">value</var> - the logical value (0, 1, true false) to write to the pin. </p> <p>If pin was unconfigured before using, pin is set into digital mode. </p> -<span id="Example-5"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-5">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino(); writeDigitalPin(a,'D5',1); </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> arduino, readDigitalPin. +<p><strong class="strong">See also:</strong> arduino, readDigitalPin. </p> </dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fwritePWMDutyCycle"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fwritePWMDutyCycle"> <h4 class="subsection">9.2.38 @arduino/writePWMDutyCycle</h4> -<span id="index-writePWMDutyCycle"></span> -<dl class="def"> -<dt id="index-writePWMDutyCyle"><span class="category">: </span><span><em></em> <strong>writePWMDutyCyle</strong> <em>(<var>ar</var>, <var>pin</var>, <var>value</var>)</em><a href='#index-writePWMDutyCyle' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-writePWMDutyCycle"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-writePWMDutyCyle"><span class="category-def">: </span><span><strong class="def-name">writePWMDutyCyle</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>, <var class="var">value</var>)</code><a class="copiable-link" href='#index-writePWMDutyCyle'> ¶</a></span></dt> <dd><p>Set pin to output a square wave with a specified duty cycle. </p> -<span id="Inputs-41"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-41">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>pin</var> - pin to write to. +<p><var class="var">pin</var> - pin to write to. </p> -<p><var>value</var> - duty cycle value where 0 = off, 0.5 = 50% on, 1 = always on. +<p><var class="var">value</var> - duty cycle value where 0 = off, 0.5 = 50% on, 1 = always on. </p> -<span id="Example-6"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-6">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino(); writePWMDutyCycle(a,'D5',0.5); </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> arduino, writePWMVoltage. +<p><strong class="strong">See also:</strong> arduino, writePWMVoltage. </p> </dd></dl> </div> -<div class="subsection" id="g_t_0040arduino_002fwritePWMVoltage"> +<div class="subsection-level-extent" id="g_t_0040arduino_002fwritePWMVoltage"> <h4 class="subsection">9.2.39 @arduino/writePWMVoltage</h4> -<span id="index-writePWMVoltage"></span> -<dl class="def"> -<dt id="index-writePWMVoltage-1"><span class="category">: </span><span><em></em> <strong>writePWMVoltage</strong> <em>(<var>ar</var>, <var>pin</var>, <var>voltage</var>)</em><a href='#index-writePWMVoltage-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-writePWMVoltage"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-writePWMVoltage-1"><span class="category-def">: </span><span><strong class="def-name">writePWMVoltage</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">pin</var>, <var class="var">voltage</var>)</code><a class="copiable-link" href='#index-writePWMVoltage-1'> ¶</a></span></dt> <dd><p>Emulate an approximate voltage out of a pin using PWM. </p> -<span id="Inputs-42"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-42">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>pin</var> - pin to write to. +<p><var class="var">pin</var> - pin to write to. </p> -<p><var>voltage</var> - voltage to emulate with PWM, between 0 - 5.0 +<p><var class="var">voltage</var> - voltage to emulate with PWM, between 0 - 5.0 </p> -<span id="Example-7"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-7">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino(); writePWMVoltage(a,'D5',1.0); </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> arduino, writePWMDutyCycle. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, writePWMDutyCycle. +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Arduino-I2C-Functions"> -<div class="header"> +<div class="section-level-extent" id="Arduino-I2C-Functions"> +<div class="nav-panel"> <p> Next: <a href="#Arduino-Rotary-Encoder-Functions" accesskey="n" rel="next">Arduino Rotary Encoder Functions</a>, Previous: <a href="#Arduino-Functions" accesskey="p" rel="prev">Arduino Functions</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Arduino-I2C-Functions-1"></span><h3 class="section">9.3 Arduino I2C Functions</h3> -<span id="index-Arduino-I2C-Functions"></span> -<ul class="section-toc"> +<h3 class="section" id="Arduino-I2C-Functions-1">9.3 Arduino I2C Functions</h3> +<a class="index-entry-id" id="index-Arduino-I2C-Functions"></a> +<ul class="mini-toc"> <li><a href="#g_t_0040device_002fdelete" accesskey="1">@device/delete</a></li> <li><a href="#g_t_0040device_002fdisplay" accesskey="2">@device/display</a></li> <li><a href="#g_t_0040device_002fread" accesskey="3">@device/read</a></li> @@ -2754,373 +2754,373 @@ Next: <a href="#Arduino-Rotary-Encoder-Functions" accesskey="n" rel="next">Ardui <li><a href="#g_t_0040i2cdev_002fwriteRegister">@i2cdev/writeRegister</a></li> <li><a href="#scanI2Cbus">scanI2Cbus</a></li> </ul> -<div class="subsection" id="g_t_0040device_002fdelete"> +<div class="subsection-level-extent" id="g_t_0040device_002fdelete"> <h4 class="subsection">9.3.1 @device/delete</h4> -<span id="index-delete-1"></span> -<dl class="def"> -<dt id="index-delete-12"><span class="category">: </span><span><em></em> <strong>delete</strong> <em>(<var>dev</var>)</em><a href='#index-delete-12' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-delete-1"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-delete-12"><span class="category-def">: </span><span><strong class="def-name">delete</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-delete-12'> ¶</a></span></dt> <dd><p>Free resources of a device object. </p> -<span id="Inputs-43"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - object to free +<h4 class="subsubheading" id="Inputs-43">Inputs</h4> +<p><var class="var">dev</var> - object to free </p> -<p><strong>See also:</strong> device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fdisplay"> +<div class="subsection-level-extent" id="g_t_0040device_002fdisplay"> <h4 class="subsection">9.3.2 @device/display</h4> -<span id="index-display-1"></span> -<dl class="def"> -<dt id="index-display-12"><span class="category">: </span><span><em></em> <strong>display</strong> <em>(<var>dev</var>)</em><a href='#index-display-12' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-display-1"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-12"><span class="category-def">: </span><span><strong class="def-name">display</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-display-12'> ¶</a></span></dt> <dd><p>Display device object. </p> -<span id="Inputs-44"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - device object to display +<h4 class="subsubheading" id="Inputs-44">Inputs</h4> +<p><var class="var">dev</var> - device object to display </p> -<p><strong>See also:</strong> device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fread"> +<div class="subsection-level-extent" id="g_t_0040device_002fread"> <h4 class="subsection">9.3.3 @device/read</h4> -<span id="index-read"></span> -<dl class="def"> -<dt id="index-read-5"><span class="category">: </span><span><em><var>data</var> =</em> <strong>read</strong> <em>(<var>dev</var>, <var>numbytes</var>)</em><a href='#index-read-5' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read-6"><span class="category">: </span><span><em><var>data</var> =</em> <strong>read</strong> <em>(<var>dev</var>, <var>numbytes</var>, <var>precision</var>)</em><a href='#index-read-6' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-read"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read-5"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">numbytes</var>)</code><a class="copiable-link" href='#index-read-5'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read-6"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">numbytes</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-read-6'> ¶</a></span></dt> <dd><p>Read a specified number of bytes from a i2c or serial device object using optional precision for bytesize. </p> -<span id="Inputs-45"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c or serial device opened using device +<h4 class="subsubheading" id="Inputs-45">Inputs</h4> +<p><var class="var">dev</var> - connected i2c or serial device opened using device </p> -<p><var>numbytes</var> - number of bytes to read. +<p><var class="var">numbytes</var> - number of bytes to read. </p> -<p><var>precision</var> - Optional precision for the output data read data. +<p><var class="var">precision</var> - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<span id="Outputs-35"></span><h4 class="subsubheading">Outputs</h4> -<p><var>data</var> - data read from the device +<h4 class="subsubheading" id="Outputs-35">Outputs</h4> +<p><var class="var">data</var> - data read from the device </p> -<p><strong>See also:</strong> arduino, device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002freadRegister"> +<div class="subsection-level-extent" id="g_t_0040device_002freadRegister"> <h4 class="subsection">9.3.4 @device/readRegister</h4> -<span id="index-readRegister"></span> -<dl class="def"> -<dt id="index-readRegister-3"><span class="category">: </span><span><em><var>data</var> =</em> <strong>readRegister</strong> <em>(<var>dev</var>, <var>reg</var>, <var>numbytes</var>)</em><a href='#index-readRegister-3' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-readRegister-4"><span class="category">: </span><span><em><var>data</var> =</em> <strong>readRegister</strong> <em>(<var>dev</var>, <var>reg</var>, <var>numbytes</var>, <var>precision</var>)</em><a href='#index-readRegister-4' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-readRegister"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readRegister-3"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">readRegister</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">reg</var>, <var class="var">numbytes</var>)</code><a class="copiable-link" href='#index-readRegister-3'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-readRegister-4"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">readRegister</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">reg</var>, <var class="var">numbytes</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-readRegister-4'> ¶</a></span></dt> <dd><p>Read a specified number of bytes from a register of an i2cdev object using optional precision for bytesize. </p> -<span id="Inputs-46"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c device opened using device +<h4 class="subsubheading" id="Inputs-46">Inputs</h4> +<p><var class="var">dev</var> - connected i2c device opened using device </p> -<p><var>reg</var> - registry value number +<p><var class="var">reg</var> - registry value number </p> -<p><var>numbytes</var> - number of bytes to read. +<p><var class="var">numbytes</var> - number of bytes to read. </p> -<p><var>precision</var> - Optional precision for the output data read data. +<p><var class="var">precision</var> - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<span id="Output"></span><h4 class="subsubheading">Output</h4> -<p><var>data</var> - data read from device. +<h4 class="subsubheading" id="Output">Output</h4> +<p><var class="var">data</var> - data read from device. </p> -<p><strong>See also:</strong> arduino, device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fsubsref"> +<div class="subsection-level-extent" id="g_t_0040device_002fsubsref"> <h4 class="subsection">9.3.5 @device/subsref</h4> -<span id="index-subsref"></span> -<dl class="def"> -<dt id="index-subsref-10"><span class="category">: </span><span><em><var>val</var> =</em> <strong>subsref</strong> <em>(<var>dev</var>, <var>sub</var>)</em><a href='#index-subsref-10' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-subsref"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-subsref-10"><span class="category-def">: </span><span><code class="def-type"><var class="var">val</var> =</code> <strong class="def-name">subsref</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">sub</var>)</code><a class="copiable-link" href='#index-subsref-10'> ¶</a></span></dt> <dd><p>subref for device </p> -<p><strong>See also:</strong> device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fwrite"> +<div class="subsection-level-extent" id="g_t_0040device_002fwrite"> <h4 class="subsection">9.3.6 @device/write</h4> -<span id="index-write"></span> -<dl class="def"> -<dt id="index-write-5"><span class="category">: </span><span><em></em> <strong>write</strong> <em>(<var>dev</var>, <var>datain</var>)</em><a href='#index-write-5' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-write-6"><span class="category">: </span><span><em></em> <strong>write</strong> <em>(<var>dev</var>, <var>datain</var>, <var>precision</var>)</em><a href='#index-write-6' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-write"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-write-5"><span class="category-def">: </span><span><strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">datain</var>)</code><a class="copiable-link" href='#index-write-5'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-write-6"><span class="category-def">: </span><span><strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">datain</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-write-6'> ¶</a></span></dt> <dd><p>Write data to a I2C or serial device object using optional precision for the data byte used for the data. </p> -<span id="Inputs-47"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c or serial device opened using device +<h4 class="subsubheading" id="Inputs-47">Inputs</h4> +<p><var class="var">dev</var> - connected i2c or serial device opened using device </p> -<p><var>datain</var> - data to write to device. Datasize should not exceed the constraints +<p><var class="var">datain</var> - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. </p> -<p><var>precision</var> - Optional precision for the input write data. +<p><var class="var">precision</var> - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<p><strong>See also:</strong> arduino, device, read. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device, read. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fwriteRegister"> +<div class="subsection-level-extent" id="g_t_0040device_002fwriteRegister"> <h4 class="subsection">9.3.7 @device/writeRegister</h4> -<span id="index-writeRegister"></span> -<dl class="def"> -<dt id="index-writeRegister-3"><span class="category">: </span><span><em></em> <strong>writeRegister</strong> <em>(<var>dev</var>, <var>reg</var>, <var>datain</var>)</em><a href='#index-writeRegister-3' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-writeRegister-4"><span class="category">: </span><span><em></em> <strong>writeRegister</strong> <em>(<var>dev</var>, <var>dev</var>, <var>datain</var>, <var>precision</var>)</em><a href='#index-writeRegister-4' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-writeRegister"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-writeRegister-3"><span class="category-def">: </span><span><strong class="def-name">writeRegister</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">reg</var>, <var class="var">datain</var>)</code><a class="copiable-link" href='#index-writeRegister-3'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-writeRegister-4"><span class="category-def">: </span><span><strong class="def-name">writeRegister</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">dev</var>, <var class="var">datain</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-writeRegister-4'> ¶</a></span></dt> <dd><p>Write data to i2c device object at a given registry position using optional precision for the data byte used for the data. </p> -<span id="Inputs-48"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c device opened using device +<h4 class="subsubheading" id="Inputs-48">Inputs</h4> +<p><var class="var">dev</var> - connected i2c device opened using device </p> -<p><var>reg</var> - registry position to write to. +<p><var class="var">reg</var> - registry position to write to. </p> -<p><var>datain</var> - data to write to device. Datasize should not exceed the constraints +<p><var class="var">datain</var> - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. </p> -<p><var>precision</var> - Optional precision for the input write data. +<p><var class="var">precision</var> - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<p><strong>See also:</strong> arduino, device, read. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device, read. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040i2cdev_002fdelete"> +<div class="subsection-level-extent" id="g_t_0040i2cdev_002fdelete"> <h4 class="subsection">9.3.8 @i2cdev/delete</h4> -<span id="index-delete-2"></span> -<dl class="def"> -<dt id="index-delete-13"><span class="category">: </span><span><em></em> <strong>delete</strong> <em>(<var>dev</var>)</em><a href='#index-delete-13' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-delete-2"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-delete-13"><span class="category-def">: </span><span><strong class="def-name">delete</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-delete-13'> ¶</a></span></dt> <dd><p>Free resources of a i2cdev object. </p> -<span id="Inputs-49"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - object to free +<h4 class="subsubheading" id="Inputs-49">Inputs</h4> +<p><var class="var">dev</var> - object to free </p> -<p><strong>See also:</strong> i2cdev. - </p></dd></dl> +<p><strong class="strong">See also:</strong> i2cdev. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040i2cdev_002fdisplay"> +<div class="subsection-level-extent" id="g_t_0040i2cdev_002fdisplay"> <h4 class="subsection">9.3.9 @i2cdev/display</h4> -<span id="index-display-2"></span> -<dl class="def"> -<dt id="index-display-13"><span class="category">: </span><span><em></em> <strong>display</strong> <em>(<var>dev</var>)</em><a href='#index-display-13' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-display-2"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-13"><span class="category-def">: </span><span><strong class="def-name">display</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-display-13'> ¶</a></span></dt> <dd><p>Display i2cdev object. </p> -<span id="Inputs-50"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - i2cdev object +<h4 class="subsubheading" id="Inputs-50">Inputs</h4> +<p><var class="var">dev</var> - i2cdev object </p> -<p><strong>See also:</strong> i2cdev. - </p></dd></dl> +<p><strong class="strong">See also:</strong> i2cdev. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040i2cdev_002fi2cdev"> +<div class="subsection-level-extent" id="g_t_0040i2cdev_002fi2cdev"> <h4 class="subsection">9.3.10 @i2cdev/i2cdev</h4> -<span id="index-i2cdev"></span> -<dl class="def"> -<dt id="index-i2cdev-1"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>i2cdev</strong> <em>(<var>ar</var>, <var>address</var>)</em><a href='#index-i2cdev-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-i2cdev-2"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>i2cdev</strong> <em>(<var>ar</var>, <var>address</var>, <var>propname</var>, <var>propvalue</var>)</em><a href='#index-i2cdev-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-i2cdev"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-i2cdev-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">i2cdev</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">address</var>)</code><a class="copiable-link" href='#index-i2cdev-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-i2cdev-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">i2cdev</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">address</var>, <var class="var">propname</var>, <var class="var">propvalue</var>)</code><a class="copiable-link" href='#index-i2cdev-2'> ¶</a></span></dt> <dd> -<p><code>i2cdev</code> is depreciated and will be removed in a future version. - Use <code>device</code> instead. +<p><code class="code">i2cdev</code> is depreciated and will be removed in a future version. + Use <code class="code">device</code> instead. </p> <p>Create an i2cdev object to communicate to the i2c port on a connected arduino. </p> -<span id="Inputs-51"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-51">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>address</var> - address to use for device on I2C bus. +<p><var class="var">address</var> - address to use for device on I2C bus. </p> -<p><var>propname</var>, <var>propvalue</var> - property name/value pair for values to pass to devices. +<p><var class="var">propname</var>, <var class="var">propvalue</var> - property name/value pair for values to pass to devices. </p> <p>Currently known properties: - </p><dl compact="compact"> -<dt><span>bus</span></dt> +</p><dl class="table"> +<dt>bus</dt> <dd><p>bus number (when arduino board supports multiple I2C buses) with value of 0 or 1. - </p></dd> +</p></dd> </dl> -<span id="Outputs-36"></span><h4 class="subsubheading">Outputs</h4> -<p><var>dev</var> - new created i2cdev object. +<h4 class="subsubheading" id="Outputs-36">Outputs</h4> +<p><var class="var">dev</var> - new created i2cdev object. </p> -<span id="Properties-1"></span><h4 class="subsubheading">Properties</h4> +<h4 class="subsubheading" id="Properties-1">Properties</h4> <p>The i2cdev object has the following public properties: - </p><dl compact="compact"> -<dt><span>parent</span></dt> +</p><dl class="table"> +<dt>parent</dt> <dd><p>The parent (arduino) for this device - </p></dd> -<dt><span>pins</span></dt> +</p></dd> +<dt>pins</dt> <dd><p>pins used by this object - </p></dd> -<dt><span>bus</span></dt> +</p></dd> +<dt>bus</dt> <dd><p>bus used for created object - </p></dd> -<dt><span>address</span></dt> +</p></dd> +<dt>address</dt> <dd><p>I2C address set for object - </p></dd> +</p></dd> </dl> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040i2cdev_002fread"> +<div class="subsection-level-extent" id="g_t_0040i2cdev_002fread"> <h4 class="subsection">9.3.11 @i2cdev/read</h4> -<span id="index-read-1"></span> -<dl class="def"> -<dt id="index-read-7"><span class="category">: </span><span><em><var>data</var> =</em> <strong>read</strong> <em>(<var>dev</var>, <var>numbytes</var>)</em><a href='#index-read-7' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read-8"><span class="category">: </span><span><em><var>data</var> =</em> <strong>read</strong> <em>(<var>dev</var>, <var>numbytes</var>, <var>precision</var>)</em><a href='#index-read-8' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-read-1"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read-7"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">numbytes</var>)</code><a class="copiable-link" href='#index-read-7'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read-8"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">numbytes</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-read-8'> ¶</a></span></dt> <dd><p>Read a specified number of bytes from a i2cdev object using optional precision for bytesize. </p> -<span id="Inputs-52"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c device opened using i2cdev +<h4 class="subsubheading" id="Inputs-52">Inputs</h4> +<p><var class="var">dev</var> - connected i2c device opened using i2cdev </p> -<p><var>numbytes</var> - number of bytes to read. +<p><var class="var">numbytes</var> - number of bytes to read. </p> -<p><var>precision</var> - Optional precision for the output data read data. +<p><var class="var">precision</var> - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<span id="Outputs-37"></span><h4 class="subsubheading">Outputs</h4> -<p><var>data</var> - data read from i2cdevice +<h4 class="subsubheading" id="Outputs-37">Outputs</h4> +<p><var class="var">data</var> - data read from i2cdevice </p> -<p><strong>See also:</strong> arduino, i2cdev. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, i2cdev. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040i2cdev_002freadRegister"> +<div class="subsection-level-extent" id="g_t_0040i2cdev_002freadRegister"> <h4 class="subsection">9.3.12 @i2cdev/readRegister</h4> -<span id="index-readRegister-1"></span> -<dl class="def"> -<dt id="index-readRegister-5"><span class="category">: </span><span><em><var>data</var> =</em> <strong>readRegister</strong> <em>(<var>dev</var>, <var>reg</var>, <var>numbytes</var>)</em><a href='#index-readRegister-5' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-readRegister-6"><span class="category">: </span><span><em><var>data</var> =</em> <strong>readRegister</strong> <em>(<var>dev</var>, <var>reg</var>, <var>numbytes</var>, <var>precision</var>)</em><a href='#index-readRegister-6' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-readRegister-1"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readRegister-5"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">readRegister</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">reg</var>, <var class="var">numbytes</var>)</code><a class="copiable-link" href='#index-readRegister-5'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-readRegister-6"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">readRegister</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">reg</var>, <var class="var">numbytes</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-readRegister-6'> ¶</a></span></dt> <dd><p>Read a specified number of bytes from a register of an i2cdev object using optional precision for bytesize. </p> -<span id="Inputs-53"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c device opened using i2cdev +<h4 class="subsubheading" id="Inputs-53">Inputs</h4> +<p><var class="var">dev</var> - connected i2c device opened using i2cdev </p> -<p><var>reg</var> - registry value number +<p><var class="var">reg</var> - registry value number </p> -<p><var>numbytes</var> - number of bytes to read. +<p><var class="var">numbytes</var> - number of bytes to read. </p> -<p><var>precision</var> - Optional precision for the output data read data. +<p><var class="var">precision</var> - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<span id="Output-1"></span><h4 class="subsubheading">Output</h4> -<p><var>data</var> - data read from device. +<h4 class="subsubheading" id="Output-1">Output</h4> +<p><var class="var">data</var> - data read from device. </p> -<p><strong>See also:</strong> arduino, i2cdev. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, i2cdev. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040i2cdev_002fsubsref"> +<div class="subsection-level-extent" id="g_t_0040i2cdev_002fsubsref"> <h4 class="subsection">9.3.13 @i2cdev/subsref</h4> -<span id="index-subsref-1"></span> -<dl class="def"> -<dt id="index-subsref-11"><span class="category">: </span><span><em><var>val</var> =</em> <strong>subsref</strong> <em>(<var>dev</var>, <var>sub</var>)</em><a href='#index-subsref-11' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-subsref-1"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-subsref-11"><span class="category-def">: </span><span><code class="def-type"><var class="var">val</var> =</code> <strong class="def-name">subsref</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">sub</var>)</code><a class="copiable-link" href='#index-subsref-11'> ¶</a></span></dt> <dd><p>subref for i2cdev </p> -<p><strong>See also:</strong> i2cdev. - </p></dd></dl> +<p><strong class="strong">See also:</strong> i2cdev. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040i2cdev_002fwrite"> +<div class="subsection-level-extent" id="g_t_0040i2cdev_002fwrite"> <h4 class="subsection">9.3.14 @i2cdev/write</h4> -<span id="index-write-1"></span> -<dl class="def"> -<dt id="index-write-7"><span class="category">: </span><span><em></em> <strong>write</strong> <em>(<var>dev</var>, <var>datain</var>)</em><a href='#index-write-7' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-write-8"><span class="category">: </span><span><em></em> <strong>write</strong> <em>(<var>dev</var>, <var>datain</var>, <var>precision</var>)</em><a href='#index-write-8' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-write-1"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-write-7"><span class="category-def">: </span><span><strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">datain</var>)</code><a class="copiable-link" href='#index-write-7'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-write-8"><span class="category-def">: </span><span><strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">datain</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-write-8'> ¶</a></span></dt> <dd><p>Write data to a i2cdev object using optional precision for the data byte used for the data. </p> -<span id="Inputs-54"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c device opened using i2cdev +<h4 class="subsubheading" id="Inputs-54">Inputs</h4> +<p><var class="var">dev</var> - connected i2c device opened using i2cdev </p> -<p><var>datain</var> - data to write to device. Datasize should not exceed the constraints +<p><var class="var">datain</var> - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. </p> -<p><var>precision</var> - Optional precision for the input write data. +<p><var class="var">precision</var> - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<p><strong>See also:</strong> arduino, i2cdev, read. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, i2cdev, read. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040i2cdev_002fwriteRegister"> +<div class="subsection-level-extent" id="g_t_0040i2cdev_002fwriteRegister"> <h4 class="subsection">9.3.15 @i2cdev/writeRegister</h4> -<span id="index-writeRegister-1"></span> -<dl class="def"> -<dt id="index-writeRegister-5"><span class="category">: </span><span><em></em> <strong>writeRegister</strong> <em>(<var>dev</var>, <var>reg</var>, <var>datain</var>)</em><a href='#index-writeRegister-5' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-writeRegister-6"><span class="category">: </span><span><em></em> <strong>writeRegister</strong> <em>(<var>dev</var>, <var>dev</var>, <var>datain</var>, <var>precision</var>)</em><a href='#index-writeRegister-6' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-writeRegister-1"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-writeRegister-5"><span class="category-def">: </span><span><strong class="def-name">writeRegister</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">reg</var>, <var class="var">datain</var>)</code><a class="copiable-link" href='#index-writeRegister-5'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-writeRegister-6"><span class="category-def">: </span><span><strong class="def-name">writeRegister</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">dev</var>, <var class="var">datain</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-writeRegister-6'> ¶</a></span></dt> <dd><p>Write data to i2cdev object at a given registry position using optional precision for the data byte used for the data. </p> -<span id="Inputs-55"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c device opened using i2cdev +<h4 class="subsubheading" id="Inputs-55">Inputs</h4> +<p><var class="var">dev</var> - connected i2c device opened using i2cdev </p> -<p><var>reg</var> - registry position to write to. +<p><var class="var">reg</var> - registry position to write to. </p> -<p><var>datain</var> - data to write to device. Datasize should not exceed the constraints +<p><var class="var">datain</var> - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. </p> -<p><var>precision</var> - Optional precision for the input write data. +<p><var class="var">precision</var> - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<p><strong>See also:</strong> arduino, i2cdev, read. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, i2cdev, read. +</p></dd></dl> </div> -<div class="subsection" id="scanI2Cbus"> +<div class="subsection-level-extent" id="scanI2Cbus"> <h4 class="subsection">9.3.16 scanI2Cbus</h4> -<span id="index-scanI2Cbus"></span> -<dl class="def"> -<dt id="index-scanI2Cbus-1"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>scanI2Cbus</strong> <em>(<var>ar</var>)</em><a href='#index-scanI2Cbus-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-scanI2Cbus-2"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>scanI2Cbus</strong> <em>(<var>ar</var>, <var>bus</var>)</em><a href='#index-scanI2Cbus-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-scanI2Cbus"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-scanI2Cbus-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">scanI2Cbus</strong> <code class="def-code-arguments">(<var class="var">ar</var>)</code><a class="copiable-link" href='#index-scanI2Cbus-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-scanI2Cbus-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">scanI2Cbus</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">bus</var>)</code><a class="copiable-link" href='#index-scanI2Cbus-2'> ¶</a></span></dt> <dd><p>Scan arduino for devices on the I2C bus. </p> -<span id="Inputs-56"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - arduino object connected to a arduino board. +<h4 class="subsubheading" id="Inputs-56">Inputs</h4> +<p><var class="var">ar</var> - arduino object connected to a arduino board. </p> -<p><var>bus</var> - bus number to scan I2C devices, when multiple buses are available. +<p><var class="var">bus</var> - bus number to scan I2C devices, when multiple buses are available. If the bus is not specified, it will default to 0. </p> -<span id="Outputs-38"></span><h4 class="subsubheading">Outputs</h4> -<p><var>retval</var> - cell array of addresses as strings in format of "0xXX". +<h4 class="subsubheading" id="Outputs-38">Outputs</h4> +<p><var class="var">retval</var> - cell array of addresses as strings in format of "0xXX". </p> -<span id="Example-8"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-8">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> # create arduino connection. ar = arduino(); # scan for devices on the I2C bus scanI2Cbus (ar) # output is each detected i2c address as a string ans = - { +{ [1,1] = 0x50 - } +} </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> arduino, i2cdev, checkI2CAddress. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, i2cdev, checkI2CAddress. +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Arduino-Rotary-Encoder-Functions"> -<div class="header"> +<div class="section-level-extent" id="Arduino-Rotary-Encoder-Functions"> +<div class="nav-panel"> <p> Next: <a href="#Arduino-Servo-Functions" accesskey="n" rel="next">Arduino Servo Functions</a>, Previous: <a href="#Arduino-I2C-Functions" accesskey="p" rel="prev">Arduino I2C Functions</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Arduino-Rotary-Encoder-Functions-1"></span><h3 class="section">9.4 Arduino Rotary Encoder Functions</h3> -<span id="index-Arduino-Rotary-Encoder-Functions"></span> -<ul class="section-toc"> +<h3 class="section" id="Arduino-Rotary-Encoder-Functions-1">9.4 Arduino Rotary Encoder Functions</h3> +<a class="index-entry-id" id="index-Arduino-Rotary-Encoder-Functions"></a> +<ul class="mini-toc"> <li><a href="#g_t_0040rotaryEncoder_002fdelete" accesskey="1">@rotaryEncoder/delete</a></li> <li><a href="#g_t_0040rotaryEncoder_002fdisplay" accesskey="2">@rotaryEncoder/display</a></li> <li><a href="#g_t_0040rotaryEncoder_002freadCount" accesskey="3">@rotaryEncoder/readCount</a></li> @@ -3129,162 +3129,162 @@ Next: <a href="#Arduino-Servo-Functions" accesskey="n" rel="next">Arduino Servo <li><a href="#g_t_0040rotaryEncoder_002frotaryEncoder" accesskey="6">@rotaryEncoder/rotaryEncoder</a></li> <li><a href="#g_t_0040rotaryEncoder_002fsubsref" accesskey="7">@rotaryEncoder/subsref</a></li> </ul> -<div class="subsection" id="g_t_0040rotaryEncoder_002fdelete"> +<div class="subsection-level-extent" id="g_t_0040rotaryEncoder_002fdelete"> <h4 class="subsection">9.4.1 @rotaryEncoder/delete</h4> -<span id="index-delete-3"></span> -<dl class="def"> -<dt id="index-delete-14"><span class="category">: </span><span><em></em> <strong>delete</strong> <em>(<var>dev</var>)</em><a href='#index-delete-14' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-delete-3"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-delete-14"><span class="category-def">: </span><span><strong class="def-name">delete</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-delete-14'> ¶</a></span></dt> <dd><p>Free resources of a encoder object. </p> -<span id="Inputs-57"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - object to free +<h4 class="subsubheading" id="Inputs-57">Inputs</h4> +<p><var class="var">dev</var> - object to free </p> -<p><strong>See also:</strong> rotartEncoder. - </p></dd></dl> +<p><strong class="strong">See also:</strong> rotartEncoder. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040rotaryEncoder_002fdisplay"> +<div class="subsection-level-extent" id="g_t_0040rotaryEncoder_002fdisplay"> <h4 class="subsection">9.4.2 @rotaryEncoder/display</h4> -<span id="index-display-3"></span> -<dl class="def"> -<dt id="index-display-14"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>display</strong> <em>(<var>obj</var>)</em><a href='#index-display-14' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-display-3"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-14"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">display</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-display-14'> ¶</a></span></dt> <dd><p>Display the rotary encoder object in a verbose way, </p> -<span id="Inputs-58"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the arduino rotary encoder object created with rotaryEncoder +<h4 class="subsubheading" id="Inputs-58">Inputs</h4> +<p><var class="var">obj</var> - the arduino rotary encoder object created with rotaryEncoder </p> -<p><strong>See also:</strong> rotaryEncoder. - </p></dd></dl> +<p><strong class="strong">See also:</strong> rotaryEncoder. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040rotaryEncoder_002freadCount"> +<div class="subsection-level-extent" id="g_t_0040rotaryEncoder_002freadCount"> <h4 class="subsection">9.4.3 @rotaryEncoder/readCount</h4> -<span id="index-readCount"></span> -<dl class="def"> -<dt id="index-readCount-1"><span class="category">: </span><span><em>[<var>count</var>, <var>time</var>] =</em> <strong>readCount</strong> <em>(<var>obj</var>)</em><a href='#index-readCount-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-readCount-2"><span class="category">: </span><span><em>[<var>count</var>, <var>time</var>] =</em> <strong>readCount</strong> <em>(<var>obj</var>, <var>name</var>, <var>value</var>)</em><a href='#index-readCount-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-readCount"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readCount-1"><span class="category-def">: </span><span><code class="def-type">[<var class="var">count</var>, <var class="var">time</var>] =</code> <strong class="def-name">readCount</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-readCount-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-readCount-2"><span class="category-def">: </span><span><code class="def-type">[<var class="var">count</var>, <var class="var">time</var>] =</code> <strong class="def-name">readCount</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">name</var>, <var class="var">value</var>)</code><a class="copiable-link" href='#index-readCount-2'> ¶</a></span></dt> <dd><p>read count value from the rotary encoder. </p> <p>subsubheading Inputs - <var>obj</var> - rotary encoder object created with rotaryEncoder call. +<var class="var">obj</var> - rotary encoder object created with rotaryEncoder call. </p> -<p><var>name</var>, <var>value</var> - optional name,value pairs +<p><var class="var">name</var>, <var class="var">value</var> - optional name,value pairs </p> <p>Valid option name pairs currently are: - </p><dl compact="compact"> -<dt><span>reset</span></dt> +</p><dl class="table"> +<dt>reset</dt> <dd><p>Reset the count after reading (if true) - </p></dd> +</p></dd> </dl> -<span id="Outputs-39"></span><h4 class="subsubheading">Outputs</h4> -<p><var>count</var> - returned count read from the encoder. +<h4 class="subsubheading" id="Outputs-39">Outputs</h4> +<p><var class="var">count</var> - returned count read from the encoder. </p> -<p><var>time</var> - seconds since arduino started +<p><var class="var">time</var> - seconds since arduino started </p> -<p><strong>See also:</strong> rotaryEncoder, resetCount. - </p></dd></dl> +<p><strong class="strong">See also:</strong> rotaryEncoder, resetCount. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040rotaryEncoder_002freadSpeed"> +<div class="subsection-level-extent" id="g_t_0040rotaryEncoder_002freadSpeed"> <h4 class="subsection">9.4.4 @rotaryEncoder/readSpeed</h4> -<span id="index-readSpeed"></span> -<dl class="def"> -<dt id="index-readSpeed-1"><span class="category">: </span><span><em><var>speed</var> =</em> <strong>readSpeed</strong> <em>(<var>obj</var>)</em><a href='#index-readSpeed-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-readSpeed"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readSpeed-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">speed</var> =</code> <strong class="def-name">readSpeed</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-readSpeed-1'> ¶</a></span></dt> <dd><p>read rotational speed from the rotary encoder. </p> -<span id="Inputs-59"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - rotary encoder object created with rotaryEncoder call. +<h4 class="subsubheading" id="Inputs-59">Inputs</h4> +<p><var class="var">obj</var> - rotary encoder object created with rotaryEncoder call. </p> -<span id="Outputs-40"></span><h4 class="subsubheading">Outputs</h4> -<p><var>speed</var> - returned speed in revolutions per minute read from the encoder. +<h4 class="subsubheading" id="Outputs-40">Outputs</h4> +<p><var class="var">speed</var> - returned speed in revolutions per minute read from the encoder. </p> -<p><strong>See also:</strong> rotaryEncoder, resetCount. - </p></dd></dl> +<p><strong class="strong">See also:</strong> rotaryEncoder, resetCount. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040rotaryEncoder_002fresetCount"> +<div class="subsection-level-extent" id="g_t_0040rotaryEncoder_002fresetCount"> <h4 class="subsection">9.4.5 @rotaryEncoder/resetCount</h4> -<span id="index-resetCount"></span> -<dl class="def"> -<dt id="index-_0028obj_0029"><span class="category">: </span><span><em>reset</em> <strong>(<var>obj</var>)</strong><a href='#index-_0028obj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-_0028obj_002c"><span class="category">: </span><span><em>reset</em> <strong>(<var>obj</var>,</strong> <em><var>cnt</var>)</em><a href='#index-_0028obj_002c' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-resetCount"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-_0028obj_0029"><span class="category-def">: </span><span><code class="def-type">reset</code> <strong class="def-name">(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-_0028obj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-_0028obj_002c"><span class="category-def">: </span><span><code class="def-type">reset</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">cnt</var>)</code><a class="copiable-link" href='#index-_0028obj_002c'> ¶</a></span></dt> <dd><p>reset the rotary encoder count values </p> -<span id="Inputs-60"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the rotaryEncoder object +<h4 class="subsubheading" id="Inputs-60">Inputs</h4> +<p><var class="var">obj</var> - the rotaryEncoder object </p> -<p><var>cnt</var> - optional count value to reset to +<p><var class="var">cnt</var> - optional count value to reset to </p> -<p><strong>See also:</strong> rotaryEncoder, readCount. - </p></dd></dl> +<p><strong class="strong">See also:</strong> rotaryEncoder, readCount. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040rotaryEncoder_002frotaryEncoder"> +<div class="subsection-level-extent" id="g_t_0040rotaryEncoder_002frotaryEncoder"> <h4 class="subsection">9.4.6 @rotaryEncoder/rotaryEncoder</h4> -<span id="index-rotaryEncoder"></span> -<dl class="def"> -<dt id="index-rotaryEncoder-1"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>rotaryEncoder</strong> <em>(<var>ar</var>, <var>chanApin</var>, <var>chanBpin</var>)</em><a href='#index-rotaryEncoder-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-rotaryEncoder-2"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>rotaryEncoder</strong> <em>(<var>ar</var>, <var>chanApin</var>, <var>chanBpin</var>, <var>ppr</var>)</em><a href='#index-rotaryEncoder-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-rotaryEncoder"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-rotaryEncoder-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">rotaryEncoder</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">chanApin</var>, <var class="var">chanBpin</var>)</code><a class="copiable-link" href='#index-rotaryEncoder-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-rotaryEncoder-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">rotaryEncoder</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">chanApin</var>, <var class="var">chanBpin</var>, <var class="var">ppr</var>)</code><a class="copiable-link" href='#index-rotaryEncoder-2'> ¶</a></span></dt> <dd><p>Create a rotaryEncoder object controlled by the input pins. </p> -<span id="Inputs-61"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object. +<h4 class="subsubheading" id="Inputs-61">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object. </p> -<p><var>chanApin</var> - pin used for channel A +<p><var class="var">chanApin</var> - pin used for channel A </p> -<p><var>chanBpin</var> - pin used for channel B +<p><var class="var">chanBpin</var> - pin used for channel B </p> -<p><var>ppr</var> - count of encoder pulsed required for a full revolution of the encoder. +<p><var class="var">ppr</var> - count of encoder pulsed required for a full revolution of the encoder. </p> -<span id="Outputs-41"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created rotary encoder object +<h4 class="subsubheading" id="Outputs-41">Outputs</h4> +<p><var class="var">obj</var> - created rotary encoder object </p> -<span id="Example-9"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-9">Example</h4> <div class="example"> -<pre class="example"> a = arduino (); +<pre class="example-preformatted"> a = arduino (); enc = rotaryEncoder(a, "d2", "d3", 180); - </pre></div> +</pre></div> -<span id="Properties-2"></span><h4 class="subsubheading">Properties</h4> +<h4 class="subsubheading" id="Properties-2">Properties</h4> <p>The rotaryEncoder object has the following public properties: - </p><dl compact="compact"> -<dt><span>parent</span></dt> +</p><dl class="table"> +<dt>parent</dt> <dd><p>The parent (arduino) for this device - </p></dd> -<dt><span>pins</span></dt> +</p></dd> +<dt>pins</dt> <dd><p>pins used by this object - </p></dd> -<dt><span>ppr</span></dt> +</p></dd> +<dt>ppr</dt> <dd><p>Number of pulses used per rotation - </p></dd> +</p></dd> </dl> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040rotaryEncoder_002fsubsref"> +<div class="subsection-level-extent" id="g_t_0040rotaryEncoder_002fsubsref"> <h4 class="subsection">9.4.7 @rotaryEncoder/subsref</h4> -<span id="index-subsref-2"></span> -<dl class="def"> -<dt id="index-subsref-12"><span class="category">: </span><span><em><var>val</var> =</em> <strong>subsref</strong> <em>(<var>dev</var>, <var>sub</var>)</em><a href='#index-subsref-12' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-subsref-2"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-subsref-12"><span class="category-def">: </span><span><code class="def-type"><var class="var">val</var> =</code> <strong class="def-name">subsref</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">sub</var>)</code><a class="copiable-link" href='#index-subsref-12'> ¶</a></span></dt> <dd><p>subref for rotaryEncoder </p> -<p><strong>See also:</strong> rotaryEncoder. - </p></dd></dl> +<p><strong class="strong">See also:</strong> rotaryEncoder. +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Arduino-Servo-Functions"> -<div class="header"> +<div class="section-level-extent" id="Arduino-Servo-Functions"> +<div class="nav-panel"> <p> Next: <a href="#Arduino-Shiftregister-Functions" accesskey="n" rel="next">Arduino Shiftregister Functions</a>, Previous: <a href="#Arduino-Rotary-Encoder-Functions" accesskey="p" rel="prev">Arduino Rotary Encoder Functions</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Arduino-Servo-Functions-1"></span><h3 class="section">9.5 Arduino Servo Functions</h3> -<span id="index-Arduino-Servo-Functions"></span> -<ul class="section-toc"> +<h3 class="section" id="Arduino-Servo-Functions-1">9.5 Arduino Servo Functions</h3> +<a class="index-entry-id" id="index-Arduino-Servo-Functions"></a> +<ul class="mini-toc"> <li><a href="#g_t_0040servo_002fdelete" accesskey="1">@servo/delete</a></li> <li><a href="#g_t_0040servo_002fdisplay" accesskey="2">@servo/display</a></li> <li><a href="#g_t_0040servo_002freadPosition" accesskey="3">@servo/readPosition</a></li> @@ -3292,150 +3292,150 @@ Next: <a href="#Arduino-Shiftregister-Functions" accesskey="n" rel="next">Arduin <li><a href="#g_t_0040servo_002fsubsref" accesskey="5">@servo/subsref</a></li> <li><a href="#g_t_0040servo_002fwritePosition" accesskey="6">@servo/writePosition</a></li> </ul> -<div class="subsection" id="g_t_0040servo_002fdelete"> +<div class="subsection-level-extent" id="g_t_0040servo_002fdelete"> <h4 class="subsection">9.5.1 @servo/delete</h4> -<span id="index-delete-4"></span> -<dl class="def"> -<dt id="index-delete-15"><span class="category">: </span><span><em></em> <strong>delete</strong> <em>(<var>dev</var>)</em><a href='#index-delete-15' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-delete-4"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-delete-15"><span class="category-def">: </span><span><strong class="def-name">delete</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-delete-15'> ¶</a></span></dt> <dd><p>Free resources of a servo object. </p> -<span id="Inputs-62"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - object to free +<h4 class="subsubheading" id="Inputs-62">Inputs</h4> +<p><var class="var">dev</var> - object to free </p> -<p><strong>See also:</strong> servo. - </p></dd></dl> +<p><strong class="strong">See also:</strong> servo. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040servo_002fdisplay"> +<div class="subsection-level-extent" id="g_t_0040servo_002fdisplay"> <h4 class="subsection">9.5.2 @servo/display</h4> -<span id="index-display-4"></span> -<dl class="def"> -<dt id="index-display-15"><span class="category">: </span><span><em></em> <strong>display</strong> <em>(<var>dev</var>)</em><a href='#index-display-15' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-display-4"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-15"><span class="category-def">: </span><span><strong class="def-name">display</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-display-15'> ¶</a></span></dt> <dd><p>Display servo object. </p> -<span id="Inputs-63"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - device to display +<h4 class="subsubheading" id="Inputs-63">Inputs</h4> +<p><var class="var">dev</var> - device to display </p> -<p><strong>See also:</strong> servo. - </p></dd></dl> +<p><strong class="strong">See also:</strong> servo. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040servo_002freadPosition"> +<div class="subsection-level-extent" id="g_t_0040servo_002freadPosition"> <h4 class="subsection">9.5.3 @servo/readPosition</h4> -<span id="index-readPosition"></span> -<dl class="def"> -<dt id="index-readPosition-1"><span class="category">: </span><span><em><var>position</var> =</em> <strong>readPosition</strong> <em>(<var>servo</var>)</em><a href='#index-readPosition-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-readPosition"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readPosition-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">position</var> =</code> <strong class="def-name">readPosition</strong> <code class="def-code-arguments">(<var class="var">servo</var>)</code><a class="copiable-link" href='#index-readPosition-1'> ¶</a></span></dt> <dd><p>Read the position of a servo </p> -<span id="Inputs-64"></span><h4 class="subsubheading">Inputs</h4> -<p><var>servo</var> - servo object created from arduino.servo. +<h4 class="subsubheading" id="Inputs-64">Inputs</h4> +<p><var class="var">servo</var> - servo object created from arduino.servo. </p> -<span id="Outputs-42"></span><h4 class="subsubheading">Outputs</h4> -<p><var>position</var> - value between 0 .. 1 for the current servo position, +<h4 class="subsubheading" id="Outputs-42">Outputs</h4> +<p><var class="var">position</var> - value between 0 .. 1 for the current servo position, where 0 is the servo min position, 1 is the servo maximum position. </p> -<p><strong>See also:</strong> servo, writePosition. - </p></dd></dl> +<p><strong class="strong">See also:</strong> servo, writePosition. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040servo_002fservo"> +<div class="subsection-level-extent" id="g_t_0040servo_002fservo"> <h4 class="subsection">9.5.4 @servo/servo</h4> -<span id="index-servo"></span> -<dl class="def"> -<dt id="index-servo-1"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>servo</strong> <em>(<var>arduinoobj</var>, <var>pin</var>)</em><a href='#index-servo-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-servo-2"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>servo</strong> <em>(<var>arduinoobj</var>, <var>pin</var>, <var>propertyname</var>, <var>propertyvalue</var>)</em><a href='#index-servo-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-servo"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-servo-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">servo</strong> <code class="def-code-arguments">(<var class="var">arduinoobj</var>, <var class="var">pin</var>)</code><a class="copiable-link" href='#index-servo-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-servo-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">servo</strong> <code class="def-code-arguments">(<var class="var">arduinoobj</var>, <var class="var">pin</var>, <var class="var">propertyname</var>, <var class="var">propertyvalue</var>)</code><a class="copiable-link" href='#index-servo-2'> ¶</a></span></dt> <dd><p>Create a servo object using a specified pin on a arduino board. </p> -<span id="Inputs-65"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - servo object +<h4 class="subsubheading" id="Inputs-65">Inputs</h4> +<p><var class="var">obj</var> - servo object </p> -<p><var>arduinoobj</var> - connected arduino object +<p><var class="var">arduinoobj</var> - connected arduino object </p> -<p><var>propertyname</var>, <var>propertyvalue</var> - name value pairs for properties to pass +<p><var class="var">propertyname</var>, <var class="var">propertyvalue</var> - name value pairs for properties to pass to the created servo object. </p> <p>Current properties are: - </p><dl compact="compact"> -<dt><span>minpulseduration</span></dt> +</p><dl class="table"> +<dt>minpulseduration</dt> <dd><p>min PWM pulse value in seconds. - </p></dd> -<dt><span>maxpulseduration</span></dt> +</p></dd> +<dt>maxpulseduration</dt> <dd><p>max PWM pulse value in seconds. - </p></dd> +</p></dd> </dl> -<span id="Outputs-43"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created servo object. +<h4 class="subsubheading" id="Outputs-43">Outputs</h4> +<p><var class="var">obj</var> - created servo object. </p> -<span id="Example-10"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-10">Example</h4> <div class="example"> -<pre class="example"> # create arduino connection +<pre class="example-preformatted"> # create arduino connection ar = arduino(); # create hobby servo (1 - 2 ms pulse range) servo = servo(ar, "d9", "minpulseduration", 1.0e-3, "maxpulseduration", 2e-3); # center the servo writePosition(servo, 0.5); - </pre></div> +</pre></div> -<span id="Properties-3"></span><h4 class="subsubheading">Properties</h4> +<h4 class="subsubheading" id="Properties-3">Properties</h4> <p>The servo object has the following public properties: - </p><dl compact="compact"> -<dt><span>parent</span></dt> +</p><dl class="table"> +<dt>parent</dt> <dd><p>The parent (arduino) for this device - </p></dd> -<dt><span>pins</span></dt> +</p></dd> +<dt>pins</dt> <dd><p>pins used by this object - </p></dd> -<dt><span>minpulseduration</span></dt> +</p></dd> +<dt>minpulseduration</dt> <dd><p>minpulseduration set for object - </p></dd> -<dt><span>maxpulseduration</span></dt> +</p></dd> +<dt>maxpulseduration</dt> <dd><p>maxpulseduration set for object - </p></dd> +</p></dd> </dl> -<p><strong>See also:</strong> arduino, readPosition, writePosition. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, readPosition, writePosition. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040servo_002fsubsref"> +<div class="subsection-level-extent" id="g_t_0040servo_002fsubsref"> <h4 class="subsection">9.5.5 @servo/subsref</h4> -<span id="index-subsref-3"></span> -<dl class="def"> -<dt id="index-subsref-13"><span class="category">: </span><span><em><var>val</var> =</em> <strong>subsref</strong> <em>(<var>dev</var>, <var>sub</var>)</em><a href='#index-subsref-13' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-subsref-3"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-subsref-13"><span class="category-def">: </span><span><code class="def-type"><var class="var">val</var> =</code> <strong class="def-name">subsref</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">sub</var>)</code><a class="copiable-link" href='#index-subsref-13'> ¶</a></span></dt> <dd><p>subref for servo </p> -<p><strong>See also:</strong> servo. - </p></dd></dl> +<p><strong class="strong">See also:</strong> servo. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040servo_002fwritePosition"> +<div class="subsection-level-extent" id="g_t_0040servo_002fwritePosition"> <h4 class="subsection">9.5.6 @servo/writePosition</h4> -<span id="index-writePosition"></span> -<dl class="def"> -<dt id="index-writePosition-1"><span class="category">: </span><span><em></em> <strong>writePosition</strong> <em>(<var>servo</var>, <var>position</var>)</em><a href='#index-writePosition-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-writePosition"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-writePosition-1"><span class="category-def">: </span><span><strong class="def-name">writePosition</strong> <code class="def-code-arguments">(<var class="var">servo</var>, <var class="var">position</var>)</code><a class="copiable-link" href='#index-writePosition-1'> ¶</a></span></dt> <dd><p>Write the position to a servo. </p> -<span id="Inputs-66"></span><h4 class="subsubheading">Inputs</h4> -<p><var>servo</var> - servo object created from arduino.servo. +<h4 class="subsubheading" id="Inputs-66">Inputs</h4> +<p><var class="var">servo</var> - servo object created from arduino.servo. </p> -<p><var>position</var> - value between 0 .. 1 for the current servo position, +<p><var class="var">position</var> - value between 0 .. 1 for the current servo position, where 0 is the servo min position, 1 is the servo maximum position. </p> -<p><strong>See also:</strong> servo, readPosition. - </p></dd></dl> +<p><strong class="strong">See also:</strong> servo, readPosition. +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Arduino-Shiftregister-Functions"> -<div class="header"> +<div class="section-level-extent" id="Arduino-Shiftregister-Functions"> +<div class="nav-panel"> <p> Next: <a href="#Arduino-SPI-Functions" accesskey="n" rel="next">Arduino SPI Functions</a>, Previous: <a href="#Arduino-Servo-Functions" accesskey="p" rel="prev">Arduino Servo Functions</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Arduino-Shiftregister-Functions-1"></span><h3 class="section">9.6 Arduino Shiftregister Functions</h3> -<span id="index-Arduino-Shiftregister-Functions"></span> -<ul class="section-toc"> +<h3 class="section" id="Arduino-Shiftregister-Functions-1">9.6 Arduino Shiftregister Functions</h3> +<a class="index-entry-id" id="index-Arduino-Shiftregister-Functions"></a> +<ul class="mini-toc"> <li><a href="#g_t_0040shiftRegister_002fdelete" accesskey="1">@shiftRegister/delete</a></li> <li><a href="#g_t_0040shiftRegister_002fdisplay" accesskey="2">@shiftRegister/display</a></li> <li><a href="#g_t_0040shiftRegister_002fread" accesskey="3">@shiftRegister/read</a></li> @@ -3444,179 +3444,179 @@ Next: <a href="#Arduino-SPI-Functions" accesskey="n" rel="next">Arduino SPI Func <li><a href="#g_t_0040shiftRegister_002fsubsref" accesskey="6">@shiftRegister/subsref</a></li> <li><a href="#g_t_0040shiftRegister_002fwrite" accesskey="7">@shiftRegister/write</a></li> </ul> -<div class="subsection" id="g_t_0040shiftRegister_002fdelete"> +<div class="subsection-level-extent" id="g_t_0040shiftRegister_002fdelete"> <h4 class="subsection">9.6.1 @shiftRegister/delete</h4> -<span id="index-delete-5"></span> -<dl class="def"> -<dt id="index-delete-16"><span class="category">: </span><span><em></em> <strong>delete</strong> <em>(<var>dev</var>)</em><a href='#index-delete-16' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-delete-5"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-delete-16"><span class="category-def">: </span><span><strong class="def-name">delete</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-delete-16'> ¶</a></span></dt> <dd><p>Free resources of a shiftRegister object. </p> -<span id="Inputs-67"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - object to free +<h4 class="subsubheading" id="Inputs-67">Inputs</h4> +<p><var class="var">dev</var> - object to free </p> -<p><strong>See also:</strong> shiftRegister. - </p></dd></dl> +<p><strong class="strong">See also:</strong> shiftRegister. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040shiftRegister_002fdisplay"> +<div class="subsection-level-extent" id="g_t_0040shiftRegister_002fdisplay"> <h4 class="subsection">9.6.2 @shiftRegister/display</h4> -<span id="index-display-5"></span> -<dl class="def"> -<dt id="index-display-16"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>display</strong> <em>(<var>register</var>)</em><a href='#index-display-16' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-display-5"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-16"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">display</strong> <code class="def-code-arguments">(<var class="var">register</var>)</code><a class="copiable-link" href='#index-display-16'> ¶</a></span></dt> <dd><p>Display the register object in a verbose way, </p> -<span id="Inputs-68"></span><h4 class="subsubheading">Inputs</h4> -<p><var>register</var> - the arduino register object created with shiftRegister. +<h4 class="subsubheading" id="Inputs-68">Inputs</h4> +<p><var class="var">register</var> - the arduino register object created with shiftRegister. </p> -<p><strong>See also:</strong> shiftRegister. - </p></dd></dl> +<p><strong class="strong">See also:</strong> shiftRegister. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040shiftRegister_002fread"> +<div class="subsection-level-extent" id="g_t_0040shiftRegister_002fread"> <h4 class="subsection">9.6.3 @shiftRegister/read</h4> -<span id="index-read-2"></span> -<dl class="def"> -<dt id="index-read-9"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>read</strong> <em>(<var>register</var>)</em><a href='#index-read-9' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read-10"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>read</strong> <em>(<var>register</var>, <var>precision</var>)</em><a href='#index-read-10' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-read-2"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read-9"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">register</var>)</code><a class="copiable-link" href='#index-read-9'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read-10"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">register</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-read-10'> ¶</a></span></dt> <dd><p>read a value from the shift register. </p> -<span id="Inputs-69"></span><h4 class="subsubheading">Inputs</h4> -<p><var>register</var> - shift register created from shiftRegister call. +<h4 class="subsubheading" id="Inputs-69">Inputs</h4> +<p><var class="var">register</var> - shift register created from shiftRegister call. </p> -<p><var>precision</var> - optional precision of the data, where precision can be a +<p><var class="var">precision</var> - optional precision of the data, where precision can be a number in a multiple of 8 (ie: 8,16,32) or can be a named integer type: 8 of ’uint8’, ’uint16’, ’uint32’. The default precision is 8. </p> -<span id="Outputs-44"></span><h4 class="subsubheading">Outputs</h4> -<p><var>retval</var> - returned data read from the register. +<h4 class="subsubheading" id="Outputs-44">Outputs</h4> +<p><var class="var">retval</var> - returned data read from the register. </p> -<p><strong>See also:</strong> shiftRegister, write. - </p></dd></dl> +<p><strong class="strong">See also:</strong> shiftRegister, write. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040shiftRegister_002freset"> +<div class="subsection-level-extent" id="g_t_0040shiftRegister_002freset"> <h4 class="subsection">9.6.4 @shiftRegister/reset</h4> -<span id="index-reset-1"></span> -<dl class="def"> -<dt id="index-_0028register_0029"><span class="category">: </span><span><em>reset</em> <strong>(<var>register</var>)</strong><a href='#index-_0028register_0029' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-reset-1"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-_0028register_0029"><span class="category-def">: </span><span><code class="def-type">reset</code> <strong class="def-name">(<var class="var">register</var>)</strong><a class="copiable-link" href='#index-_0028register_0029'> ¶</a></span></dt> <dd><p>clear the shift register value. </p> -<span id="Inputs-70"></span><h4 class="subsubheading">Inputs</h4> -<p><var>register</var> - shift register created from shiftRegister call. +<h4 class="subsubheading" id="Inputs-70">Inputs</h4> +<p><var class="var">register</var> - shift register created from shiftRegister call. </p> -<p><strong>See also:</strong> shiftRegister, read, write. - </p></dd></dl> +<p><strong class="strong">See also:</strong> shiftRegister, read, write. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040shiftRegister_002fshiftRegister"> +<div class="subsection-level-extent" id="g_t_0040shiftRegister_002fshiftRegister"> <h4 class="subsection">9.6.5 @shiftRegister/shiftRegister</h4> -<span id="index-shiftRegister"></span> -<dl class="def"> -<dt id="index-shiftRegister-1"><span class="category">: </span><span><em><var>register</var> =</em> <strong>shiftRegister</strong> <em>(<var>ar</var>, <var>shifttype</var>, <var>dataPin</var>, <var>clockPin</var> ...)</em><a href='#index-shiftRegister-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-shiftRegister-2"><span class="category">: </span><span><em><var>register</var> =</em> <strong>shiftRegister</strong> <em>(<var>ar</var>,'74hc164', <var>dataPin</var>, <var>clockPin</var>, <var>resetPin</var>)</em><a href='#index-shiftRegister-2' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-shiftRegister-3"><span class="category">: </span><span><em><var>register</var> =</em> <strong>shiftRegister</strong> <em>(<var>ar</var>,'74hc165', <var>dataPin</var>, <var>clockPin</var>, <var>loadPin</var>, <var>clockEnablePin</var>)</em><a href='#index-shiftRegister-3' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-shiftRegister_0028ar_002c_002774hc595_0027_002c"><span class="category">: </span><span><em><var>register</var> =</em> <strong>shiftRegister(<var>ar</var>,'74hc595',</strong> <em><var>dataPin</var>, <var>clockPin</var>, <var>latchPin</var> , <var>resetPin</var>)</em><a href='#index-shiftRegister_0028ar_002c_002774hc595_0027_002c' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-shiftRegister"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-shiftRegister-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">register</var> =</code> <strong class="def-name">shiftRegister</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">shifttype</var>, <var class="var">dataPin</var>, <var class="var">clockPin</var> ...)</code><a class="copiable-link" href='#index-shiftRegister-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-shiftRegister-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">register</var> =</code> <strong class="def-name">shiftRegister</strong> <code class="def-code-arguments">(<var class="var">ar</var>,'74hc164', <var class="var">dataPin</var>, <var class="var">clockPin</var>, <var class="var">resetPin</var>)</code><a class="copiable-link" href='#index-shiftRegister-2'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-shiftRegister-3"><span class="category-def">: </span><span><code class="def-type"><var class="var">register</var> =</code> <strong class="def-name">shiftRegister</strong> <code class="def-code-arguments">(<var class="var">ar</var>,'74hc165', <var class="var">dataPin</var>, <var class="var">clockPin</var>, <var class="var">loadPin</var>, <var class="var">clockEnablePin</var>)</code><a class="copiable-link" href='#index-shiftRegister-3'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-shiftRegister_0028ar_002c_002774hc595_0027_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">register</var> =</code> <strong class="def-name">shiftRegister(<var class="var">ar</var>,'74hc595',</strong> <code class="def-code-arguments"><var class="var">dataPin</var>, <var class="var">clockPin</var>, <var class="var">latchPin</var> , <var class="var">resetPin</var>)</code><a class="copiable-link" href='#index-shiftRegister_0028ar_002c_002774hc595_0027_002c'> ¶</a></span></dt> <dd><p>Create shift register of a given type, controlled by the input pins. </p> -<span id="Inputs-71"></span><h4 class="subsubheading">Inputs</h4> +<h4 class="subsubheading" id="Inputs-71">Inputs</h4> <p>Common function parameter definition: </p> -<p><var>ar</var> - connected arduino object. +<p><var class="var">ar</var> - connected arduino object. </p> -<p><var>shifttype</var> - string name of the shift register type. +<p><var class="var">shifttype</var> - string name of the shift register type. </p> -<p><var>dataPin</var> - pin used for data in/out of the device. +<p><var class="var">dataPin</var> - pin used for data in/out of the device. </p> -<p><var>clockPin</var> - pin used for clocking data on the shiftRegister. +<p><var class="var">clockPin</var> - pin used for clocking data on the shiftRegister. </p> <p>Other variables are dependent on the shift register type: - </p><dl compact="compact"> -<dt><span>’74hc164’</span></dt> +</p><dl class="table"> +<dt>’74hc164’</dt> <dd><p>Additional inputs: </p> -<p><var>resetPin</var> - optional pin for resetting the shift register. +<p><var class="var">resetPin</var> - optional pin for resetting the shift register. </p> </dd> -<dt><span>’74hc165’</span></dt> +<dt>’74hc165’</dt> <dd><p>Additional inputs: </p> -<p><var>loadPin</var> - load pin to the shift register. - <var>clockEnablePin</var> - clock enable pin. +<p><var class="var">loadPin</var> - load pin to the shift register. +<var class="var">clockEnablePin</var> - clock enable pin. </p> </dd> -<dt><span>’74hc595’</span></dt> +<dt>’74hc595’</dt> <dd><p>Additional inputs: </p> -<p><var>latchPin</var> - latching data to the shift register. - <var>resetPin</var> - optional pin for resetting the shift register. +<p><var class="var">latchPin</var> - latching data to the shift register. +<var class="var">resetPin</var> - optional pin for resetting the shift register. </p> </dd> </dl> -<span id="Outputs-45"></span><h4 class="subsubheading">Outputs</h4> -<p><var>register</var> - register object +<h4 class="subsubheading" id="Outputs-45">Outputs</h4> +<p><var class="var">register</var> - register object </p> -<span id="Properties-4"></span><h4 class="subsubheading">Properties</h4> +<h4 class="subsubheading" id="Properties-4">Properties</h4> <p>The shiftRegister object has the following public properties: - </p><dl compact="compact"> -<dt><span>parent</span></dt> +</p><dl class="table"> +<dt>parent</dt> <dd><p>The parent (arduino) for this device - </p></dd> -<dt><span>pins</span></dt> +</p></dd> +<dt>pins</dt> <dd><p>pins used by this object - </p></dd> -<dt><span>model</span></dt> +</p></dd> +<dt>model</dt> <dd><p>model set for object - </p></dd> +</p></dd> </dl> -<p><strong>See also:</strong> arduino. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040shiftRegister_002fsubsref"> +<div class="subsection-level-extent" id="g_t_0040shiftRegister_002fsubsref"> <h4 class="subsection">9.6.6 @shiftRegister/subsref</h4> -<span id="index-subsref-4"></span> -<dl class="def"> -<dt id="index-subsref-14"><span class="category">: </span><span><em><var>val</var> =</em> <strong>subsref</strong> <em>(<var>dev</var>, <var>sub</var>)</em><a href='#index-subsref-14' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-subsref-4"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-subsref-14"><span class="category-def">: </span><span><code class="def-type"><var class="var">val</var> =</code> <strong class="def-name">subsref</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">sub</var>)</code><a class="copiable-link" href='#index-subsref-14'> ¶</a></span></dt> <dd><p>subref for shiftRegister </p> -<p><strong>See also:</strong> shiftRegister. - </p></dd></dl> +<p><strong class="strong">See also:</strong> shiftRegister. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040shiftRegister_002fwrite"> +<div class="subsection-level-extent" id="g_t_0040shiftRegister_002fwrite"> <h4 class="subsection">9.6.7 @shiftRegister/write</h4> -<span id="index-write-2"></span> -<dl class="def"> -<dt id="index-_0028register_002c"><span class="category">: </span><span><em>write</em> <strong>(<var>register</var>,</strong> <em><var>dataIn</var>)</em><a href='#index-_0028register_002c' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-_0028register_002c-1"><span class="category">: </span><span><em>write</em> <strong>(<var>register</var>,</strong> <em><var>dataIn</var>, <var>precision</var>)</em><a href='#index-_0028register_002c-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-write-2"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-_0028register_002c"><span class="category-def">: </span><span><code class="def-type">write</code> <strong class="def-name">(<var class="var">register</var>,</strong> <code class="def-code-arguments"><var class="var">dataIn</var>)</code><a class="copiable-link" href='#index-_0028register_002c'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-_0028register_002c-1"><span class="category-def">: </span><span><code class="def-type">write</code> <strong class="def-name">(<var class="var">register</var>,</strong> <code class="def-code-arguments"><var class="var">dataIn</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-_0028register_002c-1'> ¶</a></span></dt> <dd><p>Write a value to the shift register. </p> -<span id="Inputs-72"></span><h4 class="subsubheading">Inputs</h4> -<p><var>register</var> - shift register created from shiftRegister call. +<h4 class="subsubheading" id="Inputs-72">Inputs</h4> +<p><var class="var">register</var> - shift register created from shiftRegister call. </p> -<p><var>dataIn</var> - data to clock into the shiftRegister. +<p><var class="var">dataIn</var> - data to clock into the shiftRegister. </p> -<p><var>precision</var> - optional precision of the data, where precision can be a +<p><var class="var">precision</var> - optional precision of the data, where precision can be a number in a multiple of 8 (ie: 8,16,32) or can be a named integer type of ’uint8’, ’uint16’, ’uint32’. The default precision is 8. </p> -<p><strong>See also:</strong> shiftRegister, read. - </p></dd></dl> +<p><strong class="strong">See also:</strong> shiftRegister, read. +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Arduino-SPI-Functions"> -<div class="header"> +<div class="section-level-extent" id="Arduino-SPI-Functions"> +<div class="nav-panel"> <p> Next: <a href="#Arduino-Serial-Functions" accesskey="n" rel="next">Arduino Serial Functions</a>, Previous: <a href="#Arduino-Shiftregister-Functions" accesskey="p" rel="prev">Arduino Shiftregister Functions</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Arduino-SPI-Functions-1"></span><h3 class="section">9.7 Arduino SPI Functions</h3> -<span id="index-Arduino-SPI-Functions"></span> -<ul class="section-toc"> +<h3 class="section" id="Arduino-SPI-Functions-1">9.7 Arduino SPI Functions</h3> +<a class="index-entry-id" id="index-Arduino-SPI-Functions"></a> +<ul class="mini-toc"> <li><a href="#g_t_0040device_002fdelete-1" accesskey="1">@device/delete</a></li> <li><a href="#g_t_0040device_002fdisplay-1" accesskey="2">@device/display</a></li> <li><a href="#g_t_0040device_002fsubsref-1" accesskey="3">@device/subsref</a></li> @@ -3627,196 +3627,196 @@ Next: <a href="#Arduino-Serial-Functions" accesskey="n" rel="next">Arduino Seria <li><a href="#g_t_0040spidev_002fsubsref" accesskey="8">@spidev/subsref</a></li> <li><a href="#g_t_0040spidev_002fwriteRead" accesskey="9">@spidev/writeRead</a></li> </ul> -<div class="subsection" id="g_t_0040device_002fdelete-1"> +<div class="subsection-level-extent" id="g_t_0040device_002fdelete-1"> <h4 class="subsection">9.7.1 @device/delete</h4> -<span id="index-delete-6"></span> -<dl class="def"> -<dt id="index-delete-17"><span class="category">: </span><span><em></em> <strong>delete</strong> <em>(<var>dev</var>)</em><a href='#index-delete-17' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-delete-6"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-delete-17"><span class="category-def">: </span><span><strong class="def-name">delete</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-delete-17'> ¶</a></span></dt> <dd><p>Free resources of a device object. </p> -<span id="Inputs-73"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - object to free +<h4 class="subsubheading" id="Inputs-73">Inputs</h4> +<p><var class="var">dev</var> - object to free </p> -<p><strong>See also:</strong> device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fdisplay-1"> +<div class="subsection-level-extent" id="g_t_0040device_002fdisplay-1"> <h4 class="subsection">9.7.2 @device/display</h4> -<span id="index-display-6"></span> -<dl class="def"> -<dt id="index-display-17"><span class="category">: </span><span><em></em> <strong>display</strong> <em>(<var>dev</var>)</em><a href='#index-display-17' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-display-6"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-17"><span class="category-def">: </span><span><strong class="def-name">display</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-display-17'> ¶</a></span></dt> <dd><p>Display device object. </p> -<span id="Inputs-74"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - device object to display +<h4 class="subsubheading" id="Inputs-74">Inputs</h4> +<p><var class="var">dev</var> - device object to display </p> -<p><strong>See also:</strong> device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fsubsref-1"> +<div class="subsection-level-extent" id="g_t_0040device_002fsubsref-1"> <h4 class="subsection">9.7.3 @device/subsref</h4> -<span id="index-subsref-5"></span> -<dl class="def"> -<dt id="index-subsref-15"><span class="category">: </span><span><em><var>val</var> =</em> <strong>subsref</strong> <em>(<var>dev</var>, <var>sub</var>)</em><a href='#index-subsref-15' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-subsref-5"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-subsref-15"><span class="category-def">: </span><span><code class="def-type"><var class="var">val</var> =</code> <strong class="def-name">subsref</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">sub</var>)</code><a class="copiable-link" href='#index-subsref-15'> ¶</a></span></dt> <dd><p>subref for device </p> -<p><strong>See also:</strong> device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fwriteRead"> +<div class="subsection-level-extent" id="g_t_0040device_002fwriteRead"> <h4 class="subsection">9.7.4 @device/writeRead</h4> -<span id="index-writeRead"></span> -<dl class="def"> -<dt id="index-readWrite"><span class="category">: </span><span><em><var>dataOut</var> =</em> <strong>readWrite</strong> <em>(<var>spi</var>, <var>dataIn</var>)</em><a href='#index-readWrite' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-writeRead"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readWrite"><span class="category-def">: </span><span><code class="def-type"><var class="var">dataOut</var> =</code> <strong class="def-name">readWrite</strong> <code class="def-code-arguments">(<var class="var">spi</var>, <var class="var">dataIn</var>)</code><a class="copiable-link" href='#index-readWrite'> ¶</a></span></dt> <dd><p>Write uint8 data to spi device and return back clocked out response data of same size. </p> -<span id="Inputs-75"></span><h4 class="subsubheading">Inputs</h4> -<p><var>spi</var> - connected spi device on arduino +<h4 class="subsubheading" id="Inputs-75">Inputs</h4> +<p><var class="var">spi</var> - connected spi device on arduino </p> -<p><var>dataIn</var> - uint8 sized data to send to spi device framed between SS frame. +<p><var class="var">dataIn</var> - uint8 sized data to send to spi device framed between SS frame. </p> -<span id="Outputs-46"></span><h4 class="subsubheading">Outputs</h4> -<p><var>dataOut</var> - uint8 data clocked out during send to dataIn. +<h4 class="subsubheading" id="Outputs-46">Outputs</h4> +<p><var class="var">dataOut</var> - uint8 data clocked out during send to dataIn. </p> -<p><strong>See also:</strong> arduino, device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040spidev_002fdelete"> +<div class="subsection-level-extent" id="g_t_0040spidev_002fdelete"> <h4 class="subsection">9.7.5 @spidev/delete</h4> -<span id="index-delete-7"></span> -<dl class="def"> -<dt id="index-delete-18"><span class="category">: </span><span><em></em> <strong>delete</strong> <em>(<var>dev</var>)</em><a href='#index-delete-18' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-delete-7"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-delete-18"><span class="category-def">: </span><span><strong class="def-name">delete</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-delete-18'> ¶</a></span></dt> <dd><p>Free resources of a spidev object. </p> -<span id="Inputs-76"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - spidev object to free +<h4 class="subsubheading" id="Inputs-76">Inputs</h4> +<p><var class="var">dev</var> - spidev object to free </p> -<p><strong>See also:</strong> spidev. - </p></dd></dl> +<p><strong class="strong">See also:</strong> spidev. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040spidev_002fdisplay"> +<div class="subsection-level-extent" id="g_t_0040spidev_002fdisplay"> <h4 class="subsection">9.7.6 @spidev/display</h4> -<span id="index-display-7"></span> -<dl class="def"> -<dt id="index-display-18"><span class="category">: </span><span><em></em> <strong>display</strong> <em>(<var>dev</var>)</em><a href='#index-display-18' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-display-7"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-18"><span class="category-def">: </span><span><strong class="def-name">display</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-display-18'> ¶</a></span></dt> <dd><p>Display spidev object. </p> -<span id="Inputs-77"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - spidev object to display +<h4 class="subsubheading" id="Inputs-77">Inputs</h4> +<p><var class="var">dev</var> - spidev object to display </p> -<p><strong>See also:</strong> spidev. - </p></dd></dl> +<p><strong class="strong">See also:</strong> spidev. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040spidev_002fspidev"> +<div class="subsection-level-extent" id="g_t_0040spidev_002fspidev"> <h4 class="subsection">9.7.7 @spidev/spidev</h4> -<span id="index-spidev"></span> -<dl class="def"> -<dt id="index-spidev-1"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>spidev</strong> <em>(<var>ar</var>, <var>cspin</var>)</em><a href='#index-spidev-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-spidev-2"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>spidev</strong> <em>(<var>ar</var>, <var>cspin</var>, <var>propname</var>, <var>propvalue</var>)</em><a href='#index-spidev-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-spidev"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-spidev-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">spidev</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">cspin</var>)</code><a class="copiable-link" href='#index-spidev-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-spidev-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">spidev</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">cspin</var>, <var class="var">propname</var>, <var class="var">propvalue</var>)</code><a class="copiable-link" href='#index-spidev-2'> ¶</a></span></dt> <dd> -<p><code>spidev</code> is depreciated and will be removed in a future version. - Use <code>device</code> instead. +<p><code class="code">spidev</code> is depreciated and will be removed in a future version. + Use <code class="code">device</code> instead. </p> <p>Create an spidev object to communicate to the SPI port on a connected arduino. </p> -<span id="Inputs-78"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-78">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>cspin</var> - chip select pin for attached spi device. +<p><var class="var">cspin</var> - chip select pin for attached spi device. </p> -<p><var>propname</var>, <var>propvalue</var> - property name/value pair for values to pass to devices. +<p><var class="var">propname</var>, <var class="var">propvalue</var> - property name/value pair for values to pass to devices. </p> <p>Currently known properties: - </p><dl compact="compact"> -<dt><span>bitrate</span></dt> +</p><dl class="table"> +<dt>bitrate</dt> <dd><p>bit rate speed in Mbs - </p></dd> -<dt><span>bitorder</span></dt> +</p></dd> +<dt>bitorder</dt> <dd><p>’msbfirst’ or ’lsbfirst’ - </p></dd> -<dt><span>mode</span></dt> +</p></dd> +<dt>mode</dt> <dd><p>SPI mode 0 - 3. - </p></dd> +</p></dd> </dl> -<span id="Outputs-47"></span><h4 class="subsubheading">Outputs</h4> -<p><var>dev</var> - created spidev object +<h4 class="subsubheading" id="Outputs-47">Outputs</h4> +<p><var class="var">dev</var> - created spidev object </p> -<span id="Properties-5"></span><h4 class="subsubheading">Properties</h4> +<h4 class="subsubheading" id="Properties-5">Properties</h4> <p>The spidev object has the following public properties: - </p><dl compact="compact"> -<dt><span>parent</span></dt> +</p><dl class="table"> +<dt>parent</dt> <dd><p>The parent (arduino) for this device - </p></dd> -<dt><span>pins</span></dt> +</p></dd> +<dt>pins</dt> <dd><p>pins used by this object - </p></dd> -<dt><span>mode</span></dt> +</p></dd> +<dt>mode</dt> <dd><p>mode used for created object - </p></dd> -<dt><span>bitrate</span></dt> +</p></dd> +<dt>bitrate</dt> <dd><p>Bitrate set for object - </p></dd> -<dt><span>bitorder</span></dt> +</p></dd> +<dt>bitorder</dt> <dd><p>Bitorder set for object - </p></dd> -<dt><span>chipselectpin</span></dt> +</p></dd> +<dt>chipselectpin</dt> <dd><p>Pin used for chipselect - </p></dd> +</p></dd> </dl> -<p><strong>See also:</strong> arduino, readWrite. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, readWrite. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040spidev_002fsubsref"> +<div class="subsection-level-extent" id="g_t_0040spidev_002fsubsref"> <h4 class="subsection">9.7.8 @spidev/subsref</h4> -<span id="index-subsref-6"></span> -<dl class="def"> -<dt id="index-subsref-16"><span class="category">: </span><span><em><var>val</var> =</em> <strong>subsref</strong> <em>(<var>dev</var>, <var>sub</var>)</em><a href='#index-subsref-16' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-subsref-6"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-subsref-16"><span class="category-def">: </span><span><code class="def-type"><var class="var">val</var> =</code> <strong class="def-name">subsref</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">sub</var>)</code><a class="copiable-link" href='#index-subsref-16'> ¶</a></span></dt> <dd><p>subref for spidev </p> -<p><strong>See also:</strong> spidev. - </p></dd></dl> +<p><strong class="strong">See also:</strong> spidev. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040spidev_002fwriteRead"> +<div class="subsection-level-extent" id="g_t_0040spidev_002fwriteRead"> <h4 class="subsection">9.7.9 @spidev/writeRead</h4> -<span id="index-writeRead-1"></span> -<dl class="def"> -<dt id="index-readWrite-1"><span class="category">: </span><span><em><var>dataOut</var> =</em> <strong>readWrite</strong> <em>(<var>spi</var>, <var>dataIn</var>)</em><a href='#index-readWrite-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-writeRead-1"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readWrite-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">dataOut</var> =</code> <strong class="def-name">readWrite</strong> <code class="def-code-arguments">(<var class="var">spi</var>, <var class="var">dataIn</var>)</code><a class="copiable-link" href='#index-readWrite-1'> ¶</a></span></dt> <dd><p>Write uint8 data to spi device and return back clocked out response data of same size. </p> -<span id="Inputs-79"></span><h4 class="subsubheading">Inputs</h4> -<p><var>spi</var> - connected spi device on arduino +<h4 class="subsubheading" id="Inputs-79">Inputs</h4> +<p><var class="var">spi</var> - connected spi device on arduino </p> -<p><var>dataIn</var> - uint8 sized data to send to spi device framed between SS frame. +<p><var class="var">dataIn</var> - uint8 sized data to send to spi device framed between SS frame. </p> -<span id="Outputs-48"></span><h4 class="subsubheading">Outputs</h4> -<p><var>dataOut</var> - uint8 data clocked out during send to dataIn. +<h4 class="subsubheading" id="Outputs-48">Outputs</h4> +<p><var class="var">dataOut</var> - uint8 data clocked out during send to dataIn. </p> -<p><strong>See also:</strong> arduino, spidev. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, spidev. +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Arduino-Serial-Functions"> -<div class="header"> +<div class="section-level-extent" id="Arduino-Serial-Functions"> +<div class="nav-panel"> <p> Next: <a href="#Arduino-Device-Functions" accesskey="n" rel="next">Arduino Device Functions</a>, Previous: <a href="#Arduino-SPI-Functions" accesskey="p" rel="prev">Arduino SPI Functions</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Arduino-Serial-Functions-1"></span><h3 class="section">9.8 Arduino Serial Functions</h3> -<span id="index-Arduino-Serial-Functions"></span> -<ul class="section-toc"> +<h3 class="section" id="Arduino-Serial-Functions-1">9.8 Arduino Serial Functions</h3> +<a class="index-entry-id" id="index-Arduino-Serial-Functions"></a> +<ul class="mini-toc"> <li><a href="#g_t_0040device_002fdelete-2" accesskey="1">@device/delete</a></li> <li><a href="#g_t_0040device_002fdevice" accesskey="2">@device/device</a></li> <li><a href="#g_t_0040device_002fdisplay-2" accesskey="3">@device/display</a></li> @@ -3825,282 +3825,282 @@ Next: <a href="#Arduino-Device-Functions" accesskey="n" rel="next">Arduino Devic <li><a href="#g_t_0040device_002fsubsref-2" accesskey="6">@device/subsref</a></li> <li><a href="#g_t_0040device_002fwrite-1" accesskey="7">@device/write</a></li> </ul> -<div class="subsection" id="g_t_0040device_002fdelete-2"> +<div class="subsection-level-extent" id="g_t_0040device_002fdelete-2"> <h4 class="subsection">9.8.1 @device/delete</h4> -<span id="index-delete-8"></span> -<dl class="def"> -<dt id="index-delete-19"><span class="category">: </span><span><em></em> <strong>delete</strong> <em>(<var>dev</var>)</em><a href='#index-delete-19' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-delete-8"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-delete-19"><span class="category-def">: </span><span><strong class="def-name">delete</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-delete-19'> ¶</a></span></dt> <dd><p>Free resources of a device object. </p> -<span id="Inputs-80"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - object to free +<h4 class="subsubheading" id="Inputs-80">Inputs</h4> +<p><var class="var">dev</var> - object to free </p> -<p><strong>See also:</strong> device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fdevice"> +<div class="subsection-level-extent" id="g_t_0040device_002fdevice"> <h4 class="subsection">9.8.2 @device/device</h4> -<span id="index-device"></span> -<dl class="def"> -<dt id="index-device-2"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>device</strong> <em>(<var>ar</var>, 'I2CAddress', <var>address</var>)</em><a href='#index-device-2' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-device-3"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>device</strong> <em>(<var>ar</var>, 'SPIChipSelectPin', <var>pin</var>)</em><a href='#index-device-3' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-device-4"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>device</strong> <em>(<var>ar</var>, 'Serial', <var>serialid</var>)</em><a href='#index-device-4' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-device-5"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>device</strong> <em>(..., <var>propname</var>, <var>propvalue</var>)</em><a href='#index-device-5' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-device"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-device-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">device</strong> <code class="def-code-arguments">(<var class="var">ar</var>, 'I2CAddress', <var class="var">address</var>)</code><a class="copiable-link" href='#index-device-2'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-device-3"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">device</strong> <code class="def-code-arguments">(<var class="var">ar</var>, 'SPIChipSelectPin', <var class="var">pin</var>)</code><a class="copiable-link" href='#index-device-3'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-device-4"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">device</strong> <code class="def-code-arguments">(<var class="var">ar</var>, 'Serial', <var class="var">serialid</var>)</code><a class="copiable-link" href='#index-device-4'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-device-5"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">device</strong> <code class="def-code-arguments">(..., <var class="var">propname</var>, <var class="var">propvalue</var>)</code><a class="copiable-link" href='#index-device-5'> ¶</a></span></dt> <dd><p>Create an i2c, spi or serial object to communicate on a connected arduino. </p> -<span id="Inputs-81"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-81">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>propname</var>, <var>propvalue</var> - property name/value pair for values to pass to devices. +<p><var class="var">propname</var>, <var class="var">propvalue</var> - property name/value pair for values to pass to devices. </p> <p>A property of ’i2caddress’, ’spichipselectpin’ or ’serial’ must be specified to denote the device type to create. </p> -<p><var>i2caddress</var> - address to use for device on I2C bus. +<p><var class="var">i2caddress</var> - address to use for device on I2C bus. </p> -<p><var>pin</var> - pin to use for device SPI chip select. +<p><var class="var">pin</var> - pin to use for device SPI chip select. </p> -<p><var>serialid</var> - Serial port id to use +<p><var class="var">serialid</var> - Serial port id to use </p> <p>Additional properties can also be specified for the device object </p> <p>Currently known input I2C properties values: - </p><dl compact="compact"> -<dt><span>bus</span></dt> +</p><dl class="table"> +<dt>bus</dt> <dd><p>bus number (when arduino board supports multiple I2C buses) with value of 0 or 1. - </p></dd> -<dt><span>noprobe</span></dt> +</p></dd> +<dt>noprobe</dt> <dd><p>Do not probe the existence of device on creation if set to 1 (default 0) - </p></dd> -<dt><span>bitrate</span></dt> +</p></dd> +<dt>bitrate</dt> <dd><p>bit rate speed in Mbs - default 100000 - </p></dd> +</p></dd> </dl> <p>Currently known input SPI properties values: - </p><dl compact="compact"> -<dt><span>bitrate</span></dt> +</p><dl class="table"> +<dt>bitrate</dt> <dd><p>bit rate speed in Mbs - </p></dd> -<dt><span>bitorder</span></dt> +</p></dd> +<dt>bitorder</dt> <dd><p>’msbfirst’ or ’lsbfirst’ - </p></dd> -<dt><span>spimode</span></dt> +</p></dd> +<dt>spimode</dt> <dd><p>SPI mode 0 - 3. - </p></dd> +</p></dd> </dl> <p>Currently known input Serial properties values: - </p><dl compact="compact"> -<dt><span>baudrate</span></dt> +</p><dl class="table"> +<dt>baudrate</dt> <dd><p>baudrate value (default 9600) - </p></dd> -<dt><span>databits</span></dt> +</p></dd> +<dt>databits</dt> <dd><p>number of databits (5,6,7,8) (default 8) - </p></dd> -<dt><span>stopbits</span></dt> +</p></dd> +<dt>stopbits</dt> <dd><p>number of stopbits (1,2) (default 1) - </p></dd> -<dt><span>parity</span></dt> +</p></dd> +<dt>parity</dt> <dd><p>parity of device (’odd’,’even’,’none’) (default ’none’) - </p></dd> +</p></dd> </dl> -<span id="Outputs-49"></span><h4 class="subsubheading">Outputs</h4> -<p><var>dev</var> - new created device object. +<h4 class="subsubheading" id="Outputs-49">Outputs</h4> +<p><var class="var">dev</var> - new created device object. </p> -<span id="Properties-6"></span><h4 class="subsubheading">Properties</h4> +<h4 class="subsubheading" id="Properties-6">Properties</h4> <p>The object has the following public properties: - </p><dl compact="compact"> -<dt><span>parent</span></dt> +</p><dl class="table"> +<dt>parent</dt> <dd><p>The parent (arduino) for this device - </p></dd> -<dt><span>interface</span></dt> +</p></dd> +<dt>interface</dt> <dd><p>The interface type for this device ("SPI" or "I2C" or "Serial") - </p></dd> +</p></dd> </dl> <p>In addition, depending on type, the object will have these properties: </p> -<span id="I2C-Properties"></span><h4 class="subsubheading">I2C Properties</h4> +<h4 class="subsubheading" id="I2C-Properties">I2C Properties</h4> <p>The object has the following public properties: - </p><dl compact="compact"> -<dt><span>bus</span></dt> +</p><dl class="table"> +<dt>bus</dt> <dd><p>bus used for created object - </p></dd> -<dt><span>i2caddress</span></dt> +</p></dd> +<dt>i2caddress</dt> <dd><p>I2C address set for object - </p></dd> -<dt><span>sclpin</span></dt> +</p></dd> +<dt>sclpin</dt> <dd><p>the SCL pin of the device - </p></dd> -<dt><span>sdapin</span></dt> +</p></dd> +<dt>sdapin</dt> <dd><p>the SDA pin of the device - </p></dd> -<dt><span>bitrate</span></dt> +</p></dd> +<dt>bitrate</dt> <dd><p>bit rate for the i2c clock - </p></dd> +</p></dd> </dl> -<span id="SPI-Properties"></span><h4 class="subsubheading">SPI Properties</h4> +<h4 class="subsubheading" id="SPI-Properties">SPI Properties</h4> <p>The object has the following public properties: - </p><dl compact="compact"> -<dt><span>spimode</span></dt> +</p><dl class="table"> +<dt>spimode</dt> <dd><p>mode used for created object - </p></dd> -<dt><span>bitrate</span></dt> +</p></dd> +<dt>bitrate</dt> <dd><p>Bitrate set for object - </p></dd> -<dt><span>bitorder</span></dt> +</p></dd> +<dt>bitorder</dt> <dd><p>Bitorder set for object - </p></dd> -<dt><span>spichipselectpin</span></dt> +</p></dd> +<dt>spichipselectpin</dt> <dd><p>Pin used for chipselect - </p></dd> -<dt><span>mosipin</span></dt> +</p></dd> +<dt>mosipin</dt> <dd><p>Pin used for mosi - </p></dd> -<dt><span>misopin</span></dt> +</p></dd> +<dt>misopin</dt> <dd><p>Pin used for miso - </p></dd> -<dt><span>sckpin</span></dt> +</p></dd> +<dt>sckpin</dt> <dd><p>Pin used for sckpin - </p></dd> +</p></dd> </dl> -<span id="Serial-Properties"></span><h4 class="subsubheading">Serial Properties</h4> +<h4 class="subsubheading" id="Serial-Properties">Serial Properties</h4> <p>The object has the following public properties: - </p><dl compact="compact"> -<dt><span>id</span></dt> +</p><dl class="table"> +<dt>id</dt> <dd><p>serial port id - </p></dd> -<dt><span>baudrate</span></dt> +</p></dd> +<dt>baudrate</dt> <dd><p>baudrate - </p></dd> -<dt><span>databits</span></dt> +</p></dd> +<dt>databits</dt> <dd><p>number of databits (5,6,7,8) - </p></dd> -<dt><span>stopbits</span></dt> +</p></dd> +<dt>stopbits</dt> <dd><p>number of stopbits (1,2) - </p></dd> -<dt><span>parity</span></dt> +</p></dd> +<dt>parity</dt> <dd><p>parity of device (’odd’,’even’,’none’) - </p></dd> +</p></dd> </dl> -<p><strong>See also:</strong> arduino, i2cdev, spidev. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, i2cdev, spidev. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fdisplay-2"> +<div class="subsection-level-extent" id="g_t_0040device_002fdisplay-2"> <h4 class="subsection">9.8.3 @device/display</h4> -<span id="index-display-8"></span> -<dl class="def"> -<dt id="index-display-19"><span class="category">: </span><span><em></em> <strong>display</strong> <em>(<var>dev</var>)</em><a href='#index-display-19' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-display-8"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-19"><span class="category-def">: </span><span><strong class="def-name">display</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-display-19'> ¶</a></span></dt> <dd><p>Display device object. </p> -<span id="Inputs-82"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - device object to display +<h4 class="subsubheading" id="Inputs-82">Inputs</h4> +<p><var class="var">dev</var> - device object to display </p> -<p><strong>See also:</strong> device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fflush"> +<div class="subsection-level-extent" id="g_t_0040device_002fflush"> <h4 class="subsection">9.8.4 @device/flush</h4> -<span id="index-flush"></span> -<dl class="def"> -<dt id="index-flush-2"><span class="category">: </span><span><em><var>data</var> =</em> <strong>flush</strong> <em>(<var>dev</var>)</em><a href='#index-flush-2' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-flush-3"><span class="category">: </span><span><em><var>data</var> =</em> <strong>flush</strong> <em>(<var>dev</var>, "input")</em><a href='#index-flush-3' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-flush-4"><span class="category">: </span><span><em><var>data</var> =</em> <strong>flush</strong> <em>(<var>dev</var>, "output")</em><a href='#index-flush-4' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-flush"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-flush-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-flush-2'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-3"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "input")</code><a class="copiable-link" href='#index-flush-3'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-4"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "output")</code><a class="copiable-link" href='#index-flush-4'> ¶</a></span></dt> <dd><p>Flush the serial port buffers </p> -<span id="Inputs-83"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected serial device opened using device +<h4 class="subsubheading" id="Inputs-83">Inputs</h4> +<p><var class="var">dev</var> - connected serial device opened using device </p> <p>If an additional parameter is provided of "input" or "output", then only the input or output buffer will be flushed </p> -<span id="Outputs-50"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-50">Outputs</h4> <p>None </p> -<p><strong>See also:</strong> arduino, device, read. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device, read. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fread-1"> +<div class="subsection-level-extent" id="g_t_0040device_002fread-1"> <h4 class="subsection">9.8.5 @device/read</h4> -<span id="index-read-3"></span> -<dl class="def"> -<dt id="index-read-11"><span class="category">: </span><span><em><var>data</var> =</em> <strong>read</strong> <em>(<var>dev</var>, <var>numbytes</var>)</em><a href='#index-read-11' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read-12"><span class="category">: </span><span><em><var>data</var> =</em> <strong>read</strong> <em>(<var>dev</var>, <var>numbytes</var>, <var>precision</var>)</em><a href='#index-read-12' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-read-3"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read-11"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">numbytes</var>)</code><a class="copiable-link" href='#index-read-11'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read-12"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">numbytes</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-read-12'> ¶</a></span></dt> <dd><p>Read a specified number of bytes from a i2c or serial device object using optional precision for bytesize. </p> -<span id="Inputs-84"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c or serial device opened using device +<h4 class="subsubheading" id="Inputs-84">Inputs</h4> +<p><var class="var">dev</var> - connected i2c or serial device opened using device </p> -<p><var>numbytes</var> - number of bytes to read. +<p><var class="var">numbytes</var> - number of bytes to read. </p> -<p><var>precision</var> - Optional precision for the output data read data. +<p><var class="var">precision</var> - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<span id="Outputs-51"></span><h4 class="subsubheading">Outputs</h4> -<p><var>data</var> - data read from the device +<h4 class="subsubheading" id="Outputs-51">Outputs</h4> +<p><var class="var">data</var> - data read from the device </p> -<p><strong>See also:</strong> arduino, device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fsubsref-2"> +<div class="subsection-level-extent" id="g_t_0040device_002fsubsref-2"> <h4 class="subsection">9.8.6 @device/subsref</h4> -<span id="index-subsref-7"></span> -<dl class="def"> -<dt id="index-subsref-17"><span class="category">: </span><span><em><var>val</var> =</em> <strong>subsref</strong> <em>(<var>dev</var>, <var>sub</var>)</em><a href='#index-subsref-17' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-subsref-7"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-subsref-17"><span class="category-def">: </span><span><code class="def-type"><var class="var">val</var> =</code> <strong class="def-name">subsref</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">sub</var>)</code><a class="copiable-link" href='#index-subsref-17'> ¶</a></span></dt> <dd><p>subref for device </p> -<p><strong>See also:</strong> device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fwrite-1"> +<div class="subsection-level-extent" id="g_t_0040device_002fwrite-1"> <h4 class="subsection">9.8.7 @device/write</h4> -<span id="index-write-3"></span> -<dl class="def"> -<dt id="index-write-9"><span class="category">: </span><span><em></em> <strong>write</strong> <em>(<var>dev</var>, <var>datain</var>)</em><a href='#index-write-9' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-write-10"><span class="category">: </span><span><em></em> <strong>write</strong> <em>(<var>dev</var>, <var>datain</var>, <var>precision</var>)</em><a href='#index-write-10' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-write-3"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-write-9"><span class="category-def">: </span><span><strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">datain</var>)</code><a class="copiable-link" href='#index-write-9'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-write-10"><span class="category-def">: </span><span><strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">datain</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-write-10'> ¶</a></span></dt> <dd><p>Write data to a I2C or serial device object using optional precision for the data byte used for the data. </p> -<span id="Inputs-85"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c or serial device opened using device +<h4 class="subsubheading" id="Inputs-85">Inputs</h4> +<p><var class="var">dev</var> - connected i2c or serial device opened using device </p> -<p><var>datain</var> - data to write to device. Datasize should not exceed the constraints +<p><var class="var">datain</var> - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. </p> -<p><var>precision</var> - Optional precision for the input write data. +<p><var class="var">precision</var> - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<p><strong>See also:</strong> arduino, device, read. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device, read. +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Arduino-Device-Functions"> -<div class="header"> +<div class="section-level-extent" id="Arduino-Device-Functions"> +<div class="nav-panel"> <p> Next: <a href="#Arduino-Ultrasonic-Functions" accesskey="n" rel="next">Arduino Ultrasonic Functions</a>, Previous: <a href="#Arduino-Serial-Functions" accesskey="p" rel="prev">Arduino Serial Functions</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Arduino-Device-Functions-1"></span><h3 class="section">9.9 Arduino Device Functions</h3> -<span id="index-Arduino-Device-Functions"></span> -<ul class="section-toc"> +<h3 class="section" id="Arduino-Device-Functions-1">9.9 Arduino Device Functions</h3> +<a class="index-entry-id" id="index-Arduino-Device-Functions"></a> +<ul class="mini-toc"> <li><a href="#g_t_0040device_002fdelete-3" accesskey="1">@device/delete</a></li> <li><a href="#g_t_0040device_002fdevice-1" accesskey="2">@device/device</a></li> <li><a href="#g_t_0040device_002fdisplay-3" accesskey="3">@device/display</a></li> @@ -4112,352 +4112,352 @@ Next: <a href="#Arduino-Ultrasonic-Functions" accesskey="n" rel="next">Arduino U <li><a href="#g_t_0040device_002fwriteRead-1" accesskey="9">@device/writeRead</a></li> <li><a href="#g_t_0040device_002fwriteRegister-1">@device/writeRegister</a></li> </ul> -<div class="subsection" id="g_t_0040device_002fdelete-3"> +<div class="subsection-level-extent" id="g_t_0040device_002fdelete-3"> <h4 class="subsection">9.9.1 @device/delete</h4> -<span id="index-delete-9"></span> -<dl class="def"> -<dt id="index-delete-20"><span class="category">: </span><span><em></em> <strong>delete</strong> <em>(<var>dev</var>)</em><a href='#index-delete-20' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-delete-9"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-delete-20"><span class="category-def">: </span><span><strong class="def-name">delete</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-delete-20'> ¶</a></span></dt> <dd><p>Free resources of a device object. </p> -<span id="Inputs-86"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - object to free +<h4 class="subsubheading" id="Inputs-86">Inputs</h4> +<p><var class="var">dev</var> - object to free </p> -<p><strong>See also:</strong> device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fdevice-1"> +<div class="subsection-level-extent" id="g_t_0040device_002fdevice-1"> <h4 class="subsection">9.9.2 @device/device</h4> -<span id="index-device-1"></span> -<dl class="def"> -<dt id="index-device-6"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>device</strong> <em>(<var>ar</var>, 'I2CAddress', <var>address</var>)</em><a href='#index-device-6' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-device-7"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>device</strong> <em>(<var>ar</var>, 'SPIChipSelectPin', <var>pin</var>)</em><a href='#index-device-7' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-device-8"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>device</strong> <em>(<var>ar</var>, 'Serial', <var>serialid</var>)</em><a href='#index-device-8' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-device-9"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>device</strong> <em>(..., <var>propname</var>, <var>propvalue</var>)</em><a href='#index-device-9' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-device-1"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-device-6"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">device</strong> <code class="def-code-arguments">(<var class="var">ar</var>, 'I2CAddress', <var class="var">address</var>)</code><a class="copiable-link" href='#index-device-6'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-device-7"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">device</strong> <code class="def-code-arguments">(<var class="var">ar</var>, 'SPIChipSelectPin', <var class="var">pin</var>)</code><a class="copiable-link" href='#index-device-7'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-device-8"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">device</strong> <code class="def-code-arguments">(<var class="var">ar</var>, 'Serial', <var class="var">serialid</var>)</code><a class="copiable-link" href='#index-device-8'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-device-9"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">device</strong> <code class="def-code-arguments">(..., <var class="var">propname</var>, <var class="var">propvalue</var>)</code><a class="copiable-link" href='#index-device-9'> ¶</a></span></dt> <dd><p>Create an i2c, spi or serial object to communicate on a connected arduino. </p> -<span id="Inputs-87"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-87">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>propname</var>, <var>propvalue</var> - property name/value pair for values to pass to devices. +<p><var class="var">propname</var>, <var class="var">propvalue</var> - property name/value pair for values to pass to devices. </p> <p>A property of ’i2caddress’, ’spichipselectpin’ or ’serial’ must be specified to denote the device type to create. </p> -<p><var>i2caddress</var> - address to use for device on I2C bus. +<p><var class="var">i2caddress</var> - address to use for device on I2C bus. </p> -<p><var>pin</var> - pin to use for device SPI chip select. +<p><var class="var">pin</var> - pin to use for device SPI chip select. </p> -<p><var>serialid</var> - Serial port id to use +<p><var class="var">serialid</var> - Serial port id to use </p> <p>Additional properties can also be specified for the device object </p> <p>Currently known input I2C properties values: - </p><dl compact="compact"> -<dt><span>bus</span></dt> +</p><dl class="table"> +<dt>bus</dt> <dd><p>bus number (when arduino board supports multiple I2C buses) with value of 0 or 1. - </p></dd> -<dt><span>noprobe</span></dt> +</p></dd> +<dt>noprobe</dt> <dd><p>Do not probe the existence of device on creation if set to 1 (default 0) - </p></dd> -<dt><span>bitrate</span></dt> +</p></dd> +<dt>bitrate</dt> <dd><p>bit rate speed in Mbs - default 100000 - </p></dd> +</p></dd> </dl> <p>Currently known input SPI properties values: - </p><dl compact="compact"> -<dt><span>bitrate</span></dt> +</p><dl class="table"> +<dt>bitrate</dt> <dd><p>bit rate speed in Mbs - </p></dd> -<dt><span>bitorder</span></dt> +</p></dd> +<dt>bitorder</dt> <dd><p>’msbfirst’ or ’lsbfirst’ - </p></dd> -<dt><span>spimode</span></dt> +</p></dd> +<dt>spimode</dt> <dd><p>SPI mode 0 - 3. - </p></dd> +</p></dd> </dl> <p>Currently known input Serial properties values: - </p><dl compact="compact"> -<dt><span>baudrate</span></dt> +</p><dl class="table"> +<dt>baudrate</dt> <dd><p>baudrate value (default 9600) - </p></dd> -<dt><span>databits</span></dt> +</p></dd> +<dt>databits</dt> <dd><p>number of databits (5,6,7,8) (default 8) - </p></dd> -<dt><span>stopbits</span></dt> +</p></dd> +<dt>stopbits</dt> <dd><p>number of stopbits (1,2) (default 1) - </p></dd> -<dt><span>parity</span></dt> +</p></dd> +<dt>parity</dt> <dd><p>parity of device (’odd’,’even’,’none’) (default ’none’) - </p></dd> +</p></dd> </dl> -<span id="Outputs-52"></span><h4 class="subsubheading">Outputs</h4> -<p><var>dev</var> - new created device object. +<h4 class="subsubheading" id="Outputs-52">Outputs</h4> +<p><var class="var">dev</var> - new created device object. </p> -<span id="Properties-7"></span><h4 class="subsubheading">Properties</h4> +<h4 class="subsubheading" id="Properties-7">Properties</h4> <p>The object has the following public properties: - </p><dl compact="compact"> -<dt><span>parent</span></dt> +</p><dl class="table"> +<dt>parent</dt> <dd><p>The parent (arduino) for this device - </p></dd> -<dt><span>interface</span></dt> +</p></dd> +<dt>interface</dt> <dd><p>The interface type for this device ("SPI" or "I2C" or "Serial") - </p></dd> +</p></dd> </dl> <p>In addition, depending on type, the object will have these properties: </p> -<span id="I2C-Properties-1"></span><h4 class="subsubheading">I2C Properties</h4> +<h4 class="subsubheading" id="I2C-Properties-1">I2C Properties</h4> <p>The object has the following public properties: - </p><dl compact="compact"> -<dt><span>bus</span></dt> +</p><dl class="table"> +<dt>bus</dt> <dd><p>bus used for created object - </p></dd> -<dt><span>i2caddress</span></dt> +</p></dd> +<dt>i2caddress</dt> <dd><p>I2C address set for object - </p></dd> -<dt><span>sclpin</span></dt> +</p></dd> +<dt>sclpin</dt> <dd><p>the SCL pin of the device - </p></dd> -<dt><span>sdapin</span></dt> +</p></dd> +<dt>sdapin</dt> <dd><p>the SDA pin of the device - </p></dd> -<dt><span>bitrate</span></dt> +</p></dd> +<dt>bitrate</dt> <dd><p>bit rate for the i2c clock - </p></dd> +</p></dd> </dl> -<span id="SPI-Properties-1"></span><h4 class="subsubheading">SPI Properties</h4> +<h4 class="subsubheading" id="SPI-Properties-1">SPI Properties</h4> <p>The object has the following public properties: - </p><dl compact="compact"> -<dt><span>spimode</span></dt> +</p><dl class="table"> +<dt>spimode</dt> <dd><p>mode used for created object - </p></dd> -<dt><span>bitrate</span></dt> +</p></dd> +<dt>bitrate</dt> <dd><p>Bitrate set for object - </p></dd> -<dt><span>bitorder</span></dt> +</p></dd> +<dt>bitorder</dt> <dd><p>Bitorder set for object - </p></dd> -<dt><span>spichipselectpin</span></dt> +</p></dd> +<dt>spichipselectpin</dt> <dd><p>Pin used for chipselect - </p></dd> -<dt><span>mosipin</span></dt> +</p></dd> +<dt>mosipin</dt> <dd><p>Pin used for mosi - </p></dd> -<dt><span>misopin</span></dt> +</p></dd> +<dt>misopin</dt> <dd><p>Pin used for miso - </p></dd> -<dt><span>sckpin</span></dt> +</p></dd> +<dt>sckpin</dt> <dd><p>Pin used for sckpin - </p></dd> +</p></dd> </dl> -<span id="Serial-Properties-1"></span><h4 class="subsubheading">Serial Properties</h4> +<h4 class="subsubheading" id="Serial-Properties-1">Serial Properties</h4> <p>The object has the following public properties: - </p><dl compact="compact"> -<dt><span>id</span></dt> +</p><dl class="table"> +<dt>id</dt> <dd><p>serial port id - </p></dd> -<dt><span>baudrate</span></dt> +</p></dd> +<dt>baudrate</dt> <dd><p>baudrate - </p></dd> -<dt><span>databits</span></dt> +</p></dd> +<dt>databits</dt> <dd><p>number of databits (5,6,7,8) - </p></dd> -<dt><span>stopbits</span></dt> +</p></dd> +<dt>stopbits</dt> <dd><p>number of stopbits (1,2) - </p></dd> -<dt><span>parity</span></dt> +</p></dd> +<dt>parity</dt> <dd><p>parity of device (’odd’,’even’,’none’) - </p></dd> +</p></dd> </dl> -<p><strong>See also:</strong> arduino, i2cdev, spidev. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, i2cdev, spidev. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fdisplay-3"> +<div class="subsection-level-extent" id="g_t_0040device_002fdisplay-3"> <h4 class="subsection">9.9.3 @device/display</h4> -<span id="index-display-9"></span> -<dl class="def"> -<dt id="index-display-20"><span class="category">: </span><span><em></em> <strong>display</strong> <em>(<var>dev</var>)</em><a href='#index-display-20' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-display-9"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-20"><span class="category-def">: </span><span><strong class="def-name">display</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-display-20'> ¶</a></span></dt> <dd><p>Display device object. </p> -<span id="Inputs-88"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - device object to display +<h4 class="subsubheading" id="Inputs-88">Inputs</h4> +<p><var class="var">dev</var> - device object to display </p> -<p><strong>See also:</strong> device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fflush-1"> +<div class="subsection-level-extent" id="g_t_0040device_002fflush-1"> <h4 class="subsection">9.9.4 @device/flush</h4> -<span id="index-flush-1"></span> -<dl class="def"> -<dt id="index-flush-5"><span class="category">: </span><span><em><var>data</var> =</em> <strong>flush</strong> <em>(<var>dev</var>)</em><a href='#index-flush-5' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-flush-6"><span class="category">: </span><span><em><var>data</var> =</em> <strong>flush</strong> <em>(<var>dev</var>, "input")</em><a href='#index-flush-6' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-flush-7"><span class="category">: </span><span><em><var>data</var> =</em> <strong>flush</strong> <em>(<var>dev</var>, "output")</em><a href='#index-flush-7' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-flush-1"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-flush-5"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-flush-5'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-6"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "input")</code><a class="copiable-link" href='#index-flush-6'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-7"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "output")</code><a class="copiable-link" href='#index-flush-7'> ¶</a></span></dt> <dd><p>Flush the serial port buffers </p> -<span id="Inputs-89"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected serial device opened using device +<h4 class="subsubheading" id="Inputs-89">Inputs</h4> +<p><var class="var">dev</var> - connected serial device opened using device </p> <p>If an additional parameter is provided of "input" or "output", then only the input or output buffer will be flushed </p> -<span id="Outputs-53"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-53">Outputs</h4> <p>None </p> -<p><strong>See also:</strong> arduino, device, read. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device, read. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fread-2"> +<div class="subsection-level-extent" id="g_t_0040device_002fread-2"> <h4 class="subsection">9.9.5 @device/read</h4> -<span id="index-read-4"></span> -<dl class="def"> -<dt id="index-read-13"><span class="category">: </span><span><em><var>data</var> =</em> <strong>read</strong> <em>(<var>dev</var>, <var>numbytes</var>)</em><a href='#index-read-13' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read-14"><span class="category">: </span><span><em><var>data</var> =</em> <strong>read</strong> <em>(<var>dev</var>, <var>numbytes</var>, <var>precision</var>)</em><a href='#index-read-14' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-read-4"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read-13"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">numbytes</var>)</code><a class="copiable-link" href='#index-read-13'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read-14"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">numbytes</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-read-14'> ¶</a></span></dt> <dd><p>Read a specified number of bytes from a i2c or serial device object using optional precision for bytesize. </p> -<span id="Inputs-90"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c or serial device opened using device +<h4 class="subsubheading" id="Inputs-90">Inputs</h4> +<p><var class="var">dev</var> - connected i2c or serial device opened using device </p> -<p><var>numbytes</var> - number of bytes to read. +<p><var class="var">numbytes</var> - number of bytes to read. </p> -<p><var>precision</var> - Optional precision for the output data read data. +<p><var class="var">precision</var> - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<span id="Outputs-54"></span><h4 class="subsubheading">Outputs</h4> -<p><var>data</var> - data read from the device +<h4 class="subsubheading" id="Outputs-54">Outputs</h4> +<p><var class="var">data</var> - data read from the device </p> -<p><strong>See also:</strong> arduino, device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002freadRegister-1"> +<div class="subsection-level-extent" id="g_t_0040device_002freadRegister-1"> <h4 class="subsection">9.9.6 @device/readRegister</h4> -<span id="index-readRegister-2"></span> -<dl class="def"> -<dt id="index-readRegister-7"><span class="category">: </span><span><em><var>data</var> =</em> <strong>readRegister</strong> <em>(<var>dev</var>, <var>reg</var>, <var>numbytes</var>)</em><a href='#index-readRegister-7' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-readRegister-8"><span class="category">: </span><span><em><var>data</var> =</em> <strong>readRegister</strong> <em>(<var>dev</var>, <var>reg</var>, <var>numbytes</var>, <var>precision</var>)</em><a href='#index-readRegister-8' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-readRegister-2"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readRegister-7"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">readRegister</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">reg</var>, <var class="var">numbytes</var>)</code><a class="copiable-link" href='#index-readRegister-7'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-readRegister-8"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">readRegister</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">reg</var>, <var class="var">numbytes</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-readRegister-8'> ¶</a></span></dt> <dd><p>Read a specified number of bytes from a register of an i2cdev object using optional precision for bytesize. </p> -<span id="Inputs-91"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c device opened using device +<h4 class="subsubheading" id="Inputs-91">Inputs</h4> +<p><var class="var">dev</var> - connected i2c device opened using device </p> -<p><var>reg</var> - registry value number +<p><var class="var">reg</var> - registry value number </p> -<p><var>numbytes</var> - number of bytes to read. +<p><var class="var">numbytes</var> - number of bytes to read. </p> -<p><var>precision</var> - Optional precision for the output data read data. +<p><var class="var">precision</var> - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<span id="Output-2"></span><h4 class="subsubheading">Output</h4> -<p><var>data</var> - data read from device. +<h4 class="subsubheading" id="Output-2">Output</h4> +<p><var class="var">data</var> - data read from device. </p> -<p><strong>See also:</strong> arduino, device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fsubsref-3"> +<div class="subsection-level-extent" id="g_t_0040device_002fsubsref-3"> <h4 class="subsection">9.9.7 @device/subsref</h4> -<span id="index-subsref-8"></span> -<dl class="def"> -<dt id="index-subsref-18"><span class="category">: </span><span><em><var>val</var> =</em> <strong>subsref</strong> <em>(<var>dev</var>, <var>sub</var>)</em><a href='#index-subsref-18' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-subsref-8"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-subsref-18"><span class="category-def">: </span><span><code class="def-type"><var class="var">val</var> =</code> <strong class="def-name">subsref</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">sub</var>)</code><a class="copiable-link" href='#index-subsref-18'> ¶</a></span></dt> <dd><p>subref for device </p> -<p><strong>See also:</strong> device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fwrite-2"> +<div class="subsection-level-extent" id="g_t_0040device_002fwrite-2"> <h4 class="subsection">9.9.8 @device/write</h4> -<span id="index-write-4"></span> -<dl class="def"> -<dt id="index-write-11"><span class="category">: </span><span><em></em> <strong>write</strong> <em>(<var>dev</var>, <var>datain</var>)</em><a href='#index-write-11' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-write-12"><span class="category">: </span><span><em></em> <strong>write</strong> <em>(<var>dev</var>, <var>datain</var>, <var>precision</var>)</em><a href='#index-write-12' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-write-4"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-write-11"><span class="category-def">: </span><span><strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">datain</var>)</code><a class="copiable-link" href='#index-write-11'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-write-12"><span class="category-def">: </span><span><strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">datain</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-write-12'> ¶</a></span></dt> <dd><p>Write data to a I2C or serial device object using optional precision for the data byte used for the data. </p> -<span id="Inputs-92"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c or serial device opened using device +<h4 class="subsubheading" id="Inputs-92">Inputs</h4> +<p><var class="var">dev</var> - connected i2c or serial device opened using device </p> -<p><var>datain</var> - data to write to device. Datasize should not exceed the constraints +<p><var class="var">datain</var> - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. </p> -<p><var>precision</var> - Optional precision for the input write data. +<p><var class="var">precision</var> - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<p><strong>See also:</strong> arduino, device, read. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device, read. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fwriteRead-1"> +<div class="subsection-level-extent" id="g_t_0040device_002fwriteRead-1"> <h4 class="subsection">9.9.9 @device/writeRead</h4> -<span id="index-writeRead-2"></span> -<dl class="def"> -<dt id="index-readWrite-2"><span class="category">: </span><span><em><var>dataOut</var> =</em> <strong>readWrite</strong> <em>(<var>spi</var>, <var>dataIn</var>)</em><a href='#index-readWrite-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-writeRead-2"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readWrite-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">dataOut</var> =</code> <strong class="def-name">readWrite</strong> <code class="def-code-arguments">(<var class="var">spi</var>, <var class="var">dataIn</var>)</code><a class="copiable-link" href='#index-readWrite-2'> ¶</a></span></dt> <dd><p>Write uint8 data to spi device and return back clocked out response data of same size. </p> -<span id="Inputs-93"></span><h4 class="subsubheading">Inputs</h4> -<p><var>spi</var> - connected spi device on arduino +<h4 class="subsubheading" id="Inputs-93">Inputs</h4> +<p><var class="var">spi</var> - connected spi device on arduino </p> -<p><var>dataIn</var> - uint8 sized data to send to spi device framed between SS frame. +<p><var class="var">dataIn</var> - uint8 sized data to send to spi device framed between SS frame. </p> -<span id="Outputs-55"></span><h4 class="subsubheading">Outputs</h4> -<p><var>dataOut</var> - uint8 data clocked out during send to dataIn. +<h4 class="subsubheading" id="Outputs-55">Outputs</h4> +<p><var class="var">dataOut</var> - uint8 data clocked out during send to dataIn. </p> -<p><strong>See also:</strong> arduino, device. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040device_002fwriteRegister-1"> +<div class="subsection-level-extent" id="g_t_0040device_002fwriteRegister-1"> <h4 class="subsection">9.9.10 @device/writeRegister</h4> -<span id="index-writeRegister-2"></span> -<dl class="def"> -<dt id="index-writeRegister-7"><span class="category">: </span><span><em></em> <strong>writeRegister</strong> <em>(<var>dev</var>, <var>reg</var>, <var>datain</var>)</em><a href='#index-writeRegister-7' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-writeRegister-8"><span class="category">: </span><span><em></em> <strong>writeRegister</strong> <em>(<var>dev</var>, <var>dev</var>, <var>datain</var>, <var>precision</var>)</em><a href='#index-writeRegister-8' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-writeRegister-2"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-writeRegister-7"><span class="category-def">: </span><span><strong class="def-name">writeRegister</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">reg</var>, <var class="var">datain</var>)</code><a class="copiable-link" href='#index-writeRegister-7'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-writeRegister-8"><span class="category-def">: </span><span><strong class="def-name">writeRegister</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">dev</var>, <var class="var">datain</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-writeRegister-8'> ¶</a></span></dt> <dd><p>Write data to i2c device object at a given registry position using optional precision for the data byte used for the data. </p> -<span id="Inputs-94"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected i2c device opened using device +<h4 class="subsubheading" id="Inputs-94">Inputs</h4> +<p><var class="var">dev</var> - connected i2c device opened using device </p> -<p><var>reg</var> - registry position to write to. +<p><var class="var">reg</var> - registry position to write to. </p> -<p><var>datain</var> - data to write to device. Datasize should not exceed the constraints +<p><var class="var">datain</var> - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. </p> -<p><var>precision</var> - Optional precision for the input write data. +<p><var class="var">precision</var> - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 </p> -<p><strong>See also:</strong> arduino, device, read. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, device, read. +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Arduino-Ultrasonic-Functions"> -<div class="header"> +<div class="section-level-extent" id="Arduino-Ultrasonic-Functions"> +<div class="nav-panel"> <p> Next: <a href="#Arduino-Addons" accesskey="n" rel="next">Arduino Addons</a>, Previous: <a href="#Arduino-Device-Functions" accesskey="p" rel="prev">Arduino Device Functions</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Arduino-Ultrasonic-Functions-1"></span><h3 class="section">9.10 Arduino Ultrasonic Functions</h3> -<span id="index-Arduino-Ultrasonic-Functions"></span> -<ul class="section-toc"> +<h3 class="section" id="Arduino-Ultrasonic-Functions-1">9.10 Arduino Ultrasonic Functions</h3> +<a class="index-entry-id" id="index-Arduino-Ultrasonic-Functions"></a> +<ul class="mini-toc"> <li><a href="#g_t_0040ultrasonic_002fdelete" accesskey="1">@ultrasonic/delete</a></li> <li><a href="#g_t_0040ultrasonic_002fdisplay" accesskey="2">@ultrasonic/display</a></li> <li><a href="#g_t_0040ultrasonic_002freadDistance" accesskey="3">@ultrasonic/readDistance</a></li> @@ -4465,141 +4465,141 @@ Next: <a href="#Arduino-Addons" accesskey="n" rel="next">Arduino Addons</a>, Pre <li><a href="#g_t_0040ultrasonic_002fsubsref" accesskey="5">@ultrasonic/subsref</a></li> <li><a href="#g_t_0040ultrasonic_002fultrasonic" accesskey="6">@ultrasonic/ultrasonic</a></li> </ul> -<div class="subsection" id="g_t_0040ultrasonic_002fdelete"> +<div class="subsection-level-extent" id="g_t_0040ultrasonic_002fdelete"> <h4 class="subsection">9.10.1 @ultrasonic/delete</h4> -<span id="index-delete-10"></span> -<dl class="def"> -<dt id="index-delete-21"><span class="category">: </span><span><em></em> <strong>delete</strong> <em>(<var>dev</var>)</em><a href='#index-delete-21' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-delete-10"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-delete-21"><span class="category-def">: </span><span><strong class="def-name">delete</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-delete-21'> ¶</a></span></dt> <dd><p>Free resources of a ultrasonic object. </p> -<span id="Inputs-95"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - ultrasonic object to free +<h4 class="subsubheading" id="Inputs-95">Inputs</h4> +<p><var class="var">dev</var> - ultrasonic object to free </p> -<p><strong>See also:</strong> ultrasonic. - </p></dd></dl> +<p><strong class="strong">See also:</strong> ultrasonic. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040ultrasonic_002fdisplay"> +<div class="subsection-level-extent" id="g_t_0040ultrasonic_002fdisplay"> <h4 class="subsection">9.10.2 @ultrasonic/display</h4> -<span id="index-display-10"></span> -<dl class="def"> -<dt id="index-display-21"><span class="category">: </span><span><em></em> <strong>display</strong> <em>(<var>dev</var>)</em><a href='#index-display-21' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-display-10"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-21"><span class="category-def">: </span><span><strong class="def-name">display</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-display-21'> ¶</a></span></dt> <dd><p>Display ultrasonic object. </p> -<span id="Inputs-96"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - ultrasonic object to display +<h4 class="subsubheading" id="Inputs-96">Inputs</h4> +<p><var class="var">dev</var> - ultrasonic object to display </p> -<p><strong>See also:</strong> ultrasonic. - </p></dd></dl> +<p><strong class="strong">See also:</strong> ultrasonic. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040ultrasonic_002freadDistance"> +<div class="subsection-level-extent" id="g_t_0040ultrasonic_002freadDistance"> <h4 class="subsection">9.10.3 @ultrasonic/readDistance</h4> -<span id="index-readDistance"></span> -<dl class="def"> -<dt id="index-readDistance-1"><span class="category">: </span><span><em><var>distance</var> =</em> <strong>readDistance</strong> <em>(<var>dev</var>)</em><a href='#index-readDistance-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-readDistance"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readDistance-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">distance</var> =</code> <strong class="def-name">readDistance</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-readDistance-1'> ¶</a></span></dt> <dd><p>Read the distance from a ultrasonic device </p> -<span id="Inputs-97"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected ultrasonic device opened using ultrasonic +<h4 class="subsubheading" id="Inputs-97">Inputs</h4> +<p><var class="var">dev</var> - connected ultrasonic device opened using ultrasonic </p> -<span id="Outputs-56"></span><h4 class="subsubheading">Outputs</h4> -<p><var>distance</var> - distance value in meters from the ultrasonic device, or Inf if out of sensor range +<h4 class="subsubheading" id="Outputs-56">Outputs</h4> +<p><var class="var">distance</var> - distance value in meters from the ultrasonic device, or Inf if out of sensor range </p> -<p><strong>See also:</strong> arduino, ultrasonic. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, ultrasonic. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040ultrasonic_002freadEchoTime"> +<div class="subsection-level-extent" id="g_t_0040ultrasonic_002freadEchoTime"> <h4 class="subsection">9.10.4 @ultrasonic/readEchoTime</h4> -<span id="index-readEchoTime"></span> -<dl class="def"> -<dt id="index-readEchoTime-1"><span class="category">: </span><span><em><var>time</var> =</em> <strong>readEchoTime</strong> <em>(<var>dev</var>)</em><a href='#index-readEchoTime-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-readEchoTime"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readEchoTime-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">time</var> =</code> <strong class="def-name">readEchoTime</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-readEchoTime-1'> ¶</a></span></dt> <dd><p>Measure the time for waves to reflect back to the ultrasonic device </p> -<span id="Inputs-98"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dev</var> - connected ultrasonic device opened using ultrasonic() +<h4 class="subsubheading" id="Inputs-98">Inputs</h4> +<p><var class="var">dev</var> - connected ultrasonic device opened using ultrasonic() </p> -<span id="Outputs-57"></span><h4 class="subsubheading">Outputs</h4> -<p><var>time</var> - time in seconds, or Inf if out of sensor range +<h4 class="subsubheading" id="Outputs-57">Outputs</h4> +<p><var class="var">time</var> - time in seconds, or Inf if out of sensor range </p> -<p><strong>See also:</strong> arduino, ultrasonic. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, ultrasonic. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040ultrasonic_002fsubsref"> +<div class="subsection-level-extent" id="g_t_0040ultrasonic_002fsubsref"> <h4 class="subsection">9.10.5 @ultrasonic/subsref</h4> -<span id="index-subsref-9"></span> -<dl class="def"> -<dt id="index-subsref-19"><span class="category">: </span><span><em><var>val</var> =</em> <strong>subsref</strong> <em>(<var>dev</var>, <var>sub</var>)</em><a href='#index-subsref-19' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-subsref-9"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-subsref-19"><span class="category-def">: </span><span><code class="def-type"><var class="var">val</var> =</code> <strong class="def-name">subsref</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">sub</var>)</code><a class="copiable-link" href='#index-subsref-19'> ¶</a></span></dt> <dd><p>subref for ultrasonic </p> -<p><strong>See also:</strong> ultrasonic. - </p></dd></dl> +<p><strong class="strong">See also:</strong> ultrasonic. +</p></dd></dl> </div> -<div class="subsection" id="g_t_0040ultrasonic_002fultrasonic"> +<div class="subsection-level-extent" id="g_t_0040ultrasonic_002fultrasonic"> <h4 class="subsection">9.10.6 @ultrasonic/ultrasonic</h4> -<span id="index-ultrasonic"></span> -<dl class="def"> -<dt id="index-ultrasonic-1"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>ultrasonic</strong> <em>(<var>ar</var>, <var>triggerpin</var>)</em><a href='#index-ultrasonic-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-ultrasonic-2"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>ultrasonic</strong> <em>(<var>ar</var>, <var>triggerpin</var>, <var>echopin</var>)</em><a href='#index-ultrasonic-2' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-ultrasonic-3"><span class="category">: </span><span><em><var>dev</var> =</em> <strong>ultrasonic</strong> <em>(<var>ar</var>, <var>triggerpin</var>, <var>echopin</var>, <var>propname</var>, <var>propvalue</var>)</em><a href='#index-ultrasonic-3' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-ultrasonic"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-ultrasonic-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">ultrasonic</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">triggerpin</var>)</code><a class="copiable-link" href='#index-ultrasonic-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-ultrasonic-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">ultrasonic</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">triggerpin</var>, <var class="var">echopin</var>)</code><a class="copiable-link" href='#index-ultrasonic-2'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-ultrasonic-3"><span class="category-def">: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">ultrasonic</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">triggerpin</var>, <var class="var">echopin</var>, <var class="var">propname</var>, <var class="var">propvalue</var>)</code><a class="copiable-link" href='#index-ultrasonic-3'> ¶</a></span></dt> <dd><p>Create an ultrasonic object to communicate to a connected ultrasonic device </p> -<span id="Inputs-99"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-99">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>triggerpin</var> - trigger pin for attached device. +<p><var class="var">triggerpin</var> - trigger pin for attached device. </p> -<p><var>echopin</var> - trigger pin for attached device. +<p><var class="var">echopin</var> - trigger pin for attached device. </p> -<p><var>propname</var>, <var>propvalue</var> - property name/value pair for values to pass to devices. +<p><var class="var">propname</var>, <var class="var">propvalue</var> - property name/value pair for values to pass to devices. </p> <p>Currently known properties: - </p><dl compact="compact"> -<dt><span>outputformat</span></dt> +</p><dl class="table"> +<dt>outputformat</dt> <dd><p>string designating number format for output (’double’) - </p></dd> +</p></dd> </dl> -<span id="Outputs-58"></span><h4 class="subsubheading">Outputs</h4> -<p><var>dev</var> - created ultrasonic object +<h4 class="subsubheading" id="Outputs-58">Outputs</h4> +<p><var class="var">dev</var> - created ultrasonic object </p> -<span id="Properties-8"></span><h4 class="subsubheading">Properties</h4> +<h4 class="subsubheading" id="Properties-8">Properties</h4> <p>The ultrasonic object has the following public properties: - </p><dl compact="compact"> -<dt><span>parent</span></dt> +</p><dl class="table"> +<dt>parent</dt> <dd><p>The parent (arduino) for this device - </p></dd> -<dt><span>pins</span></dt> +</p></dd> +<dt>pins</dt> <dd><p>pins used by this object - </p></dd> -<dt><span>triggerpin</span></dt> +</p></dd> +<dt>triggerpin</dt> <dd><p>trigger used for created object - </p></dd> -<dt><span>echopin</span></dt> +</p></dd> +<dt>echopin</dt> <dd><p>Echo pin set for object - </p></dd> -<dt><span>outputformat</span></dt> +</p></dd> +<dt>outputformat</dt> <dd><p>Output format for the created object - </p></dd> +</p></dd> </dl> -<p><strong>See also:</strong> arduino, readDistance, readEchoTime. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, readDistance, readEchoTime. +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Arduino-Addons"> -<div class="header"> +<div class="section-level-extent" id="Arduino-Addons"> +<div class="nav-panel"> <p> Next: <a href="#Arduino-Sensors" accesskey="n" rel="next">Arduino Sensors</a>, Previous: <a href="#Arduino-Ultrasonic-Functions" accesskey="p" rel="prev">Arduino Ultrasonic Functions</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Arduino-Addons-1"></span><h3 class="section">9.11 Arduino Addons</h3> -<span id="index-Arduino-Addons"></span> -<ul class="section-toc"> +<h3 class="section" id="Arduino-Addons-1">9.11 Arduino Addons</h3> +<a class="index-entry-id" id="index-Arduino-Addons"></a> +<ul class="mini-toc"> <li><a href="#addon" accesskey="1">addon</a></li> <li><a href="#arduinoioaddons_002eEEPRomAddon_002eEEPRom" accesskey="2">arduinoioaddons.EEPRomAddon.EEPRom</a></li> <li><a href="#arduinoioaddons_002eExampleAddon_002eEcho" accesskey="3">arduinoioaddons.ExampleAddon.Echo</a></li> @@ -4610,1390 +4610,1390 @@ Next: <a href="#Arduino-Sensors" accesskey="n" rel="next">Arduino Sensors</a>, P <li><a href="#arduinoioaddons_002eadafruit_002emotorshieldv2" accesskey="8">arduinoioaddons.adafruit.motorshieldv2</a></li> <li><a href="#arduinoioaddons_002eadafruit_002estepper" accesskey="9">arduinoioaddons.adafruit.stepper</a></li> </ul> -<div class="subsection" id="addon"> +<div class="subsection-level-extent" id="addon"> <h4 class="subsection">9.11.1 addon</h4> -<span id="index-addon"></span> -<dl class="def"> -<dt id="index-addon-1"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>addon</strong> <em>(<var>ar</var>, <var>addonname</var>)</em><a href='#index-addon-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-addon-2"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>addon</strong> <em>(<var>ar</var>, <var>addonname</var>, varargs)</em><a href='#index-addon-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-addon"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-addon-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">addon</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">addonname</var>)</code><a class="copiable-link" href='#index-addon-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-addon-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">addon</strong> <code class="def-code-arguments">(<var class="var">ar</var>, <var class="var">addonname</var>, varargs)</code><a class="copiable-link" href='#index-addon-2'> ¶</a></span></dt> <dd><p>Create an addon object using the addon named class. </p> -<span id="Inputs-100"></span><h4 class="subsubheading">Inputs</h4> -<p><var>ar</var> - connected arduino object +<h4 class="subsubheading" id="Inputs-100">Inputs</h4> +<p><var class="var">ar</var> - connected arduino object </p> -<p><var>addonname</var> - the name of the addon to create. The addon name can be a user +<p><var class="var">addonname</var> - the name of the addon to create. The addon name can be a user addon or an inbuilt addon, however must appear in the listArduinoLibraries output and have been programmed onto the arduino. </p> -<p><var>varargs</var> - optional values that will be provided verbatim to the +<p><var class="var">varargs</var> - optional values that will be provided verbatim to the the addon class constructor. </p> -<span id="Outputs-59"></span><h4 class="subsubheading">Outputs</h4> -<p><var>retval</var> - cell array of string library names. +<h4 class="subsubheading" id="Outputs-59">Outputs</h4> +<p><var class="var">retval</var> - cell array of string library names. </p> -<p><strong>See also:</strong> arduino, arduinosetup, listArduinoLibraries. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, arduinosetup, listArduinoLibraries. +</p></dd></dl> </div> -<div class="subsection" id="arduinoioaddons_002eEEPRomAddon_002eEEPRom"> +<div class="subsection-level-extent" id="arduinoioaddons_002eEEPRomAddon_002eEEPRom"> <h4 class="subsection">9.11.2 arduinoioaddons.EEPRomAddon.EEPRom</h4> -<span id="index-EEPRom"></span> -<dl class="def"> -<dt id="index-arduinoioaddons_002eEEPRomAddon_002eEEPRom"><span class="category">: </span><span><em></em> <strong>arduinoioaddons.EEPRomAddon.EEPRom</strong><a href='#index-arduinoioaddons_002eEEPRomAddon_002eEEPRom' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-EEPRom"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinoioaddons_002eEEPRomAddon_002eEEPRom"><span class="category-def">: </span><span><strong class="def-name">arduinoioaddons.EEPRomAddon.EEPRom</strong><a class="copiable-link" href='#index-arduinoioaddons_002eEEPRomAddon_002eEEPRom'> ¶</a></span></dt> <dd><p>EEPROM addon for arduino </p> <p>Allows read and write of uint8 data to the onboard arduino EEPROM. </p> -<span id="Example-11"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-11">Example</h4> <p>Assuming eeprom addon has been programmed into the Arduino: - </p><div class="example"> -<pre class="example"> a = arduino (); +</p><div class="example"> +<pre class="example-preformatted"> a = arduino (); e = addon (a, "eepromaddon/eeprom"); write (e, 0, uint8("hello world")); str = uint8( read(e, 0, 11) ) - </pre></div> +</pre></div> -<p><strong>See also:</strong> addon. - </p></dd></dl> +<p><strong class="strong">See also:</strong> addon. +</p></dd></dl> -<span id="Properties-9"></span><h4 class="subsubheading">Properties</h4> -<p><var>length</var> - Size of the EEPROM. +<h4 class="subsubheading" id="Properties-9">Properties</h4> +<p><var class="var">length</var> - Size of the EEPROM. </p> -<span id="Methods"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-EEPRom-1"><span class="category">: </span><span><em><var>eeprom</var> =</em> <strong>EEPRom</strong> <em>()</em><a href='#index-EEPRom-1' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-EEPRom-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">eeprom</var> =</code> <strong class="def-name">EEPRom</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-EEPRom-1'> ¶</a></span></dt> <dd><p>Constructor to create EEPROM device. - </p><span id="Outputs-60"></span><h4 class="subsubheading">Outputs</h4> -<p><var>eeprom</var> - created EEPROM device. - </p></dd></dl> +</p><h4 class="subsubheading" id="Outputs-60">Outputs</h4> +<p><var class="var">eeprom</var> - created EEPROM device. +</p></dd></dl> -<dl class="def"> -<dt id="index-erase"><span class="category">: </span><span><em></em> <strong>erase</strong> <em>()</em><a href='#index-erase' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-erase"><span class="category-def">: </span><span><strong class="def-name">erase</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-erase'> ¶</a></span></dt> <dd><p>Erase all values in EEPROM (Effectively setting the 0xFF) - </p></dd></dl> +</p></dd></dl> -<dl class="def"> -<dt id="index-write-13"><span class="category">: </span><span><em></em> <strong>write</strong> <em>(<var>address</var>, <var>uintdata</var>)</em><a href='#index-write-13' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-write-13"><span class="category-def">: </span><span><strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">address</var>, <var class="var">uintdata</var>)</code><a class="copiable-link" href='#index-write-13'> ¶</a></span></dt> <dd><p>Write data to EEPROM at the provided address. - </p><span id="Inputs-101"></span><h4 class="subsubheading">Inputs</h4> -<p><var>address</var> - start address to write data to, should be an +</p><h4 class="subsubheading" id="Inputs-101">Inputs</h4> +<p><var class="var">address</var> - start address to write data to, should be an integer between 0 and the size of the EEPROM. </p> -<p><var>uintdata</var> a value or array of uint8 data to write to EEPROM. - </p></dd></dl> +<p><var class="var">uintdata</var> a value or array of uint8 data to write to EEPROM. +</p></dd></dl> -<dl class="def"> -<dt id="index-read-15"><span class="category">: </span><span><em><var>data</var> =</em> <strong>read</strong> <em>(<var>address</var>)</em><a href='#index-read-15' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read-16"><span class="category">: </span><span><em><var>data</var> =</em> <strong>read</strong> <em>(<var>address</var>, <var>count</var>)</em><a href='#index-read-16' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read-15"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">address</var>)</code><a class="copiable-link" href='#index-read-15'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read-16"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">address</var>, <var class="var">count</var>)</code><a class="copiable-link" href='#index-read-16'> ¶</a></span></dt> <dd><p>Read data from starting address of EEPROM. - </p><span id="Inputs-102"></span><h4 class="subsubheading">Inputs</h4> -<p><var>address</var> - start address to read data from, should be an +</p><h4 class="subsubheading" id="Inputs-102">Inputs</h4> +<p><var class="var">address</var> - start address to read data from, should be an integer between 0 and the size of the EEPROM. </p> -<p><var>count</var> - Number of uint8 values to read from the EEPROM (default is 1) +<p><var class="var">count</var> - Number of uint8 values to read from the EEPROM (default is 1) </p> -<span id="Outputs-61"></span><h4 class="subsubheading">Outputs</h4> -<p><var>data</var> a value or array of uint8 data read from the EEPROM. - </p></dd></dl> +<h4 class="subsubheading" id="Outputs-61">Outputs</h4> +<p><var class="var">data</var> a value or array of uint8 data read from the EEPROM. +</p></dd></dl> </div> -<div class="subsection" id="arduinoioaddons_002eExampleAddon_002eEcho"> +<div class="subsection-level-extent" id="arduinoioaddons_002eExampleAddon_002eEcho"> <h4 class="subsection">9.11.3 arduinoioaddons.ExampleAddon.Echo</h4> -<span id="index-Echo"></span> -<dl class="def"> -<dt id="index-arduinoioaddons_002eExampleAddon_002eEcho"><span class="category">: </span><span><em></em> <strong>arduinoioaddons.ExampleAddon.Echo</strong><a href='#index-arduinoioaddons_002eExampleAddon_002eEcho' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-Echo"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinoioaddons_002eExampleAddon_002eEcho"><span class="category-def">: </span><span><strong class="def-name">arduinoioaddons.ExampleAddon.Echo</strong><a class="copiable-link" href='#index-arduinoioaddons_002eExampleAddon_002eEcho'> ¶</a></span></dt> <dd><p>Basic Example matlab/octave code to illustrate creating a user addon. </p> -<p><strong>See also:</strong> addon. - </p></dd></dl> +<p><strong class="strong">See also:</strong> addon. +</p></dd></dl> -<span id="Properties-10"></span><h4 class="subsubheading">Properties</h4> -<p><var>Parent</var> - the parent arduino object. +<h4 class="subsubheading" id="Properties-10">Properties</h4> +<p><var class="var">Parent</var> - the parent arduino object. </p> -<p><var>Pins</var> - the pins allocated the addon. +<p><var class="var">Pins</var> - the pins allocated the addon. </p> -<span id="Methods-1"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-Echo_0028arObj_0029"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>Echo(arObj)</strong><a href='#index-Echo_0028arObj_0029' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-1">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-Echo_0028arObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">Echo(arObj)</strong><a class="copiable-link" href='#index-Echo_0028arObj_0029'> ¶</a></span></dt> <dd><p>Constructor to create Echo addon - </p><span id="Inputs-103"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-103">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<span id="Outputs-62"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created Echo object - </p></dd></dl> +<h4 class="subsubheading" id="Outputs-62">Outputs</h4> +<p><var class="var">obj</var> - created Echo object +</p></dd></dl> -<dl class="def"> -<dt id="index-shout_0028text_0029"><span class="category">: </span><span><em><var>response</var> =</em> <strong>shout(<var>text</var>)</strong><a href='#index-shout_0028text_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-shout_0028text_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">response</var> =</code> <strong class="def-name">shout(<var class="var">text</var>)</strong><a class="copiable-link" href='#index-shout_0028text_0029'> ¶</a></span></dt> <dd><p>Send text to arduino and receive back the echoed reply </p> -<span id="Inputs-104"></span><h4 class="subsubheading">Inputs</h4> -<p><var>text</var> - text to send to arduino +<h4 class="subsubheading" id="Inputs-104">Inputs</h4> +<p><var class="var">text</var> - text to send to arduino </p> -<span id="Outputs-63"></span><h4 class="subsubheading">Outputs</h4> -<p><var>response</var> - response from the arduino, which should be the same as +<h4 class="subsubheading" id="Outputs-63">Outputs</h4> +<p><var class="var">response</var> - response from the arduino, which should be the same as the input text. - </p></dd></dl> +</p></dd></dl> </div> -<div class="subsection" id="arduinoioaddons_002eExampleLCD_002eLCD"> +<div class="subsection-level-extent" id="arduinoioaddons_002eExampleLCD_002eLCD"> <h4 class="subsection">9.11.4 arduinoioaddons.ExampleLCD.LCD</h4> -<span id="index-LCD"></span> -<dl class="def"> -<dt id="index-arduinoioaddons_002eLCDAddon_002eLCD"><span class="category">: </span><span><em></em> <strong>arduinoioaddons.LCDAddon.LCD</strong><a href='#index-arduinoioaddons_002eLCDAddon_002eLCD' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-LCD"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinoioaddons_002eLCDAddon_002eLCD"><span class="category-def">: </span><span><strong class="def-name">arduinoioaddons.LCDAddon.LCD</strong><a class="copiable-link" href='#index-arduinoioaddons_002eLCDAddon_002eLCD'> ¶</a></span></dt> <dd><p>Basic Example octave addon for LCD </p> <p>Allows basic manipulation of an LCD as a illustration of using the addon functionality. - </p><span id="Example-12"></span><h4 class="subsubheading">Example</h4> +</p><h4 class="subsubheading" id="Example-12">Example</h4> <p>Assuming the arduino has been programmed with the lcd addon: - </p><div class="example"> -<pre class="example"> a = arduino(); +</p><div class="example"> +<pre class="example-preformatted"> a = arduino(); lcd = addon(a, "examplelcd/lcd", "d8", "d9", "d4", "d5", "d6", "d7") clearLCD(lcd); printLCD(lcd, "Hello"); # go to next line gotoLCD(lcd, 0, 1); printLCD(lcd, "World"); - </pre></div> +</pre></div> -<p><strong>See also:</strong> addon. - </p></dd></dl> +<p><strong class="strong">See also:</strong> addon. +</p></dd></dl> -<span id="Properties-11"></span><h4 class="subsubheading">Properties</h4> -<p><var>Pins</var> - the pins allocated the LCD display. +<h4 class="subsubheading" id="Properties-11">Properties</h4> +<p><var class="var">Pins</var> - the pins allocated the LCD display. </p> -<span id="Methods-2"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-LCD_0028arObj_002c"><span class="category">: </span><span><em><var>lcd</var> =</em> <strong>LCD(arObj,</strong> <em>rs, enable, d0, d1, d2, d3)</em><a href='#index-LCD_0028arObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-2">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-LCD_0028arObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">lcd</var> =</code> <strong class="def-name">LCD(arObj,</strong> <code class="def-code-arguments">rs, enable, d0, d1, d2, d3)</code><a class="copiable-link" href='#index-LCD_0028arObj_002c'> ¶</a></span></dt> <dd><p>Constructor to create LCD device - </p><span id="Inputs-105"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-105">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>rs</var> - the pin to use for the rs line. +<p><var class="var">rs</var> - the pin to use for the rs line. </p> -<p><var>enable</var> - the pin to use for the enable line. +<p><var class="var">enable</var> - the pin to use for the enable line. </p> -<p><var>d0</var> - the pin to use for the d0 line. +<p><var class="var">d0</var> - the pin to use for the d0 line. </p> -<p><var>d1</var> - the pin to use for the d1 line. +<p><var class="var">d1</var> - the pin to use for the d1 line. </p> -<p><var>d2</var> - the pin to use for the d2 line. +<p><var class="var">d2</var> - the pin to use for the d2 line. </p> -<p><var>d3</var> - the pin to use for the d3 line. +<p><var class="var">d3</var> - the pin to use for the d3 line. </p> -<span id="Outputs-64"></span><h4 class="subsubheading">Outputs</h4> -<p><var>lcd</var> - created LCD object - </p></dd></dl> +<h4 class="subsubheading" id="Outputs-64">Outputs</h4> +<p><var class="var">lcd</var> - created LCD object +</p></dd></dl> -<dl class="def"> -<dt id="index-freeLCD_0028_0029"><span class="category">: </span><span><em></em> <strong>freeLCD()</strong><a href='#index-freeLCD_0028_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-freeLCD_0028_0029"><span class="category-def">: </span><span><strong class="def-name">freeLCD()</strong><a class="copiable-link" href='#index-freeLCD_0028_0029'> ¶</a></span></dt> <dd><p>Free the LCD </p> <p>Should be called before discarding the LCD - </p><span id="Inputs-106"></span><h4 class="subsubheading">Inputs</h4> +</p><h4 class="subsubheading" id="Inputs-106">Inputs</h4> <p>None. </p> -<span id="Outputs-65"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-65">Outputs</h4> <p>None. - </p></dd></dl> +</p></dd></dl> -<dl class="def"> -<dt id="index-clearLCD_0028_0029"><span class="category">: </span><span><em></em> <strong>clearLCD()</strong><a href='#index-clearLCD_0028_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-clearLCD_0028_0029"><span class="category-def">: </span><span><strong class="def-name">clearLCD()</strong><a class="copiable-link" href='#index-clearLCD_0028_0029'> ¶</a></span></dt> <dd><p>Clear the LCD display and set the cursor position to the home position. </p> -<span id="Inputs-107"></span><h4 class="subsubheading">Inputs</h4> +<h4 class="subsubheading" id="Inputs-107">Inputs</h4> <p>None. </p> -<span id="Outputs-66"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-66">Outputs</h4> <p>None. - </p></dd></dl> +</p></dd></dl> -<dl class="def"> -<dt id="index-printLCD_0028text_0029"><span class="category">: </span><span><em></em> <strong>printLCD(<var>text</var>)</strong><a href='#index-printLCD_0028text_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-printLCD_0028text_0029"><span class="category-def">: </span><span><strong class="def-name">printLCD(<var class="var">text</var>)</strong><a class="copiable-link" href='#index-printLCD_0028text_0029'> ¶</a></span></dt> <dd><p>Display text on LCD starting at the current cursor position. </p> -<span id="Inputs-108"></span><h4 class="subsubheading">Inputs</h4> -<p><var>text</var> - text to display on LCD +<h4 class="subsubheading" id="Inputs-108">Inputs</h4> +<p><var class="var">text</var> - text to display on LCD </p> -<span id="Outputs-67"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-67">Outputs</h4> <p>None. - </p></dd></dl> +</p></dd></dl> -<dl class="def"> -<dt id="index-gotoLCD_0028col_002c"><span class="category">: </span><span><em></em> <strong>gotoLCD(<var>col</var>,</strong> <em><var>row</var>)</em><a href='#index-gotoLCD_0028col_002c' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-gotoLCD_0028col_002c"><span class="category-def">: </span><span><strong class="def-name">gotoLCD(<var class="var">col</var>,</strong> <code class="def-code-arguments"><var class="var">row</var>)</code><a class="copiable-link" href='#index-gotoLCD_0028col_002c'> ¶</a></span></dt> <dd><p>Set the cursor position to row, col </p> -<span id="Inputs-109"></span><h4 class="subsubheading">Inputs</h4> -<p><var>col</var> - 0 indexed LCD column to position to. +<h4 class="subsubheading" id="Inputs-109">Inputs</h4> +<p><var class="var">col</var> - 0 indexed LCD column to position to. </p> -<p><var>row</var> - 0 indexed LCD row to position to. +<p><var class="var">row</var> - 0 indexed LCD row to position to. </p> -<span id="Outputs-68"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-68">Outputs</h4> <p>None. - </p></dd></dl> +</p></dd></dl> </div> -<div class="subsection" id="arduinoioaddons_002eRTCAddon_002eDS1307"> +<div class="subsection-level-extent" id="arduinoioaddons_002eRTCAddon_002eDS1307"> <h4 class="subsection">9.11.5 arduinoioaddons.RTCAddon.DS1307</h4> -<span id="index-DS1307"></span> -<dl class="def"> -<dt id="index-arduinoioaddons_002eRTCAddon_002eDS1307"><span class="category">: </span><span><em></em> <strong>arduinoioaddons.RTCAddon.DS1307</strong><a href='#index-arduinoioaddons_002eRTCAddon_002eDS1307' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-DS1307"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinoioaddons_002eRTCAddon_002eDS1307"><span class="category-def">: </span><span><strong class="def-name">arduinoioaddons.RTCAddon.DS1307</strong><a class="copiable-link" href='#index-arduinoioaddons_002eRTCAddon_002eDS1307'> ¶</a></span></dt> <dd><p>DS1307 addon </p> -<p><strong>See also:</strong> addon. - </p></dd></dl> +<p><strong class="strong">See also:</strong> addon. +</p></dd></dl> -<span id="Properties-12"></span><h4 class="subsubheading">Properties</h4> -<p><var>Parent</var> - the parent arduino object. +<h4 class="subsubheading" id="Properties-12">Properties</h4> +<p><var class="var">Parent</var> - the parent arduino object. </p> -<p><var>Pins</var> - the pins allocated the addon. +<p><var class="var">Pins</var> - the pins allocated the addon. </p> -<span id="Methods-3"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-DS1307_0028arObj_0029"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>DS1307(<var>arObj</var>)</strong><a href='#index-DS1307_0028arObj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-DS1307_0028arObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>DS1307(<var>arObj</var>,</strong> <em><var>propertyname, propertyvalue</var> ....)</em><a href='#index-DS1307_0028arObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-3">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-DS1307_0028arObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">DS1307(<var class="var">arObj</var>)</strong><a class="copiable-link" href='#index-DS1307_0028arObj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-DS1307_0028arObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">DS1307(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-DS1307_0028arObj_002c'> ¶</a></span></dt> <dd><p>Constructor to create DS1307 addon - </p><span id="Inputs-110"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-110">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>propertyname, propertyvalue</var> - optional property name, value pairs. +<p><var class="var">propertyname, propertyvalue</var> - optional property name, value pairs. Current known properties are: - </p><dl compact="compact"> -<dt><span>address</span></dt> +</p><dl class="table"> +<dt>address</dt> <dd><p>I2C address of the DS1307 (default 0x68) - </p></dd> +</p></dd> </dl> -<span id="Outputs-69"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created DS1307 object +<h4 class="subsubheading" id="Outputs-69">Outputs</h4> +<p><var class="var">obj</var> - created DS1307 object </p> -<span id="Example-13"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-13">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() rtc = addon(a, "rtcaddon/ds1307") </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-clock_0028dsObj_0029"><span class="category">: </span><span><em><var>date</var> =</em> <strong>clock(<var>dsObj</var>)</strong><a href='#index-clock_0028dsObj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-clock_0028dsObj_002c"><span class="category">: </span><span><em></em> <strong>clock(<var>dsObj</var>,</strong> <em><var>date</var>)</em><a href='#index-clock_0028dsObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-clock_0028dsObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">date</var> =</code> <strong class="def-name">clock(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-clock_0028dsObj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-clock_0028dsObj_002c"><span class="category-def">: </span><span><strong class="def-name">clock(<var class="var">dsObj</var>,</strong> <code class="def-code-arguments"><var class="var">date</var>)</code><a class="copiable-link" href='#index-clock_0028dsObj_002c'> ¶</a></span></dt> <dd><p>Get/set the DS1307 clock </p> -<span id="Inputs-111"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the ds1307 object +<h4 class="subsubheading" id="Inputs-111">Inputs</h4> +<p><var class="var">dsObj</var> - the ds1307 object </p> -<p><var>date</var> - a date vector in same format as datevec and clock +<p><var class="var">date</var> - a date vector in same format as datevec and clock </p> -<span id="Outputs-70"></span><h4 class="subsubheading">Outputs</h4> -<p><var>date</var> - a date vector in same format as datevec and clock +<h4 class="subsubheading" id="Outputs-70">Outputs</h4> +<p><var class="var">date</var> - a date vector in same format as datevec and clock </p> -<span id="Example-14"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-14">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() rtc = addon(a, "rtcaddon/ds1307") # get and display rtc time as a date string datestr(rtc.clock) </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> datevec. - </p></dd></dl> +<p><strong class="strong">See also:</strong> datevec. +</p></dd></dl> -<dl class="def"> -<dt id="index-control_0028dsObj_0029"><span class="category">: </span><span><em><var>ctrl</var> =</em> <strong>control(<var>dsObj</var>)</strong><a href='#index-control_0028dsObj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-control_0028dsObj_002c"><span class="category">: </span><span><em></em> <strong>control(<var>dsObj</var>,</strong> <em><var>ctrl</var>)</em><a href='#index-control_0028dsObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-control_0028dsObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">ctrl</var> =</code> <strong class="def-name">control(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-control_0028dsObj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-control_0028dsObj_002c"><span class="category-def">: </span><span><strong class="def-name">control(<var class="var">dsObj</var>,</strong> <code class="def-code-arguments"><var class="var">ctrl</var>)</code><a class="copiable-link" href='#index-control_0028dsObj_002c'> ¶</a></span></dt> <dd><p>Get/set the DS1307 clock </p> -<span id="Inputs-112"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the ds1307 object +<h4 class="subsubheading" id="Inputs-112">Inputs</h4> +<p><var class="var">dsObj</var> - the ds1307 object </p> -<p><var>ctrl</var> - a structure containing the control bit fields. +<p><var class="var">ctrl</var> - a structure containing the control bit fields. </p> -<span id="Outputs-71"></span><h4 class="subsubheading">Outputs</h4> -<p><var>ctrl</var> - a structure containing the control bit fields. +<h4 class="subsubheading" id="Outputs-71">Outputs</h4> +<p><var class="var">ctrl</var> - a structure containing the control bit fields. </p> <p>Control structure fields are: Current properties are: - </p><dl compact="compact"> -<dt><span>out</span></dt> +</p><dl class="table"> +<dt>out</dt> <dd><p>Out bit in the control register - </p></dd> -<dt><span>sqwe</span></dt> +</p></dd> +<dt>sqwe</dt> <dd><p>Square wave enable bit in control register - </p></dd> -<dt><span>rs</span></dt> +</p></dd> +<dt>rs</dt> <dd><p>The combined RS0, RS1 value - </p></dd> +</p></dd> </dl> </dd></dl> -<dl class="def"> -<dt id="index-isstarted_0028dsObj_0029"><span class="category">: </span><span><em><var>YN</var> =</em> <strong>isstarted(<var>dsObj</var>)</strong><a href='#index-isstarted_0028dsObj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-isstarted_0028dsObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">YN</var> =</code> <strong class="def-name">isstarted(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-isstarted_0028dsObj_0029'> ¶</a></span></dt> <dd><p>Get whether the RTC clock is currently counting time </p> -<span id="Inputs-113"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the ds1307 object +<h4 class="subsubheading" id="Inputs-113">Inputs</h4> +<p><var class="var">dsObj</var> - the ds1307 object </p> -<span id="Outputs-72"></span><h4 class="subsubheading">Outputs</h4> -<p><var>YN</var> - returns true if the RTC is counting +<h4 class="subsubheading" id="Outputs-72">Outputs</h4> +<p><var class="var">YN</var> - returns true if the RTC is counting </p> -<p><strong>See also:</strong> start, stop. - </p></dd></dl> +<p><strong class="strong">See also:</strong> start, stop. +</p></dd></dl> -<dl class="def"> -<dt id="index-start_0028dsObj_0029"><span class="category">: </span><span><em></em> <strong>start(<var>dsObj</var>)</strong><a href='#index-start_0028dsObj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-start_0028dsObj_0029"><span class="category-def">: </span><span><strong class="def-name">start(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-start_0028dsObj_0029'> ¶</a></span></dt> <dd><p>Start the RTC counting </p> -<span id="Inputs-114"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the ds1307 object +<h4 class="subsubheading" id="Inputs-114">Inputs</h4> +<p><var class="var">dsObj</var> - the ds1307 object </p> -<span id="Outputs-73"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-73">Outputs</h4> <p>None </p> -<p><strong>See also:</strong> datevec. - </p></dd></dl> +<p><strong class="strong">See also:</strong> datevec. +</p></dd></dl> -<dl class="def"> -<dt id="index-stop_0028dsObj_0029"><span class="category">: </span><span><em></em> <strong>stop(<var>dsObj</var>)</strong><a href='#index-stop_0028dsObj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-stop_0028dsObj_0029"><span class="category-def">: </span><span><strong class="def-name">stop(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-stop_0028dsObj_0029'> ¶</a></span></dt> <dd><p>Stop the RTC counting </p> -<span id="Inputs-115"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the ds1307 object +<h4 class="subsubheading" id="Inputs-115">Inputs</h4> +<p><var class="var">dsObj</var> - the ds1307 object </p> -<span id="Outputs-74"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-74">Outputs</h4> <p>None </p> -<p><strong>See also:</strong> datevec. - </p></dd></dl> +<p><strong class="strong">See also:</strong> datevec. +</p></dd></dl> </div> -<div class="subsection" id="arduinoioaddons_002eSimpleStepper_002eSimpleStepper"> +<div class="subsection-level-extent" id="arduinoioaddons_002eSimpleStepper_002eSimpleStepper"> <h4 class="subsection">9.11.6 arduinoioaddons.SimpleStepper.SimpleStepper</h4> -<span id="index-SimpleStepper"></span> -<dl class="def"> -<dt id="index-arduinoioaddons_002eSimpleStepper"><span class="category">: </span><span><em></em> <strong>arduinoioaddons.SimpleStepper</strong><a href='#index-arduinoioaddons_002eSimpleStepper' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-SimpleStepper"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinoioaddons_002eSimpleStepper"><span class="category-def">: </span><span><strong class="def-name">arduinoioaddons.SimpleStepper</strong><a class="copiable-link" href='#index-arduinoioaddons_002eSimpleStepper'> ¶</a></span></dt> <dd><p>Stepper class for stepper control using ULN2003 and compatible drivers - </p></dd></dl> +</p></dd></dl> -<span id="Properties-13"></span><h4 class="subsubheading">Properties</h4> -<dl compact="compact"> -<dt><span><var>Id</var></span></dt> +<h4 class="subsubheading" id="Properties-13">Properties</h4> +<dl class="table"> +<dt><var class="var">Id</var></dt> <dd><p>Id of the stepper (Read only) - </p></dd> -<dt><span><var>Speed</var></span></dt> +</p></dd> +<dt><var class="var">Speed</var></dt> <dd><p>Number of steps to do per second. - </p></dd> -<dt><span>Status</span></dt> +</p></dd> +<dt>Status</dt> <dd><p>Status of stepper (Read only). 0 = not moving, 1 = moving, 2 = rotating - </p></dd> -<dt><span>Parent</span></dt> +</p></dd> +<dt>Parent</dt> <dd><p>the Arduino parent (read only) - </p></dd> -<dt><span>Pins</span></dt> +</p></dd> +<dt>Pins</dt> <dd><p>the pins used for the stepper (read only) - </p></dd> +</p></dd> </dl> -<span id="Methods-4"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-SimpleStepper_0028aObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>SimpleStepper(<var>aObj</var>,</strong> <em><var>pin1</var>, <var>pin2</var>, <var>pin3</var>, <var>pin4</var>)</em><a href='#index-SimpleStepper_0028aObj_002c' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-SimpleStepper_0028aObj_002c-1"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>SimpleStepper(<var>aObj</var>,</strong> <em><var>pin1</var>, <var>pin2</var>, <var>pin3</var>, <var>pin4</var>, <var>pin5</var>)</em><a href='#index-SimpleStepper_0028aObj_002c-1' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-4">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-SimpleStepper_0028aObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">SimpleStepper(<var class="var">aObj</var>,</strong> <code class="def-code-arguments"><var class="var">pin1</var>, <var class="var">pin2</var>, <var class="var">pin3</var>, <var class="var">pin4</var>)</code><a class="copiable-link" href='#index-SimpleStepper_0028aObj_002c'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-SimpleStepper_0028aObj_002c-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">SimpleStepper(<var class="var">aObj</var>,</strong> <code class="def-code-arguments"><var class="var">pin1</var>, <var class="var">pin2</var>, <var class="var">pin3</var>, <var class="var">pin4</var>, <var class="var">pin5</var>)</code><a class="copiable-link" href='#index-SimpleStepper_0028aObj_002c-1'> ¶</a></span></dt> <dd><p>Constructor to create a stepper object - </p><span id="Inputs-116"></span><h4 class="subsubheading">Inputs</h4> -<p><var>aObj</var> - The arduino +</p><h4 class="subsubheading" id="Inputs-116">Inputs</h4> +<p><var class="var">aObj</var> - The arduino </p> -<p><var>pin1</var> - The first pin of the controller +<p><var class="var">pin1</var> - The first pin of the controller </p> -<p><var>pin2</var> - The second pin of the controller +<p><var class="var">pin2</var> - The second pin of the controller </p> -<p><var>pin3</var> - The third pin of the controller +<p><var class="var">pin3</var> - The third pin of the controller </p> -<p><var>pin4</var> - The fourth pin of the controller +<p><var class="var">pin4</var> - The fourth pin of the controller </p> -<p><var>pin5</var> - The fifth pin of the controller +<p><var class="var">pin5</var> - The fifth pin of the controller </p> -<span id="Outputs-75"></span><h4 class="subsubheading">Outputs</h4> -<p><var>s</var> - a simplestepper object +<h4 class="subsubheading" id="Outputs-75">Outputs</h4> +<p><var class="var">s</var> - a simplestepper object </p> -<span id="Example-15"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-15">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() # create stepper object s = addon(a, "simplestepper/simplestepper", "d2", "d3", "d4", "d5") # start rotating left s.rotate(-1); </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> addon. - </p></dd></dl> +<p><strong class="strong">See also:</strong> addon. +</p></dd></dl> -<dl class="def"> -<dt id="index-move_0028sObj_002c"><span class="category">: </span><span><em></em> <strong>move(<var>sObj</var>,</strong> <em><var>steps</var>)</em><a href='#index-move_0028sObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-move_0028sObj_002c"><span class="category-def">: </span><span><strong class="def-name">move(<var class="var">sObj</var>,</strong> <code class="def-code-arguments"><var class="var">steps</var>)</code><a class="copiable-link" href='#index-move_0028sObj_002c'> ¶</a></span></dt> <dd><p>Move the motor the specified number of steps using the configured Speed. </p> -<span id="Inputs-117"></span><h4 class="subsubheading">Inputs</h4> -<p><var>sObj</var> - the stepper object +<h4 class="subsubheading" id="Inputs-117">Inputs</h4> +<p><var class="var">sObj</var> - the stepper object </p> -<p><var>steps</var> - the number of steps to move. steps less than 0 will be moving left. +<p><var class="var">steps</var> - the number of steps to move. steps less than 0 will be moving left. </p> -<span id="Outputs-76"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-76">Outputs</h4> <p>None </p> -<p><strong>See also:</strong> rotate. - </p></dd></dl> +<p><strong class="strong">See also:</strong> rotate. +</p></dd></dl> -<dl class="def"> -<dt id="index-rotate_0028sObj_002c"><span class="category">: </span><span><em></em> <strong>rotate(<var>sObj</var>,</strong> <em><var>dir</var>)</em><a href='#index-rotate_0028sObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-rotate_0028sObj_002c"><span class="category-def">: </span><span><strong class="def-name">rotate(<var class="var">sObj</var>,</strong> <code class="def-code-arguments"><var class="var">dir</var>)</code><a class="copiable-link" href='#index-rotate_0028sObj_002c'> ¶</a></span></dt> <dd><p>Start steppermotor moving in the specified direction using the configured Speed. </p> -<span id="Inputs-118"></span><h4 class="subsubheading">Inputs</h4> -<p><var>sObj</var> - the stepper object +<h4 class="subsubheading" id="Inputs-118">Inputs</h4> +<p><var class="var">sObj</var> - the stepper object </p> -<p><var>dir</var> - Direction to move. -1 = left, 0 = stop, 1 = right. +<p><var class="var">dir</var> - Direction to move. -1 = left, 0 = stop, 1 = right. </p> -<span id="Outputs-77"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-77">Outputs</h4> <p>None </p> -<p><strong>See also:</strong> move. - </p></dd></dl> +<p><strong class="strong">See also:</strong> move. +</p></dd></dl> -<dl class="def"> -<dt id="index-release_0028sObj_0029"><span class="category">: </span><span><em></em> <strong>release(<var>sObj</var>)</strong><a href='#index-release_0028sObj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-release_0028sObj_0029"><span class="category-def">: </span><span><strong class="def-name">release(<var class="var">sObj</var>)</strong><a class="copiable-link" href='#index-release_0028sObj_0029'> ¶</a></span></dt> <dd><p>Release this stepper motor </p> -<span id="Inputs-119"></span><h4 class="subsubheading">Inputs</h4> -<p><var>sObj</var> - the stepper object +<h4 class="subsubheading" id="Inputs-119">Inputs</h4> +<p><var class="var">sObj</var> - the stepper object </p> -<span id="Outputs-78"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-78">Outputs</h4> <p>None </p> </dd></dl> </div> -<div class="subsection" id="arduinoioaddons_002eadafruit_002edcmotorv2"> +<div class="subsection-level-extent" id="arduinoioaddons_002eadafruit_002edcmotorv2"> <h4 class="subsection">9.11.7 arduinoioaddons.adafruit.dcmotorv2</h4> -<span id="index-dcmotorv2"></span> -<dl class="def"> -<dt id="index-arduinoioaddons_002eadafruit_002edcmotorv2"><span class="category">: </span><span><em></em> <strong>arduinoioaddons.adafruit.dcmotorv2</strong><a href='#index-arduinoioaddons_002eadafruit_002edcmotorv2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-dcmotorv2"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinoioaddons_002eadafruit_002edcmotorv2"><span class="category-def">: </span><span><strong class="def-name">arduinoioaddons.adafruit.dcmotorv2</strong><a class="copiable-link" href='#index-arduinoioaddons_002eadafruit_002edcmotorv2'> ¶</a></span></dt> <dd><p>DC Motor class for dc motor control on the adafruit motor shield </p> -<p><strong>See also:</strong> arduinoioaddons.adafruit.motorshieldv2. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduinoioaddons.adafruit.motorshieldv2. +</p></dd></dl> -<span id="Properties-14"></span><h4 class="subsubheading">Properties</h4> -<p><var>Speed</var> - The speed value set for the motor +<h4 class="subsubheading" id="Properties-14">Properties</h4> +<p><var class="var">Speed</var> - The speed value set for the motor </p> -<p><var>Parent</var> - The parent shield for object (read only) +<p><var class="var">Parent</var> - The parent shield for object (read only) </p> -<p><var>MotorNumber</var> - The motor number (read only) values 1-4 +<p><var class="var">MotorNumber</var> - The motor number (read only) values 1-4 </p> -<p><var>IsRunning</var> - boolean for if the motor is started (read only) +<p><var class="var">IsRunning</var> - boolean for if the motor is started (read only) </p> -<span id="Methods-5"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-dcmotorv2_0028mObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>dcmotorv2(<var>mObj</var>,</strong> <em><var>mnum</var>)</em><a href='#index-dcmotorv2_0028mObj_002c' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-dcmotorv2_0028mObj_002c-1"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>dcmotorv2(<var>mObj</var>,</strong> <em><var>mnum</var>, <var>propertyname, propertyvalue</var> ....)</em><a href='#index-dcmotorv2_0028mObj_002c-1' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-5">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-dcmotorv2_0028mObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">dcmotorv2(<var class="var">mObj</var>,</strong> <code class="def-code-arguments"><var class="var">mnum</var>)</code><a class="copiable-link" href='#index-dcmotorv2_0028mObj_002c'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-dcmotorv2_0028mObj_002c-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">dcmotorv2(<var class="var">mObj</var>,</strong> <code class="def-code-arguments"><var class="var">mnum</var>, <var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-dcmotorv2_0028mObj_002c-1'> ¶</a></span></dt> <dd><p>Constructor to create dcmotor object - </p><span id="Inputs-120"></span><h4 class="subsubheading">Inputs</h4> -<p><var>mObj</var> - the motor shield object +</p><h4 class="subsubheading" id="Inputs-120">Inputs</h4> +<p><var class="var">mObj</var> - the motor shield object </p> -<p><var>mnum</var> - The motor number (1 - 4) +<p><var class="var">mnum</var> - The motor number (1 - 4) </p> -<p><var>propertyname, propertyvalue</var> - Optional property name/value +<p><var class="var">propertyname, propertyvalue</var> - Optional property name/value pairs to pass to motor object. </p> <p>Current known properties are: - </p><dl compact="compact"> -<dt><span>Speed</span></dt> +</p><dl class="table"> +<dt>Speed</dt> <dd><p>Initial speed (default 0). Should be a value between -1 and 1. - </p></dd> +</p></dd> </dl> -<span id="Outputs-79"></span><h4 class="subsubheading">Outputs</h4> -<p><var>s</var> - a dcmotorv2 object +<h4 class="subsubheading" id="Outputs-79">Outputs</h4> +<p><var class="var">s</var> - a dcmotorv2 object </p> -<span id="Example-16"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-16">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() ms = addon(a, "adafruit/motorshieldv2") mtr = dcmotor(ms, 1) </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-start_0028dcObj_0029"><span class="category">: </span><span><em></em> <strong>start(<var>dcObj</var>)</strong><a href='#index-start_0028dcObj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-start_0028dcObj_0029"><span class="category-def">: </span><span><strong class="def-name">start(<var class="var">dcObj</var>)</strong><a class="copiable-link" href='#index-start_0028dcObj_0029'> ¶</a></span></dt> <dd><p>Start the motor moving in previously set speed/direction </p> -<span id="Inputs-121"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dcObj</var> - the dcmotor object +<h4 class="subsubheading" id="Inputs-121">Inputs</h4> +<p><var class="var">dcObj</var> - the dcmotor object </p> -<span id="Outputs-80"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-80">Outputs</h4> <p>None </p> -<p><strong>See also:</strong> adafruit.motorshieldv2. - </p></dd></dl> +<p><strong class="strong">See also:</strong> adafruit.motorshieldv2. +</p></dd></dl> -<dl class="def"> -<dt id="index-stop_0028dcObj_0029"><span class="category">: </span><span><em></em> <strong>stop(<var>dcObj</var>)</strong><a href='#index-stop_0028dcObj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-stop_0028dcObj_0029"><span class="category-def">: </span><span><strong class="def-name">stop(<var class="var">dcObj</var>)</strong><a class="copiable-link" href='#index-stop_0028dcObj_0029'> ¶</a></span></dt> <dd><p>Stop the motor moving </p> -<span id="Inputs-122"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dcObj</var> - the dcmotor object +<h4 class="subsubheading" id="Inputs-122">Inputs</h4> +<p><var class="var">dcObj</var> - the dcmotor object </p> -<span id="Outputs-81"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-81">Outputs</h4> <p>None </p> -<p><strong>See also:</strong> adafruit.motorshieldv2. - </p></dd></dl> +<p><strong class="strong">See also:</strong> adafruit.motorshieldv2. +</p></dd></dl> </div> -<div class="subsection" id="arduinoioaddons_002eadafruit_002emotorshieldv2"> +<div class="subsection-level-extent" id="arduinoioaddons_002eadafruit_002emotorshieldv2"> <h4 class="subsection">9.11.8 arduinoioaddons.adafruit.motorshieldv2</h4> -<span id="index-motorshieldv2"></span> -<dl class="def"> -<dt id="index-arduinoioaddons_002eadafruit_002emotorshieldv2"><span class="category">: </span><span><em></em> <strong>arduinoioaddons.adafruit.motorshieldv2</strong><a href='#index-arduinoioaddons_002eadafruit_002emotorshieldv2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-motorshieldv2"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinoioaddons_002eadafruit_002emotorshieldv2"><span class="category-def">: </span><span><strong class="def-name">arduinoioaddons.adafruit.motorshieldv2</strong><a class="copiable-link" href='#index-arduinoioaddons_002eadafruit_002emotorshieldv2'> ¶</a></span></dt> <dd><p>Adafruit motor shield addon </p> -<p><strong>See also:</strong> addon. - </p></dd></dl> +<p><strong class="strong">See also:</strong> addon. +</p></dd></dl> -<span id="Properties-15"></span><h4 class="subsubheading">Properties</h4> -<p><var>Parent</var> - the parent arduino object. +<h4 class="subsubheading" id="Properties-15">Properties</h4> +<p><var class="var">Parent</var> - the parent arduino object. </p> -<p><var>Pins</var> - the pins allocated the addon. +<p><var class="var">Pins</var> - the pins allocated the addon. </p> -<p><var>I2CAddress</var> - the i2c address used for accessing this shield. +<p><var class="var">I2CAddress</var> - the i2c address used for accessing this shield. </p> -<p><var>PWMFrequency</var> - the set PWM frequency for this shield. +<p><var class="var">PWMFrequency</var> - the set PWM frequency for this shield. </p> -<span id="Methods-6"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-motorshieldv2_0028arObj_0029"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>motorshieldv2(<var>arObj</var>)</strong><a href='#index-motorshieldv2_0028arObj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-motorshieldv2_0028arObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>motorshieldv2(<var>arObj</var>,</strong> <em><var>propertyname, propertyvalue</var> ....)</em><a href='#index-motorshieldv2_0028arObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-6">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-motorshieldv2_0028arObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">motorshieldv2(<var class="var">arObj</var>)</strong><a class="copiable-link" href='#index-motorshieldv2_0028arObj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-motorshieldv2_0028arObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">motorshieldv2(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-motorshieldv2_0028arObj_002c'> ¶</a></span></dt> <dd><p>Constructor to create motorshieldv2 addon object - </p><span id="Inputs-123"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-123">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>propertyname, propertyvalue</var> - optional property name, value pairs. +<p><var class="var">propertyname, propertyvalue</var> - optional property name, value pairs. Current known properties are: - </p><dl compact="compact"> -<dt><span>address</span></dt> +</p><dl class="table"> +<dt>address</dt> <dd><p>I2C address of the motor shield (default 0x60) - </p></dd> -<dt><span>pwmfrequency</span></dt> +</p></dd> +<dt>pwmfrequency</dt> <dd><p>PWM Frequency to set on shield (default 1600) - </p></dd> +</p></dd> </dl> -<span id="Outputs-82"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created motorshieldv2 object +<h4 class="subsubheading" id="Outputs-82">Outputs</h4> +<p><var class="var">obj</var> - created motorshieldv2 object </p> -<span id="Example-17"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-17">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() mtr = addon(a, "adafruit/motorshieldv2") </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-servo_0028mObj_002c"><span class="category">: </span><span><em><var>s</var> =</em> <strong>servo(<var>mObj</var>,</strong> <em><var>mtrnum</var>)</em><a href='#index-servo_0028mObj_002c' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-servo_0028mObj_002c-1"><span class="category">: </span><span><em><var>s</var> =</em> <strong>servo(<var>mObj</var>,</strong> <em><var>mtrnum</var>, <var>propertyname</var>, <var>propertyvalue</var> ...)</em><a href='#index-servo_0028mObj_002c-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-servo_0028mObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">s</var> =</code> <strong class="def-name">servo(<var class="var">mObj</var>,</strong> <code class="def-code-arguments"><var class="var">mtrnum</var>)</code><a class="copiable-link" href='#index-servo_0028mObj_002c'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-servo_0028mObj_002c-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">s</var> =</code> <strong class="def-name">servo(<var class="var">mObj</var>,</strong> <code class="def-code-arguments"><var class="var">mtrnum</var>, <var class="var">propertyname</var>, <var class="var">propertyvalue</var> ...)</code><a class="copiable-link" href='#index-servo_0028mObj_002c-1'> ¶</a></span></dt> <dd><p>Create a servo object </p> -<span id="Inputs-124"></span><h4 class="subsubheading">Inputs</h4> -<p><var>mObj</var> - the motor shield object +<h4 class="subsubheading" id="Inputs-124">Inputs</h4> +<p><var class="var">mObj</var> - the motor shield object </p> -<p><var>mtrnum</var> - The servo motor number, where 1 is servo on +<p><var class="var">mtrnum</var> - The servo motor number, where 1 is servo on pin "d10" and 2 is a servo on pin "d9" </p> -<p><var>propertyname</var>, <var>propertyvalue</var> - Optional property +<p><var class="var">propertyname</var>, <var class="var">propertyvalue</var> - Optional property name/value pairs to pass to servo object. </p> <p>Properties are the same as the base servo object. </p> -<span id="Outputs-83"></span><h4 class="subsubheading">Outputs</h4> -<p><var>s</var> - a servo object +<h4 class="subsubheading" id="Outputs-83">Outputs</h4> +<p><var class="var">s</var> - a servo object </p> -<span id="Example-18"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-18">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() ms = addon(a, "adafruit/motorshieldv2") # get servo 1 (servo on pin D10) s = ms.servo(1) </code> - </pre></div> +</pre></div> <p>The function if the equivalent of calling the arduino.servo with the D9 or D10 pin has the input pin. </p> -<p><strong>See also:</strong> servo. - </p></dd></dl> +<p><strong class="strong">See also:</strong> servo. +</p></dd></dl> -<dl class="def"> -<dt id="index-stepper_0028mObj_002c"><span class="category">: </span><span><em><var>s</var> =</em> <strong>stepper(<var>mObj</var>,</strong> <em><var>mtrnum</var>, <var>stepsperrev</var>)</em><a href='#index-stepper_0028mObj_002c' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-stepper_0028mObj_002c-1"><span class="category">: </span><span><em><var>s</var> =</em> <strong>stepper(<var>mObj</var>,</strong> <em><var>mtrnum</var>, <var>stepsperrev</var>, <var>propertyname</var>, <var>propertyvalue</var> ...)</em><a href='#index-stepper_0028mObj_002c-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-stepper_0028mObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">s</var> =</code> <strong class="def-name">stepper(<var class="var">mObj</var>,</strong> <code class="def-code-arguments"><var class="var">mtrnum</var>, <var class="var">stepsperrev</var>)</code><a class="copiable-link" href='#index-stepper_0028mObj_002c'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-stepper_0028mObj_002c-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">s</var> =</code> <strong class="def-name">stepper(<var class="var">mObj</var>,</strong> <code class="def-code-arguments"><var class="var">mtrnum</var>, <var class="var">stepsperrev</var>, <var class="var">propertyname</var>, <var class="var">propertyvalue</var> ...)</code><a class="copiable-link" href='#index-stepper_0028mObj_002c-1'> ¶</a></span></dt> <dd><p>Create a stepper motor object </p> -<span id="Inputs-125"></span><h4 class="subsubheading">Inputs</h4> -<p><var>mObj</var> - the motor shield object +<h4 class="subsubheading" id="Inputs-125">Inputs</h4> +<p><var class="var">mObj</var> - the motor shield object </p> -<p><var>mtrnum</var> - The stepper motor number (1 or 2) +<p><var class="var">mtrnum</var> - The stepper motor number (1 or 2) </p> -<p><var>stepsperrev</var> - Number of steps per revolution. +<p><var class="var">stepsperrev</var> - Number of steps per revolution. </p> -<p><var>propertyname</var>, <var>propertyvalue</var> - Optional property +<p><var class="var">propertyname</var>, <var class="var">propertyvalue</var> - Optional property name/value pairs to pass to stepper object. </p> -<span id="Outputs-84"></span><h4 class="subsubheading">Outputs</h4> -<p><var>s</var> - a stepper object +<h4 class="subsubheading" id="Outputs-84">Outputs</h4> +<p><var class="var">s</var> - a stepper object </p> </dd></dl> -<dl class="def"> -<dt id="index-dcmotor_0028mObj_002c"><span class="category">: </span><span><em><var>s</var> =</em> <strong>dcmotor(<var>mObj</var>,</strong> <em><var>mtrnum</var>)</em><a href='#index-dcmotor_0028mObj_002c' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-dcmotor_0028mObj_002c-1"><span class="category">: </span><span><em><var>s</var> =</em> <strong>dcmotor(<var>mObj</var>,</strong> <em><var>mtrnum</var>, <var>propertyname</var>, <var>propertyvalue</var> ...)</em><a href='#index-dcmotor_0028mObj_002c-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-dcmotor_0028mObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">s</var> =</code> <strong class="def-name">dcmotor(<var class="var">mObj</var>,</strong> <code class="def-code-arguments"><var class="var">mtrnum</var>)</code><a class="copiable-link" href='#index-dcmotor_0028mObj_002c'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-dcmotor_0028mObj_002c-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">s</var> =</code> <strong class="def-name">dcmotor(<var class="var">mObj</var>,</strong> <code class="def-code-arguments"><var class="var">mtrnum</var>, <var class="var">propertyname</var>, <var class="var">propertyvalue</var> ...)</code><a class="copiable-link" href='#index-dcmotor_0028mObj_002c-1'> ¶</a></span></dt> <dd><p>Create a dcmotor motor object </p> -<span id="Inputs-126"></span><h4 class="subsubheading">Inputs</h4> -<p><var>mObj</var> - the motor shield object +<h4 class="subsubheading" id="Inputs-126">Inputs</h4> +<p><var class="var">mObj</var> - the motor shield object </p> -<p><var>mtrnum</var> - The motor number (1 - 4) +<p><var class="var">mtrnum</var> - The motor number (1 - 4) </p> -<p><var>propertyname</var>, <var>propertyvalue</var> - Optional property +<p><var class="var">propertyname</var>, <var class="var">propertyvalue</var> - Optional property name/value pairs to pass to motor object. </p> -<span id="Outputs-85"></span><h4 class="subsubheading">Outputs</h4> -<p><var>s</var> - a dcmotorv2 object +<h4 class="subsubheading" id="Outputs-85">Outputs</h4> +<p><var class="var">s</var> - a dcmotorv2 object </p> </dd></dl> </div> -<div class="subsection" id="arduinoioaddons_002eadafruit_002estepper"> +<div class="subsection-level-extent" id="arduinoioaddons_002eadafruit_002estepper"> <h4 class="subsection">9.11.9 arduinoioaddons.adafruit.stepper</h4> -<span id="index-stepper"></span> -<dl class="def"> -<dt id="index-arduinoioaddons_002eadafruit_002estepper"><span class="category">: </span><span><em></em> <strong>arduinoioaddons.adafruit.stepper</strong><a href='#index-arduinoioaddons_002eadafruit_002estepper' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-stepper"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinoioaddons_002eadafruit_002estepper"><span class="category-def">: </span><span><strong class="def-name">arduinoioaddons.adafruit.stepper</strong><a class="copiable-link" href='#index-arduinoioaddons_002eadafruit_002estepper'> ¶</a></span></dt> <dd><p>Stepper class for stepper control on the adafruit motor shield </p> -<p><strong>See also:</strong> arduinoioaddons.adafruit.motorshieldv2. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduinoioaddons.adafruit.motorshieldv2. +</p></dd></dl> -<span id="Properties-16"></span><h4 class="subsubheading">Properties</h4> -<dl compact="compact"> -<dt><span><var>RPM</var></span></dt> +<h4 class="subsubheading" id="Properties-16">Properties</h4> +<dl class="table"> +<dt><var class="var">RPM</var></dt> <dd><p>The rpm value set for the stepper motor - </p></dd> -<dt><span>StepType</span></dt> +</p></dd> +<dt>StepType</dt> <dd><p>the StepType for the stepper (string) which can be "single", "double", "interleave" or "microstep" - </p></dd> -<dt><span>StepsPerRevolution</span></dt> +</p></dd> +<dt>StepsPerRevolution</dt> <dd><p>the StepsPerRevoluion for the stepper (read only) - </p></dd> -<dt><span>MotorNumber</span></dt> +</p></dd> +<dt>MotorNumber</dt> <dd><p>the motor number for the stepper (read only) value will be 1 or 2. - </p></dd> -<dt><span>Parent</span></dt> +</p></dd> +<dt>Parent</dt> <dd><p>the parent shield of this stepper (read only) - </p></dd> +</p></dd> </dl> -<span id="Methods-7"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-stepper_0028mObj_002c-2"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>stepper(<var>mObj</var>,</strong> <em><var>mnum</var>, <var>stepsperrev</var>)</em><a href='#index-stepper_0028mObj_002c-2' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-stepper_0028mObj_002c-3"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>stepper(<var>mObj</var>,</strong> <em><var>mnum</var>, <var>stepsperrev</var>, <var>propertyname, propertyvalue</var> ....)</em><a href='#index-stepper_0028mObj_002c-3' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-7">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-stepper_0028mObj_002c-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">stepper(<var class="var">mObj</var>,</strong> <code class="def-code-arguments"><var class="var">mnum</var>, <var class="var">stepsperrev</var>)</code><a class="copiable-link" href='#index-stepper_0028mObj_002c-2'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-stepper_0028mObj_002c-3"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">stepper(<var class="var">mObj</var>,</strong> <code class="def-code-arguments"><var class="var">mnum</var>, <var class="var">stepsperrev</var>, <var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-stepper_0028mObj_002c-3'> ¶</a></span></dt> <dd><p>Constructor to create dcmotor object - </p><span id="Inputs-127"></span><h4 class="subsubheading">Inputs</h4> -<p><var>mObj</var> - the motor shield object +</p><h4 class="subsubheading" id="Inputs-127">Inputs</h4> +<p><var class="var">mObj</var> - the motor shield object </p> -<p><var>mnum</var> - The motor number (1 or 2) +<p><var class="var">mnum</var> - The motor number (1 or 2) </p> -<p><var>stepsperrev</var> - Number of steps per revolution. +<p><var class="var">stepsperrev</var> - Number of steps per revolution. </p> -<p><var>propertyname, propertyvalue</var> - Optional property +<p><var class="var">propertyname, propertyvalue</var> - Optional property name/value pairs to pass to motor object. </p> <p>Current known properties are: - </p><dl compact="compact"> -<dt><span>RPM</span></dt> +</p><dl class="table"> +<dt>RPM</dt> <dd><p>the RPM for the stepper (revolutions per minute) - </p></dd> -<dt><span>StepType</span></dt> +</p></dd> +<dt>StepType</dt> <dd><p>the StepType for the stepper (string) which can be "single", "double", "interleave" or "microstep" - </p></dd> +</p></dd> </dl> -<span id="Outputs-86"></span><h4 class="subsubheading">Outputs</h4> -<p><var>s</var> - a stepper object +<h4 class="subsubheading" id="Outputs-86">Outputs</h4> +<p><var class="var">s</var> - a stepper object </p> -<span id="Example-19"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-19">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() ms = addon(a, "adafruit/motorshieldv2") mtr = stepper(ms, 1, 200) </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-move_0028sObj_002c-1"><span class="category">: </span><span><em></em> <strong>move(<var>sObj</var>,</strong> <em><var>steps</var>)</em><a href='#index-move_0028sObj_002c-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-move_0028sObj_002c-1"><span class="category-def">: </span><span><strong class="def-name">move(<var class="var">sObj</var>,</strong> <code class="def-code-arguments"><var class="var">steps</var>)</code><a class="copiable-link" href='#index-move_0028sObj_002c-1'> ¶</a></span></dt> <dd><p>Move the motor moving in the specified steps using the configured RPM. </p> -<span id="Inputs-128"></span><h4 class="subsubheading">Inputs</h4> -<p><var>sObj</var> - the stepper object +<h4 class="subsubheading" id="Inputs-128">Inputs</h4> +<p><var class="var">sObj</var> - the stepper object </p> -<span id="Outputs-87"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-87">Outputs</h4> <p>None </p> -<p><strong>See also:</strong> adafruit.motorshieldv2. - </p></dd></dl> +<p><strong class="strong">See also:</strong> adafruit.motorshieldv2. +</p></dd></dl> -<dl class="def"> -<dt id="index-release_0028sObj_0029-1"><span class="category">: </span><span><em></em> <strong>release(<var>sObj</var>)</strong><a href='#index-release_0028sObj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-release_0028sObj_0029-1"><span class="category-def">: </span><span><strong class="def-name">release(<var class="var">sObj</var>)</strong><a class="copiable-link" href='#index-release_0028sObj_0029-1'> ¶</a></span></dt> <dd><p>Release this motor </p> -<span id="Inputs-129"></span><h4 class="subsubheading">Inputs</h4> -<p><var>sObj</var> - the stepper object +<h4 class="subsubheading" id="Inputs-129">Inputs</h4> +<p><var class="var">sObj</var> - the stepper object </p> -<span id="Outputs-88"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-88">Outputs</h4> <p>None </p> -<p><strong>See also:</strong> adafruit.motorshieldv2. - </p></dd></dl> +<p><strong class="strong">See also:</strong> adafruit.motorshieldv2. +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Arduino-Sensors"> -<div class="header"> +<div class="section-level-extent" id="Arduino-Sensors"> +<div class="nav-panel"> <p> Next: <a href="#Arduino-I_002fO-package" accesskey="n" rel="next">Arduino I/O package</a>, Previous: <a href="#Arduino-Addons" accesskey="p" rel="prev">Arduino Addons</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Arduino-Sensors-1"></span><h3 class="section">9.12 Arduino Sensors</h3> -<span id="index-Arduino-Sensors"></span> -<ul class="section-toc"> +<h3 class="section" id="Arduino-Sensors-1">9.12 Arduino Sensors</h3> +<a class="index-entry-id" id="index-Arduino-Sensors"></a> +<ul class="mini-toc"> <li><a href="#arduinosensor_002eDS1307" accesskey="1">arduinosensor.DS1307</a></li> <li><a href="#arduinosensor_002eGUVAS12SD" accesskey="2">arduinosensor.GUVAS12SD</a></li> <li><a href="#arduinosensor_002eMPC3002" accesskey="3">arduinosensor.MPC3002</a></li> <li><a href="#arduinosensor_002eSI7021" accesskey="4">arduinosensor.SI7021</a></li> </ul> -<div class="subsection" id="arduinosensor_002eDS1307"> +<div class="subsection-level-extent" id="arduinosensor_002eDS1307"> <h4 class="subsection">9.12.1 arduinosensor.DS1307</h4> -<span id="index-DS1307-1"></span> -<dl class="def"> -<dt id="index-arduinosensor_002eDS1307"><span class="category">: </span><span><em></em> <strong>arduinosensor.DS1307</strong><a href='#index-arduinosensor_002eDS1307' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-DS1307-1"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinosensor_002eDS1307"><span class="category-def">: </span><span><strong class="def-name">arduinosensor.DS1307</strong><a class="copiable-link" href='#index-arduinosensor_002eDS1307'> ¶</a></span></dt> <dd><p>DS1307 realtime clock sensor - </p></dd></dl> +</p></dd></dl> -<span id="Methods-8"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-DS1307_0028arObj_0029-1"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>DS1307(<var>arObj</var>)</strong><a href='#index-DS1307_0028arObj_0029-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-DS1307_0028arObj_002c-1"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>DS1307(<var>arObj</var>,</strong> <em><var>propertyname, propertyvalue</var> ....)</em><a href='#index-DS1307_0028arObj_002c-1' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-8">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-DS1307_0028arObj_0029-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">DS1307(<var class="var">arObj</var>)</strong><a class="copiable-link" href='#index-DS1307_0028arObj_0029-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-DS1307_0028arObj_002c-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">DS1307(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-DS1307_0028arObj_002c-1'> ¶</a></span></dt> <dd><p>Constructor to create DS1307 sensor - </p><span id="Inputs-130"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-130">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>propertyname, propertyvalue</var> - optional property name, value pairs. +<p><var class="var">propertyname, propertyvalue</var> - optional property name, value pairs. Current known properties are: Current properties are: - </p><dl compact="compact"> -<dt><span>i2caddress</span></dt> +</p><dl class="table"> +<dt>i2caddress</dt> <dd><p>I2C address of the DS1307 (default 0x68) - </p></dd> +</p></dd> </dl> -<span id="Outputs-89"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created DS1307 object +<h4 class="subsubheading" id="Outputs-89">Outputs</h4> +<p><var class="var">obj</var> - created DS1307 object </p> -<span id="Example-20"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-20">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() rtc = arduinosensor.DS1307(a) </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-clock_0028dsObj_0029-1"><span class="category">: </span><span><em><var>date</var> =</em> <strong>clock(<var>dsObj</var>)</strong><a href='#index-clock_0028dsObj_0029-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-clock_0028dsObj_002c-1"><span class="category">: </span><span><em></em> <strong>clock(<var>dsObj</var>,</strong> <em><var>date</var>)</em><a href='#index-clock_0028dsObj_002c-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-clock_0028dsObj_0029-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">date</var> =</code> <strong class="def-name">clock(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-clock_0028dsObj_0029-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-clock_0028dsObj_002c-1"><span class="category-def">: </span><span><strong class="def-name">clock(<var class="var">dsObj</var>,</strong> <code class="def-code-arguments"><var class="var">date</var>)</code><a class="copiable-link" href='#index-clock_0028dsObj_002c-1'> ¶</a></span></dt> <dd><p>Get/set the DS1307 clock </p> -<span id="Inputs-131"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the ds1307 object +<h4 class="subsubheading" id="Inputs-131">Inputs</h4> +<p><var class="var">dsObj</var> - the ds1307 object </p> -<p><var>date</var> - a date vector in same format as datevec and clock +<p><var class="var">date</var> - a date vector in same format as datevec and clock </p> -<span id="Outputs-90"></span><h4 class="subsubheading">Outputs</h4> -<p><var>date</var> - a date vector in same format as datevec and clock +<h4 class="subsubheading" id="Outputs-90">Outputs</h4> +<p><var class="var">date</var> - a date vector in same format as datevec and clock </p> -<span id="Example-21"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-21">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() rtc = arduinosensor.DS1307(a) # get and display rtc time as a date string datestr(rtc.clock) </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> datevec. - </p></dd></dl> +<p><strong class="strong">See also:</strong> datevec. +</p></dd></dl> -<dl class="def"> -<dt id="index-control_0028dsObj_0029-1"><span class="category">: </span><span><em><var>ctrl</var> =</em> <strong>control(<var>dsObj</var>)</strong><a href='#index-control_0028dsObj_0029-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-control_0028dsObj_002c-1"><span class="category">: </span><span><em></em> <strong>control(<var>dsObj</var>,</strong> <em><var>ctrl</var>)</em><a href='#index-control_0028dsObj_002c-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-control_0028dsObj_0029-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">ctrl</var> =</code> <strong class="def-name">control(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-control_0028dsObj_0029-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-control_0028dsObj_002c-1"><span class="category-def">: </span><span><strong class="def-name">control(<var class="var">dsObj</var>,</strong> <code class="def-code-arguments"><var class="var">ctrl</var>)</code><a class="copiable-link" href='#index-control_0028dsObj_002c-1'> ¶</a></span></dt> <dd><p>Get/set the DS1307 clock </p> -<span id="Inputs-132"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the ds1307 object +<h4 class="subsubheading" id="Inputs-132">Inputs</h4> +<p><var class="var">dsObj</var> - the ds1307 object </p> -<p><var>ctrl</var> - a structure containing the control bit fields. +<p><var class="var">ctrl</var> - a structure containing the control bit fields. </p> -<span id="Outputs-91"></span><h4 class="subsubheading">Outputs</h4> -<p><var>ctrl</var> - a structure containing the control bit fields. +<h4 class="subsubheading" id="Outputs-91">Outputs</h4> +<p><var class="var">ctrl</var> - a structure containing the control bit fields. </p> <p>Control structure fields are: Current properties are: - </p><dl compact="compact"> -<dt><span>out</span></dt> +</p><dl class="table"> +<dt>out</dt> <dd><p>Out bit in the control register - </p></dd> -<dt><span>sqwe</span></dt> +</p></dd> +<dt>sqwe</dt> <dd><p>Square wave enable bit in control register - </p></dd> -<dt><span>rs</span></dt> +</p></dd> +<dt>rs</dt> <dd><p>The combined RS0, RS1 value - </p></dd> +</p></dd> </dl> </dd></dl> -<dl class="def"> -<dt id="index-isstarted_0028dsObj_0029-1"><span class="category">: </span><span><em><var>YN</var> =</em> <strong>isstarted(<var>dsObj</var>)</strong><a href='#index-isstarted_0028dsObj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-isstarted_0028dsObj_0029-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">YN</var> =</code> <strong class="def-name">isstarted(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-isstarted_0028dsObj_0029-1'> ¶</a></span></dt> <dd><p>Get whether the RTC clock is currently counting time </p> -<span id="Inputs-133"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the ds1307 object +<h4 class="subsubheading" id="Inputs-133">Inputs</h4> +<p><var class="var">dsObj</var> - the ds1307 object </p> -<span id="Outputs-92"></span><h4 class="subsubheading">Outputs</h4> -<p><var>YN</var> - returns true if the RTC is counting +<h4 class="subsubheading" id="Outputs-92">Outputs</h4> +<p><var class="var">YN</var> - returns true if the RTC is counting </p> -<p><strong>See also:</strong> start, stop. - </p></dd></dl> +<p><strong class="strong">See also:</strong> start, stop. +</p></dd></dl> -<dl class="def"> -<dt id="index-start_0028dsObj_0029-1"><span class="category">: </span><span><em></em> <strong>start(<var>dsObj</var>)</strong><a href='#index-start_0028dsObj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-start_0028dsObj_0029-1"><span class="category-def">: </span><span><strong class="def-name">start(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-start_0028dsObj_0029-1'> ¶</a></span></dt> <dd><p>Start the RTC counting </p> -<span id="Inputs-134"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the ds1307 object +<h4 class="subsubheading" id="Inputs-134">Inputs</h4> +<p><var class="var">dsObj</var> - the ds1307 object </p> -<span id="Outputs-93"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-93">Outputs</h4> <p>None </p> -<p><strong>See also:</strong> datevec. - </p></dd></dl> +<p><strong class="strong">See also:</strong> datevec. +</p></dd></dl> -<dl class="def"> -<dt id="index-stop_0028dsObj_0029-1"><span class="category">: </span><span><em></em> <strong>stop(<var>dsObj</var>)</strong><a href='#index-stop_0028dsObj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-stop_0028dsObj_0029-1"><span class="category-def">: </span><span><strong class="def-name">stop(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-stop_0028dsObj_0029-1'> ¶</a></span></dt> <dd><p>Stop the RTC counting </p> -<span id="Inputs-135"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the ds1307 object +<h4 class="subsubheading" id="Inputs-135">Inputs</h4> +<p><var class="var">dsObj</var> - the ds1307 object </p> -<span id="Outputs-94"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-94">Outputs</h4> <p>None </p> -<p><strong>See also:</strong> datevec. - </p></dd></dl> +<p><strong class="strong">See also:</strong> datevec. +</p></dd></dl> </div> -<div class="subsection" id="arduinosensor_002eGUVAS12SD"> +<div class="subsection-level-extent" id="arduinosensor_002eGUVAS12SD"> <h4 class="subsection">9.12.2 arduinosensor.GUVAS12SD</h4> -<span id="index-GUVAS12SD"></span> -<dl class="def"> -<dt id="index-arduinosensor_002eGUVAS12SD"><span class="category">: </span><span><em></em> <strong>arduinosensor.GUVAS12SD</strong><a href='#index-arduinosensor_002eGUVAS12SD' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-GUVAS12SD"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinosensor_002eGUVAS12SD"><span class="category-def">: </span><span><strong class="def-name">arduinosensor.GUVAS12SD</strong><a class="copiable-link" href='#index-arduinosensor_002eGUVAS12SD'> ¶</a></span></dt> <dd><p>A thin wrapper for the GUVAS12SD analog UV-B sensor - </p></dd></dl> +</p></dd></dl> -<span id="Methods-9"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-GUVAS12SD_0028arObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>GUVAS12SD(<var>arObj</var>,</strong> <em><var>pin</var>)</em><a href='#index-GUVAS12SD_0028arObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-9">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-GUVAS12SD_0028arObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">GUVAS12SD(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">pin</var>)</code><a class="copiable-link" href='#index-GUVAS12SD_0028arObj_002c'> ¶</a></span></dt> <dd><p>Constructor to create GUVAS12SD sensor - </p><span id="Inputs-136"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-136">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>pin</var> - the analog pin that the sensor is connected to +<p><var class="var">pin</var> - the analog pin that the sensor is connected to </p> -<span id="Outputs-95"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created GUVAS12SD object +<h4 class="subsubheading" id="Outputs-95">Outputs</h4> +<p><var class="var">obj</var> - created GUVAS12SD object </p> -<span id="Example-22"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-22">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() # create sensor attached to pin a0. sensor = arduinosensor.GUVAS12SD(a, "a0") </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-read_0028dsObj_0029"><span class="category">: </span><span><em><var>V</var> =</em> <strong>read(<var>dsObj</var>)</strong><a href='#index-read_0028dsObj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read_0028dsObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">V</var> =</code> <strong class="def-name">read(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-read_0028dsObj_0029'> ¶</a></span></dt> <dd><p>Read the voltage of the sensor </p> -<span id="Inputs-137"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the GUVAS12SD object +<h4 class="subsubheading" id="Inputs-137">Inputs</h4> +<p><var class="var">dsObj</var> - the GUVAS12SD object </p> -<span id="Outputs-96"></span><h4 class="subsubheading">Outputs</h4> -<p><var>V</var> - read voltage - effectively equivalent to +<h4 class="subsubheading" id="Outputs-96">Outputs</h4> +<p><var class="var">V</var> - read voltage - effectively equivalent to readAnalogPin(arObj, pin). </p> -<span id="Example-23"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-23">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() s = arduinosensor.GUVAS12SD(a) # voltage volts = s.read </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> arduinosensor.GUVAS12SD. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduinosensor.GUVAS12SD. +</p></dd></dl> -<dl class="def"> -<dt id="index-readIndex_0028dsObj_0029"><span class="category">: </span><span><em><var>Idx</var> =</em> <strong>readIndex(<var>dsObj</var>)</strong><a href='#index-readIndex_0028dsObj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readIndex_0028dsObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">Idx</var> =</code> <strong class="def-name">readIndex(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-readIndex_0028dsObj_0029'> ¶</a></span></dt> <dd><p>Read the UV index </p> -<span id="Inputs-138"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the GUVAS12SD object +<h4 class="subsubheading" id="Inputs-138">Inputs</h4> +<p><var class="var">dsObj</var> - the GUVAS12SD object </p> -<span id="Outputs-97"></span><h4 class="subsubheading">Outputs</h4> -<p><var>Idx</var> - the sensor reading as a UV index reading - </p></dd></dl> +<h4 class="subsubheading" id="Outputs-97">Outputs</h4> +<p><var class="var">Idx</var> - the sensor reading as a UV index reading +</p></dd></dl> -<dl class="def"> -<dt id="index-readuA_0028dsObj_0029"><span class="category">: </span><span><em><var>uA</var> =</em> <strong>readuA(<var>dsObj</var>)</strong><a href='#index-readuA_0028dsObj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readuA_0028dsObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">uA</var> =</code> <strong class="def-name">readuA(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-readuA_0028dsObj_0029'> ¶</a></span></dt> <dd><p>Read the uA of the sensor </p> -<span id="Inputs-139"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the GUVAS12SD object +<h4 class="subsubheading" id="Inputs-139">Inputs</h4> +<p><var class="var">dsObj</var> - the GUVAS12SD object </p> -<span id="Outputs-98"></span><h4 class="subsubheading">Outputs</h4> -<p><var>uA</var> - the sensor reading as a uAmp value - </p></dd></dl> +<h4 class="subsubheading" id="Outputs-98">Outputs</h4> +<p><var class="var">uA</var> - the sensor reading as a uAmp value +</p></dd></dl> </div> -<div class="subsection" id="arduinosensor_002eMPC3002"> +<div class="subsection-level-extent" id="arduinosensor_002eMPC3002"> <h4 class="subsection">9.12.3 arduinosensor.MPC3002</h4> -<span id="index-MPC3002"></span> -<dl class="def"> -<dt id="index-arduinosensor_002eMPC3002"><span class="category">: </span><span><em></em> <strong>arduinosensor.MPC3002</strong><a href='#index-arduinosensor_002eMPC3002' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-MPC3002"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinosensor_002eMPC3002"><span class="category-def">: </span><span><strong class="def-name">arduinosensor.MPC3002</strong><a class="copiable-link" href='#index-arduinosensor_002eMPC3002'> ¶</a></span></dt> <dd><p>MCP3002 ADC sensor - </p></dd></dl> +</p></dd></dl> -<span id="Methods-10"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-MPC3002_0028arObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>MPC3002(<var>arObj</var>,</strong> <em><var>selectPin</var>)</em><a href='#index-MPC3002_0028arObj_002c' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-MPC3002_0028arObj_002c-1"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>MPC3002(<var>arObj</var>,</strong> <em><var>selectPin</var>, <var>propertyname, propertyvalue</var> ....)</em><a href='#index-MPC3002_0028arObj_002c-1' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-10">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-MPC3002_0028arObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">MPC3002(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">selectPin</var>)</code><a class="copiable-link" href='#index-MPC3002_0028arObj_002c'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-MPC3002_0028arObj_002c-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">MPC3002(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">selectPin</var>, <var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-MPC3002_0028arObj_002c-1'> ¶</a></span></dt> <dd><p>Constructor to create MPC3002 sensor - </p><span id="Inputs-140"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-140">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>selectPin</var> - the SPI cs select pin +<p><var class="var">selectPin</var> - the SPI cs select pin </p> -<p><var>propertyname, propertyvalue</var> - optional property name, value pairs. +<p><var class="var">propertyname, propertyvalue</var> - optional property name, value pairs. </p> <p>Current properties are: - </p><dl compact="compact"> -<dt><span>referenceVoltage</span></dt> +</p><dl class="table"> +<dt>referenceVoltage</dt> <dd><p>Reference voltage for scaling the ADC inputs (default 5.0) - </p></dd> +</p></dd> </dl> -<span id="Outputs-99"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created MCP3002 object +<h4 class="subsubheading" id="Outputs-99">Outputs</h4> +<p><var class="var">obj</var> - created MCP3002 object </p> -<span id="Example-24"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-24">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() sensor = arduinosensor.MPC3002(a, "d10") </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-readVoltage_0028dsObj_002c"><span class="category">: </span><span><em><var>voltage</var> =</em> <strong>readVoltage(<var>dsObj</var>,</strong> <em><var>chan</var>)</em><a href='#index-readVoltage_0028dsObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readVoltage_0028dsObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">voltage</var> =</code> <strong class="def-name">readVoltage(<var class="var">dsObj</var>,</strong> <code class="def-code-arguments"><var class="var">chan</var>)</code><a class="copiable-link" href='#index-readVoltage_0028dsObj_002c'> ¶</a></span></dt> <dd><p>Read the voltage from a channel </p> -<span id="Inputs-141"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the MPC3002 object +<h4 class="subsubheading" id="Inputs-141">Inputs</h4> +<p><var class="var">dsObj</var> - the MPC3002 object </p> -<p><var>chan</var> - the channel to read (0 or 1) +<p><var class="var">chan</var> - the channel to read (0 or 1) </p> -<span id="Outputs-100"></span><h4 class="subsubheading">Outputs</h4> -<p><var>voltage</var> - read voltage. +<h4 class="subsubheading" id="Outputs-100">Outputs</h4> +<p><var class="var">voltage</var> - read voltage. </p> -<span id="Example-25"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-25">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() s = arduinosensor.MPC3002(a, "d10") volts = readVoltage(s, 0) </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> arduinosensor.MPC3002. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduinosensor.MPC3002. +</p></dd></dl> </div> -<div class="subsection" id="arduinosensor_002eSI7021"> +<div class="subsection-level-extent" id="arduinosensor_002eSI7021"> <h4 class="subsection">9.12.4 arduinosensor.SI7021</h4> -<span id="index-SI7021"></span> -<dl class="def"> -<dt id="index-arduinosensor_002eSI7021"><span class="category">: </span><span><em></em> <strong>arduinosensor.SI7021</strong><a href='#index-arduinosensor_002eSI7021' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-SI7021"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinosensor_002eSI7021"><span class="category-def">: </span><span><strong class="def-name">arduinosensor.SI7021</strong><a class="copiable-link" href='#index-arduinosensor_002eSI7021'> ¶</a></span></dt> <dd><p>SI7021 temperature and humidity sensor - </p></dd></dl> +</p></dd></dl> -<span id="Methods-11"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-SI7021_0028arObj_0029"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>SI7021(<var>arObj</var>)</strong><a href='#index-SI7021_0028arObj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-SI7021_0028arObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>SI7021(<var>arObj</var>,</strong> <em><var>propertyname, propertyvalue</var> ....)</em><a href='#index-SI7021_0028arObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-11">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-SI7021_0028arObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">SI7021(<var class="var">arObj</var>)</strong><a class="copiable-link" href='#index-SI7021_0028arObj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-SI7021_0028arObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">SI7021(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-SI7021_0028arObj_002c'> ¶</a></span></dt> <dd><p>Constructor to create SI7021 sensor - </p><span id="Inputs-142"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-142">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>propertyname, propertyvalue</var> - optional property name, value pairs. +<p><var class="var">propertyname, propertyvalue</var> - optional property name, value pairs. Current known properties are: Current properties are: - </p><dl compact="compact"> -<dt><span>i2caddress</span></dt> +</p><dl class="table"> +<dt>i2caddress</dt> <dd><p>I2C address of the SI7021 (default 0x40) - </p></dd> +</p></dd> </dl> -<span id="Outputs-101"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created SI7020 object +<h4 class="subsubheading" id="Outputs-101">Outputs</h4> +<p><var class="var">obj</var> - created SI7020 object </p> -<span id="Example-26"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-26">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() sensor = arduinosensor.SI7021(a) </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-temperature_0028dsObj_0029"><span class="category">: </span><span><em><var>C</var> =</em> <strong>temperature(<var>dsObj</var>)</strong><a href='#index-temperature_0028dsObj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-temperature_0028dsObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">C</var> =</code> <strong class="def-name">temperature(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-temperature_0028dsObj_0029'> ¶</a></span></dt> <dd><p>Read the temperature </p> -<span id="Inputs-143"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the si7021 object +<h4 class="subsubheading" id="Inputs-143">Inputs</h4> +<p><var class="var">dsObj</var> - the si7021 object </p> -<span id="Outputs-102"></span><h4 class="subsubheading">Outputs</h4> -<p><var>C</var> - read temperature in deg C. +<h4 class="subsubheading" id="Outputs-102">Outputs</h4> +<p><var class="var">C</var> - read temperature in deg C. </p> -<span id="Example-27"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-27">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() s = arduinosensor.SI7021(a) # get temp temp = s.temperature </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> arduinosensor.SI7021. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduinosensor.SI7021. +</p></dd></dl> -<dl class="def"> -<dt id="index-humidity_0028dsObj_0029"><span class="category">: </span><span><em><var>relH</var> =</em> <strong>humidity(<var>dsObj</var>)</strong><a href='#index-humidity_0028dsObj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-humidity_0028dsObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">relH</var> =</code> <strong class="def-name">humidity(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-humidity_0028dsObj_0029'> ¶</a></span></dt> <dd><p>Read the relative humidity </p> -<span id="Inputs-144"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the si7021 object +<h4 class="subsubheading" id="Inputs-144">Inputs</h4> +<p><var class="var">dsObj</var> - the si7021 object </p> -<span id="Outputs-103"></span><h4 class="subsubheading">Outputs</h4> -<p><var>relH</var> - relative humidity as a percentage (0 - 100.0) - </p></dd></dl> +<h4 class="subsubheading" id="Outputs-103">Outputs</h4> +<p><var class="var">relH</var> - relative humidity as a percentage (0 - 100.0) +</p></dd></dl> -<dl class="def"> -<dt id="index-info_0028dsObj_0029"><span class="category">: </span><span><em><var>relH</var> =</em> <strong>info(<var>dsObj</var>)</strong><a href='#index-info_0028dsObj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-info_0028dsObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">relH</var> =</code> <strong class="def-name">info(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-info_0028dsObj_0029'> ¶</a></span></dt> <dd><p>Read the sensor info </p> -<span id="Inputs-145"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the si7021 object +<h4 class="subsubheading" id="Inputs-145">Inputs</h4> +<p><var class="var">dsObj</var> - the si7021 object </p> -<span id="Outputs-104"></span><h4 class="subsubheading">Outputs</h4> -<p><var>inf</var> - structure containing the sensor information. +<h4 class="subsubheading" id="Outputs-104">Outputs</h4> +<p><var class="var">inf</var> - structure containing the sensor information. </p> <p>Structure fields are: - </p><dl compact="compact"> -<dt><span>version</span></dt> +</p><dl class="table"> +<dt>version</dt> <dd><p>Chip firmware version - </p></dd> -<dt><span>id</span></dt> +</p></dd> +<dt>id</dt> <dd><p>sensor id1,id2 value - </p></dd> -<dt><span>type</span></dt> +</p></dd> +<dt>type</dt> <dd><p>String for detected chip type - </p></dd> +</p></dd> </dl> </dd></dl> <hr> </div> </div> -<div class="section" id="Arduino-I_002fO-package"> -<div class="header"> +<div class="section-level-extent" id="Arduino-I_002fO-package"> +<div class="nav-panel"> <p> -Next: <a href="#Matlab-Compatability-Classes" accesskey="n" rel="next">Matlab Compatability Classes</a>, Previous: <a href="#Arduino-Sensors" accesskey="p" rel="prev">Arduino Sensors</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#Matlab-Compatibility-Classes" accesskey="n" rel="next">Matlab Compatibility Classes</a>, Previous: <a href="#Arduino-Sensors" accesskey="p" rel="prev">Arduino Sensors</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Arduino-I_002fO-package-1"></span><h3 class="section">9.13 Arduino I/O package</h3> -<span id="index-Arduino-I_002fO-package"></span> -<ul class="section-toc"> +<h3 class="section" id="Arduino-I_002fO-package-1">9.13 Arduino I/O package</h3> +<a class="index-entry-id" id="index-Arduino-I_002fO-package"></a> +<ul class="mini-toc"> <li><a href="#arduinoio_002eAddonBase" accesskey="1">arduinoio.AddonBase</a></li> <li><a href="#arduinoio_002eFilePath" accesskey="2">arduinoio.FilePath</a></li> <li><a href="#arduinoio_002eLibFiles" accesskey="3">arduinoio.LibFiles</a></li> <li><a href="#arduinoio_002eLibraryBase" accesskey="4">arduinoio.LibraryBase</a></li> <li><a href="#arduinoio_002egetBoardConfig" accesskey="5">arduinoio.getBoardConfig</a></li> </ul> -<div class="subsection" id="arduinoio_002eAddonBase"> +<div class="subsection-level-extent" id="arduinoio_002eAddonBase"> <h4 class="subsection">9.13.1 arduinoio.AddonBase</h4> -<span id="index-AddonBase"></span> -<dl class="def"> -<dt id="index-arduinoio_002eAddonBase"><span class="category">: </span><span><em></em> <strong>arduinoio.AddonBase</strong><a href='#index-arduinoio_002eAddonBase' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-AddonBase"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinoio_002eAddonBase"><span class="category-def">: </span><span><strong class="def-name">arduinoio.AddonBase</strong><a class="copiable-link" href='#index-arduinoio_002eAddonBase'> ¶</a></span></dt> <dd><p>Base class used for arduino library sensors </p> -<p><strong>See also:</strong> arduinoio.LibraryBase. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduinoio.LibraryBase. +</p></dd></dl> -<span id="Properties-17"></span><h4 class="subheading">Properties</h4> +<h4 class="subheading" id="Properties-17">Properties</h4> <p>Base properties are expected to be inherited and overwritten in inherited classes. and are constant in order to query through the metaobject mechanism. </p> -<p><var>Parent</var> - parent librarybase object +<p><var class="var">Parent</var> - parent librarybase object </p> -<span id="Methods-12"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-AddonBase-1"><span class="category">: </span><span><em><var>ab</var> =</em> <strong>AddonBase</strong> <em>()</em><a href='#index-AddonBase-1' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-12">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-AddonBase-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">ab</var> =</code> <strong class="def-name">AddonBase</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-AddonBase-1'> ¶</a></span></dt> <dd><p>Constructor of base class </p> -<span id="Outputs-105"></span><h4 class="subsubheading">Outputs</h4> -<p>The return value <var>ab</var> is an object of the arduinio.AddonBase class. +<h4 class="subsubheading" id="Outputs-105">Outputs</h4> +<p>The return value <var class="var">ab</var> is an object of the arduinio.AddonBase class. </p> -<p><strong>See also:</strong> arduino, addon. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, addon. +</p></dd></dl> -<dl class="def"> -<dt id="index-display-22"><span class="category">: </span><span><em></em> <strong>display</strong> <em>()</em><a href='#index-display-22' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-22"><span class="category-def">: </span><span><strong class="def-name">display</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-display-22'> ¶</a></span></dt> <dd><p>Display the addon in a verbose way. - </p></dd></dl> +</p></dd></dl> </div> -<div class="subsection" id="arduinoio_002eFilePath"> +<div class="subsection-level-extent" id="arduinoio_002eFilePath"> <h4 class="subsection">9.13.2 arduinoio.FilePath</h4> -<span id="index-FilePath"></span> -<dl class="def"> -<dt id="index-arduinoio_002eFilePath"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>arduinoio.FilePath</strong> <em>(<var>fullpathname</var>)</em><a href='#index-arduinoio_002eFilePath' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-FilePath"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinoio_002eFilePath"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">arduinoio.FilePath</strong> <code class="def-code-arguments">(<var class="var">fullpathname</var>)</code><a class="copiable-link" href='#index-arduinoio_002eFilePath'> ¶</a></span></dt> <dd><p>Get the directory component of a pathname. </p> -<span id="Inputs-146"></span><h4 class="subsubheading">Inputs</h4> -<p><var>fullpathname</var> filepath to get directory component of. +<h4 class="subsubheading" id="Inputs-146">Inputs</h4> +<p><var class="var">fullpathname</var> filepath to get directory component of. </p> -<span id="Outputs-106"></span><h4 class="subsubheading">Outputs</h4> -<p><var>retval</var> the directory part of the filename. - </p></dd></dl> +<h4 class="subsubheading" id="Outputs-106">Outputs</h4> +<p><var class="var">retval</var> the directory part of the filename. +</p></dd></dl> </div> -<div class="subsection" id="arduinoio_002eLibFiles"> +<div class="subsection-level-extent" id="arduinoio_002eLibFiles"> <h4 class="subsection">9.13.3 arduinoio.LibFiles</h4> -<span id="index-LibFiles"></span> -<dl class="def"> -<dt id="index-arduinoio_002eLibFiles"><span class="category">: </span><span><em><var>filelist</var> =</em> <strong>arduinoio.LibFiles</strong> <em>()</em><a href='#index-arduinoio_002eLibFiles' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-LibFiles"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinoio_002eLibFiles"><span class="category-def">: </span><span><code class="def-type"><var class="var">filelist</var> =</code> <strong class="def-name">arduinoio.LibFiles</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-arduinoio_002eLibFiles'> ¶</a></span></dt> <dd><p>Get the list of files used for the building arduino library - </p><span id="Outputs-107"></span><h4 class="subsubheading">Outputs</h4> -<p><var>filelist</var> - string cell array of files for the arduino project - </p></dd></dl> +</p><h4 class="subsubheading" id="Outputs-107">Outputs</h4> +<p><var class="var">filelist</var> - string cell array of files for the arduino project +</p></dd></dl> </div> -<div class="subsection" id="arduinoio_002eLibraryBase"> +<div class="subsection-level-extent" id="arduinoio_002eLibraryBase"> <h4 class="subsection">9.13.4 arduinoio.LibraryBase</h4> -<span id="index-LibraryBase"></span> -<dl class="def"> -<dt id="index-arduinoio_002eLibraryBase"><span class="category">: </span><span><em></em> <strong>arduinoio.LibraryBase</strong><a href='#index-arduinoio_002eLibraryBase' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-LibraryBase"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinoio_002eLibraryBase"><span class="category-def">: </span><span><strong class="def-name">arduinoio.LibraryBase</strong><a class="copiable-link" href='#index-arduinoio_002eLibraryBase'> ¶</a></span></dt> <dd><p>Base class used for arduino library plugins </p> -<p><strong>See also:</strong> arduino, listArduinoLibraries, addon. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, listArduinoLibraries, addon. +</p></dd></dl> -<span id="Properties-18"></span><h4 class="subheading">Properties</h4> +<h4 class="subheading" id="Properties-18">Properties</h4> <p>Base properties are expected to be inherited and overwritten in inherited classes and are constant in order to query through the metaobject mechanism. </p> -<p><var>LibraryName</var> - name of the addon library +<p><var class="var">LibraryName</var> - name of the addon library </p> -<p><var>DependentLibraries</var> - array of dependent library names that +<p><var class="var">DependentLibraries</var> - array of dependent library names that must be included when installing this plugin. </p> -<p><var>CppHeaderFile</var> - name (if any) of header file that will be +<p><var class="var">CppHeaderFile</var> - name (if any) of header file that will be included into the arduino project when adding this library. </p> -<p><var>CppSourceFile</var> - name (if any) of source file that will be +<p><var class="var">CppSourceFile</var> - name (if any) of source file that will be included into the arduino project when adding this library. </p> -<p><var>CppClassName</var> - name of the cpp class for the addon library. +<p><var class="var">CppClassName</var> - name of the cpp class for the addon library. project when adding this library. </p> -<p><var>Pins</var> - pins allocated to the addon +<p><var class="var">Pins</var> - pins allocated to the addon </p> -<p><var>Parent</var> - parent arduino object. +<p><var class="var">Parent</var> - parent arduino object. </p> -<span id="Methods-13"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-LibraryBase-2"><span class="category">: </span><span><em><var>lb</var> =</em> <strong>LibraryBase</strong> <em>()</em><a href='#index-LibraryBase-2' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-13">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-LibraryBase-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">lb</var> =</code> <strong class="def-name">LibraryBase</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-LibraryBase-2'> ¶</a></span></dt> <dd><p>Constructor of base class </p> <p>The constructor is usually not called but called indirectly from the addon function. </p> -<span id="Outputs-108"></span><h4 class="subsubheading">Outputs</h4> -<p>The return value <var>lb</var> is an object of the arduinio.LibraryBase class. +<h4 class="subsubheading" id="Outputs-108">Outputs</h4> +<p>The return value <var class="var">lb</var> is an object of the arduinio.LibraryBase class. </p> -<p><strong>See also:</strong> arduino, listArduinoLibraries, addon. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, listArduinoLibraries, addon. +</p></dd></dl> -<dl class="def"> -<dt id="index-display-23"><span class="category">: </span><span><em></em> <strong>display</strong> <em>()</em><a href='#index-display-23' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-23"><span class="category-def">: </span><span><strong class="def-name">display</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-display-23'> ¶</a></span></dt> <dd><p>Display the addon in a verbose way. - </p></dd></dl> +</p></dd></dl> </div> -<div class="subsection" id="arduinoio_002egetBoardConfig"> +<div class="subsection-level-extent" id="arduinoio_002egetBoardConfig"> <h4 class="subsection">9.13.5 arduinoio.getBoardConfig</h4> -<span id="index-getBoardConfig"></span> -<dl class="def"> -<dt id="index-arduinoio_002egetBoardConfig"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>arduinoio.getBoardConfig</strong> <em>(<var>boardname</var>)</em><a href='#index-arduinoio_002egetBoardConfig' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-getBoardConfig"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduinoio_002egetBoardConfig"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">arduinoio.getBoardConfig</strong> <code class="def-code-arguments">(<var class="var">boardname</var>)</code><a class="copiable-link" href='#index-arduinoio_002egetBoardConfig'> ¶</a></span></dt> <dd><p>Return the configuration for a known arduino board type </p> <p>Function is used to get the expected pin/board configuration for a named board type which is used to verify and identify the functionality of the board. </p> -<span id="Inputs-147"></span><h4 class="subsubheading">Inputs</h4> -<p><var>boardname</var> - name of board to get configuration of ie: "uno" +<h4 class="subsubheading" id="Inputs-147">Inputs</h4> +<p><var class="var">boardname</var> - name of board to get configuration of ie: "uno" </p> -<span id="Outputs-109"></span><h4 class="subsubheading">Outputs</h4> -<p><var>retval</var> configuration struct. - </p></dd></dl> +<h4 class="subsubheading" id="Outputs-109">Outputs</h4> +<p><var class="var">retval</var> configuration struct. +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Matlab-Compatability-Classes"> -<div class="header"> +<div class="section-level-extent" id="Matlab-Compatibility-Classes"> +<div class="nav-panel"> <p> Next: <a href="#Sensors" accesskey="n" rel="next">Sensors</a>, Previous: <a href="#Arduino-I_002fO-package" accesskey="p" rel="prev">Arduino I/O package</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Matlab-Compatability-Classes-1"></span><h3 class="section">9.14 Matlab Compatability Classes</h3> -<span id="index-Matlab-Compatability-Classes"></span> -<ul class="section-toc"> +<h3 class="section" id="Matlab-Compatibility-Classes-1">9.14 Matlab Compatibility Classes</h3> +<a class="index-entry-id" id="index-Matlab-Compatibility-Classes"></a> +<ul class="mini-toc"> <li><a href="#matlabshared_002eaddon_002eLibraryBase" accesskey="1">matlabshared.addon.LibraryBase</a></li> </ul> -<div class="subsection" id="matlabshared_002eaddon_002eLibraryBase"> +<div class="subsection-level-extent" id="matlabshared_002eaddon_002eLibraryBase"> <h4 class="subsection">9.14.1 matlabshared.addon.LibraryBase</h4> -<span id="index-LibraryBase-1"></span> -<dl class="def"> -<dt id="index-matlabshared_002eaddon_002eLibraryBase"><span class="category">: </span><span><em></em> <strong>matlabshared.addon.LibraryBase</strong><a href='#index-matlabshared_002eaddon_002eLibraryBase' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-LibraryBase-1"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-matlabshared_002eaddon_002eLibraryBase"><span class="category-def">: </span><span><strong class="def-name">matlabshared.addon.LibraryBase</strong><a class="copiable-link" href='#index-matlabshared_002eaddon_002eLibraryBase'> ¶</a></span></dt> <dd><p>Compatability class used for arduino library plugins using matlabshared.addons.LibraryBase </p> -<p><strong>See also:</strong> arduinoio.LibraryBase, arduino, listArduinoLibraries, addon. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduinoio.LibraryBase, arduino, listArduinoLibraries, addon. +</p></dd></dl> -<span id="Properties-19"></span><h4 class="subheading">Properties</h4> +<h4 class="subheading" id="Properties-19">Properties</h4> <p>Base properties are expected to be inherited and overwritten in inherited classes and are constant in order to query through the metaobject mechanism. </p> -<p><var>LibraryName</var> - name of the addon library +<p><var class="var">LibraryName</var> - name of the addon library </p> -<p><var>DependentLibraries</var> - array of dependent library names that +<p><var class="var">DependentLibraries</var> - array of dependent library names that must be included when installing this plugin. </p> -<p><var>CppHeaderFile</var> - name (if any) of header file that will be +<p><var class="var">CppHeaderFile</var> - name (if any) of header file that will be included into the arduino project when adding this library. </p> -<p><var>CppSourceFile</var> - name (if any) of source file that will be +<p><var class="var">CppSourceFile</var> - name (if any) of source file that will be included into the arduino project when adding this library. </p> -<p><var>CppClassName</var> - name of the cpp class for the addon library. +<p><var class="var">CppClassName</var> - name of the cpp class for the addon library. project when adding this library. </p> -<p><var>Pins</var> - pins allocated to the addon +<p><var class="var">Pins</var> - pins allocated to the addon </p> -<p><var>Parent</var> - parent arduino object. +<p><var class="var">Parent</var> - parent arduino object. </p> -<span id="Methods-14"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-LibraryBase-3"><span class="category">: </span><span><em><var>lb</var> =</em> <strong>LibraryBase</strong> <em>()</em><a href='#index-LibraryBase-3' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-14">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-LibraryBase-3"><span class="category-def">: </span><span><code class="def-type"><var class="var">lb</var> =</code> <strong class="def-name">LibraryBase</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-LibraryBase-3'> ¶</a></span></dt> <dd><p>Constructor of base class </p> <p>The constructor is usually not called but called indirectly from the addon function. </p> -<span id="Outputs-110"></span><h4 class="subsubheading">Outputs</h4> -<p>The return value <var>lb</var> is an object of the +<h4 class="subsubheading" id="Outputs-110">Outputs</h4> +<p>The return value <var class="var">lb</var> is an object of the matlabshare.addons.LibraryBase class. </p> -<p><strong>See also:</strong> arduino, listArduinoLibraries, addon. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, listArduinoLibraries, addon. +</p></dd></dl> -<dl class="def"> -<dt id="index-display-24"><span class="category">: </span><span><em></em> <strong>display</strong> <em>()</em><a href='#index-display-24' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-display-24"><span class="category-def">: </span><span><strong class="def-name">display</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-display-24'> ¶</a></span></dt> <dd><p>Display the addon in a verbose way. - </p></dd></dl> +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Sensors"> -<div class="header"> +<div class="section-level-extent" id="Sensors"> +<div class="nav-panel"> <p> -Next: <a href="#Test-Functions" accesskey="n" rel="next">Test Functions</a>, Previous: <a href="#Matlab-Compatability-Classes" accesskey="p" rel="prev">Matlab Compatability Classes</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#Test-Functions" accesskey="n" rel="next">Test Functions</a>, Previous: <a href="#Matlab-Compatibility-Classes" accesskey="p" rel="prev">Matlab Compatibility Classes</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Sensors-1"></span><h3 class="section">9.15 Sensors</h3> -<span id="index-Sensors"></span> -<ul class="section-toc"> +<h3 class="section" id="Sensors-1">9.15 Sensors</h3> +<a class="index-entry-id" id="index-Sensors"></a> +<ul class="mini-toc"> <li><a href="#bme280" accesskey="1">bme280</a></li> <li><a href="#bno055" accesskey="2">bno055</a></li> <li><a href="#lis3dh" accesskey="3">lis3dh</a></li> @@ -6002,1182 +6002,1182 @@ Next: <a href="#Test-Functions" accesskey="n" rel="next">Test Functions</a>, Pre <li><a href="#mpu6050" accesskey="6">mpu6050</a></li> <li><a href="#si7021" accesskey="7">si7021</a></li> </ul> -<div class="subsection" id="bme280"> +<div class="subsection-level-extent" id="bme280"> <h4 class="subsection">9.15.1 bme280</h4> -<span id="index-bme280"></span> -<dl class="def"> -<dt id="index-bme280-1"><span class="category">: </span><span><em></em> <strong>bme280</strong><a href='#index-bme280-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-bme280"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-bme280-1"><span class="category-def">: </span><span><strong class="def-name">bme280</strong><a class="copiable-link" href='#index-bme280-1'> ¶</a></span></dt> <dd><p>BME280 pressure, temperature and humidity sensor - </p></dd></dl> +</p></dd></dl> -<span id="Methods-15"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-bme280_0028arObj_0029"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>bme280(<var>arObj</var>)</strong><a href='#index-bme280_0028arObj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-bme280_0028arObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>bme280(<var>arObj</var>,</strong> <em><var>propertyname, propertyvalue</var> ....)</em><a href='#index-bme280_0028arObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-15">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-bme280_0028arObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">bme280(<var class="var">arObj</var>)</strong><a class="copiable-link" href='#index-bme280_0028arObj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-bme280_0028arObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">bme280(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-bme280_0028arObj_002c'> ¶</a></span></dt> <dd><p>Constructor to create BME280 sensor - </p><span id="Inputs-148"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-148">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>propertyname, propertyvalue</var> - optional property name, value pairs. +<p><var class="var">propertyname, propertyvalue</var> - optional property name, value pairs. Current known properties are: Current properties are: - </p><dl compact="compact"> -<dt><span>I2CAddress</span></dt> +</p><dl class="table"> +<dt>I2CAddress</dt> <dd><p>I2C address of the sensor (default 0x40) - </p></dd> -<dt><span>Bus</span></dt> +</p></dd> +<dt>Bus</dt> <dd><p>I2C bus - 0 or 1 (default 0) - </p></dd> +</p></dd> </dl> -<span id="Outputs-111"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created object +<h4 class="subsubheading" id="Outputs-111">Outputs</h4> +<p><var class="var">obj</var> - created object </p> -<span id="Example-28"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-28">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() sensor = bme280(a) </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-readTemperature_0028obj_0029"><span class="category">: </span><span><em>[<var>C</var>, <var>timestamp</var>] =</em> <strong>readTemperature(<var>obj</var>)</strong><a href='#index-readTemperature_0028obj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readTemperature_0028obj_0029"><span class="category-def">: </span><span><code class="def-type">[<var class="var">C</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readTemperature(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readTemperature_0028obj_0029'> ¶</a></span></dt> <dd><p>Read the temperature </p> -<span id="Inputs-149"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-149">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-112"></span><h4 class="subsubheading">Outputs</h4> -<p><var>C</var> - read temperature in deg C. +<h4 class="subsubheading" id="Outputs-112">Outputs</h4> +<p><var class="var">C</var> - read temperature in deg C. </p> -<p><var>timestamp</var> - timestamp when read +<p><var class="var">timestamp</var> - timestamp when read </p> -<span id="Example-29"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-29">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() s = bme280(a) # get temp temp = s.readTemperature </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> bme280. - </p></dd></dl> +<p><strong class="strong">See also:</strong> bme280. +</p></dd></dl> -<dl class="def"> -<dt id="index-readHumidity_0028obj_0029"><span class="category">: </span><span><em>[<var>relH</var>, <var>timestamp</var>] =</em> <strong>readHumidity(<var>obj</var>)</strong><a href='#index-readHumidity_0028obj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readHumidity_0028obj_0029"><span class="category-def">: </span><span><code class="def-type">[<var class="var">relH</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readHumidity(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readHumidity_0028obj_0029'> ¶</a></span></dt> <dd><p>Read the relative humidity </p> -<span id="Inputs-150"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-150">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-113"></span><h4 class="subsubheading">Outputs</h4> -<p><var>relH</var> - relative humidity as a percentage (0 - 100.0) +<h4 class="subsubheading" id="Outputs-113">Outputs</h4> +<p><var class="var">relH</var> - relative humidity as a percentage (0 - 100.0) </p> -<p><var>timestamp</var> - timestamp when read - </p></dd></dl> +<p><var class="var">timestamp</var> - timestamp when read +</p></dd></dl> -<dl class="def"> -<dt id="index-readPressure_0028obj_0029"><span class="category">: </span><span><em>[<var>P</var>, <var>timestamp</var>] =</em> <strong>readPressure(<var>obj</var>)</strong><a href='#index-readPressure_0028obj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readPressure_0028obj_0029"><span class="category-def">: </span><span><code class="def-type">[<var class="var">P</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readPressure(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readPressure_0028obj_0029'> ¶</a></span></dt> <dd><p>Read the pressure </p> -<span id="Inputs-151"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-151">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-114"></span><h4 class="subsubheading">Outputs</h4> -<p><var>P</var> - pressure reading from sensor. +<h4 class="subsubheading" id="Outputs-114">Outputs</h4> +<p><var class="var">P</var> - pressure reading from sensor. </p> -<p><var>timestamp</var> - timestamp when read - </p></dd></dl> +<p><var class="var">timestamp</var> - timestamp when read +</p></dd></dl> -<dl class="def"> -<dt id="index-read_0028obj_0029"><span class="category">: </span><span><em>[<var>readings</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read_0028obj_0029-1"><span class="category">: </span><span><em>[<var>P</var>, <var>H</var>, <var>C</var>, <var>timestamp</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read_0028obj_0029"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readings</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read_0028obj_0029-1"><span class="category-def">: </span><span><code class="def-type">[<var class="var">P</var>, <var class="var">H</var>, <var class="var">C</var>, <var class="var">timestamp</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-1'> ¶</a></span></dt> <dd><p>Read the sensor data </p> -<span id="Inputs-152"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-152">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-115"></span><h4 class="subsubheading">Outputs</h4> -<p><var>P</var> - pressure reading from sensor. +<h4 class="subsubheading" id="Outputs-115">Outputs</h4> +<p><var class="var">P</var> - pressure reading from sensor. </p> -<p><var>H</var> - humidity reading from sensor. +<p><var class="var">H</var> - humidity reading from sensor. </p> -<p><var>C</var> - temperature reading from sensor. +<p><var class="var">C</var> - temperature reading from sensor. </p> -<p><var>timestamp</var> - timestamp when read +<p><var class="var">timestamp</var> - timestamp when read </p> -<p><var>overrun</var> - overrun flag. +<p><var class="var">overrun</var> - overrun flag. </p> -<p><var>readings</var> - table structure with fields for Timestamp, Pressure, Temperature and Humidity. - </p></dd></dl> +<p><var class="var">readings</var> - table structure with fields for Timestamp, Pressure, Temperature and Humidity. +</p></dd></dl> -<dl class="def"> -<dt id="index-info_0028obj_0029"><span class="category">: </span><span><em><var>inf</var> =</em> <strong>info(<var>obj</var>)</strong><a href='#index-info_0028obj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-info_0028obj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">inf</var> =</code> <strong class="def-name">info(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-info_0028obj_0029'> ¶</a></span></dt> <dd><p>Read the sensor info </p> -<span id="Inputs-153"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-153">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-116"></span><h4 class="subsubheading">Outputs</h4> -<p><var>inf</var> - structure containing the sensor information. +<h4 class="subsubheading" id="Outputs-116">Outputs</h4> +<p><var class="var">inf</var> - structure containing the sensor information. </p> <p>Structure fields are: - </p><dl compact="compact"> -<dt><span>Version</span></dt> +</p><dl class="table"> +<dt>Version</dt> <dd><p>Chip firmware version - </p></dd> -<dt><span>SensorId</span></dt> +</p></dd> +<dt>SensorId</dt> <dd><p>sensor id value - </p></dd> -<dt><span>Type</span></dt> +</p></dd> +<dt>Type</dt> <dd><p>sensor type ’bme280’ - </p></dd> -<dt><span>Status</span></dt> +</p></dd> +<dt>Status</dt> <dd><p>Status value read from sensor - </p></dd> +</p></dd> </dl> </dd></dl> -<dl class="def"> -<dt id="index-flush_0028obj_0029"><span class="category">: </span><span><em></em> <strong>flush(<var>obj</var>)</strong><a href='#index-flush_0028obj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-flush_0028obj_0029"><span class="category-def">: </span><span><strong class="def-name">flush(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-flush_0028obj_0029'> ¶</a></span></dt> <dd><p>Flush sensor data </p> -<span id="Inputs-154"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-154">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-117"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-117">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> -<dl class="def"> -<dt id="index-release_0028obj_0029"><span class="category">: </span><span><em></em> <strong>release(<var>obj</var>)</strong><a href='#index-release_0028obj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-release_0028obj_0029"><span class="category-def">: </span><span><strong class="def-name">release(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-release_0028obj_0029'> ¶</a></span></dt> <dd><p>Release the resources of the sensor </p> -<span id="Inputs-155"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-155">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-118"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-118">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> </div> -<div class="subsection" id="bno055"> +<div class="subsection-level-extent" id="bno055"> <h4 class="subsection">9.15.2 bno055</h4> -<span id="index-bno055"></span> -<dl class="def"> -<dt id="index-bno055-1"><span class="category">: </span><span><em></em> <strong>bno055</strong><a href='#index-bno055-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-bno055"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-bno055-1"><span class="category-def">: </span><span><strong class="def-name">bno055</strong><a class="copiable-link" href='#index-bno055-1'> ¶</a></span></dt> <dd><p>BNO055 9 axis orientation sensor - </p></dd></dl> +</p></dd></dl> -<span id="Methods-16"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-bno055_0028arObj_0029"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>bno055(<var>arObj</var>)</strong><a href='#index-bno055_0028arObj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-bno055_0028arObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>bno055(<var>arObj</var>,</strong> <em><var>propertyname, propertyvalue</var> ....)</em><a href='#index-bno055_0028arObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-16">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-bno055_0028arObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">bno055(<var class="var">arObj</var>)</strong><a class="copiable-link" href='#index-bno055_0028arObj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-bno055_0028arObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">bno055(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-bno055_0028arObj_002c'> ¶</a></span></dt> <dd><p>Constructor to create BME280 sensor - </p><span id="Inputs-156"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-156">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>propertyname, propertyvalue</var> - optional property name, value pairs. +<p><var class="var">propertyname, propertyvalue</var> - optional property name, value pairs. Current known properties are: Current properties are: - </p><dl compact="compact"> -<dt><span>I2CAddress</span></dt> +</p><dl class="table"> +<dt>I2CAddress</dt> <dd><p>I2C address of the sensor (default 0x40) - </p></dd> -<dt><span>Bus</span></dt> +</p></dd> +<dt>Bus</dt> <dd><p>I2C bus - 0 or 1 (default 0) - </p></dd> -<dt><span>OperatingMode</span></dt> +</p></dd> +<dt>OperatingMode</dt> <dd><p>Operating mode ’ndof’ or ’amg’ - </p></dd> +</p></dd> </dl> -<span id="Outputs-119"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created object +<h4 class="subsubheading" id="Outputs-119">Outputs</h4> +<p><var class="var">obj</var> - created object </p> -<span id="Example-30"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-30">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() sensor = bno055(a) </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-readTemperature_0028obj_0029-1"><span class="category">: </span><span><em>[<var>C</var>, <var>timestamp</var>] =</em> <strong>readTemperature(<var>obj</var>)</strong><a href='#index-readTemperature_0028obj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readTemperature_0028obj_0029-1"><span class="category-def">: </span><span><code class="def-type">[<var class="var">C</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readTemperature(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readTemperature_0028obj_0029-1'> ¶</a></span></dt> <dd><p>Read the temperature </p> -<span id="Inputs-157"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-157">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-120"></span><h4 class="subsubheading">Outputs</h4> -<p><var>C</var> - read temperature in deg C. +<h4 class="subsubheading" id="Outputs-120">Outputs</h4> +<p><var class="var">C</var> - read temperature in deg C. </p> -<p><var>timestamp</var> - timestamp when read +<p><var class="var">timestamp</var> - timestamp when read </p> -<span id="Example-31"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-31">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() s = bno055(a) # get temp temp = s.readTemperature </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> bno055. - </p></dd></dl> +<p><strong class="strong">See also:</strong> bno055. +</p></dd></dl> -<dl class="def"> -<dt id="index-readAcceleration_0028obj_0029"><span class="category">: </span><span><em>[<var>readVal</var>, <var>timestamp</var>] =</em> <strong>readAcceleration(<var>obj</var>)</strong><a href='#index-readAcceleration_0028obj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readAcceleration_0028obj_0029"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readVal</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readAcceleration(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readAcceleration_0028obj_0029'> ¶</a></span></dt> <dd><p>Read the acceleration rate </p> -<span id="Inputs-158"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-158">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-121"></span><h4 class="subsubheading">Outputs</h4> -<p><var>readVal</var> - the 3 acceleration values +<h4 class="subsubheading" id="Outputs-121">Outputs</h4> +<p><var class="var">readVal</var> - the 3 acceleration values </p> -<p><var>timestamp</var> - timestamp when read - </p></dd></dl> +<p><var class="var">timestamp</var> - timestamp when read +</p></dd></dl> -<dl class="def"> -<dt id="index-readAngularVelocity_0028obj_0029"><span class="category">: </span><span><em>[<var>readVal</var>, <var>timestamp</var>] =</em> <strong>readAngularVelocity(<var>obj</var>)</strong><a href='#index-readAngularVelocity_0028obj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readAngularVelocity_0028obj_0029"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readVal</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readAngularVelocity(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readAngularVelocity_0028obj_0029'> ¶</a></span></dt> <dd><p>Read the angular velocity </p> -<span id="Inputs-159"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-159">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-122"></span><h4 class="subsubheading">Outputs</h4> -<p><var>readVal</var> - the 3 angular velocity values +<h4 class="subsubheading" id="Outputs-122">Outputs</h4> +<p><var class="var">readVal</var> - the 3 angular velocity values </p> -<p><var>timestamp</var> - timestamp when read - </p></dd></dl> +<p><var class="var">timestamp</var> - timestamp when read +</p></dd></dl> -<dl class="def"> -<dt id="index-readMagneticField_0028obj_0029"><span class="category">: </span><span><em>[<var>readVal</var>, <var>timestamp</var>] =</em> <strong>readMagneticField(<var>obj</var>)</strong><a href='#index-readMagneticField_0028obj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readMagneticField_0028obj_0029"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readVal</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readMagneticField(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readMagneticField_0028obj_0029'> ¶</a></span></dt> <dd><p>Read the magnetic field components </p> -<span id="Inputs-160"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-160">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-123"></span><h4 class="subsubheading">Outputs</h4> -<p><var>readVal</var> - the 3 magnetic field values +<h4 class="subsubheading" id="Outputs-123">Outputs</h4> +<p><var class="var">readVal</var> - the 3 magnetic field values </p> -<p><var>timestamp</var> - timestamp when read - </p></dd></dl> +<p><var class="var">timestamp</var> - timestamp when read +</p></dd></dl> -<dl class="def"> -<dt id="index-readOrientation_0028obj_0029"><span class="category">: </span><span><em>[<var>readVal</var>, <var>timestamp</var>] =</em> <strong>readOrientation(<var>obj</var>)</strong><a href='#index-readOrientation_0028obj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readOrientation_0028obj_0029"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readVal</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readOrientation(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readOrientation_0028obj_0029'> ¶</a></span></dt> <dd><p>Read the oriientation components </p> -<span id="Inputs-161"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-161">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-124"></span><h4 class="subsubheading">Outputs</h4> -<p><var>readVal</var> - the 3 orientation values +<h4 class="subsubheading" id="Outputs-124">Outputs</h4> +<p><var class="var">readVal</var> - the 3 orientation values </p> -<p><var>timestamp</var> - timestamp when read - </p></dd></dl> +<p><var class="var">timestamp</var> - timestamp when read +</p></dd></dl> -<dl class="def"> -<dt id="index-read_0028obj_0029-2"><span class="category">: </span><span><em>[<var>readings</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-2' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read_0028obj_0029-3"><span class="category">: </span><span><em>[<var>accel</var>, <var>gyro</var>, <var>mag</var>, <var>timestamp</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-3' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read_0028obj_0029-4"><span class="category">: </span><span><em>[<var>accel</var>, <var>gyro</var>, <var>mag</var>, <var>orientation</var>, <var>timestamp</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-4' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read_0028obj_0029-2"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readings</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-2'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read_0028obj_0029-3"><span class="category-def">: </span><span><code class="def-type">[<var class="var">accel</var>, <var class="var">gyro</var>, <var class="var">mag</var>, <var class="var">timestamp</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-3'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read_0028obj_0029-4"><span class="category-def">: </span><span><code class="def-type">[<var class="var">accel</var>, <var class="var">gyro</var>, <var class="var">mag</var>, <var class="var">orientation</var>, <var class="var">timestamp</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-4'> ¶</a></span></dt> <dd><p>Read the sensor data </p> -<span id="Inputs-162"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-162">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-125"></span><h4 class="subsubheading">Outputs</h4> -<p><var>accel</var> - acceleration reading from sensor. +<h4 class="subsubheading" id="Outputs-125">Outputs</h4> +<p><var class="var">accel</var> - acceleration reading from sensor. </p> -<p><var>gyro</var> - angular acceleration reading from sensor. +<p><var class="var">gyro</var> - angular acceleration reading from sensor. </p> -<p><var>mag</var> - magnetic field reading from sensor. +<p><var class="var">mag</var> - magnetic field reading from sensor. </p> -<p><var>orientation</var> - orientation reading from sensor. +<p><var class="var">orientation</var> - orientation reading from sensor. </p> -<p><var>timestamp</var> - timestamp when read +<p><var class="var">timestamp</var> - timestamp when read </p> -<p><var>overrun</var> - overrun flag. +<p><var class="var">overrun</var> - overrun flag. </p> -<p><var>readings</var> - table structure with fields for Timestamp, Acceleration, AngularVelocity, MagneticField, Orientation. - </p></dd></dl> +<p><var class="var">readings</var> - table structure with fields for Timestamp, Acceleration, AngularVelocity, MagneticField, Orientation. +</p></dd></dl> -<dl class="def"> -<dt id="index-readCalibrationStatus_0028obj_0029"><span class="category">: </span><span><em><var>inf</var> =</em> <strong>readCalibrationStatus(<var>obj</var>)</strong><a href='#index-readCalibrationStatus_0028obj_0029' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readCalibrationStatus_0028obj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">inf</var> =</code> <strong class="def-name">readCalibrationStatus(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readCalibrationStatus_0028obj_0029'> ¶</a></span></dt> <dd><p>Read the sensor calibration status </p> -<span id="Inputs-163"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-163">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-126"></span><h4 class="subsubheading">Outputs</h4> -<p><var>status</var> - structure containing the calibration information. +<h4 class="subsubheading" id="Outputs-126">Outputs</h4> +<p><var class="var">status</var> - structure containing the calibration information. </p> <p>Structure fields are: - </p><dl compact="compact"> -<dt><span>System</span></dt> +</p><dl class="table"> +<dt>System</dt> <dd><p>System calibrarion - </p></dd> -<dt><span>Accelerometer</span></dt> +</p></dd> +<dt>Accelerometer</dt> <dd><p>Accelerometer calibration status - </p></dd> -<dt><span>Gyroscope</span></dt> +</p></dd> +<dt>Gyroscope</dt> <dd><p>Gyroscope calibration status - </p></dd> -<dt><span>Magnetometer</span></dt> +</p></dd> +<dt>Magnetometer</dt> <dd><p>Magnetometer calibration status - </p></dd> +</p></dd> </dl> <p>Values for each will be either ’uncalibrated’, ’partial’ or ’full’. </p> </dd></dl> -<dl class="def"> -<dt id="index-info_0028obj_0029-1"><span class="category">: </span><span><em><var>inf</var> =</em> <strong>info(<var>obj</var>)</strong><a href='#index-info_0028obj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-info_0028obj_0029-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">inf</var> =</code> <strong class="def-name">info(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-info_0028obj_0029-1'> ¶</a></span></dt> <dd><p>Read the sensor info </p> -<span id="Inputs-164"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-164">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-127"></span><h4 class="subsubheading">Outputs</h4> -<p><var>inf</var> - structure containing the sensor information. +<h4 class="subsubheading" id="Outputs-127">Outputs</h4> +<p><var class="var">inf</var> - structure containing the sensor information. </p> <p>Structure fields are: - </p><dl compact="compact"> -<dt><span>Version</span></dt> +</p><dl class="table"> +<dt>Version</dt> <dd><p>Software firmware version - </p></dd> -<dt><span>SensorId</span></dt> +</p></dd> +<dt>SensorId</dt> <dd><p>sensor id value - </p></dd> -<dt><span>Type</span></dt> +</p></dd> +<dt>Type</dt> <dd><p>sensor type ’bno055’ - </p></dd> +</p></dd> </dl> </dd></dl> -<dl class="def"> -<dt id="index-flush_0028obj_0029-1"><span class="category">: </span><span><em></em> <strong>flush(<var>obj</var>)</strong><a href='#index-flush_0028obj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-flush_0028obj_0029-1"><span class="category-def">: </span><span><strong class="def-name">flush(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-flush_0028obj_0029-1'> ¶</a></span></dt> <dd><p>Flush sensor data </p> -<span id="Inputs-165"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-165">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-128"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-128">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> -<dl class="def"> -<dt id="index-release_0028obj_0029-1"><span class="category">: </span><span><em></em> <strong>release(<var>obj</var>)</strong><a href='#index-release_0028obj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-release_0028obj_0029-1"><span class="category-def">: </span><span><strong class="def-name">release(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-release_0028obj_0029-1'> ¶</a></span></dt> <dd><p>Release the resources of the sensor </p> -<span id="Inputs-166"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-166">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-129"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-129">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> </div> -<div class="subsection" id="lis3dh"> +<div class="subsection-level-extent" id="lis3dh"> <h4 class="subsection">9.15.3 lis3dh</h4> -<span id="index-lis3dh"></span> -<dl class="def"> -<dt id="index-lis3dh-1"><span class="category">: </span><span><em></em> <strong>lis3dh</strong><a href='#index-lis3dh-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-lis3dh"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-lis3dh-1"><span class="category-def">: </span><span><strong class="def-name">lis3dh</strong><a class="copiable-link" href='#index-lis3dh-1'> ¶</a></span></dt> <dd><p>LIS3DH 3 degrees sensor - </p></dd></dl> +</p></dd></dl> -<span id="Methods-17"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-lis3dh_0028arObj_0029"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>lis3dh(<var>arObj</var>)</strong><a href='#index-lis3dh_0028arObj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-lis3dh_0028arObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>lis3dh(<var>arObj</var>,</strong> <em><var>propertyname, propertyvalue</var> ....)</em><a href='#index-lis3dh_0028arObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-17">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-lis3dh_0028arObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">lis3dh(<var class="var">arObj</var>)</strong><a class="copiable-link" href='#index-lis3dh_0028arObj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-lis3dh_0028arObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">lis3dh(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-lis3dh_0028arObj_002c'> ¶</a></span></dt> <dd><p>Constructor to create LIS3DH sensor - </p><span id="Inputs-167"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-167">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>propertyname, propertyvalue</var> - optional property name, value pairs. +<p><var class="var">propertyname, propertyvalue</var> - optional property name, value pairs. Current known properties are: Current properties are: - </p><dl compact="compact"> -<dt><span>I2CAddress</span></dt> +</p><dl class="table"> +<dt>I2CAddress</dt> <dd><p>I2C address of the sensor (default 0x40) - </p></dd> -<dt><span>Bus</span></dt> +</p></dd> +<dt>Bus</dt> <dd><p>I2C bus - 0 or 1 (default 0) - </p></dd> +</p></dd> </dl> -<span id="Outputs-130"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created object +<h4 class="subsubheading" id="Outputs-130">Outputs</h4> +<p><var class="var">obj</var> - created object </p> -<span id="Example-32"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-32">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() sensor = lis3dh(a) </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-readAcceleration_0028obj_0029-1"><span class="category">: </span><span><em>[<var>readVal</var>, <var>timestamp</var>] =</em> <strong>readAcceleration(<var>obj</var>)</strong><a href='#index-readAcceleration_0028obj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readAcceleration_0028obj_0029-1"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readVal</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readAcceleration(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readAcceleration_0028obj_0029-1'> ¶</a></span></dt> <dd><p>Read the acceleration rate </p> -<span id="Inputs-168"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-168">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-131"></span><h4 class="subsubheading">Outputs</h4> -<p><var>readVal</var> - the 3 acceleration values +<h4 class="subsubheading" id="Outputs-131">Outputs</h4> +<p><var class="var">readVal</var> - the 3 acceleration values </p> -<p><var>timestamp</var> - timestamp when read - </p></dd></dl> +<p><var class="var">timestamp</var> - timestamp when read +</p></dd></dl> -<dl class="def"> -<dt id="index-read_0028obj_0029-5"><span class="category">: </span><span><em>[<var>readings</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-5' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read_0028obj_0029-6"><span class="category">: </span><span><em>[<var>accel</var>, <var>timestamp</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-6' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read_0028obj_0029-5"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readings</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-5'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read_0028obj_0029-6"><span class="category-def">: </span><span><code class="def-type">[<var class="var">accel</var>, <var class="var">timestamp</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-6'> ¶</a></span></dt> <dd><p>Read the sensor data </p> -<span id="Inputs-169"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-169">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-132"></span><h4 class="subsubheading">Outputs</h4> -<p><var>accel</var> - acceleration reading from sensor. +<h4 class="subsubheading" id="Outputs-132">Outputs</h4> +<p><var class="var">accel</var> - acceleration reading from sensor. </p> -<p><var>timestamp</var> - timestamp when read +<p><var class="var">timestamp</var> - timestamp when read </p> -<p><var>overrun</var> - overrun flag. +<p><var class="var">overrun</var> - overrun flag. </p> -<p><var>readings</var> - table structure with fields for Timestamp, Acceleration. - </p></dd></dl> +<p><var class="var">readings</var> - table structure with fields for Timestamp, Acceleration. +</p></dd></dl> -<dl class="def"> -<dt id="index-info_0028obj_0029-2"><span class="category">: </span><span><em><var>inf</var> =</em> <strong>info(<var>obj</var>)</strong><a href='#index-info_0028obj_0029-2' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-info_0028obj_0029-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">inf</var> =</code> <strong class="def-name">info(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-info_0028obj_0029-2'> ¶</a></span></dt> <dd><p>Read the sensor info </p> -<span id="Inputs-170"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-170">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-133"></span><h4 class="subsubheading">Outputs</h4> -<p><var>inf</var> - structure containing the sensor information. +<h4 class="subsubheading" id="Outputs-133">Outputs</h4> +<p><var class="var">inf</var> - structure containing the sensor information. </p> <p>Structure fields are: - </p><dl compact="compact"> -<dt><span>SensorId</span></dt> +</p><dl class="table"> +<dt>SensorId</dt> <dd><p>sensor id value - </p></dd> -<dt><span>Type</span></dt> +</p></dd> +<dt>Type</dt> <dd><p>sensor type ’lis3dh’ - </p></dd> -<dt><span>Status</span></dt> +</p></dd> +<dt>Status</dt> <dd><p>sensor status value - </p></dd> +</p></dd> </dl> </dd></dl> -<dl class="def"> -<dt id="index-flush_0028obj_0029-2"><span class="category">: </span><span><em></em> <strong>flush(<var>obj</var>)</strong><a href='#index-flush_0028obj_0029-2' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-flush_0028obj_0029-2"><span class="category-def">: </span><span><strong class="def-name">flush(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-flush_0028obj_0029-2'> ¶</a></span></dt> <dd><p>Flush sensor data </p> -<span id="Inputs-171"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-171">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-134"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-134">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> -<dl class="def"> -<dt id="index-release_0028obj_0029-2"><span class="category">: </span><span><em></em> <strong>release(<var>obj</var>)</strong><a href='#index-release_0028obj_0029-2' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-release_0028obj_0029-2"><span class="category-def">: </span><span><strong class="def-name">release(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-release_0028obj_0029-2'> ¶</a></span></dt> <dd><p>Release the resources of the sensor </p> -<span id="Inputs-172"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-172">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-135"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-135">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> </div> -<div class="subsection" id="lps22hb"> +<div class="subsection-level-extent" id="lps22hb"> <h4 class="subsection">9.15.4 lps22hb</h4> -<span id="index-lps22hb"></span> -<dl class="def"> -<dt id="index-lps22hb-1"><span class="category">: </span><span><em></em> <strong>lps22hb</strong><a href='#index-lps22hb-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-lps22hb"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-lps22hb-1"><span class="category-def">: </span><span><strong class="def-name">lps22hb</strong><a class="copiable-link" href='#index-lps22hb-1'> ¶</a></span></dt> <dd><p>LPS22HB absolute pressure and temperature sensor - </p></dd></dl> +</p></dd></dl> -<span id="Methods-18"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-lps22hb_0028arObj_0029"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>lps22hb(<var>arObj</var>)</strong><a href='#index-lps22hb_0028arObj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-lps22hb_0028arObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>lps22hb(<var>arObj</var>,</strong> <em><var>propertyname, propertyvalue</var> ....)</em><a href='#index-lps22hb_0028arObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-18">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-lps22hb_0028arObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">lps22hb(<var class="var">arObj</var>)</strong><a class="copiable-link" href='#index-lps22hb_0028arObj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-lps22hb_0028arObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">lps22hb(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-lps22hb_0028arObj_002c'> ¶</a></span></dt> <dd><p>Constructor to create LPS22HB sensor - </p><span id="Inputs-173"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-173">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>propertyname, propertyvalue</var> - optional property name, value pairs. +<p><var class="var">propertyname, propertyvalue</var> - optional property name, value pairs. Current known properties are: Current properties are: - </p><dl compact="compact"> -<dt><span>I2CAddress</span></dt> +</p><dl class="table"> +<dt>I2CAddress</dt> <dd><p>I2C address of the sensor (default 0x5C) - </p></dd> -<dt><span>Bus</span></dt> +</p></dd> +<dt>Bus</dt> <dd><p>I2C bus - 0 or 1 (default 0) - </p></dd> +</p></dd> </dl> -<span id="Outputs-136"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created object +<h4 class="subsubheading" id="Outputs-136">Outputs</h4> +<p><var class="var">obj</var> - created object </p> -<span id="Example-33"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-33">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() sensor = lps22hb(a) </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-readTemperature_0028obj_0029-2"><span class="category">: </span><span><em>[<var>C</var>, <var>timestamp</var>] =</em> <strong>readTemperature(<var>obj</var>)</strong><a href='#index-readTemperature_0028obj_0029-2' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readTemperature_0028obj_0029-2"><span class="category-def">: </span><span><code class="def-type">[<var class="var">C</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readTemperature(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readTemperature_0028obj_0029-2'> ¶</a></span></dt> <dd><p>Read the temperature </p> -<span id="Inputs-174"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-174">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-137"></span><h4 class="subsubheading">Outputs</h4> -<p><var>C</var> - read temperature in deg C. +<h4 class="subsubheading" id="Outputs-137">Outputs</h4> +<p><var class="var">C</var> - read temperature in deg C. </p> -<p><var>timestamp</var> - timestamp when read +<p><var class="var">timestamp</var> - timestamp when read </p> -<span id="Example-34"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-34">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() s = lps22hb(a) # get temp temp = s.readTemperature </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> lps22hb. - </p></dd></dl> +<p><strong class="strong">See also:</strong> lps22hb. +</p></dd></dl> -<dl class="def"> -<dt id="index-readPressure_0028obj_0029-1"><span class="category">: </span><span><em>[<var>P</var>, <var>timestamp</var>] =</em> <strong>readPressure(<var>obj</var>)</strong><a href='#index-readPressure_0028obj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readPressure_0028obj_0029-1"><span class="category-def">: </span><span><code class="def-type">[<var class="var">P</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readPressure(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readPressure_0028obj_0029-1'> ¶</a></span></dt> <dd><p>Read the pressure </p> -<span id="Inputs-175"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-175">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-138"></span><h4 class="subsubheading">Outputs</h4> -<p><var>P</var> - pressure reading from sensor. +<h4 class="subsubheading" id="Outputs-138">Outputs</h4> +<p><var class="var">P</var> - pressure reading from sensor. </p> -<p><var>timestamp</var> - timestamp when read - </p></dd></dl> +<p><var class="var">timestamp</var> - timestamp when read +</p></dd></dl> -<dl class="def"> -<dt id="index-read_0028obj_0029-7"><span class="category">: </span><span><em>[<var>readings</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-7' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read_0028obj_0029-8"><span class="category">: </span><span><em>[<var>P</var>, <var>C</var>, <var>timestamp</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-8' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read_0028obj_0029-7"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readings</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-7'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read_0028obj_0029-8"><span class="category-def">: </span><span><code class="def-type">[<var class="var">P</var>, <var class="var">C</var>, <var class="var">timestamp</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-8'> ¶</a></span></dt> <dd><p>Read the sensor data </p> -<span id="Inputs-176"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-176">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-139"></span><h4 class="subsubheading">Outputs</h4> -<p><var>P</var> - pressure reading from sensor. +<h4 class="subsubheading" id="Outputs-139">Outputs</h4> +<p><var class="var">P</var> - pressure reading from sensor. </p> -<p><var>C</var> - temperature reading from sensor. +<p><var class="var">C</var> - temperature reading from sensor. </p> -<p><var>timestamp</var> - timestamp when read +<p><var class="var">timestamp</var> - timestamp when read </p> -<p><var>overrun</var> - overrun flag. +<p><var class="var">overrun</var> - overrun flag. </p> -<p><var>readings</var> - table structure with fields for Timestamp, Pressure, Temperature and Humidity. - </p></dd></dl> +<p><var class="var">readings</var> - table structure with fields for Timestamp, Pressure, Temperature and Humidity. +</p></dd></dl> -<dl class="def"> -<dt id="index-info_0028obj_0029-3"><span class="category">: </span><span><em><var>inf</var> =</em> <strong>info(<var>obj</var>)</strong><a href='#index-info_0028obj_0029-3' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-info_0028obj_0029-3"><span class="category-def">: </span><span><code class="def-type"><var class="var">inf</var> =</code> <strong class="def-name">info(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-info_0028obj_0029-3'> ¶</a></span></dt> <dd><p>Read the sensor info </p> -<span id="Inputs-177"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-177">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-140"></span><h4 class="subsubheading">Outputs</h4> -<p><var>inf</var> - structure containing the sensor information. +<h4 class="subsubheading" id="Outputs-140">Outputs</h4> +<p><var class="var">inf</var> - structure containing the sensor information. </p> <p>Structure fields are: - </p><dl compact="compact"> -<dt><span>Version</span></dt> +</p><dl class="table"> +<dt>Version</dt> <dd><p>Chip firmware version - </p></dd> -<dt><span>SensorId</span></dt> +</p></dd> +<dt>SensorId</dt> <dd><p>sensor id value - </p></dd> -<dt><span>Type</span></dt> +</p></dd> +<dt>Type</dt> <dd><p>sensor type ’lps22hb’ - </p></dd> -<dt><span>Status</span></dt> +</p></dd> +<dt>Status</dt> <dd><p>Status value read from sensor - </p></dd> +</p></dd> </dl> </dd></dl> -<dl class="def"> -<dt id="index-flush_0028obj_0029-3"><span class="category">: </span><span><em></em> <strong>flush(<var>obj</var>)</strong><a href='#index-flush_0028obj_0029-3' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-flush_0028obj_0029-3"><span class="category-def">: </span><span><strong class="def-name">flush(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-flush_0028obj_0029-3'> ¶</a></span></dt> <dd><p>Flush sensor data </p> -<span id="Inputs-178"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-178">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-141"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-141">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> -<dl class="def"> -<dt id="index-release_0028obj_0029-3"><span class="category">: </span><span><em></em> <strong>release(<var>obj</var>)</strong><a href='#index-release_0028obj_0029-3' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-release_0028obj_0029-3"><span class="category-def">: </span><span><strong class="def-name">release(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-release_0028obj_0029-3'> ¶</a></span></dt> <dd><p>Release the resources of the sensor </p> -<span id="Inputs-179"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-179">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-142"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-142">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> </div> -<div class="subsection" id="lsm6dso"> +<div class="subsection-level-extent" id="lsm6dso"> <h4 class="subsection">9.15.5 lsm6dso</h4> -<span id="index-lsm6dso"></span> -<dl class="def"> -<dt id="index-lsm6dso-1"><span class="category">: </span><span><em></em> <strong>lsm6dso</strong><a href='#index-lsm6dso-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-lsm6dso"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-lsm6dso-1"><span class="category-def">: </span><span><strong class="def-name">lsm6dso</strong><a class="copiable-link" href='#index-lsm6dso-1'> ¶</a></span></dt> <dd><p>LSM6DSO 6 degrees sensor - </p></dd></dl> +</p></dd></dl> -<span id="Methods-19"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-lsm6dso_0028arObj_0029"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>lsm6dso(<var>arObj</var>)</strong><a href='#index-lsm6dso_0028arObj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-lsm6dso_0028arObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>lsm6dso(<var>arObj</var>,</strong> <em><var>propertyname, propertyvalue</var> ....)</em><a href='#index-lsm6dso_0028arObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-19">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-lsm6dso_0028arObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">lsm6dso(<var class="var">arObj</var>)</strong><a class="copiable-link" href='#index-lsm6dso_0028arObj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-lsm6dso_0028arObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">lsm6dso(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-lsm6dso_0028arObj_002c'> ¶</a></span></dt> <dd><p>Constructor to create LSM6DSO sensor - </p><span id="Inputs-180"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-180">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>propertyname, propertyvalue</var> - optional property name, value pairs. +<p><var class="var">propertyname, propertyvalue</var> - optional property name, value pairs. Current known properties are: Current properties are: - </p><dl compact="compact"> -<dt><span>I2CAddress</span></dt> +</p><dl class="table"> +<dt>I2CAddress</dt> <dd><p>I2C address of the sensor (default 0x40) - </p></dd> -<dt><span>Bus</span></dt> +</p></dd> +<dt>Bus</dt> <dd><p>I2C bus - 0 or 1 (default 0) - </p></dd> +</p></dd> </dl> -<span id="Outputs-143"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created object +<h4 class="subsubheading" id="Outputs-143">Outputs</h4> +<p><var class="var">obj</var> - created object </p> -<span id="Example-35"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-35">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() sensor = lsm6dso(a) </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-readTemperature_0028obj_0029-3"><span class="category">: </span><span><em>[<var>C</var>, <var>timestamp</var>] =</em> <strong>readTemperature(<var>obj</var>)</strong><a href='#index-readTemperature_0028obj_0029-3' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readTemperature_0028obj_0029-3"><span class="category-def">: </span><span><code class="def-type">[<var class="var">C</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readTemperature(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readTemperature_0028obj_0029-3'> ¶</a></span></dt> <dd><p>Read the temperature </p> -<span id="Inputs-181"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-181">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-144"></span><h4 class="subsubheading">Outputs</h4> -<p><var>C</var> - read temperature in deg C. +<h4 class="subsubheading" id="Outputs-144">Outputs</h4> +<p><var class="var">C</var> - read temperature in deg C. </p> -<p><var>timestamp</var> - timestamp when read +<p><var class="var">timestamp</var> - timestamp when read </p> -<span id="Example-36"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-36">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() s = lsm6dso(a) # get temp temp = s.readTemperature </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> lsm6dso. - </p></dd></dl> +<p><strong class="strong">See also:</strong> lsm6dso. +</p></dd></dl> -<dl class="def"> -<dt id="index-readAcceleration_0028obj_0029-2"><span class="category">: </span><span><em>[<var>readVal</var>, <var>timestamp</var>] =</em> <strong>readAcceleration(<var>obj</var>)</strong><a href='#index-readAcceleration_0028obj_0029-2' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readAcceleration_0028obj_0029-2"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readVal</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readAcceleration(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readAcceleration_0028obj_0029-2'> ¶</a></span></dt> <dd><p>Read the acceleration rate </p> -<span id="Inputs-182"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-182">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-145"></span><h4 class="subsubheading">Outputs</h4> -<p><var>readVal</var> - the 3 acceleration values +<h4 class="subsubheading" id="Outputs-145">Outputs</h4> +<p><var class="var">readVal</var> - the 3 acceleration values </p> -<p><var>timestamp</var> - timestamp when read - </p></dd></dl> +<p><var class="var">timestamp</var> - timestamp when read +</p></dd></dl> -<dl class="def"> -<dt id="index-readAngularVelocity_0028obj_0029-1"><span class="category">: </span><span><em>[<var>readVal</var>, <var>timestamp</var>] =</em> <strong>readAngularVelocity(<var>obj</var>)</strong><a href='#index-readAngularVelocity_0028obj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readAngularVelocity_0028obj_0029-1"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readVal</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readAngularVelocity(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readAngularVelocity_0028obj_0029-1'> ¶</a></span></dt> <dd><p>Read the angular velocity </p> -<span id="Inputs-183"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-183">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-146"></span><h4 class="subsubheading">Outputs</h4> -<p><var>readVal</var> - the 3 angular velocity values +<h4 class="subsubheading" id="Outputs-146">Outputs</h4> +<p><var class="var">readVal</var> - the 3 angular velocity values </p> -<p><var>timestamp</var> - timestamp when read - </p></dd></dl> +<p><var class="var">timestamp</var> - timestamp when read +</p></dd></dl> -<dl class="def"> -<dt id="index-read_0028obj_0029-9"><span class="category">: </span><span><em>[<var>readings</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-9' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read_0028obj_0029-10"><span class="category">: </span><span><em>[<var>accel</var>, <var>gyro</var>, <var>mag</var>, <var>timestamp</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-10' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read_0028obj_0029-9"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readings</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-9'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read_0028obj_0029-10"><span class="category-def">: </span><span><code class="def-type">[<var class="var">accel</var>, <var class="var">gyro</var>, <var class="var">mag</var>, <var class="var">timestamp</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-10'> ¶</a></span></dt> <dd><p>Read the sensor data </p> -<span id="Inputs-184"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-184">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-147"></span><h4 class="subsubheading">Outputs</h4> -<p><var>accel</var> - acceleration reading from sensor. +<h4 class="subsubheading" id="Outputs-147">Outputs</h4> +<p><var class="var">accel</var> - acceleration reading from sensor. </p> -<p><var>gyro</var> - angular acceleration reading from sensor. +<p><var class="var">gyro</var> - angular acceleration reading from sensor. </p> -<p><var>timestamp</var> - timestamp when read +<p><var class="var">timestamp</var> - timestamp when read </p> -<p><var>overrun</var> - overrun flag. +<p><var class="var">overrun</var> - overrun flag. </p> -<p><var>readings</var> - table structure with fields for Timestamp, Acceleration, AngularVelocity. - </p></dd></dl> +<p><var class="var">readings</var> - table structure with fields for Timestamp, Acceleration, AngularVelocity. +</p></dd></dl> -<dl class="def"> -<dt id="index-info_0028obj_0029-4"><span class="category">: </span><span><em><var>inf</var> =</em> <strong>info(<var>obj</var>)</strong><a href='#index-info_0028obj_0029-4' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-info_0028obj_0029-4"><span class="category-def">: </span><span><code class="def-type"><var class="var">inf</var> =</code> <strong class="def-name">info(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-info_0028obj_0029-4'> ¶</a></span></dt> <dd><p>Read the sensor info </p> -<span id="Inputs-185"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-185">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-148"></span><h4 class="subsubheading">Outputs</h4> -<p><var>inf</var> - structure containing the sensor information. +<h4 class="subsubheading" id="Outputs-148">Outputs</h4> +<p><var class="var">inf</var> - structure containing the sensor information. </p> <p>Structure fields are: - </p><dl compact="compact"> -<dt><span>SensorId</span></dt> +</p><dl class="table"> +<dt>SensorId</dt> <dd><p>sensor id value - </p></dd> -<dt><span>Type</span></dt> +</p></dd> +<dt>Type</dt> <dd><p>sensor type ’lsm6dso’ - </p></dd> +</p></dd> </dl> </dd></dl> -<dl class="def"> -<dt id="index-flush_0028obj_0029-4"><span class="category">: </span><span><em></em> <strong>flush(<var>obj</var>)</strong><a href='#index-flush_0028obj_0029-4' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-flush_0028obj_0029-4"><span class="category-def">: </span><span><strong class="def-name">flush(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-flush_0028obj_0029-4'> ¶</a></span></dt> <dd><p>Flush sensor data </p> -<span id="Inputs-186"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-186">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-149"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-149">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> -<dl class="def"> -<dt id="index-release_0028obj_0029-4"><span class="category">: </span><span><em></em> <strong>release(<var>obj</var>)</strong><a href='#index-release_0028obj_0029-4' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-release_0028obj_0029-4"><span class="category-def">: </span><span><strong class="def-name">release(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-release_0028obj_0029-4'> ¶</a></span></dt> <dd><p>Release the resources of the sensor </p> -<span id="Inputs-187"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-187">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-150"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-150">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> </div> -<div class="subsection" id="mpu6050"> +<div class="subsection-level-extent" id="mpu6050"> <h4 class="subsection">9.15.6 mpu6050</h4> -<span id="index-mpu6050"></span> -<dl class="def"> -<dt id="index-mpu6050-1"><span class="category">: </span><span><em></em> <strong>mpu6050</strong><a href='#index-mpu6050-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-mpu6050"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-mpu6050-1"><span class="category-def">: </span><span><strong class="def-name">mpu6050</strong><a class="copiable-link" href='#index-mpu6050-1'> ¶</a></span></dt> <dd><p>MPU-6050 6 degrees sensor - </p></dd></dl> +</p></dd></dl> -<span id="Methods-20"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-mpu6050_0028arObj_0029"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>mpu6050(<var>arObj</var>)</strong><a href='#index-mpu6050_0028arObj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-mpu6050_0028arObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>mpu6050(<var>arObj</var>,</strong> <em><var>propertyname, propertyvalue</var> ....)</em><a href='#index-mpu6050_0028arObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-20">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-mpu6050_0028arObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">mpu6050(<var class="var">arObj</var>)</strong><a class="copiable-link" href='#index-mpu6050_0028arObj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-mpu6050_0028arObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">mpu6050(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-mpu6050_0028arObj_002c'> ¶</a></span></dt> <dd><p>Constructor to create MPU-6050 sensor - </p><span id="Inputs-188"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-188">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>propertyname, propertyvalue</var> - optional property name, value pairs. +<p><var class="var">propertyname, propertyvalue</var> - optional property name, value pairs. Current known properties are: Current properties are: - </p><dl compact="compact"> -<dt><span>I2CAddress</span></dt> +</p><dl class="table"> +<dt>I2CAddress</dt> <dd><p>I2C address of the sensor (default 0x40) - </p></dd> -<dt><span>Bus</span></dt> +</p></dd> +<dt>Bus</dt> <dd><p>I2C bus - 0 or 1 (default 0) - </p></dd> +</p></dd> </dl> -<span id="Outputs-151"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created object +<h4 class="subsubheading" id="Outputs-151">Outputs</h4> +<p><var class="var">obj</var> - created object </p> -<span id="Example-37"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-37">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() sensor = mpu6050(a) </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-readTemperature_0028obj_0029-4"><span class="category">: </span><span><em>[<var>C</var>, <var>timestamp</var>] =</em> <strong>readTemperature(<var>obj</var>)</strong><a href='#index-readTemperature_0028obj_0029-4' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readTemperature_0028obj_0029-4"><span class="category-def">: </span><span><code class="def-type">[<var class="var">C</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readTemperature(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readTemperature_0028obj_0029-4'> ¶</a></span></dt> <dd><p>Read the temperature </p> -<span id="Inputs-189"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-189">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-152"></span><h4 class="subsubheading">Outputs</h4> -<p><var>C</var> - read temperature in deg C. +<h4 class="subsubheading" id="Outputs-152">Outputs</h4> +<p><var class="var">C</var> - read temperature in deg C. </p> -<p><var>timestamp</var> - timestamp when read +<p><var class="var">timestamp</var> - timestamp when read </p> -<span id="Example-38"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-38">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() s = mpu6050(a) # get temp temp = s.readTemperature </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> mpu6050. - </p></dd></dl> +<p><strong class="strong">See also:</strong> mpu6050. +</p></dd></dl> -<dl class="def"> -<dt id="index-readAcceleration_0028obj_0029-3"><span class="category">: </span><span><em>[<var>readVal</var>, <var>timestamp</var>] =</em> <strong>readAcceleration(<var>obj</var>)</strong><a href='#index-readAcceleration_0028obj_0029-3' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readAcceleration_0028obj_0029-3"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readVal</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readAcceleration(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readAcceleration_0028obj_0029-3'> ¶</a></span></dt> <dd><p>Read the acceleration rate </p> -<span id="Inputs-190"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-190">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-153"></span><h4 class="subsubheading">Outputs</h4> -<p><var>readVal</var> - the 3 acceleration values +<h4 class="subsubheading" id="Outputs-153">Outputs</h4> +<p><var class="var">readVal</var> - the 3 acceleration values </p> -<p><var>timestamp</var> - timestamp when read - </p></dd></dl> +<p><var class="var">timestamp</var> - timestamp when read +</p></dd></dl> -<dl class="def"> -<dt id="index-readAngularVelocity_0028obj_0029-2"><span class="category">: </span><span><em>[<var>readVal</var>, <var>timestamp</var>] =</em> <strong>readAngularVelocity(<var>obj</var>)</strong><a href='#index-readAngularVelocity_0028obj_0029-2' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readAngularVelocity_0028obj_0029-2"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readVal</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readAngularVelocity(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readAngularVelocity_0028obj_0029-2'> ¶</a></span></dt> <dd><p>Read the angular velocity </p> -<span id="Inputs-191"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-191">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-154"></span><h4 class="subsubheading">Outputs</h4> -<p><var>readVal</var> - the 3 angular velocity values +<h4 class="subsubheading" id="Outputs-154">Outputs</h4> +<p><var class="var">readVal</var> - the 3 angular velocity values </p> -<p><var>timestamp</var> - timestamp when read - </p></dd></dl> +<p><var class="var">timestamp</var> - timestamp when read +</p></dd></dl> -<dl class="def"> -<dt id="index-read_0028obj_0029-11"><span class="category">: </span><span><em>[<var>readings</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-11' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read_0028obj_0029-12"><span class="category">: </span><span><em>[<var>accel</var>, <var>gyro</var>, <var>mag</var>, <var>timestamp</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-12' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read_0028obj_0029-11"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readings</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-11'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read_0028obj_0029-12"><span class="category-def">: </span><span><code class="def-type">[<var class="var">accel</var>, <var class="var">gyro</var>, <var class="var">mag</var>, <var class="var">timestamp</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-12'> ¶</a></span></dt> <dd><p>Read the sensor data </p> -<span id="Inputs-192"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-192">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-155"></span><h4 class="subsubheading">Outputs</h4> -<p><var>accel</var> - acceleration reading from sensor. +<h4 class="subsubheading" id="Outputs-155">Outputs</h4> +<p><var class="var">accel</var> - acceleration reading from sensor. </p> -<p><var>gyro</var> - angular acceleration reading from sensor. +<p><var class="var">gyro</var> - angular acceleration reading from sensor. </p> -<p><var>timestamp</var> - timestamp when read +<p><var class="var">timestamp</var> - timestamp when read </p> -<p><var>overrun</var> - overrun flag. +<p><var class="var">overrun</var> - overrun flag. </p> -<p><var>readings</var> - table structure with fields for Timestamp, Acceleration, AngularVelocity. - </p></dd></dl> +<p><var class="var">readings</var> - table structure with fields for Timestamp, Acceleration, AngularVelocity. +</p></dd></dl> -<dl class="def"> -<dt id="index-info_0028obj_0029-5"><span class="category">: </span><span><em><var>inf</var> =</em> <strong>info(<var>obj</var>)</strong><a href='#index-info_0028obj_0029-5' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-info_0028obj_0029-5"><span class="category-def">: </span><span><code class="def-type"><var class="var">inf</var> =</code> <strong class="def-name">info(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-info_0028obj_0029-5'> ¶</a></span></dt> <dd><p>Read the sensor info </p> -<span id="Inputs-193"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-193">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-156"></span><h4 class="subsubheading">Outputs</h4> -<p><var>inf</var> - structure containing the sensor information. +<h4 class="subsubheading" id="Outputs-156">Outputs</h4> +<p><var class="var">inf</var> - structure containing the sensor information. </p> <p>Structure fields are: - </p><dl compact="compact"> -<dt><span>SensorId</span></dt> +</p><dl class="table"> +<dt>SensorId</dt> <dd><p>sensor id value - </p></dd> -<dt><span>Type</span></dt> +</p></dd> +<dt>Type</dt> <dd><p>sensor type ’mpu6050’ - </p></dd> +</p></dd> </dl> </dd></dl> -<dl class="def"> -<dt id="index-flush_0028obj_0029-5"><span class="category">: </span><span><em></em> <strong>flush(<var>obj</var>)</strong><a href='#index-flush_0028obj_0029-5' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-flush_0028obj_0029-5"><span class="category-def">: </span><span><strong class="def-name">flush(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-flush_0028obj_0029-5'> ¶</a></span></dt> <dd><p>Flush sensor data </p> -<span id="Inputs-194"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-194">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-157"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-157">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> -<dl class="def"> -<dt id="index-release_0028obj_0029-5"><span class="category">: </span><span><em></em> <strong>release(<var>obj</var>)</strong><a href='#index-release_0028obj_0029-5' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-release_0028obj_0029-5"><span class="category-def">: </span><span><strong class="def-name">release(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-release_0028obj_0029-5'> ¶</a></span></dt> <dd><p>Release the resources of the sensor </p> -<span id="Inputs-195"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-195">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-158"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-158">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> </div> -<div class="subsection" id="si7021"> +<div class="subsection-level-extent" id="si7021"> <h4 class="subsection">9.15.7 si7021</h4> -<span id="index-si7021"></span> -<dl class="def"> -<dt id="index-si7021-1"><span class="category">: </span><span><em></em> <strong>si7021</strong><a href='#index-si7021-1' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-si7021"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-si7021-1"><span class="category-def">: </span><span><strong class="def-name">si7021</strong><a class="copiable-link" href='#index-si7021-1'> ¶</a></span></dt> <dd><p>SI7021 temperature and humidity sensor - </p></dd></dl> +</p></dd></dl> -<span id="Methods-21"></span><h4 class="subheading">Methods</h4> -<dl class="def"> -<dt id="index-si7021_0028arObj_0029"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>si7021(<var>arObj</var>)</strong><a href='#index-si7021_0028arObj_0029' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-si7021_0028arObj_002c"><span class="category">: </span><span><em><var>obj</var> =</em> <strong>si7021(<var>arObj</var>,</strong> <em><var>propertyname, propertyvalue</var> ....)</em><a href='#index-si7021_0028arObj_002c' class='copiable-anchor'> ¶</a></span></dt> +<h4 class="subheading" id="Methods-21">Methods</h4> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-si7021_0028arObj_0029"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">si7021(<var class="var">arObj</var>)</strong><a class="copiable-link" href='#index-si7021_0028arObj_0029'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-si7021_0028arObj_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">obj</var> =</code> <strong class="def-name">si7021(<var class="var">arObj</var>,</strong> <code class="def-code-arguments"><var class="var">propertyname, propertyvalue</var> ....)</code><a class="copiable-link" href='#index-si7021_0028arObj_002c'> ¶</a></span></dt> <dd><p>Constructor to create si7021 sensor - </p><span id="Inputs-196"></span><h4 class="subsubheading">Inputs</h4> -<p><var>arObj</var> - the arduino parent object +</p><h4 class="subsubheading" id="Inputs-196">Inputs</h4> +<p><var class="var">arObj</var> - the arduino parent object </p> -<p><var>propertyname, propertyvalue</var> - optional property name, value pairs. +<p><var class="var">propertyname, propertyvalue</var> - optional property name, value pairs. Current known properties are: Current properties are: - </p><dl compact="compact"> -<dt><span>I2Caddress</span></dt> +</p><dl class="table"> +<dt>I2Caddress</dt> <dd><p>I2C address of the si7021 (default 0x40) - </p></dd> -<dt><span>Bus</span></dt> +</p></dd> +<dt>Bus</dt> <dd><p>I2C bus (default 0) - </p></dd> +</p></dd> </dl> -<span id="Outputs-159"></span><h4 class="subsubheading">Outputs</h4> -<p><var>obj</var> - created SI7020 object +<h4 class="subsubheading" id="Outputs-159">Outputs</h4> +<p><var class="var">obj</var> - created SI7020 object </p> -<span id="Example-39"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-39">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() sensor = si7021(a) </code> - </pre></div> +</pre></div> </dd></dl> -<dl class="def"> -<dt id="index-readTemperature_0028obj_0029-5"><span class="category">: </span><span><em>[<var>C</var>, <var>timestamp</var>] =</em> <strong>readTemperature(<var>obj</var>)</strong><a href='#index-readTemperature_0028obj_0029-5' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readTemperature_0028obj_0029-5"><span class="category-def">: </span><span><code class="def-type">[<var class="var">C</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readTemperature(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readTemperature_0028obj_0029-5'> ¶</a></span></dt> <dd><p>Read the temperature </p> -<span id="Inputs-197"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the si7021 object +<h4 class="subsubheading" id="Inputs-197">Inputs</h4> +<p><var class="var">obj</var> - the si7021 object </p> -<span id="Outputs-160"></span><h4 class="subsubheading">Outputs</h4> -<p><var>C</var> - read temperature in deg C. +<h4 class="subsubheading" id="Outputs-160">Outputs</h4> +<p><var class="var">C</var> - read temperature in deg C. </p> -<p><var>timestamp</var> - timestamp when read +<p><var class="var">timestamp</var> - timestamp when read </p> -<span id="Example-40"></span><h4 class="subsubheading">Example</h4> +<h4 class="subsubheading" id="Example-40">Example</h4> <div class="example"> -<pre class="example"> <code> +<pre class="example-preformatted"><code class="code"> a = arduino() s = si7021(a) # get temp temp = s.readTemperature() </code> - </pre></div> +</pre></div> -<p><strong>See also:</strong> si7021. - </p></dd></dl> +<p><strong class="strong">See also:</strong> si7021. +</p></dd></dl> -<dl class="def"> -<dt id="index-readHumidity_0028obj_0029-1"><span class="category">: </span><span><em>[<var>relH</var>, <var>timestamp</var>] =</em> <strong>readHumidity(<var>obj</var>)</strong><a href='#index-readHumidity_0028obj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-readHumidity_0028obj_0029-1"><span class="category-def">: </span><span><code class="def-type">[<var class="var">relH</var>, <var class="var">timestamp</var>] =</code> <strong class="def-name">readHumidity(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-readHumidity_0028obj_0029-1'> ¶</a></span></dt> <dd><p>Read the relative humidity </p> -<span id="Inputs-198"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the si7021 object +<h4 class="subsubheading" id="Inputs-198">Inputs</h4> +<p><var class="var">obj</var> - the si7021 object </p> -<span id="Outputs-161"></span><h4 class="subsubheading">Outputs</h4> -<p><var>relH</var> - relative humidity as a percentage (0 - 100.0) +<h4 class="subsubheading" id="Outputs-161">Outputs</h4> +<p><var class="var">relH</var> - relative humidity as a percentage (0 - 100.0) </p> -<p><var>timestamp</var> - timestamp when read - </p></dd></dl> +<p><var class="var">timestamp</var> - timestamp when read +</p></dd></dl> -<dl class="def"> -<dt id="index-read_0028obj_0029-13"><span class="category">: </span><span><em>[<var>readings</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-13' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-read_0028obj_0029-14"><span class="category">: </span><span><em>[<var>H</var>, <var>C</var>, <var>timestamp</var>, <var>overrun</var>] =</em> <strong>read(<var>obj</var>)</strong><a href='#index-read_0028obj_0029-14' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-read_0028obj_0029-13"><span class="category-def">: </span><span><code class="def-type">[<var class="var">readings</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-13'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-read_0028obj_0029-14"><span class="category-def">: </span><span><code class="def-type">[<var class="var">H</var>, <var class="var">C</var>, <var class="var">timestamp</var>, <var class="var">overrun</var>] =</code> <strong class="def-name">read(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-read_0028obj_0029-14'> ¶</a></span></dt> <dd><p>Read the sensor data </p> -<span id="Inputs-199"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the si2071 sensor object +<h4 class="subsubheading" id="Inputs-199">Inputs</h4> +<p><var class="var">obj</var> - the si2071 sensor object </p> -<span id="Outputs-162"></span><h4 class="subsubheading">Outputs</h4> -<p><var>H</var> - humidity reading from sensor. +<h4 class="subsubheading" id="Outputs-162">Outputs</h4> +<p><var class="var">H</var> - humidity reading from sensor. </p> -<p><var>C</var> - temperature reading from sensor. +<p><var class="var">C</var> - temperature reading from sensor. </p> -<p><var>timestamp</var> - timestamp when read +<p><var class="var">timestamp</var> - timestamp when read </p> -<p><var>overrun</var> - overrun flag. +<p><var class="var">overrun</var> - overrun flag. </p> -<p><var>readings</var> - table structure with fields for Timestamp, Temperature and Humidity. - </p></dd></dl> +<p><var class="var">readings</var> - table structure with fields for Timestamp, Temperature and Humidity. +</p></dd></dl> -<dl class="def"> -<dt id="index-info_0028dsObj_0029-1"><span class="category">: </span><span><em><var>relH</var> =</em> <strong>info(<var>dsObj</var>)</strong><a href='#index-info_0028dsObj_0029-1' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-info_0028dsObj_0029-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">relH</var> =</code> <strong class="def-name">info(<var class="var">dsObj</var>)</strong><a class="copiable-link" href='#index-info_0028dsObj_0029-1'> ¶</a></span></dt> <dd><p>Read the sensor info </p> -<span id="Inputs-200"></span><h4 class="subsubheading">Inputs</h4> -<p><var>dsObj</var> - the si7021 object +<h4 class="subsubheading" id="Inputs-200">Inputs</h4> +<p><var class="var">dsObj</var> - the si7021 object </p> -<span id="Outputs-163"></span><h4 class="subsubheading">Outputs</h4> -<p><var>inf</var> - structure containing the sensor information. +<h4 class="subsubheading" id="Outputs-163">Outputs</h4> +<p><var class="var">inf</var> - structure containing the sensor information. </p> <p>Structure fields are: - </p><dl compact="compact"> -<dt><span>Version</span></dt> +</p><dl class="table"> +<dt>Version</dt> <dd><p>Chip firmware version - </p></dd> -<dt><span>SensorDd</span></dt> +</p></dd> +<dt>SensorDd</dt> <dd><p>sensor id value - </p></dd> -<dt><span>Type</span></dt> +</p></dd> +<dt>Type</dt> <dd><p>String for detected chip type - </p></dd> +</p></dd> </dl> </dd></dl> -<dl class="def"> -<dt id="index-flush_0028obj_0029-6"><span class="category">: </span><span><em></em> <strong>flush(<var>obj</var>)</strong><a href='#index-flush_0028obj_0029-6' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-flush_0028obj_0029-6"><span class="category-def">: </span><span><strong class="def-name">flush(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-flush_0028obj_0029-6'> ¶</a></span></dt> <dd><p>Flush sensor data </p> -<span id="Inputs-201"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-201">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-164"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-164">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> -<dl class="def"> -<dt id="index-release_0028obj_0029-6"><span class="category">: </span><span><em></em> <strong>release(<var>obj</var>)</strong><a href='#index-release_0028obj_0029-6' class='copiable-anchor'> ¶</a></span></dt> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-release_0028obj_0029-6"><span class="category-def">: </span><span><strong class="def-name">release(<var class="var">obj</var>)</strong><a class="copiable-link" href='#index-release_0028obj_0029-6'> ¶</a></span></dt> <dd><p>Release the resources of the sensor </p> -<span id="Inputs-202"></span><h4 class="subsubheading">Inputs</h4> -<p><var>obj</var> - the sensor object +<h4 class="subsubheading" id="Inputs-202">Inputs</h4> +<p><var class="var">obj</var> - the sensor object </p> -<span id="Outputs-165"></span><h4 class="subsubheading">Outputs</h4> +<h4 class="subsubheading" id="Outputs-165">Outputs</h4> <p>None - </p></dd></dl> +</p></dd></dl> <hr> </div> </div> -<div class="section" id="Test-Functions"> -<div class="header"> +<div class="section-level-extent" id="Test-Functions"> +<div class="nav-panel"> <p> Previous: <a href="#Sensors" accesskey="p" rel="prev">Sensors</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Test-Functions-1"></span><h3 class="section">9.16 Test Functions</h3> -<span id="index-Test-Functions"></span> -<ul class="section-toc"> +<h3 class="section" id="Test-Functions-1">9.16 Test Functions</h3> +<a class="index-entry-id" id="index-Test-Functions"></a> +<ul class="mini-toc"> <li><a href="#arduino_005fbistsetup" accesskey="1">arduino_bistsetup</a></li> </ul> -<div class="subsection" id="arduino_005fbistsetup"> +<div class="subsection-level-extent" id="arduino_005fbistsetup"> <h4 class="subsection">9.16.1 arduino_bistsetup</h4> -<span id="index-arduino_005fbistsetup"></span> -<dl class="def"> -<dt id="index-arduino_005fbistsetup-1"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>arduino_bistsetup</strong> <em>()</em><a href='#index-arduino_005fbistsetup-1' class='copiable-anchor'> ¶</a></span></dt> -<dt id="index-arduino_005fbistsetup-2"><span class="category">: </span><span><em><var>retval</var> =</em> <strong>arduino_bistsetup</strong> <em>(<var>propertyname</var>, <var>propertyvalue</var>)</em><a href='#index-arduino_005fbistsetup-2' class='copiable-anchor'> ¶</a></span></dt> +<a class="index-entry-id" id="index-arduino_005fbistsetup"></a> +<dl class="first-deftypefn"> +<dt class="deftypefn" id="index-arduino_005fbistsetup-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">arduino_bistsetup</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-arduino_005fbistsetup-1'> ¶</a></span></dt> +<dt class="deftypefnx def-cmd-deftypefn" id="index-arduino_005fbistsetup-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">retval</var> =</code> <strong class="def-name">arduino_bistsetup</strong> <code class="def-code-arguments">(<var class="var">propertyname</var>, <var class="var">propertyvalue</var>)</code><a class="copiable-link" href='#index-arduino_005fbistsetup-2'> ¶</a></span></dt> <dd><p>Install on an arduino the required core libraries to run the BIST tests </p> <p>As part of the setup, the arduino IDE will be opened to allow programming the arduino board. </p> -<span id="Inputs-203"></span><h4 class="subsubheading">Inputs</h4> +<h4 class="subsubheading" id="Inputs-203">Inputs</h4> -<p><var>propertyname</var>, <var>propertyvalue</var> - A sequence of property name/value pairs can be given +<p><var class="var">propertyname</var>, <var class="var">propertyvalue</var> - A sequence of property name/value pairs can be given to set defaults while programming. </p> <p>Currently the following properties can be set: - </p><dl compact="compact"> -<dt><span>arduinobinary</span></dt> +</p><dl class="table"> +<dt>arduinobinary</dt> <dd><p>The value should be the name/path of the arduino IDE binary for programming. If not specified, the function will attempt to find the binary itself. - </p></dd> -<dt><span>debug</span></dt> +</p></dd> +<dt>debug</dt> <dd><p>Set the debug flag when checking the arduino - </p></dd> +</p></dd> </dl> -<span id="Outputs-166"></span><h4 class="subsubheading">Outputs</h4> -<p><var>retval</var> - return 1 if everything installed ok +<h4 class="subsubheading" id="Outputs-166">Outputs</h4> +<p><var class="var">retval</var> - return 1 if everything installed ok </p> -<p><strong>See also:</strong> arduino, arduinosetup. - </p></dd></dl> +<p><strong class="strong">See also:</strong> arduino, arduinosetup. +</p></dd></dl> <hr> </div> </div> </div> -<div class="appendix" id="Copying"> -<div class="header"> +<div class="appendix-level-extent" id="Copying"> +<div class="nav-panel"> <p> Next: <a href="#Index" accesskey="n" rel="next">Index</a>, Previous: <a href="#Function-Reference" accesskey="p" rel="prev">Function Reference</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="GNU-General-Public-License"></span><h2 class="appendix">Appendix A GNU General Public License</h2> -<span id="index-warranty"></span> -<span id="index-copyright"></span> +<h2 class="appendix" id="GNU-General-Public-License">Appendix A GNU General Public License</h2> +<a class="index-entry-id" id="index-warranty"></a> +<a class="index-entry-id" id="index-copyright"></a> -<div align="center">Version 3, 29 June 2007 +<div class="center">Version 3, 29 June 2007 </div> <div class="display"> -<pre class="display">Copyright © 2007 Free Software Foundation, Inc. <a href="http://fsf.org/">http://fsf.org/</a> +<pre class="display-preformatted">Copyright © 2007 Free Software Foundation, Inc. <a class="url" href="http://fsf.org/">http://fsf.org/</a> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. </pre></div> -<span id="Preamble"></span><h3 class="heading">Preamble</h3> +<h3 class="heading" id="Preamble">Preamble</h3> <p>The GNU General Public License is a free, copyleft license for software and other kinds of works. @@ -7242,9 +7242,9 @@ assures that patents cannot be used to render the program non-free. <p>The precise terms and conditions for copying, distribution and modification follow. </p> -<span id="TERMS-AND-CONDITIONS"></span><h3 class="heading">TERMS AND CONDITIONS</h3> +<h3 class="heading" id="TERMS-AND-CONDITIONS">TERMS AND CONDITIONS</h3> -<ol start="0"> +<ol class="enumerate" start="0"> <li> Definitions. <p>“This License” refers to version 3 of the GNU General Public License. @@ -7387,7 +7387,7 @@ produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: </p> -<ol type="a" start="1"> +<ol class="enumerate" type="a" start="1"> <li> The work must carry prominent notices stating that you modified it, and giving a relevant date. @@ -7427,7 +7427,7 @@ sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: </p> -<ol type="a" start="1"> +<ol class="enumerate" type="a" start="1"> <li> Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily @@ -7544,7 +7544,7 @@ for which you have or can give appropriate copyright permission. add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: </p> -<ol type="a" start="1"> +<ol class="enumerate" type="a" start="1"> <li> Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or @@ -7806,9 +7806,9 @@ copy of the Program in return for a fee. </p> </li></ol> -<span id="END-OF-TERMS-AND-CONDITIONS"></span><h3 class="heading">END OF TERMS AND CONDITIONS</h3> +<h3 class="heading" id="END-OF-TERMS-AND-CONDITIONS">END OF TERMS AND CONDITIONS</h3> -<span id="How-to-Apply-These-Terms-to-Your-New-Programs"></span><h3 class="heading">How to Apply These Terms to Your New Programs</h3> +<h3 class="heading" id="How-to-Apply-These-Terms-to-Your-New-Programs">How to Apply These Terms to Your New Programs</h3> <p>If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it @@ -7820,9 +7820,9 @@ to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found. </p> -<div class="example"> -<pre class="example"><var>one line to give the program's name and a brief idea of what it does.</var> -Copyright (C) <var>year</var> <var>name of author</var> +<div class="example smallexample"> +<pre class="example-preformatted"><var class="var">one line to give the program's name and a brief idea of what it does.</var> +Copyright (C) <var class="var">year</var> <var class="var">name of author</var> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -7835,7 +7835,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License -along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>. +along with this program. If not, see <a class="url" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>. </pre></div> <p>Also add information on how to contact you by electronic and paper mail. @@ -7843,14 +7843,14 @@ along with this program. If not, see <a href="http://www.gnu.org/licenses/">htt <p>If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: </p> -<div class="example"> -<pre class="example"><var>program</var> Copyright (C) <var>year</var> <var>name of author</var> -This program comes with ABSOLUTELY NO WARRANTY; for details type ‘<samp>show w</samp>’. +<div class="example smallexample"> +<pre class="example-preformatted"><var class="var">program</var> Copyright (C) <var class="var">year</var> <var class="var">name of author</var> +This program comes with ABSOLUTELY NO WARRANTY; for details type ‘<samp class="samp">show w</samp>’. This is free software, and you are welcome to redistribute it -under certain conditions; type ‘<samp>show c</samp>’ for details. +under certain conditions; type ‘<samp class="samp">show c</samp>’ for details. </pre></div> -<p>The hypothetical commands ‘<samp>show w</samp>’ and ‘<samp>show c</samp>’ should show +<p>The hypothetical commands ‘<samp class="samp">show w</samp>’ and ‘<samp class="samp">show c</samp>’ should show the appropriate parts of the General Public License. Of course, your program’s commands might be different; for a GUI interface, you would use an “about box”. @@ -7858,354 +7858,356 @@ use an “about box”. <p>You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see -<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>. +<a class="url" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>. </p> <p>The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But -first, please read <a href="http://www.gnu.org/philosophy/why-not-lgpl.html">http://www.gnu.org/philosophy/why-not-lgpl.html</a>. +first, please read <a class="url" href="http://www.gnu.org/philosophy/why-not-lgpl.html">http://www.gnu.org/philosophy/why-not-lgpl.html</a>. </p> <hr> </div> -<div class="unnumbered" id="Index"> -<div class="header"> +<div class="unnumbered-level-extent" id="Index"> +<div class="nav-panel"> <p> Previous: <a href="#Copying" accesskey="p" rel="prev">GNU General Public License</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> </div> -<span id="Index-1"></span><h2 class="unnumbered">Index</h2> +<h2 class="unnumbered" id="Index-1">Index</h2> -<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Index_cp_letter-A"><b>A</b></a> +<div class="printindex cp-printindex"> +<table class="cp-letters-header-printindex"><tr><th>Jump to: </th><td><a class="summary-letter-printindex" href="#Index_cp_letter-A"><b>A</b></a> -<a class="summary-letter" href="#Index_cp_letter-B"><b>B</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-B"><b>B</b></a> -<a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-C"><b>C</b></a> -<a class="summary-letter" href="#Index_cp_letter-D"><b>D</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-D"><b>D</b></a> -<a class="summary-letter" href="#Index_cp_letter-E"><b>E</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-E"><b>E</b></a> -<a class="summary-letter" href="#Index_cp_letter-F"><b>F</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-F"><b>F</b></a> -<a class="summary-letter" href="#Index_cp_letter-G"><b>G</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-G"><b>G</b></a> -<a class="summary-letter" href="#Index_cp_letter-H"><b>H</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-H"><b>H</b></a> -<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-I"><b>I</b></a> -<a class="summary-letter" href="#Index_cp_letter-K"><b>K</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-K"><b>K</b></a> -<a class="summary-letter" href="#Index_cp_letter-L"><b>L</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-L"><b>L</b></a> -<a class="summary-letter" href="#Index_cp_letter-M"><b>M</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-M"><b>M</b></a> -<a class="summary-letter" href="#Index_cp_letter-O"><b>O</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-O"><b>O</b></a> -<a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-P"><b>P</b></a> -<a class="summary-letter" href="#Index_cp_letter-Q"><b>Q</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-Q"><b>Q</b></a> -<a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-R"><b>R</b></a> -<a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-S"><b>S</b></a> -<a class="summary-letter" href="#Index_cp_letter-T"><b>T</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-T"><b>T</b></a> -<a class="summary-letter" href="#Index_cp_letter-U"><b>U</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-U"><b>U</b></a> -<a class="summary-letter" href="#Index_cp_letter-V"><b>V</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-V"><b>V</b></a> -<a class="summary-letter" href="#Index_cp_letter-W"><b>W</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-W"><b>W</b></a> </td></tr></table> -<table class="index-cp" border="0"> -<tr><td></td><th align="left">Index Entry</th><td> </td><th align="left"> Section</th></tr> +<table class="cp-entries-printindex" border="0"> +<tr><td></td><th class="entries-header-printindex">Index Entry</th><td> </td><th class="sections-header-printindex"> Section</th></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-A">A</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-addon">addon</a>:</td><td> </td><td valign="top"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Addon-Introduction">Addon Introduction</a>:</td><td> </td><td valign="top"><a href="#Addons-Overview">Addons Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Addon-package-_002em-file">Addon package .m file</a>:</td><td> </td><td valign="top"><a href="#Addons-Overview">Addons Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Addon-package-directory">Addon package directory</a>:</td><td> </td><td valign="top"><a href="#Addons-Overview">Addons Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Addon-package-header-file">Addon package header file</a>:</td><td> </td><td valign="top"><a href="#Addons-Overview">Addons Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-AddonBase">AddonBase</a>:</td><td> </td><td valign="top"><a href="#Arduino-I_002fO-package">Arduino I/O package</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Addons-Overview">Addons Overview</a>:</td><td> </td><td valign="top"><a href="#Addons-Overview">Addons Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-arduino">arduino</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Arduino-Addons">Arduino Addons</a>:</td><td> </td><td valign="top"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Arduino-Device-Functions">Arduino Device Functions</a>:</td><td> </td><td valign="top"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Arduino-Functions">Arduino Functions</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Arduino-I_002fO-package">Arduino I/O package</a>:</td><td> </td><td valign="top"><a href="#Arduino-I_002fO-package">Arduino I/O package</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Arduino-I2C-Functions">Arduino I2C Functions</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a>:</td><td> </td><td valign="top"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Arduino-Sensor">Arduino Sensor</a>:</td><td> </td><td valign="top"><a href="#Sensors-Overview">Sensors Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Arduino-Sensors">Arduino Sensors</a>:</td><td> </td><td valign="top"><a href="#Arduino-Sensors">Arduino Sensors</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Arduino-Serial-Functions">Arduino Serial Functions</a>:</td><td> </td><td valign="top"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Arduino-Servo-Functions">Arduino Servo Functions</a>:</td><td> </td><td valign="top"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a>:</td><td> </td><td valign="top"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Arduino-SPI-Functions">Arduino SPI Functions</a>:</td><td> </td><td valign="top"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a>:</td><td> </td><td valign="top"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-arduinosetup">arduinosetup</a>:</td><td> </td><td valign="top"><a href="#General-Functions">General Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-arduino_005fbistsetup">arduino_bistsetup</a>:</td><td> </td><td valign="top"><a href="#Test-Functions">Test Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Available-Sensors">Available Sensors</a>:</td><td> </td><td valign="top"><a href="#Sensors-Overview">Sensors Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Available-Sensors-1">Available Sensors</a>:</td><td> </td><td valign="top"><a href="#Sensors-Overview">Sensors Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-addon">addon</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Addon-Introduction">Addon Introduction</a>:</td><td> </td><td class="printindex-index-section"><a href="#Addons-Overview">Addons Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Addon-package-_002em-file">Addon package .m file</a>:</td><td> </td><td class="printindex-index-section"><a href="#Addons-Overview">Addons Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Addon-package-directory">Addon package directory</a>:</td><td> </td><td class="printindex-index-section"><a href="#Addons-Overview">Addons Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Addon-package-header-file">Addon package header file</a>:</td><td> </td><td class="printindex-index-section"><a href="#Addons-Overview">Addons Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-AddonBase">AddonBase</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I_002fO-package">Arduino I/O package</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Addons-Overview">Addons Overview</a>:</td><td> </td><td class="printindex-index-section"><a href="#Addons-Overview">Addons Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-arduino">arduino</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Arduino-Addons">Arduino Addons</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Arduino-Device-Functions">Arduino Device Functions</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Arduino-Functions">Arduino Functions</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Arduino-I_002fO-package">Arduino I/O package</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I_002fO-package">Arduino I/O package</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Arduino-I2C-Functions">Arduino I2C Functions</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Arduino-Sensor">Arduino Sensor</a>:</td><td> </td><td class="printindex-index-section"><a href="#Sensors-Overview">Sensors Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Arduino-Sensors">Arduino Sensors</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Sensors">Arduino Sensors</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Arduino-Serial-Functions">Arduino Serial Functions</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Arduino-Servo-Functions">Arduino Servo Functions</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Arduino-SPI-Functions">Arduino SPI Functions</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-arduinosetup">arduinosetup</a>:</td><td> </td><td class="printindex-index-section"><a href="#General-Functions">General Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-arduino_005fbistsetup">arduino_bistsetup</a>:</td><td> </td><td class="printindex-index-section"><a href="#Test-Functions">Test Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Available-Sensors">Available Sensors</a>:</td><td> </td><td class="printindex-index-section"><a href="#Sensors-Overview">Sensors Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Available-Sensors-1">Available Sensors</a>:</td><td> </td><td class="printindex-index-section"><a href="#Sensors-Overview">Sensors Overview</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-B">B</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-Basic-Input-and-Output-Overview">Basic Input and Output Overview</a>:</td><td> </td><td valign="top"><a href="#Basic-Input-and-Output-Overview">Basic Input and Output Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Blinking-an-LED">Blinking an LED</a>:</td><td> </td><td valign="top"><a href="#Examples">Examples</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-bme280">bme280</a>:</td><td> </td><td valign="top"><a href="#Sensors">Sensors</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-bno055">bno055</a>:</td><td> </td><td valign="top"><a href="#Sensors">Sensors</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Basic-Input-and-Output-Overview">Basic Input and Output Overview</a>:</td><td> </td><td class="printindex-index-section"><a href="#Basic-Input-and-Output-Overview">Basic Input and Output Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Blinking-an-LED">Blinking an LED</a>:</td><td> </td><td class="printindex-index-section"><a href="#Examples">Examples</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-bme280">bme280</a>:</td><td> </td><td class="printindex-index-section"><a href="#Sensors">Sensors</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-bno055">bno055</a>:</td><td> </td><td class="printindex-index-section"><a href="#Sensors">Sensors</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-C">C</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-checkI2CAddress">checkI2CAddress</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-configurePin">configurePin</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-configurePinResource">configurePinResource</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Connecting-to-a-single-arduino">Connecting to a single arduino</a>:</td><td> </td><td valign="top"><a href="#Connecting-to-an-arduino">Connecting to an arduino</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Connecting-to-a-specific-arduino">Connecting to a specific arduino</a>:</td><td> </td><td valign="top"><a href="#Connecting-to-an-arduino">Connecting to an arduino</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Connecting-to-an-arduino">Connecting to an arduino</a>:</td><td> </td><td valign="top"><a href="#Connecting-to-an-arduino">Connecting to an arduino</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-copyright">copyright</a>:</td><td> </td><td valign="top"><a href="#Copying">Copying</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Creating-a-addon-object">Creating a addon object</a>:</td><td> </td><td valign="top"><a href="#Addons-Overview">Addons Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Creating-an-addon">Creating an addon</a>:</td><td> </td><td valign="top"><a href="#Addons-Overview">Addons Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-checkI2CAddress">checkI2CAddress</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-configurePin">configurePin</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-configurePinResource">configurePinResource</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Connecting-to-a-single-arduino">Connecting to a single arduino</a>:</td><td> </td><td class="printindex-index-section"><a href="#Connecting-to-an-arduino">Connecting to an arduino</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Connecting-to-a-specific-arduino">Connecting to a specific arduino</a>:</td><td> </td><td class="printindex-index-section"><a href="#Connecting-to-an-arduino">Connecting to an arduino</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Connecting-to-an-arduino">Connecting to an arduino</a>:</td><td> </td><td class="printindex-index-section"><a href="#Connecting-to-an-arduino">Connecting to an arduino</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-copyright">copyright</a>:</td><td> </td><td class="printindex-index-section"><a href="#Copying">Copying</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Creating-a-addon-object">Creating a addon object</a>:</td><td> </td><td class="printindex-index-section"><a href="#Addons-Overview">Addons Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Creating-an-addon">Creating an addon</a>:</td><td> </td><td class="printindex-index-section"><a href="#Addons-Overview">Addons Overview</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-D">D</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-dcmotorv2">dcmotorv2</a>:</td><td> </td><td valign="top"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-decrementResourceCount">decrementResourceCount</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-delete">delete</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-delete-1">delete</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-delete-2">delete</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-delete-3">delete</a>:</td><td> </td><td valign="top"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-delete-4">delete</a>:</td><td> </td><td valign="top"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-delete-5">delete</a>:</td><td> </td><td valign="top"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-delete-6">delete</a>:</td><td> </td><td valign="top"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-delete-7">delete</a>:</td><td> </td><td valign="top"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-delete-8">delete</a>:</td><td> </td><td valign="top"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-delete-9">delete</a>:</td><td> </td><td valign="top"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-delete-10">delete</a>:</td><td> </td><td valign="top"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-device">device</a>:</td><td> </td><td valign="top"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-device-1">device</a>:</td><td> </td><td valign="top"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-display">display</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-display-1">display</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-display-2">display</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-display-3">display</a>:</td><td> </td><td valign="top"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-display-4">display</a>:</td><td> </td><td valign="top"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-display-5">display</a>:</td><td> </td><td valign="top"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-display-6">display</a>:</td><td> </td><td valign="top"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-display-7">display</a>:</td><td> </td><td valign="top"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-display-8">display</a>:</td><td> </td><td valign="top"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-display-9">display</a>:</td><td> </td><td valign="top"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-display-10">display</a>:</td><td> </td><td valign="top"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-DS1307">DS1307</a>:</td><td> </td><td valign="top"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-DS1307-1">DS1307</a>:</td><td> </td><td valign="top"><a href="#Arduino-Sensors">Arduino Sensors</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-dcmotorv2">dcmotorv2</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-decrementResourceCount">decrementResourceCount</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-delete">delete</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-delete-1">delete</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-delete-2">delete</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-delete-3">delete</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-delete-4">delete</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-delete-5">delete</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-delete-6">delete</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-delete-7">delete</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-delete-8">delete</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-delete-9">delete</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-delete-10">delete</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-device">device</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-device-1">device</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-display">display</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-display-1">display</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-display-2">display</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-display-3">display</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-display-4">display</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-display-5">display</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-display-6">display</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-display-7">display</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-display-8">display</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-display-9">display</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-display-10">display</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-DS1307">DS1307</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-DS1307-1">DS1307</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Sensors">Arduino Sensors</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-E">E</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-Echo">Echo</a>:</td><td> </td><td valign="top"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-EEPRom">EEPRom</a>:</td><td> </td><td valign="top"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Examples">Examples</a>:</td><td> </td><td valign="top"><a href="#Examples">Examples</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Echo">Echo</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-EEPRom">EEPRom</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Examples">Examples</a>:</td><td> </td><td class="printindex-index-section"><a href="#Examples">Examples</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-F">F</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-FilePath">FilePath</a>:</td><td> </td><td valign="top"><a href="#Arduino-I_002fO-package">Arduino I/O package</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-flush">flush</a>:</td><td> </td><td valign="top"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-flush-1">flush</a>:</td><td> </td><td valign="top"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Function-Reference">Function Reference</a>:</td><td> </td><td valign="top"><a href="#Function-Reference">Function Reference</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-FilePath">FilePath</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I_002fO-package">Arduino I/O package</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-flush">flush</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-flush-1">flush</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Function-Reference">Function Reference</a>:</td><td> </td><td class="printindex-index-section"><a href="#Function-Reference">Function Reference</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-G">G</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-General-Functions">General Functions</a>:</td><td> </td><td valign="top"><a href="#General-Functions">General Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getBoardConfig">getBoardConfig</a>:</td><td> </td><td valign="top"><a href="#Arduino-I_002fO-package">Arduino I/O package</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getEndian">getEndian</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getI2CTerminals">getI2CTerminals</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getInterruptTerminals">getInterruptTerminals</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getLEDTerminals">getLEDTerminals</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getMCU">getMCU</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getPinAlias">getPinAlias</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getPinInfo">getPinInfo</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getPinsFromTerminals">getPinsFromTerminals</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getPWMTerminals">getPWMTerminals</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getResourceCount">getResourceCount</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getResourceOwner">getResourceOwner</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getServoTerminals">getServoTerminals</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getSharedResourceProperty">getSharedResourceProperty</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getSPITerminals">getSPITerminals</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getTerminalMode">getTerminalMode</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-getTerminalsFromPins">getTerminalsFromPins</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-GUVAS12SD">GUVAS12SD</a>:</td><td> </td><td valign="top"><a href="#Arduino-Sensors">Arduino Sensors</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-General-Functions">General Functions</a>:</td><td> </td><td class="printindex-index-section"><a href="#General-Functions">General Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getBoardConfig">getBoardConfig</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I_002fO-package">Arduino I/O package</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getEndian">getEndian</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getI2CTerminals">getI2CTerminals</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getInterruptTerminals">getInterruptTerminals</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getLEDTerminals">getLEDTerminals</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getMCU">getMCU</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getPinAlias">getPinAlias</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getPinInfo">getPinInfo</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getPinsFromTerminals">getPinsFromTerminals</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getPWMTerminals">getPWMTerminals</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getResourceCount">getResourceCount</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getResourceOwner">getResourceOwner</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getServoTerminals">getServoTerminals</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getSharedResourceProperty">getSharedResourceProperty</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getSPITerminals">getSPITerminals</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getTerminalMode">getTerminalMode</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-getTerminalsFromPins">getTerminalsFromPins</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-GUVAS12SD">GUVAS12SD</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Sensors">Arduino Sensors</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-H">H</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-Hardware-setup">Hardware setup</a>:</td><td> </td><td valign="top"><a href="#Hardware-setup">Hardware setup</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Hardware-setup">Hardware setup</a>:</td><td> </td><td class="printindex-index-section"><a href="#Hardware-setup">Hardware setup</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-I">I</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-I2C-communication">I2C communication</a>:</td><td> </td><td valign="top"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-i2cdev">i2cdev</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-incrementResourceCount">incrementResourceCount</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Installing-and-loading">Installing and loading</a>:</td><td> </td><td valign="top"><a href="#Installing-and-loading">Installing and loading</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-isarduino">isarduino</a>:</td><td> </td><td valign="top"><a href="#General-Functions">General Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-isTerminalAnalog">isTerminalAnalog</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-isTerminalDigital">isTerminalDigital</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-I2C-communication">I2C communication</a>:</td><td> </td><td class="printindex-index-section"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-i2cdev">i2cdev</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-incrementResourceCount">incrementResourceCount</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Installing-and-loading">Installing and loading</a>:</td><td> </td><td class="printindex-index-section"><a href="#Installing-and-loading">Installing and loading</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-isarduino">isarduino</a>:</td><td> </td><td class="printindex-index-section"><a href="#General-Functions">General Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-isTerminalAnalog">isTerminalAnalog</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-isTerminalDigital">isTerminalDigital</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-K">K</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-Known-Arduino-Board-Types">Known Arduino Board Types</a>:</td><td> </td><td valign="top"><a href="#Hardware-setup">Hardware setup</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Known-Arduino-Board-Types">Known Arduino Board Types</a>:</td><td> </td><td class="printindex-index-section"><a href="#Hardware-setup">Hardware setup</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-L">L</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-LCD">LCD</a>:</td><td> </td><td valign="top"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-LibFiles">LibFiles</a>:</td><td> </td><td valign="top"><a href="#Arduino-I_002fO-package">Arduino I/O package</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-LibraryBase">LibraryBase</a>:</td><td> </td><td valign="top"><a href="#Arduino-I_002fO-package">Arduino I/O package</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-LibraryBase-1">LibraryBase</a>:</td><td> </td><td valign="top"><a href="#Matlab-Compatability-Classes">Matlab Compatability Classes</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-lis3dh">lis3dh</a>:</td><td> </td><td valign="top"><a href="#Sensors">Sensors</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-listArduinoLibraries">listArduinoLibraries</a>:</td><td> </td><td valign="top"><a href="#General-Functions">General Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Loading">Loading</a>:</td><td> </td><td valign="top"><a href="#Installing-and-loading">Installing and loading</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-lps22hb">lps22hb</a>:</td><td> </td><td valign="top"><a href="#Sensors">Sensors</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-lsm6dso">lsm6dso</a>:</td><td> </td><td valign="top"><a href="#Sensors">Sensors</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-LCD">LCD</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-LibFiles">LibFiles</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I_002fO-package">Arduino I/O package</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-LibraryBase">LibraryBase</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I_002fO-package">Arduino I/O package</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-LibraryBase-1">LibraryBase</a>:</td><td> </td><td class="printindex-index-section"><a href="#Matlab-Compatibility-Classes">Matlab Compatibility Classes</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-lis3dh">lis3dh</a>:</td><td> </td><td class="printindex-index-section"><a href="#Sensors">Sensors</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-listArduinoLibraries">listArduinoLibraries</a>:</td><td> </td><td class="printindex-index-section"><a href="#General-Functions">General Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Loading">Loading</a>:</td><td> </td><td class="printindex-index-section"><a href="#Installing-and-loading">Installing and loading</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-lps22hb">lps22hb</a>:</td><td> </td><td class="printindex-index-section"><a href="#Sensors">Sensors</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-lsm6dso">lsm6dso</a>:</td><td> </td><td class="printindex-index-section"><a href="#Sensors">Sensors</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-M">M</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-Matlab-Compatability-Classes">Matlab Compatability Classes</a>:</td><td> </td><td valign="top"><a href="#Matlab-Compatability-Classes">Matlab Compatability Classes</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Matlab-Compatible-Sensor">Matlab Compatible Sensor</a>:</td><td> </td><td valign="top"><a href="#Sensors-Overview">Sensors Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-motorshieldv2">motorshieldv2</a>:</td><td> </td><td valign="top"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-MPC3002">MPC3002</a>:</td><td> </td><td valign="top"><a href="#Arduino-Sensors">Arduino Sensors</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-mpu6050">mpu6050</a>:</td><td> </td><td valign="top"><a href="#Sensors">Sensors</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Matlab-Compatibility-Classes">Matlab Compatibility Classes</a>:</td><td> </td><td class="printindex-index-section"><a href="#Matlab-Compatibility-Classes">Matlab Compatibility Classes</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Matlab-Compatible-Sensor">Matlab Compatible Sensor</a>:</td><td> </td><td class="printindex-index-section"><a href="#Sensors-Overview">Sensors Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-motorshieldv2">motorshieldv2</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-MPC3002">MPC3002</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Sensors">Arduino Sensors</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-mpu6050">mpu6050</a>:</td><td> </td><td class="printindex-index-section"><a href="#Sensors">Sensors</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-O">O</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-Off_002dline-install">Off-line install</a>:</td><td> </td><td valign="top"><a href="#Installing-and-loading">Installing and loading</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Online-install">Online install</a>:</td><td> </td><td valign="top"><a href="#Installing-and-loading">Installing and loading</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Off_002dline-install">Off-line install</a>:</td><td> </td><td class="printindex-index-section"><a href="#Installing-and-loading">Installing and loading</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Online-install">Online install</a>:</td><td> </td><td class="printindex-index-section"><a href="#Installing-and-loading">Installing and loading</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-P">P</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-Performing-Analog-Input">Performing Analog Input</a>:</td><td> </td><td valign="top"><a href="#Basic-Input-and-Output-Overview">Basic Input and Output Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Performing-Digital-I_002fO">Performing Digital I/O</a>:</td><td> </td><td valign="top"><a href="#Basic-Input-and-Output-Overview">Basic Input and Output Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-playTone">playTone</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Programming-the-Arduino">Programming the Arduino</a>:</td><td> </td><td valign="top"><a href="#Hardware-setup">Hardware setup</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Programming-the-arduino-with-the-addon">Programming the arduino with the addon</a>:</td><td> </td><td valign="top"><a href="#Addons-Overview">Addons Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a>:</td><td> </td><td valign="top"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Performing-Analog-Input">Performing Analog Input</a>:</td><td> </td><td class="printindex-index-section"><a href="#Basic-Input-and-Output-Overview">Basic Input and Output Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Performing-Digital-I_002fO">Performing Digital I/O</a>:</td><td> </td><td class="printindex-index-section"><a href="#Basic-Input-and-Output-Overview">Basic Input and Output Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-playTone">playTone</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Programming-the-Arduino">Programming the Arduino</a>:</td><td> </td><td class="printindex-index-section"><a href="#Hardware-setup">Hardware setup</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Programming-the-arduino-with-the-addon">Programming the arduino with the addon</a>:</td><td> </td><td class="printindex-index-section"><a href="#Addons-Overview">Addons Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a>:</td><td> </td><td class="printindex-index-section"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-Q">Q</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-Querying-available-arduinos">Querying available arduinos</a>:</td><td> </td><td valign="top"><a href="#Connecting-to-an-arduino">Connecting to an arduino</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Querying-available-arduinos">Querying available arduinos</a>:</td><td> </td><td class="printindex-index-section"><a href="#Connecting-to-an-arduino">Connecting to an arduino</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-R">R</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-read">read</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-read-1">read</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-read-2">read</a>:</td><td> </td><td valign="top"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-read-3">read</a>:</td><td> </td><td valign="top"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-read-4">read</a>:</td><td> </td><td valign="top"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-readAnalogPin">readAnalogPin</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-readCount">readCount</a>:</td><td> </td><td valign="top"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-readDigitalPin">readDigitalPin</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-readDistance">readDistance</a>:</td><td> </td><td valign="top"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-readEchoTime">readEchoTime</a>:</td><td> </td><td valign="top"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-readPosition">readPosition</a>:</td><td> </td><td valign="top"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-readRegister">readRegister</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-readRegister-1">readRegister</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-readRegister-2">readRegister</a>:</td><td> </td><td valign="top"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-readSpeed">readSpeed</a>:</td><td> </td><td valign="top"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-readVoltage">readVoltage</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-reset">reset</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-reset-1">reset</a>:</td><td> </td><td valign="top"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-resetCount">resetCount</a>:</td><td> </td><td valign="top"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Rotary-Encoder">Rotary Encoder</a>:</td><td> </td><td valign="top"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-rotaryEncoder">rotaryEncoder</a>:</td><td> </td><td valign="top"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-read">read</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-read-1">read</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-read-2">read</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-read-3">read</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-read-4">read</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-readAnalogPin">readAnalogPin</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-readCount">readCount</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-readDigitalPin">readDigitalPin</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-readDistance">readDistance</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-readEchoTime">readEchoTime</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-readPosition">readPosition</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-readRegister">readRegister</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-readRegister-1">readRegister</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-readRegister-2">readRegister</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-readSpeed">readSpeed</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-readVoltage">readVoltage</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-reset">reset</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-reset-1">reset</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-resetCount">resetCount</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Rotary-Encoder">Rotary Encoder</a>:</td><td> </td><td class="printindex-index-section"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-rotaryEncoder">rotaryEncoder</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-S">S</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-scanForArduinos">scanForArduinos</a>:</td><td> </td><td valign="top"><a href="#General-Functions">General Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-scanI2Cbus">scanI2Cbus</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-sendCommand">sendCommand</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Sensors">Sensors</a>:</td><td> </td><td valign="top"><a href="#Sensors">Sensors</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Sensors-Overview">Sensors Overview</a>:</td><td> </td><td valign="top"><a href="#Sensors-Overview">Sensors Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Serial-communication">Serial communication</a>:</td><td> </td><td valign="top"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-servo">servo</a>:</td><td> </td><td valign="top"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Servo-communication">Servo communication</a>:</td><td> </td><td valign="top"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-setSharedResourceProperty">setSharedResourceProperty</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Shift-Registers">Shift Registers</a>:</td><td> </td><td valign="top"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-shiftRegister">shiftRegister</a>:</td><td> </td><td valign="top"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-SI7021">SI7021</a>:</td><td> </td><td valign="top"><a href="#Arduino-Sensors">Arduino Sensors</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-si7021">si7021</a>:</td><td> </td><td valign="top"><a href="#Sensors">Sensors</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-SimpleStepper">SimpleStepper</a>:</td><td> </td><td valign="top"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-SPI-communication">SPI communication</a>:</td><td> </td><td valign="top"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-spidev">spidev</a>:</td><td> </td><td valign="top"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-stepper">stepper</a>:</td><td> </td><td valign="top"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-subsref">subsref</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-subsref-1">subsref</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-subsref-2">subsref</a>:</td><td> </td><td valign="top"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-subsref-3">subsref</a>:</td><td> </td><td valign="top"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-subsref-4">subsref</a>:</td><td> </td><td valign="top"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-subsref-5">subsref</a>:</td><td> </td><td valign="top"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-subsref-6">subsref</a>:</td><td> </td><td valign="top"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-subsref-7">subsref</a>:</td><td> </td><td valign="top"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-subsref-8">subsref</a>:</td><td> </td><td valign="top"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-subsref-9">subsref</a>:</td><td> </td><td valign="top"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-scanForArduinos">scanForArduinos</a>:</td><td> </td><td class="printindex-index-section"><a href="#General-Functions">General Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-scanI2Cbus">scanI2Cbus</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-sendCommand">sendCommand</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Sensors">Sensors</a>:</td><td> </td><td class="printindex-index-section"><a href="#Sensors">Sensors</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Sensors-Overview">Sensors Overview</a>:</td><td> </td><td class="printindex-index-section"><a href="#Sensors-Overview">Sensors Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Serial-communication">Serial communication</a>:</td><td> </td><td class="printindex-index-section"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-servo">servo</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Servo-communication">Servo communication</a>:</td><td> </td><td class="printindex-index-section"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-setSharedResourceProperty">setSharedResourceProperty</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Shift-Registers">Shift Registers</a>:</td><td> </td><td class="printindex-index-section"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-shiftRegister">shiftRegister</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-SI7021">SI7021</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Sensors">Arduino Sensors</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-si7021">si7021</a>:</td><td> </td><td class="printindex-index-section"><a href="#Sensors">Sensors</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-SimpleStepper">SimpleStepper</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-SPI-communication">SPI communication</a>:</td><td> </td><td class="printindex-index-section"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-spidev">spidev</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-stepper">stepper</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Addons">Arduino Addons</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-subsref">subsref</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-subsref-1">subsref</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-subsref-2">subsref</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Rotary-Encoder-Functions">Arduino Rotary Encoder Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-subsref-3">subsref</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-subsref-4">subsref</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-subsref-5">subsref</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-subsref-6">subsref</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-subsref-7">subsref</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-subsref-8">subsref</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-subsref-9">subsref</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-T">T</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-Test-Functions">Test Functions</a>:</td><td> </td><td valign="top"><a href="#Test-Functions">Test Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Test-Functions">Test Functions</a>:</td><td> </td><td class="printindex-index-section"><a href="#Test-Functions">Test Functions</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-U">U</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-ultrasonic">ultrasonic</a>:</td><td> </td><td valign="top"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Ultrasonic-Sensors">Ultrasonic Sensors</a>:</td><td> </td><td valign="top"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-uptime">uptime</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Using-Addons">Using Addons</a>:</td><td> </td><td valign="top"><a href="#Addons-Overview">Addons Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Using-I2C-to-communicate-with-an-EEPROM">Using I2C to communicate with an EEPROM</a>:</td><td> </td><td valign="top"><a href="#Examples">Examples</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Using-SPI-to-communicate-with-a-mcp3002-10-bit-ADC">Using SPI to communicate with a mcp3002 10 bit ADC</a>:</td><td> </td><td valign="top"><a href="#Examples">Examples</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-ultrasonic">ultrasonic</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Ultrasonic-Functions">Arduino Ultrasonic Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Ultrasonic-Sensors">Ultrasonic Sensors</a>:</td><td> </td><td class="printindex-index-section"><a href="#Protocol-based-I_002fO-Overview">Protocol based I/O Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-uptime">uptime</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Using-Addons">Using Addons</a>:</td><td> </td><td class="printindex-index-section"><a href="#Addons-Overview">Addons Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Using-I2C-to-communicate-with-an-EEPROM">Using I2C to communicate with an EEPROM</a>:</td><td> </td><td class="printindex-index-section"><a href="#Examples">Examples</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Using-SPI-to-communicate-with-a-mcp3002-10-bit-ADC">Using SPI to communicate with a mcp3002 10 bit ADC</a>:</td><td> </td><td class="printindex-index-section"><a href="#Examples">Examples</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-V">V</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-validatePin">validatePin</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-Verify-octave-can-see-the-addon">Verify octave can see the addon</a>:</td><td> </td><td valign="top"><a href="#Addons-Overview">Addons Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-version">version</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-validatePin">validatePin</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-Verify-octave-can-see-the-addon">Verify octave can see the addon</a>:</td><td> </td><td class="printindex-index-section"><a href="#Addons-Overview">Addons Overview</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-version">version</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th id="Index_cp_letter-W">W</th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-warranty">warranty</a>:</td><td> </td><td valign="top"><a href="#Copying">Copying</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-write">write</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-write-1">write</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-write-2">write</a>:</td><td> </td><td valign="top"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-write-3">write</a>:</td><td> </td><td valign="top"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-write-4">write</a>:</td><td> </td><td valign="top"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-writeDigitalPin">writeDigitalPin</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-writePosition">writePosition</a>:</td><td> </td><td valign="top"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-writePWMDutyCycle">writePWMDutyCycle</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-writePWMVoltage">writePWMVoltage</a>:</td><td> </td><td valign="top"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-writeRead">writeRead</a>:</td><td> </td><td valign="top"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-writeRead-1">writeRead</a>:</td><td> </td><td valign="top"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-writeRead-2">writeRead</a>:</td><td> </td><td valign="top"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-writeRegister">writeRegister</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-writeRegister-1">writeRegister</a>:</td><td> </td><td valign="top"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-writeRegister-2">writeRegister</a>:</td><td> </td><td valign="top"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-warranty">warranty</a>:</td><td> </td><td class="printindex-index-section"><a href="#Copying">Copying</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-write">write</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-write-1">write</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-write-2">write</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Shiftregister-Functions">Arduino Shiftregister Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-write-3">write</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Serial-Functions">Arduino Serial Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-write-4">write</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-writeDigitalPin">writeDigitalPin</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-writePosition">writePosition</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Servo-Functions">Arduino Servo Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-writePWMDutyCycle">writePWMDutyCycle</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-writePWMVoltage">writePWMVoltage</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Functions">Arduino Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-writeRead">writeRead</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-writeRead-1">writeRead</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-SPI-Functions">Arduino SPI Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-writeRead-2">writeRead</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-writeRegister">writeRegister</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-writeRegister-1">writeRegister</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-I2C-Functions">Arduino I2C Functions</a></td></tr> +<tr><td></td><td class="printindex-index-entry"><a href="#index-writeRegister-2">writeRegister</a>:</td><td> </td><td class="printindex-index-section"><a href="#Arduino-Device-Functions">Arduino Device Functions</a></td></tr> <tr><td colspan="4"> <hr></td></tr> </table> -<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Index_cp_letter-A"><b>A</b></a> +<table class="cp-letters-footer-printindex"><tr><th>Jump to: </th><td><a class="summary-letter-printindex" href="#Index_cp_letter-A"><b>A</b></a> -<a class="summary-letter" href="#Index_cp_letter-B"><b>B</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-B"><b>B</b></a> -<a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-C"><b>C</b></a> -<a class="summary-letter" href="#Index_cp_letter-D"><b>D</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-D"><b>D</b></a> -<a class="summary-letter" href="#Index_cp_letter-E"><b>E</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-E"><b>E</b></a> -<a class="summary-letter" href="#Index_cp_letter-F"><b>F</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-F"><b>F</b></a> -<a class="summary-letter" href="#Index_cp_letter-G"><b>G</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-G"><b>G</b></a> -<a class="summary-letter" href="#Index_cp_letter-H"><b>H</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-H"><b>H</b></a> -<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-I"><b>I</b></a> -<a class="summary-letter" href="#Index_cp_letter-K"><b>K</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-K"><b>K</b></a> -<a class="summary-letter" href="#Index_cp_letter-L"><b>L</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-L"><b>L</b></a> -<a class="summary-letter" href="#Index_cp_letter-M"><b>M</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-M"><b>M</b></a> -<a class="summary-letter" href="#Index_cp_letter-O"><b>O</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-O"><b>O</b></a> -<a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-P"><b>P</b></a> -<a class="summary-letter" href="#Index_cp_letter-Q"><b>Q</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-Q"><b>Q</b></a> -<a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-R"><b>R</b></a> -<a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-S"><b>S</b></a> -<a class="summary-letter" href="#Index_cp_letter-T"><b>T</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-T"><b>T</b></a> -<a class="summary-letter" href="#Index_cp_letter-U"><b>U</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-U"><b>U</b></a> -<a class="summary-letter" href="#Index_cp_letter-V"><b>V</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-V"><b>V</b></a> -<a class="summary-letter" href="#Index_cp_letter-W"><b>W</b></a> +<a class="summary-letter-printindex" href="#Index_cp_letter-W"><b>W</b></a> </td></tr></table> +</div> </div> </div> diff --git a/doc/arduino.pdf b/doc/arduino.pdf Binary files differindex f9905e4..0400da9 100644 --- a/doc/arduino.pdf +++ b/doc/arduino.pdf diff --git a/doc/arduino.qch b/doc/arduino.qch Binary files differindex 6a509e4..4df5b3e 100644 --- a/doc/arduino.qch +++ b/doc/arduino.qch diff --git a/doc/arduino.qhc b/doc/arduino.qhc Binary files differindex 7b50515..8107ce8 100644 --- a/doc/arduino.qhc +++ b/doc/arduino.qhc diff --git a/doc/arduino.texi b/doc/arduino.texi index f4d1975..6250641 100644 --- a/doc/arduino.texi +++ b/doc/arduino.texi @@ -11,11 +11,11 @@ @afourpaper @paragraphindent 0 @finalout -@set VERSION 0.10.0 -@set COPYRIGHT_DATE 2018-2022 +@set COPYRIGHT_DATE 2018-2023 @c @afourwide @c %*** End of the HEADER +@include version.texi @include macros.texi @macro boxnote {args} @@ -219,6 +219,10 @@ Arduino UNO WiFi rev2 @boxnote{The Arduino servo library code may require modifications to eliminate conflicts between servos and the tone library} @item +Arduino UNO WiFi r4 +@item +Arduino UNO Minima r4 +@item Raspberry Pi Pico @item EPS32 Dev diff --git a/doc/functions.texi b/doc/functions.texi index e43fb3c..ae3ab04 100644 --- a/doc/functions.texi +++ b/doc/functions.texi @@ -6,123 +6,123 @@ @c ----------------------------------------- @subsection arduinosetup @cindex arduinosetup - @deftypefn {} {@var{retval} =} arduinosetup () - @deftypefnx {} {@var{retval} =} arduinosetup (@var{propertyname}, @var{propertyvalue}) +@deftypefn {} {@var{retval} =} arduinosetup () +@deftypefnx {} {@var{retval} =} arduinosetup (@var{propertyname}, @var{propertyvalue}) Open the arduino config / programming tool to program the arduino hardware for usage with the Octave arduino functions. arduinosetup will create a temporary project using the arduino IDE and allow compiling and programming of the code to an arduino. - @subsubheading Inputs +@subsubheading Inputs - @var{propertyname}, @var{propertyvalue} - A sequence of property name/value pairs can be given +@var{propertyname}, @var{propertyvalue} - A sequence of property name/value pairs can be given to set defaults while programming. Currently the following properties can be set: - @table @asis - @item libraries +@table @asis +@item libraries The value should be the name of a library, or string array of libraries to program on the arduino board. - @item arduinobinary +@item arduinobinary The value should be the name/path of the arduino IDE binary for programming. If not specified, the function will use getpref preferences of arduino.arduino_binary, and if not found, the function will attempt to find the binary itself. If provided, the value will be saved to preferences for future calls. - @end table +@end table - @subsubheading Outputs - @var{retval} - return 1 if arduino IDE returned without an error +@subsubheading Outputs +@var{retval} - return 1 if arduino IDE returned without an error - @xseealso{arduino, __arduino_binary__} - @end deftypefn +@xseealso{arduino, __arduino_binary__} +@end deftypefn @c General Functions isarduino @c ----------------------------------------- @subsection isarduino @cindex isarduino - @deftypefn {} {@var{retval} =} isarduino (@var{obj}) +@deftypefn {} {@var{retval} =} isarduino (@var{obj}) Check if input value is an arduino object Function is essentially just a call of - @code { +@code { retval = isa(obj, "arduino"); } - @subsubheading Inputs - @var{obj} - The object to check +@subsubheading Inputs +@var{obj} - The object to check - @subsubheading Outputs - @var{retval} is true, if obj is an arduino object, false otherwise. +@subsubheading Outputs +@var{retval} is true, if obj is an arduino object, false otherwise. - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c General Functions listArduinoLibraries @c ----------------------------------------- @subsection listArduinoLibraries @cindex listArduinoLibraries - @deftypefn {} {@var{retval} =} listArduinoLibraries () - @deftypefnx {} {@var{retval} =} listArduinoLibraries (@var{libtypes}) +@deftypefn {} {@var{retval} =} listArduinoLibraries () +@deftypefnx {} {@var{retval} =} listArduinoLibraries (@var{libtypes}) Retrieve list of all known arduino library modules that are available. - @subsubheading Inputs - @var{libtypes} - optional specifier for type of libraries to list. +@subsubheading Inputs +@var{libtypes} - optional specifier for type of libraries to list. Options are: - @table @asis - @item all +@table @asis +@item all List core and addons - @item core +@item core List core only libraries - @item addons +@item addons List addons only - @end table +@end table When no libtypes is specified, all libraries are shown. - @subsubheading Outputs - @var{retval} is an cell array of string library names that are +@subsubheading Outputs +@var{retval} is an cell array of string library names that are available for programming to the arduino. - @xseealso{arduino, arduinosetup} - @end deftypefn +@xseealso{arduino, arduinosetup} +@end deftypefn @c General Functions scanForArduinos @c ----------------------------------------- @subsection scanForArduinos @cindex scanForArduinos - @deftypefn {} {@var{retval} =} scanForArduinos (@var{maxCount}) - @deftypefnx {} {@var{retval} =} scanForArduinos (@var{"debug"}) - @deftypefnx {} {@var{retval} =} scanForArduinos (@var{maxCount}, @var{type}) +@deftypefn {} {@var{retval} =} scanForArduinos (@var{maxCount}) +@deftypefnx {} {@var{retval} =} scanForArduinos (@var{"debug"}) +@deftypefnx {} {@var{retval} =} scanForArduinos (@var{maxCount}, @var{type}) Scan system for programmed arduino boards. scanForArduinos will scan the system for programmed arduino boards and return at most @var{maxCount} of them as a cell array in @var{retval}. - @subsubheading Inputs - @var{maxCount} - max number of arduino boards to detect. +@subsubheading Inputs +@var{maxCount} - max number of arduino boards to detect. if @var{maxCount} is not specified, or is a less than 1, the function will return as many arduino boards as it can detect. - @var{type} - optional board type to match. If specified, the board +@var{type} - optional board type to match. If specified, the board type must match for the arduino to be added to the return list. - @var{"debug"} - if single input parameter is "debug", the +@var{"debug"} - if single input parameter is "debug", the scanForArduinos will display debug information as it scans all available ports for arduinos. - @subsubheading Outputs - @var{retval} structure cell array of matching detected arduino boards. +@subsubheading Outputs +@var{retval} structure cell array of matching detected arduino boards. Each cell value of the cell array will contain a structure with values of: - @table @asis - @item port +@table @asis +@item port the serial port the arduino is connected to - @item board +@item board the board type of the arduino - @end table +@end table - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c --------------------------------------------------- @node Arduino Functions @section Arduino Functions @@ -131,21 +131,21 @@ @c ----------------------------------------- @subsection @@arduino/arduino @cindex arduino - @deftypefn {} {@var{retval} =} arduino () - @deftypefnx {} {@var{retval} =} arduino (@var{port}) - @deftypefnx {} {@var{retval} =} arduino (@var{port}, @var{board}) - @deftypefnx {} {@var{retval} =} arduino (@var{port}, @var{board}[, [@var{propname}, @var{propvalue}]*) - @deftypefnx {} {@var{retval} =} arduino (@var{iaddress}) - @deftypefnx {} {@var{retval} =} arduino (@var{ipaddress}, @var{board}) +@deftypefn {} {@var{retval} =} arduino () +@deftypefnx {} {@var{retval} =} arduino (@var{port}) +@deftypefnx {} {@var{retval} =} arduino (@var{port}, @var{board}) +@deftypefnx {} {@var{retval} =} arduino (@var{port}, @var{board}[, [@var{propname}, @var{propvalue}]*) +@deftypefnx {} {@var{retval} =} arduino (@var{iaddress}) +@deftypefnx {} {@var{retval} =} arduino (@var{ipaddress}, @var{board}) Create a arduino object with a connection to an arduino board. - @subsubheading Inputs - @var{port} - full path of serial port to connect to. For Linux, +@subsubheading Inputs +@var{port} - full path of serial port to connect to. For Linux, usually /dev/ttySXXX, for windows COMXX. - @var{board} - name of board to connect (default is 'uno'). +@var{board} - name of board to connect (default is 'uno'). - @var{propname}, @var{propvalue} - property name and value pair +@var{propname}, @var{propvalue} - property name and value pair for additional properties to pass to the creation of the arduino object. @@ -154,54 +154,54 @@ if the arduino function is called without parameters, it will scan for the first available arduino it can find and connect to it. - @subsubheading Outputs - @var{retval} - a successfully connected arduino object. +@subsubheading Outputs +@var{retval} - a successfully connected arduino object. - @subsubheading Properties +@subsubheading Properties The arduino object has the following public properties: - @table @asis - @item name +@table @asis +@item name name assigned to the arduino object - @item debug +@item debug true / false flag for whether debug in turned on - @item forcebuildon +@item forcebuildon true / false flag for whether to force show of the arduino IDE to reprogram the arduino - @item port (read only) +@item port (read only) the communications port the board is connected to. - @item board (read only) +@item board (read only) The name of the board type that the arduino connected to - @item libraries (read only) +@item libraries (read only) The libraries currently programmed onto the board - @item availablepins +@item availablepins The pins available for use on the board - @item analogreference +@item analogreference The analog voltage reference - @end table - @xseealso{scanForArduinos, arduinosetup} - @end deftypefn +@end table +@xseealso{scanForArduinos, arduinosetup} +@end deftypefn @c Arduino Functions @arduino/checkI2CAddress @c ----------------------------------------- @subsection @@arduino/checkI2CAddress @cindex checkI2CAddress - @deftypefn {} {@var{retval} =} checkI2CAddress (@var{ar}, @var{address}) - @deftypefnx {} {@var{retval} =} checkI2CAddress (@var{ar}, @var{address}, @var{bus}) +@deftypefn {} {@var{retval} =} checkI2CAddress (@var{ar}, @var{address}) +@deftypefnx {} {@var{retval} =} checkI2CAddress (@var{ar}, @var{address}, @var{bus}) Check that an address of given address responds on the I2C bus - @subsubheading Inputs - @var{ar} - arduino object connected to a arduino board. +@subsubheading Inputs +@var{ar} - arduino object connected to a arduino board. - @var{address} - I2C address number to check +@var{address} - I2C address number to check - @var{bus} - bus number to check for I2C device, when multiple buses are available. +@var{bus} - bus number to check for I2C device, when multiple buses are available. If the bus is not specified, it will default to 0. - @subsubheading Outputs - @var{retval} - boolean value of true if address responds on the I2C bus +@subsubheading Outputs +@var{retval} - boolean value of true if address responds on the I2C bus - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { # create arduino connection. ar = arduino(); # scan for devices on the I2C bus @@ -210,16 +210,16 @@ ans = 1 } - @end example +@end example - @xseealso{arduino, scanI2Cbus} - @end deftypefn +@xseealso{arduino, scanI2Cbus} +@end deftypefn @c Arduino Functions @arduino/configurePin @c ----------------------------------------- @subsection @@arduino/configurePin @cindex configurePin - @deftypefn {} {@var{currmode} =} configurePin (@var{ar}, @var{pin}) - @deftypefnx {} {} configurePin (@var{ar}, @var{pin}, @var{mode}) +@deftypefn {} {@var{currmode} =} configurePin (@var{ar}, @var{pin}) +@deftypefnx {} {} configurePin (@var{ar}, @var{pin}, @var{mode}) Set/Get pin mode for a specified pin on arduino connection. configurePin (@var{ar}, @var{pin}) will get the current mode of the specified pin. @@ -227,53 +227,53 @@ configurePin (@var{ar}, @var{pin}, @var{mode}) will attempt set the pin to the specified mode if the mode is unset. - @subsubheading Inputs - @var{ar} - the arduino object of the connection to an arduino board. +@subsubheading Inputs +@var{ar} - the arduino object of the connection to an arduino board. - @var{pin} - string name of the pin to set/get the mode of. +@var{pin} - string name of the pin to set/get the mode of. - @var{mode} - string mode to set the pin to. +@var{mode} - string mode to set the pin to. - @subsubheading Outputs - @var{mode} - string current mode of the pin. +@subsubheading Outputs +@var{mode} - string current mode of the pin. Valid modes can be: - @itemize @bullet - @item AnalogInput +@itemize @bullet +@item AnalogInput - Acquire analog signals from pin - @item DigitalInput +@item DigitalInput - Acquire digital signals from pin - @item DigitalOutput +@item DigitalOutput - Generate digital signals from pin - @item I2C +@item I2C - Specify a pin to use with I2C protocol - @item Pullup +@item Pullup - Specify pin to use a pullup switch - @item PWM +@item PWM - Specify pin to use a pulse width modulator - @item Servo +@item Servo - Specify pin to use a servo - @item SPI +@item SPI - Specify a pin to use with SPI protocol - @item Interrupt +@item Interrupt - Specify a pin to use for with interrupts - @item Reserved +@item Reserved - Specify a pin to be reserved - @item Unset +@item Unset - Clears pin designation. The pin is no longer reserved and can be automatically set at the next operation. - @end itemize +@end itemize - @xseealso{arduino} +@xseealso{arduino} - @end deftypefn +@end deftypefn @c Arduino Functions @arduino/configurePinResource @c ----------------------------------------- @subsection @@arduino/configurePinResource @cindex configurePinResource - @deftypefn {} {@var{currmode} =} configurePinResource (@var{ar}, @var{pin}) - @deftypefnx {} {} configurePinResource (@var{ar}, @var{pin}, @var{owner}, @var{mode}) - @deftypefnx {} {} configurePinResource (@var{ar}, @var{pin}, @var{owner}, @var{mode}, @var{force}) +@deftypefn {} {@var{currmode} =} configurePinResource (@var{ar}, @var{pin}) +@deftypefnx {} {} configurePinResource (@var{ar}, @var{pin}, @var{owner}, @var{mode}) +@deftypefnx {} {} configurePinResource (@var{ar}, @var{pin}, @var{owner}, @var{mode}, @var{force}) Set/Get pin mode for a specified pin on arduino connection. configurePinResource (@var{ar}, @var{pin}) will get the current mode of the specified pin. @@ -284,744 +284,744 @@ If the pin is already owned by another owner, the configure will fail unless the force option is used. If the mode is already set, configure will fail unless force is used. - @subsubheading Inputs - @var{ar} - the arduino object of the connection to an arduino board. +@subsubheading Inputs +@var{ar} - the arduino object of the connection to an arduino board. - @var{pin} - string name of the pin to set/get the mode of. +@var{pin} - string name of the pin to set/get the mode of. - @var{mode} - string mode to set the pin to. +@var{mode} - string mode to set the pin to. - @var{owner} - string name to use as the pin owner. +@var{owner} - string name to use as the pin owner. - @var{force} - boolean to force mode change. If not set, it will be false. +@var{force} - boolean to force mode change. If not set, it will be false. - @subsubheading Outputs - @var{currmode} - current string mode of the pin. +@subsubheading Outputs +@var{currmode} - current string mode of the pin. Valid modes can be: - @itemize @bullet - @item AnalogInput +@itemize @bullet +@item AnalogInput - Acquire analog signals from pin - @item DigitalInput +@item DigitalInput - Acquire digital signals from pin - @item DigitalOutput +@item DigitalOutput - Generate digital signals from pin - @item I2C +@item I2C - Specify a pin to use with I2C protocol - @item Pullup +@item Pullup - Specify pin to use a pullup switch - @item PWM +@item PWM - Specify pin to use a pulse width modulator - @item Servo +@item Servo - Specify pin to use a servo - @item SPI +@item SPI - Specify a pin to use with SPI protocol - @item Interrupt +@item Interrupt - Specify a pin to use with interrupts - @item Reserved +@item Reserved - Pin marked reserved, but not for of any particular mode - @item Unset +@item Unset - Clears pin designation. The pin is no longer reserved and can be automatically set at the next operation. - @end itemize +@end itemize - @xseealso{arduino, configurePin} - @end deftypefn +@xseealso{arduino, configurePin} +@end deftypefn @c Arduino Functions @arduino/decrementResourceCount @c ----------------------------------------- @subsection @@arduino/decrementResourceCount @cindex decrementResourceCount - @deftypefn {} {@var{count} =} decrementResourceCount (@var{ar}, @var{resource}) +@deftypefn {} {@var{count} =} decrementResourceCount (@var{ar}, @var{resource}) Decrement the count of a named resource by 1 and return the new count. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{resource} - name of resource to decrement count. +@var{resource} - name of resource to decrement count. - @subsubheading Outputs - @var{count} = count of uses registered to resource. +@subsubheading Outputs +@var{count} = count of uses registered to resource. - @xseealso{getResourceCount. incrementResourceCount} - @end deftypefn +@xseealso{getResourceCount. incrementResourceCount} +@end deftypefn @c Arduino Functions @arduino/delete @c ----------------------------------------- @subsection @@arduino/delete @cindex delete - @deftypefn {} {} delete (@var{dev}) +@deftypefn {} {} delete (@var{dev}) Free resources of an arduino object. - @subsubheading Inputs - @var{dev} - object to free +@subsubheading Inputs +@var{dev} - object to free - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c Arduino Functions @arduino/display @c ----------------------------------------- @subsection @@arduino/display @cindex display - @deftypefn {} {} display (@var{ar}) +@deftypefn {} {} display (@var{ar}) Display the arduino object in a verbose way, showing the board and available pins. - @subsubheading Inputs - @var{ar} - the arduino object. +@subsubheading Inputs +@var{ar} - the arduino object. If the arduino object has debug mode set, additional information will be displayed. - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c Arduino Functions @arduino/getEndian @c ----------------------------------------- @subsection @@arduino/getEndian @cindex getEndian - @deftypefn {} {@var{mcu} =} getEndian (@var{ar}) +@deftypefn {} {@var{mcu} =} getEndian (@var{ar}) Get the endian used by the connected arduino. - @subsubheading Inputs - @var{ar} - arduino object connected to a arduino board. +@subsubheading Inputs +@var{ar} - arduino object connected to a arduino board. - @subsubheading Outputs - @var{endian} - string representing the endian used by the arduino board. +@subsubheading Outputs +@var{endian} - string representing the endian used by the arduino board. 'L' means little endian, 'B' means big endian - @xseealso{arduino, getMCU} - @end deftypefn +@xseealso{arduino, getMCU} +@end deftypefn @c Arduino Functions @arduino/getI2CTerminals @c ----------------------------------------- @subsection @@arduino/getI2CTerminals @cindex getI2CTerminals - @deftypefn {} {@var{pinlist} =} getI2CTerminals (@var{ar}) - @deftypefnx {} {@var{pinlist} =} getI2CTerminals (@var{ar}, @var{bus}) +@deftypefn {} {@var{pinlist} =} getI2CTerminals (@var{ar}) +@deftypefnx {} {@var{pinlist} =} getI2CTerminals (@var{ar}, @var{bus}) Get a cell list of pin Ids available are used for I2C mode. - @subsubheading Inputs - @var{ar} - the arduino object. +@subsubheading Inputs +@var{ar} - the arduino object. - @var{bus} - optional bus number 0 or 1 for boards that support more than 1 bus. +@var{bus} - optional bus number 0 or 1 for boards that support more than 1 bus. - @subsubheading Outputs - @var{pinlist} - cell list of pin numbers available for I2C use. +@subsubheading Outputs +@var{pinlist} - cell list of pin numbers available for I2C use. - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c Arduino Functions @arduino/getInterruptTerminals @c ----------------------------------------- @subsection @@arduino/getInterruptTerminals @cindex getInterruptTerminals - @deftypefn {} {@var{pinlist} =} getInterruptTerminals (@var{ar}) +@deftypefn {} {@var{pinlist} =} getInterruptTerminals (@var{ar}) Get a cell list of pin Ids available have interrupt functionality - @subsubheading Inputs - @var{ar} - the arduino object. +@subsubheading Inputs +@var{ar} - the arduino object. - @subsubheading Outputs - @var{pinlist} - cell list of pin numbers available for interrupt use. +@subsubheading Outputs +@var{pinlist} - cell list of pin numbers available for interrupt use. - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c Arduino Functions @arduino/getLEDTerminals @c ----------------------------------------- @subsection @@arduino/getLEDTerminals @cindex getLEDTerminals - @deftypefn {} {@var{pinlist} =} getLEDTerminals (@var{ar}) +@deftypefn {} {@var{pinlist} =} getLEDTerminals (@var{ar}) Get a cell list of pin Ids available are connected natively to LEDs. - @subsubheading Inputs - @var{ar} - the arduino object. +@subsubheading Inputs +@var{ar} - the arduino object. - @subsubheading Outputs - @var{pinlist} - cell list of pin numbers available for LED use. +@subsubheading Outputs +@var{pinlist} - cell list of pin numbers available for LED use. - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c Arduino Functions @arduino/getMCU @c ----------------------------------------- @subsection @@arduino/getMCU @cindex getMCU - @deftypefn {} {@var{mcu} =} getMCU (@var{ar}) +@deftypefn {} {@var{mcu} =} getMCU (@var{ar}) Get the MCU used by the connected arduino. - @subsubheading Inputs - @var{ar} - arduino object connected to a arduino board. +@subsubheading Inputs +@var{ar} - arduino object connected to a arduino board. - @subsubheading Outputs - @var{mcu} - string representing the mcu used by the arduino board. +@subsubheading Outputs +@var{mcu} - string representing the mcu used by the arduino board. - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c Arduino Functions @arduino/getPWMTerminals @c ----------------------------------------- @subsection @@arduino/getPWMTerminals @cindex getPWMTerminals - @deftypefn {} {@var{pinlist} =} getPWMTerminals (@var{ar}) +@deftypefn {} {@var{pinlist} =} getPWMTerminals (@var{ar}) Get a cell list of pin Ids available for PWM use. - @subsubheading Inputs - @var{ar} - the arduino object. +@subsubheading Inputs +@var{ar} - the arduino object. - @subsubheading Outputs - @var{pinlist} - cell list of pin numbers available for PWM use. +@subsubheading Outputs +@var{pinlist} - cell list of pin numbers available for PWM use. - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c Arduino Functions @arduino/getPinAlias @c ----------------------------------------- @subsection @@arduino/getPinAlias @cindex getPinAlias - @deftypefn {} {@var{ouy} =} getPinAlias (@var{ar}, @var{pin}) +@deftypefn {} {@var{ouy} =} getPinAlias (@var{ar}, @var{pin}) Get the pin actual pin name from a pin alias. For example, the arduino Leonardo, pin "D4" is also "A6". - @subsubheading Inputs - @var{ar} - the connected arduino object. +@subsubheading Inputs +@var{ar} - the connected arduino object. - @var{pin} - a pin name. +@var{pin} - a pin name. - @subsubheading Outputs - @var{out} - alias pin name, or same as @var{pin} if the pin doesnt have any alias names. +@subsubheading Outputs +@var{out} - alias pin name, or same as @var{pin} if the pin doesnt have any alias names. - @xseealso{arduino, configurePinResource, getResourceOwner} - @end deftypefn +@xseealso{arduino, configurePinResource, getResourceOwner} +@end deftypefn @c Arduino Functions @arduino/getPinInfo @c ----------------------------------------- @subsection @@arduino/getPinInfo @cindex getPinInfo - @deftypefn {} {@var{pininfo} =} getPinInfo (@var{ar}, @var{pin}) - @deftypefnx {} {@var{pininfoarray} =} getPinInfo (@var{ar}, @var{pinarray}) +@deftypefn {} {@var{pininfo} =} getPinInfo (@var{ar}, @var{pin}) +@deftypefnx {} {@var{pininfoarray} =} getPinInfo (@var{ar}, @var{pinarray}) Get the pin information from the input pins values. getPinInfo (@var{ar}, @var{pin}) will get information for a single pin. getPinInfo (@var{ar}, @var{pinarray}) will get a cell array of pin information - @subsubheading Inputs - @var{ar} - the connected arduino object. +@subsubheading Inputs +@var{ar} - the connected arduino object. - @var{pin} - a pin number or pin name. +@var{pin} - a pin number or pin name. - @var{pinarray} - the array of pin numbers or names +@var{pinarray} - the array of pin numbers or names The pininfo struct contains the following fields: - @table @asis - @item terminal +@table @asis +@item terminal Terminal number of the pin - @item name +@item name String name of the pin - @item owner +@item owner Current item owner of the pin - @item mode +@item mode Current configured mode for the pin - @end table +@end table - @subsubheading Outputs - @var{pininfo} - struct on pin information. +@subsubheading Outputs +@var{pininfo} - struct on pin information. - @var{pininfolist} - cell array of pin info +@var{pininfolist} - cell array of pin info - @xseealso{arduino, configurePinResource, getResourceOwner} - @end deftypefn +@xseealso{arduino, configurePinResource, getResourceOwner} +@end deftypefn @c Arduino Functions @arduino/getPinsFromTerminals @c ----------------------------------------- @subsection @@arduino/getPinsFromTerminals @cindex getPinsFromTerminals - @deftypefn {} {@var{pinnames} =} getPinsFromTerminals (@var{ar}, @var{terminals}) +@deftypefn {} {@var{pinnames} =} getPinsFromTerminals (@var{ar}, @var{terminals}) Get the pin names from the input terminal values. - @subsubheading Inputs - @var{ar} - the connected arduino object. +@subsubheading Inputs +@var{ar} - the connected arduino object. - @var{terminals} - the numeric pin number, or array of pin numbers to get pin names. +@var{terminals} - the numeric pin number, or array of pin numbers to get pin names. - @subsubheading Outputs - @var{pinnames} - the string names of each input pin. If terminals was a single value, the return +@subsubheading Outputs +@var{pinnames} - the string names of each input pin. If terminals was a single value, the return will be a single string, otherwise it will return a cell array of each pin name. - @xseealso{arduino, getTerminalsFromPins} - @end deftypefn +@xseealso{arduino, getTerminalsFromPins} +@end deftypefn @c Arduino Functions @arduino/getResourceCount @c ----------------------------------------- @subsection @@arduino/getResourceCount @cindex getResourceCount - @deftypefn {} {@var{count} =} getResourceCount (@var{ar}, @var{resource}) +@deftypefn {} {@var{count} =} getResourceCount (@var{ar}, @var{resource}) Get the count of uses of a given resource. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{resource} - name of resource to get count for. +@var{resource} - name of resource to get count for. - @subsubheading Outputs - @var{count} = count of uses registered to resource. +@subsubheading Outputs +@var{count} = count of uses registered to resource. - @xseealso{incrementResourceCount. decrementResourceCount} - @end deftypefn +@xseealso{incrementResourceCount. decrementResourceCount} +@end deftypefn @c Arduino Functions @arduino/getResourceOwner @c ----------------------------------------- @subsection @@arduino/getResourceOwner @cindex getResourceOwner - @deftypefn {} {@var{owner} =} getResourceOwner (@var{ar}, @var{terminal}) +@deftypefn {} {@var{owner} =} getResourceOwner (@var{ar}, @var{terminal}) Get the owner of pin allocated previously by configurePinResource. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{terminal} - terminal number to get owner of. +@var{terminal} - terminal number to get owner of. - @subsubheading Outputs - @var{owner} = owner of the terminal pin, or "" if not owned. +@subsubheading Outputs +@var{owner} = owner of the terminal pin, or "" if not owned. - @xseealso{configurePinResource} - @end deftypefn +@xseealso{configurePinResource} +@end deftypefn @c Arduino Functions @arduino/getSPITerminals @c ----------------------------------------- @subsection @@arduino/getSPITerminals @cindex getSPITerminals - @deftypefn {} {@var{pinlist} =} getSPITerminals (@var{ar}) +@deftypefn {} {@var{pinlist} =} getSPITerminals (@var{ar}) Get a cell list of pin Ids available for SPI mode. - @subsubheading Inputs - @var{ar} - the arduino object. +@subsubheading Inputs +@var{ar} - the arduino object. - @subsubheading Outputs - @var{pinlist} - cell list of pin numbers available for SPI use. +@subsubheading Outputs +@var{pinlist} - cell list of pin numbers available for SPI use. - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c Arduino Functions @arduino/getServoTerminals @c ----------------------------------------- @subsection @@arduino/getServoTerminals @cindex getServoTerminals - @deftypefn {} {@var{pinlist} =} getServoTerminals (@var{ar}) +@deftypefn {} {@var{pinlist} =} getServoTerminals (@var{ar}) Get a cell list of pin Ids available for servo use. - @subsubheading Inputs - @var{ar} - the arduino object. +@subsubheading Inputs +@var{ar} - the arduino object. - @subsubheading Outputs - @var{pinlist} - cell list of pin numbers available for servo use. +@subsubheading Outputs +@var{pinlist} - cell list of pin numbers available for servo use. - @xseealso{arduino, getPWMTerminals} - @end deftypefn +@xseealso{arduino, getPWMTerminals} +@end deftypefn @c Arduino Functions @arduino/getSharedResourceProperty @c ----------------------------------------- @subsection @@arduino/getSharedResourceProperty @cindex getSharedResourceProperty - @deftypefn {} {@var{count} =} getSharedResourceProperty (@var{ar}, @var{resource}, @var{property}) +@deftypefn {} {@var{count} =} getSharedResourceProperty (@var{ar}, @var{resource}, @var{property}) Get the value of a property from a given resource. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{resource} - name of resource to get property for. +@var{resource} - name of resource to get property for. - @var{property} - name of property from the resource. +@var{property} - name of property from the resource. - @subsubheading Outputs - @var{propvalue} - value of the property +@subsubheading Outputs +@var{propvalue} - value of the property - @xseealso{getResourceCount, setSharedResourceProperty} - @end deftypefn +@xseealso{getResourceCount, setSharedResourceProperty} +@end deftypefn @c Arduino Functions @arduino/getTerminalMode @c ----------------------------------------- @subsection @@arduino/getTerminalMode @cindex getTerminalMode - @deftypefn {} {@var{mode} =} getTerminalMode (@var{ar}, @var{terminal}) +@deftypefn {} {@var{mode} =} getTerminalMode (@var{ar}, @var{terminal}) Get the mode of a pin allocated previously by configurePinResource. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{terminal} - terminal number to get owner of. +@var{terminal} - terminal number to get owner of. - @subsubheading Outputs - @var{mode} - mode of the terminal pin, or "not_set" if not owned. +@subsubheading Outputs +@var{mode} - mode of the terminal pin, or "not_set" if not owned. - @xseealso{configurePinResource, getResourceOwner} - @end deftypefn +@xseealso{configurePinResource, getResourceOwner} +@end deftypefn @c Arduino Functions @arduino/getTerminalsFromPins @c ----------------------------------------- @subsection @@arduino/getTerminalsFromPins @cindex getTerminalsFromPins - @deftypefn {} {@var{pinnums} =} getTerminalsFromPins (@var{ar}, @var{pins}) +@deftypefn {} {@var{pinnums} =} getTerminalsFromPins (@var{ar}, @var{pins}) Get the terminal number for each pin. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{pins} - single pin name or cell or vector array of pin names. +@var{pins} - single pin name or cell or vector array of pin names. - @subsubheading Outputs - @var{pinnums} - pin number of each named pin. If the input was a single string, returns a number. +@subsubheading Outputs +@var{pinnums} - pin number of each named pin. If the input was a single string, returns a number. if the input pins was a vector or cell array, return a cell array of pin numbers corresponding to each input pin name. - @xseealso{arduino, getPinsFromTerminals} - @end deftypefn +@xseealso{arduino, getPinsFromTerminals} +@end deftypefn @c Arduino Functions @arduino/incrementResourceCount @c ----------------------------------------- @subsection @@arduino/incrementResourceCount @cindex incrementResourceCount - @deftypefn {} {@var{count} =} incrementResourceCount (@var{ar}, @var{resource}) +@deftypefn {} {@var{count} =} incrementResourceCount (@var{ar}, @var{resource}) Increment the count value of a named resource by 1 and return the new count - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{resource} - name of resource to increment count. +@var{resource} - name of resource to increment count. - @subsubheading Outputs - @var{count} = count of uses registered to resource. +@subsubheading Outputs +@var{count} = count of uses registered to resource. - @xseealso{getResourceCount. decrementResourceCount} - @end deftypefn +@xseealso{getResourceCount. decrementResourceCount} +@end deftypefn @c Arduino Functions @arduino/isTerminalAnalog @c ----------------------------------------- @subsection @@arduino/isTerminalAnalog @cindex isTerminalAnalog - @deftypefn {} {@var{ret} = } isTerminalAnalog (@var{obj}, @var{terminal}) +@deftypefn {} {@var{ret} = } isTerminalAnalog (@var{obj}, @var{terminal}) Return true if pin is capable of analog input - @subsubheading Inputs - @var{ar} - the connected arduino object +@subsubheading Inputs +@var{ar} - the connected arduino object - @var{terminal} is a terminal number to check +@var{terminal} is a terminal number to check - @subsubheading Outputs - @var{ret} return 1 if terminal is a analog pin, 0 otherwise +@subsubheading Outputs +@var{ret} return 1 if terminal is a analog pin, 0 otherwise - @end deftypefn +@end deftypefn @c Arduino Functions @arduino/isTerminalDigital @c ----------------------------------------- @subsection @@arduino/isTerminalDigital @cindex isTerminalDigital - @deftypefn {} {@var{ret} = } isTerminalDigital(@var{obj}, @var{terminal}) +@deftypefn {} {@var{ret} = } isTerminalDigital(@var{obj}, @var{terminal}) Return true if pin is capable of digital functions - @subsubheading Inputs - @var{ar} - the connected arduino object +@subsubheading Inputs +@var{ar} - the connected arduino object - @var{terminal} is a terminal number to check +@var{terminal} is a terminal number to check - @subsubheading Outputs - @var{ret} return 1 if terminal is a digital pin, 0 otherwise - @end deftypefn +@subsubheading Outputs +@var{ret} return 1 if terminal is a digital pin, 0 otherwise +@end deftypefn @c Arduino Functions @arduino/playTone @c ----------------------------------------- @subsection @@arduino/playTone @cindex playTone - @deftypefn {} {} playTone (@var{ar}, @var{pin}, @var{freq}, @var{duration}) +@deftypefn {} {} playTone (@var{ar}, @var{pin}, @var{freq}, @var{duration}) Play a tone of a given frequency on a specified pin. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{pin} - digital pin to play tone on +@var{pin} - digital pin to play tone on - @var{freq} - frequency in hertz to play between 0 and 32767Hz. +@var{freq} - frequency in hertz to play between 0 and 32767Hz. - @var{duration} duration in seconds to play tone between 0 and 30 seconds +@var{duration} duration in seconds to play tone between 0 and 30 seconds If duration is 0 or not specified, tone will continue to play until next tone is commanded. If frequency is 0, tone will stop playing - @strong{NOTE:} use of playTone can interfere with PWM output. - @end deftypefn +@strong{NOTE:} use of playTone can interfere with PWM output. +@end deftypefn @c Arduino Functions @arduino/readAnalogPin @c ----------------------------------------- @subsection @@arduino/readAnalogPin @cindex readAnalogPin - @deftypefn {} {@var{value} =} readAnalogPin (@var{ar}, @var{pin}) +@deftypefn {} {@var{value} =} readAnalogPin (@var{ar}, @var{pin}) Read analog voltage of @var{pin}. - @subsubheading Inputs - @var{ar} - connected arduino object. +@subsubheading Inputs +@var{ar} - connected arduino object. - @var{pin} - string name of the pin to read. +@var{pin} - string name of the pin to read. - @subsubheading Outputs - @var{value} - analog value of the pin +@subsubheading Outputs +@var{value} - analog value of the pin - @subsubheading Example - @example - @code{ +@subsubheading Example +@example +@code{ ar = arduino (); readAnalogPin(ar, "A4"); ans = 87 } - @end example - @xseealso{arduino, readVoltage} - @end deftypefn +@end example +@xseealso{arduino, readVoltage} +@end deftypefn @c Arduino Functions @arduino/readDigitalPin @c ----------------------------------------- @subsection @@arduino/readDigitalPin @cindex readDigitalPin - @deftypefn {} {@var{value} =} readDigitalPin (@var{obj}, @var{pin}) +@deftypefn {} {@var{value} =} readDigitalPin (@var{obj}, @var{pin}) Read digital value from a digital I/O pin. - @subsubheading Inputs - @var{ar} - connected arduino object. +@subsubheading Inputs +@var{ar} - connected arduino object. - @var{pin} - string name of the pin to read. +@var{pin} - string name of the pin to read. - @subsubheading Outputs - @var{value} - the logical value (0, 1, true false) of the current pin state. +@subsubheading Outputs +@var{value} - the logical value (0, 1, true false) of the current pin state. - @subsubheading Example - @example - @code{ +@subsubheading Example +@example +@code{ a = arduino (); pinvalue = readDigitalPin (a, 'D5'); } - @end example +@end example - @xseealso{arduino, writeDigitalPin} - @end deftypefn +@xseealso{arduino, writeDigitalPin} +@end deftypefn @c Arduino Functions @arduino/readVoltage @c ----------------------------------------- @subsection @@arduino/readVoltage @cindex readVoltage - @deftypefn {} {@var{voltage} =} readVoltage (@var{ar}, @var{pin}) +@deftypefn {} {@var{voltage} =} readVoltage (@var{ar}, @var{pin}) Read analog voltage of a pin. - @subsubheading Inputs - @var{ar} - connected arduino. +@subsubheading Inputs +@var{ar} - connected arduino. - @var{pin} - pin name or number to query for voltage +@var{pin} - pin name or number to query for voltage - @subsubheading Outputs - @var{voltage} - scaled pin value as a voltage +@subsubheading Outputs +@var{voltage} - scaled pin value as a voltage - @subsubheading Example - @example - @code{ +@subsubheading Example +@example +@code{ ar = arduino (); readVoltage(ar, "A4"); ans = 1.401 } - @end example - @xseealso{arduino, readAnalogPin} - @end deftypefn +@end example +@xseealso{arduino, readAnalogPin} +@end deftypefn @c Arduino Functions @arduino/reset @c ----------------------------------------- @subsection @@arduino/reset @cindex reset - @deftypefn {} {} reset (@var{ar}) +@deftypefn {} {} reset (@var{ar}) Send reset command to arduino hardware to force a hardware reset. - @subsubheading Inputs - @var{ar} - connected arduino object. +@subsubheading Inputs +@var{ar} - connected arduino object. - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c Arduino Functions @arduino/sendCommand @c ----------------------------------------- @subsection @@arduino/sendCommand @cindex sendCommand - @deftypefn {} {@var{outdata, outsize} =} sendCommand (@var{ar}, @var{libname}, @var{commandid}) - @deftypefnx {} {@var{outdata, outsize} =} sendCommand (@var{ar}, @var{libname}, @var{commandid}, @var{data}) - @deftypefnx {} {@var{outdata, outsize} =} sendCommand (@var{ar}, @var{libname}, @var{commandid}, @var{data}, @var{timeout}) +@deftypefn {} {@var{outdata, outsize} =} sendCommand (@var{ar}, @var{libname}, @var{commandid}) +@deftypefnx {} {@var{outdata, outsize} =} sendCommand (@var{ar}, @var{libname}, @var{commandid}, @var{data}) +@deftypefnx {} {@var{outdata, outsize} =} sendCommand (@var{ar}, @var{libname}, @var{commandid}, @var{data}, @var{timeout}) Send a command with option data to the connected arduino, waiting up to a specified number of seconds for a response. - @subsubheading Inputs - @var{ar} - connected arduino object. +@subsubheading Inputs +@var{ar} - connected arduino object. - @var{libname} - library sending the command. The name should match a programmed +@var{libname} - library sending the command. The name should match a programmed library of the arduino, or an error will be displayed. - @var{commandid} - integer value for the command being sent to the arduino. +@var{commandid} - integer value for the command being sent to the arduino. - @var{data} - optional data sent with the command. +@var{data} - optional data sent with the command. - @var{timeout} - optional timeout to wait for data +@var{timeout} - optional timeout to wait for data - @subsubheading Outputs - @var{outdata} - data returned back from the arduino in response to command +@subsubheading Outputs +@var{outdata} - data returned back from the arduino in response to command - @var{outsize} - size of data received +@var{outsize} - size of data received If the arduino fails to respond with a valid reply, sendCommand will error. - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c Arduino Functions @arduino/setSharedResourceProperty @c ----------------------------------------- @subsection @@arduino/setSharedResourceProperty @cindex setSharedResourceProperty - @deftypefn {} {} setSharedResourceProperty (@var{ar}, @var{resource}, @var{propname}, @var{propvalue}) - @deftypefnx {} {} setSharedResourceProperty (@var{ar}, @var{resource}, @var{propname}, @var{propvalue}, ___) +@deftypefn {} {} setSharedResourceProperty (@var{ar}, @var{resource}, @var{propname}, @var{propvalue}) +@deftypefnx {} {} setSharedResourceProperty (@var{ar}, @var{resource}, @var{propname}, @var{propvalue}, ___) Set property values for a given resource. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{resource} - name of resource to get property for. +@var{resource} - name of resource to get property for. - @var{propname} - name of property from the resource. +@var{propname} - name of property from the resource. - @var{propvalue} - value of property from the resource. +@var{propvalue} - value of property from the resource. Multiple @var{propname}, @var{propvalue} pairs can be given. - @subsubheading Outputs +@subsubheading Outputs None - @subsubheading Example - @example - @code{ +@subsubheading Example +@example +@code{ ar = arduino(); setSharedResourceProperty(ar, "myresource", "myproperty", [1 2 3]) } - @end example +@end example - @xseealso{getSharedResourceProperty} - @end deftypefn +@xseealso{getSharedResourceProperty} +@end deftypefn @c Arduino Functions @arduino/uptime @c ----------------------------------------- @subsection @@arduino/uptime @cindex uptime - @deftypefn {} {@var{sec} =} uptime (@var{ar}) +@deftypefn {} {@var{sec} =} uptime (@var{ar}) Get the number of seconds the arduino board has been running concurrently. - @subsubheading Inputs - @var{ar} - the arduino object of the connection to an arduino board. +@subsubheading Inputs +@var{ar} - the arduino object of the connection to an arduino board. - @subsubheading Outputs - @var{sec} - the number seconds the board has been running. Note that the count will wrap around after +@subsubheading Outputs +@var{sec} - the number seconds the board has been running. Note that the count will wrap around after approximately 50 days. - @xseealso{arduino} +@xseealso{arduino} - @end deftypefn +@end deftypefn @c Arduino Functions @arduino/validatePin @c ----------------------------------------- @subsection @@arduino/validatePin @cindex validatePin - @deftypefn {} {} validatePin (@var{ar}, @var{pin}, @var{type}) +@deftypefn {} {} validatePin (@var{ar}, @var{pin}, @var{type}) Validate that the mode is allowed for specified pin If the mode is not valid, and error will be thrown. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{pin} - name of pin to query mode validity of +@var{pin} - name of pin to query mode validity of - @var{mode} - mode to query +@var{mode} - mode to query Known modes are: - @itemize @bullet - @item 'I2C' - @item 'SPI' - @item 'PWM' - @item 'Servo' - @item 'analog' - @item 'digital' - - @end itemize - - @xseealso{arduino, configurePin} - @end deftypefn +@itemize @bullet +@item 'I2C' +@item 'SPI' +@item 'PWM' +@item 'Servo' +@item 'analog' +@item 'digital' + +@end itemize + +@xseealso{arduino, configurePin} +@end deftypefn @c Arduino Functions @arduino/version @c ----------------------------------------- @subsection @@arduino/version @cindex version - @deftypefn {} {@var{ver} =} version (@var{ar}) +@deftypefn {} {@var{ver} =} version (@var{ar}) Get version of library code installed on arduino board - @subsubheading Inputs - @var{ar} - the arduino object of the connection to an arduino board. +@subsubheading Inputs +@var{ar} - the arduino object of the connection to an arduino board. - @subsubheading Outputs - @var{ver} - version string in format of X.Y.Z. +@subsubheading Outputs +@var{ver} - version string in format of X.Y.Z. - @xseealso{arduino} +@xseealso{arduino} - @end deftypefn +@end deftypefn @c Arduino Functions @arduino/writeDigitalPin @c ----------------------------------------- @subsection @@arduino/writeDigitalPin @cindex writeDigitalPin - @deftypefn {} {} writeDigitalPin (@var{ar}, @var{pin}, @var{value}) +@deftypefn {} {} writeDigitalPin (@var{ar}, @var{pin}, @var{value}) Write digital value to a digital I/O pin. - @subsubheading Inputs - @var{ar} - connected arduino object. +@subsubheading Inputs +@var{ar} - connected arduino object. - @var{pin} - string name of the pin to write to. +@var{pin} - string name of the pin to write to. - @var{value} - the logical value (0, 1, true false) to write to the pin. +@var{value} - the logical value (0, 1, true false) to write to the pin. If pin was unconfigured before using, pin is set into digital mode. - @subsubheading Example - @example - @code{ +@subsubheading Example +@example +@code{ a = arduino(); writeDigitalPin(a,'D5',1); } - @end example +@end example - @xseealso{arduino, readDigitalPin} +@xseealso{arduino, readDigitalPin} - @end deftypefn +@end deftypefn @c Arduino Functions @arduino/writePWMDutyCycle @c ----------------------------------------- @subsection @@arduino/writePWMDutyCycle @cindex writePWMDutyCycle - @deftypefn {} {} writePWMDutyCyle (@var{ar}, @var{pin}, @var{value}) +@deftypefn {} {} writePWMDutyCyle (@var{ar}, @var{pin}, @var{value}) Set pin to output a square wave with a specified duty cycle. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{pin} - pin to write to. +@var{pin} - pin to write to. - @var{value} - duty cycle value where 0 = off, 0.5 = 50% on, 1 = always on. +@var{value} - duty cycle value where 0 = off, 0.5 = 50% on, 1 = always on. - @subsubheading Example - @example - @code{ +@subsubheading Example +@example +@code{ a = arduino(); writePWMDutyCycle(a,'D5',0.5); } - @end example +@end example - @xseealso{arduino, writePWMVoltage} +@xseealso{arduino, writePWMVoltage} - @end deftypefn +@end deftypefn @c Arduino Functions @arduino/writePWMVoltage @c ----------------------------------------- @subsection @@arduino/writePWMVoltage @cindex writePWMVoltage - @deftypefn {} {} writePWMVoltage (@var{ar}, @var{pin}, @var{voltage}) +@deftypefn {} {} writePWMVoltage (@var{ar}, @var{pin}, @var{voltage}) Emulate an approximate voltage out of a pin using PWM. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{pin} - pin to write to. +@var{pin} - pin to write to. - @var{voltage} - voltage to emulate with PWM, between 0 - 5.0 +@var{voltage} - voltage to emulate with PWM, between 0 - 5.0 - @subsubheading Example - @example - @code{ +@subsubheading Example +@example +@code{ a = arduino(); writePWMVoltage(a,'D5',1.0); } - @end example +@end example - @xseealso{arduino, writePWMDutyCycle} - @end deftypefn +@xseealso{arduino, writePWMDutyCycle} +@end deftypefn @c --------------------------------------------------- @node Arduino I2C Functions @section Arduino I2C Functions @@ -1030,322 +1030,322 @@ @c ----------------------------------------- @subsection @@device/delete @cindex delete - @deftypefn {} {} delete (@var{dev}) +@deftypefn {} {} delete (@var{dev}) Free resources of a device object. - @subsubheading Inputs - @var{dev} - object to free +@subsubheading Inputs +@var{dev} - object to free - @xseealso{device} - @end deftypefn +@xseealso{device} +@end deftypefn @c Arduino I2C Functions @device/display @c ----------------------------------------- @subsection @@device/display @cindex display - @deftypefn {} {} display (@var{dev}) +@deftypefn {} {} display (@var{dev}) Display device object. - @subsubheading Inputs - @var{dev} - device object to display +@subsubheading Inputs +@var{dev} - device object to display - @xseealso{device} - @end deftypefn +@xseealso{device} +@end deftypefn @c Arduino I2C Functions @device/read @c ----------------------------------------- @subsection @@device/read @cindex read - @deftypefn {} {@var{data} =} read (@var{dev}, @var{numbytes}) - @deftypefnx {} {@var{data} =} read (@var{dev}, @var{numbytes}, @var{precision}) +@deftypefn {} {@var{data} =} read (@var{dev}, @var{numbytes}) +@deftypefnx {} {@var{data} =} read (@var{dev}, @var{numbytes}, @var{precision}) Read a specified number of bytes from a i2c or serial device object using optional precision for bytesize. - @subsubheading Inputs - @var{dev} - connected i2c or serial device opened using device +@subsubheading Inputs +@var{dev} - connected i2c or serial device opened using device - @var{numbytes} - number of bytes to read. +@var{numbytes} - number of bytes to read. - @var{precision} - Optional precision for the output data read data. +@var{precision} - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 - @subsubheading Outputs - @var{data} - data read from the device +@subsubheading Outputs +@var{data} - data read from the device - @xseealso{arduino, device} - @end deftypefn +@xseealso{arduino, device} +@end deftypefn @c Arduino I2C Functions @device/readRegister @c ----------------------------------------- @subsection @@device/readRegister @cindex readRegister - @deftypefn {} {@var{data} =} readRegister (@var{dev}, @var{reg}, @var{numbytes}) - @deftypefnx {} {@var{data} =} readRegister (@var{dev}, @var{reg}, @var{numbytes}, @var{precision}) +@deftypefn {} {@var{data} =} readRegister (@var{dev}, @var{reg}, @var{numbytes}) +@deftypefnx {} {@var{data} =} readRegister (@var{dev}, @var{reg}, @var{numbytes}, @var{precision}) Read a specified number of bytes from a register of an i2cdev object using optional precision for bytesize. - @subsubheading Inputs - @var{dev} - connected i2c device opened using device +@subsubheading Inputs +@var{dev} - connected i2c device opened using device - @var{reg} - registry value number +@var{reg} - registry value number - @var{numbytes} - number of bytes to read. +@var{numbytes} - number of bytes to read. - @var{precision} - Optional precision for the output data read data. +@var{precision} - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 - @subsubheading Output - @var{data} - data read from device. +@subsubheading Output +@var{data} - data read from device. - @xseealso{arduino, device} - @end deftypefn +@xseealso{arduino, device} +@end deftypefn @c Arduino I2C Functions @device/subsref @c ----------------------------------------- @subsection @@device/subsref @cindex subsref - @deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) +@deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) subref for device - @xseealso{device} - @end deftypefn +@xseealso{device} +@end deftypefn @c Arduino I2C Functions @device/write @c ----------------------------------------- @subsection @@device/write @cindex write - @deftypefn {} {} write (@var{dev}, @var{datain}) - @deftypefnx {} {} write (@var{dev}, @var{datain}, @var{precision}) +@deftypefn {} {} write (@var{dev}, @var{datain}) +@deftypefnx {} {} write (@var{dev}, @var{datain}, @var{precision}) Write data to a I2C or serial device object using optional precision for the data byte used for the data. - @subsubheading Inputs - @var{dev} - connected i2c or serial device opened using device +@subsubheading Inputs +@var{dev} - connected i2c or serial device opened using device - @var{datain} - data to write to device. Datasize should not exceed the constraints +@var{datain} - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. - @var{precision} - Optional precision for the input write data. +@var{precision} - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 - @xseealso{arduino, device, read} - @end deftypefn +@xseealso{arduino, device, read} +@end deftypefn @c Arduino I2C Functions @device/writeRegister @c ----------------------------------------- @subsection @@device/writeRegister @cindex writeRegister - @deftypefn {} {} writeRegister (@var{dev}, @var{reg}, @var{datain}) - @deftypefnx {} {} writeRegister (@var{dev}, @var{dev}, @var{datain}, @var{precision}) +@deftypefn {} {} writeRegister (@var{dev}, @var{reg}, @var{datain}) +@deftypefnx {} {} writeRegister (@var{dev}, @var{dev}, @var{datain}, @var{precision}) Write data to i2c device object at a given registry position using optional precision for the data byte used for the data. - @subsubheading Inputs - @var{dev} - connected i2c device opened using device +@subsubheading Inputs +@var{dev} - connected i2c device opened using device - @var{reg} - registry position to write to. +@var{reg} - registry position to write to. - @var{datain} - data to write to device. Datasize should not exceed the constraints +@var{datain} - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. - @var{precision} - Optional precision for the input write data. +@var{precision} - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 - @xseealso{arduino, device, read} - @end deftypefn +@xseealso{arduino, device, read} +@end deftypefn @c Arduino I2C Functions @i2cdev/delete @c ----------------------------------------- @subsection @@i2cdev/delete @cindex delete - @deftypefn {} {} delete (@var{dev}) +@deftypefn {} {} delete (@var{dev}) Free resources of a i2cdev object. - @subsubheading Inputs - @var{dev} - object to free +@subsubheading Inputs +@var{dev} - object to free - @xseealso{i2cdev} - @end deftypefn +@xseealso{i2cdev} +@end deftypefn @c Arduino I2C Functions @i2cdev/display @c ----------------------------------------- @subsection @@i2cdev/display @cindex display - @deftypefn {} {} display (@var{dev}) +@deftypefn {} {} display (@var{dev}) Display i2cdev object. - @subsubheading Inputs - @var{dev} - i2cdev object +@subsubheading Inputs +@var{dev} - i2cdev object - @xseealso{i2cdev} - @end deftypefn +@xseealso{i2cdev} +@end deftypefn @c Arduino I2C Functions @i2cdev/i2cdev @c ----------------------------------------- @subsection @@i2cdev/i2cdev @cindex i2cdev - @deftypefn {} {@var{dev} =} i2cdev (@var{ar}, @var{address}) - @deftypefnx {} {@var{dev} =} i2cdev (@var{ar}, @var{address}, @var{propname}, @var{propvalue}) +@deftypefn {} {@var{dev} =} i2cdev (@var{ar}, @var{address}) +@deftypefnx {} {@var{dev} =} i2cdev (@var{ar}, @var{address}, @var{propname}, @var{propvalue}) - @code{i2cdev} is depreciated and will be removed in a future version. +@code{i2cdev} is depreciated and will be removed in a future version. Use @code{device} instead. Create an i2cdev object to communicate to the i2c port on a connected arduino. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{address} - address to use for device on I2C bus. +@var{address} - address to use for device on I2C bus. - @var{propname}, @var{propvalue} - property name/value pair for values to pass to devices. +@var{propname}, @var{propvalue} - property name/value pair for values to pass to devices. Currently known properties: - @table @asis - @item bus +@table @asis +@item bus bus number (when arduino board supports multiple I2C buses) with value of 0 or 1. - @end table +@end table - @subsubheading Outputs - @var{dev} - new created i2cdev object. +@subsubheading Outputs +@var{dev} - new created i2cdev object. - @subsubheading Properties +@subsubheading Properties The i2cdev object has the following public properties: - @table @asis - @item parent +@table @asis +@item parent The parent (arduino) for this device - @item pins +@item pins pins used by this object - @item bus +@item bus bus used for created object - @item address +@item address I2C address set for object - @end table +@end table - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c Arduino I2C Functions @i2cdev/read @c ----------------------------------------- @subsection @@i2cdev/read @cindex read - @deftypefn {} {@var{data} =} read (@var{dev}, @var{numbytes}) - @deftypefnx {} {@var{data} =} read (@var{dev}, @var{numbytes}, @var{precision}) +@deftypefn {} {@var{data} =} read (@var{dev}, @var{numbytes}) +@deftypefnx {} {@var{data} =} read (@var{dev}, @var{numbytes}, @var{precision}) Read a specified number of bytes from a i2cdev object using optional precision for bytesize. - @subsubheading Inputs - @var{dev} - connected i2c device opened using i2cdev +@subsubheading Inputs +@var{dev} - connected i2c device opened using i2cdev - @var{numbytes} - number of bytes to read. +@var{numbytes} - number of bytes to read. - @var{precision} - Optional precision for the output data read data. +@var{precision} - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 - @subsubheading Outputs - @var{data} - data read from i2cdevice +@subsubheading Outputs +@var{data} - data read from i2cdevice - @xseealso{arduino, i2cdev} - @end deftypefn +@xseealso{arduino, i2cdev} +@end deftypefn @c Arduino I2C Functions @i2cdev/readRegister @c ----------------------------------------- @subsection @@i2cdev/readRegister @cindex readRegister - @deftypefn {} {@var{data} =} readRegister (@var{dev}, @var{reg}, @var{numbytes}) - @deftypefnx {} {@var{data} =} readRegister (@var{dev}, @var{reg}, @var{numbytes}, @var{precision}) +@deftypefn {} {@var{data} =} readRegister (@var{dev}, @var{reg}, @var{numbytes}) +@deftypefnx {} {@var{data} =} readRegister (@var{dev}, @var{reg}, @var{numbytes}, @var{precision}) Read a specified number of bytes from a register of an i2cdev object using optional precision for bytesize. - @subsubheading Inputs - @var{dev} - connected i2c device opened using i2cdev +@subsubheading Inputs +@var{dev} - connected i2c device opened using i2cdev - @var{reg} - registry value number +@var{reg} - registry value number - @var{numbytes} - number of bytes to read. +@var{numbytes} - number of bytes to read. - @var{precision} - Optional precision for the output data read data. +@var{precision} - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 - @subsubheading Output - @var{data} - data read from device. +@subsubheading Output +@var{data} - data read from device. - @xseealso{arduino, i2cdev} - @end deftypefn +@xseealso{arduino, i2cdev} +@end deftypefn @c Arduino I2C Functions @i2cdev/subsref @c ----------------------------------------- @subsection @@i2cdev/subsref @cindex subsref - @deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) +@deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) subref for i2cdev - @xseealso{i2cdev} - @end deftypefn +@xseealso{i2cdev} +@end deftypefn @c Arduino I2C Functions @i2cdev/write @c ----------------------------------------- @subsection @@i2cdev/write @cindex write - @deftypefn {} {} write (@var{dev}, @var{datain}) - @deftypefnx {} {} write (@var{dev}, @var{datain}, @var{precision}) +@deftypefn {} {} write (@var{dev}, @var{datain}) +@deftypefnx {} {} write (@var{dev}, @var{datain}, @var{precision}) Write data to a i2cdev object using optional precision for the data byte used for the data. - @subsubheading Inputs - @var{dev} - connected i2c device opened using i2cdev +@subsubheading Inputs +@var{dev} - connected i2c device opened using i2cdev - @var{datain} - data to write to device. Datasize should not exceed the constraints +@var{datain} - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. - @var{precision} - Optional precision for the input write data. +@var{precision} - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 - @xseealso{arduino, i2cdev, read} - @end deftypefn +@xseealso{arduino, i2cdev, read} +@end deftypefn @c Arduino I2C Functions @i2cdev/writeRegister @c ----------------------------------------- @subsection @@i2cdev/writeRegister @cindex writeRegister - @deftypefn {} {} writeRegister (@var{dev}, @var{reg}, @var{datain}) - @deftypefnx {} {} writeRegister (@var{dev}, @var{dev}, @var{datain}, @var{precision}) +@deftypefn {} {} writeRegister (@var{dev}, @var{reg}, @var{datain}) +@deftypefnx {} {} writeRegister (@var{dev}, @var{dev}, @var{datain}, @var{precision}) Write data to i2cdev object at a given registry position using optional precision for the data byte used for the data. - @subsubheading Inputs - @var{dev} - connected i2c device opened using i2cdev +@subsubheading Inputs +@var{dev} - connected i2c device opened using i2cdev - @var{reg} - registry position to write to. +@var{reg} - registry position to write to. - @var{datain} - data to write to device. Datasize should not exceed the constraints +@var{datain} - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. - @var{precision} - Optional precision for the input write data. +@var{precision} - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 - @xseealso{arduino, i2cdev, read} - @end deftypefn +@xseealso{arduino, i2cdev, read} +@end deftypefn @c Arduino I2C Functions scanI2Cbus @c ----------------------------------------- @subsection scanI2Cbus @cindex scanI2Cbus - @deftypefn {} {@var{retval} =} scanI2Cbus (@var{ar}) - @deftypefnx {} {@var{retval} =} scanI2Cbus (@var{ar}, @var{bus}) +@deftypefn {} {@var{retval} =} scanI2Cbus (@var{ar}) +@deftypefnx {} {@var{retval} =} scanI2Cbus (@var{ar}, @var{bus}) Scan arduino for devices on the I2C bus. - @subsubheading Inputs - @var{ar} - arduino object connected to a arduino board. +@subsubheading Inputs +@var{ar} - arduino object connected to a arduino board. - @var{bus} - bus number to scan I2C devices, when multiple buses are available. +@var{bus} - bus number to scan I2C devices, when multiple buses are available. If the bus is not specified, it will default to 0. - @subsubheading Outputs - @var{retval} - cell array of addresses as strings in format of "0xXX". +@subsubheading Outputs +@var{retval} - cell array of addresses as strings in format of "0xXX". - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { # create arduino connection. ar = arduino(); # scan for devices on the I2C bus scanI2Cbus (ar) # output is each detected i2c address as a string ans = - @{ +@{ [1,1] = 0x50 - @} +@} } - @end example +@end example - @xseealso{arduino, i2cdev, checkI2CAddress} - @end deftypefn +@xseealso{arduino, i2cdev, checkI2CAddress} +@end deftypefn @c --------------------------------------------------- @node Arduino Rotary Encoder Functions @section Arduino Rotary Encoder Functions @@ -1354,130 +1354,130 @@ @c ----------------------------------------- @subsection @@rotaryEncoder/delete @cindex delete - @deftypefn {} {} delete (@var{dev}) +@deftypefn {} {} delete (@var{dev}) Free resources of a encoder object. - @subsubheading Inputs - @var{dev} - object to free +@subsubheading Inputs +@var{dev} - object to free - @xseealso{rotartEncoder} - @end deftypefn +@xseealso{rotartEncoder} +@end deftypefn @c Arduino Rotary Encoder Functions @rotaryEncoder/display @c ----------------------------------------- @subsection @@rotaryEncoder/display @cindex display - @deftypefn {} {@var{retval} =} display (@var{obj}) +@deftypefn {} {@var{retval} =} display (@var{obj}) Display the rotary encoder object in a verbose way, - @subsubheading Inputs - @var{obj} - the arduino rotary encoder object created with rotaryEncoder +@subsubheading Inputs +@var{obj} - the arduino rotary encoder object created with rotaryEncoder - @xseealso{rotaryEncoder} - @end deftypefn +@xseealso{rotaryEncoder} +@end deftypefn @c Arduino Rotary Encoder Functions @rotaryEncoder/readCount @c ----------------------------------------- @subsection @@rotaryEncoder/readCount @cindex readCount - @deftypefn {} {[@var{count}, @var{time}] =} readCount (@var{obj}) - @deftypefnx {} {[@var{count}, @var{time}] =} readCount (@var{obj}, @var{name}, @var{value}) +@deftypefn {} {[@var{count}, @var{time}] =} readCount (@var{obj}) +@deftypefnx {} {[@var{count}, @var{time}] =} readCount (@var{obj}, @var{name}, @var{value}) read count value from the rotary encoder. subsubheading Inputs - @var{obj} - rotary encoder object created with rotaryEncoder call. +@var{obj} - rotary encoder object created with rotaryEncoder call. - @var{name}, @var{value} - optional name,value pairs +@var{name}, @var{value} - optional name,value pairs Valid option name pairs currently are: - @table @asis - @item reset +@table @asis +@item reset Reset the count after reading (if true) - @end table +@end table - @subsubheading Outputs - @var{count} - returned count read from the encoder. +@subsubheading Outputs +@var{count} - returned count read from the encoder. - @var{time} - seconds since arduino started +@var{time} - seconds since arduino started - @xseealso{rotaryEncoder, resetCount} - @end deftypefn +@xseealso{rotaryEncoder, resetCount} +@end deftypefn @c Arduino Rotary Encoder Functions @rotaryEncoder/readSpeed @c ----------------------------------------- @subsection @@rotaryEncoder/readSpeed @cindex readSpeed - @deftypefn {} {@var{speed} =} readSpeed (@var{obj}) +@deftypefn {} {@var{speed} =} readSpeed (@var{obj}) read rotational speed from the rotary encoder. - @subsubheading Inputs - @var{obj} - rotary encoder object created with rotaryEncoder call. +@subsubheading Inputs +@var{obj} - rotary encoder object created with rotaryEncoder call. - @subsubheading Outputs - @var{speed} - returned speed in revolutions per minute read from the encoder. +@subsubheading Outputs +@var{speed} - returned speed in revolutions per minute read from the encoder. - @xseealso{rotaryEncoder, resetCount} - @end deftypefn +@xseealso{rotaryEncoder, resetCount} +@end deftypefn @c Arduino Rotary Encoder Functions @rotaryEncoder/resetCount @c ----------------------------------------- @subsection @@rotaryEncoder/resetCount @cindex resetCount - @deftypefn {} reset (@var{obj}) - @deftypefnx {} reset (@var{obj}, @var{cnt}) +@deftypefn {} reset (@var{obj}) +@deftypefnx {} reset (@var{obj}, @var{cnt}) reset the rotary encoder count values - @subsubheading Inputs - @var{obj} - the rotaryEncoder object +@subsubheading Inputs +@var{obj} - the rotaryEncoder object - @var{cnt} - optional count value to reset to +@var{cnt} - optional count value to reset to - @xseealso{rotaryEncoder, readCount} - @end deftypefn +@xseealso{rotaryEncoder, readCount} +@end deftypefn @c Arduino Rotary Encoder Functions @rotaryEncoder/rotaryEncoder @c ----------------------------------------- @subsection @@rotaryEncoder/rotaryEncoder @cindex rotaryEncoder - @deftypefn {} {@var{obj} =} rotaryEncoder (@var{ar}, @var{chanApin}, @var{chanBpin}) - @deftypefnx {} {@var{obj} =} rotaryEncoder (@var{ar}, @var{chanApin}, @var{chanBpin}, @var{ppr}) +@deftypefn {} {@var{obj} =} rotaryEncoder (@var{ar}, @var{chanApin}, @var{chanBpin}) +@deftypefnx {} {@var{obj} =} rotaryEncoder (@var{ar}, @var{chanApin}, @var{chanBpin}, @var{ppr}) Create a rotaryEncoder object controlled by the input pins. - @subsubheading Inputs - @var{ar} - connected arduino object. +@subsubheading Inputs +@var{ar} - connected arduino object. - @var{chanApin} - pin used for channel A +@var{chanApin} - pin used for channel A - @var{chanBpin} - pin used for channel B +@var{chanBpin} - pin used for channel B - @var{ppr} - count of encoder pulsed required for a full revolution of the encoder. +@var{ppr} - count of encoder pulsed required for a full revolution of the encoder. - @subsubheading Outputs - @var{obj} - created rotary encoder object +@subsubheading Outputs +@var{obj} - created rotary encoder object - @subsubheading Example - @example +@subsubheading Example +@example a = arduino (); enc = rotaryEncoder(a, "d2", "d3", 180); - @end example +@end example - @subsubheading Properties +@subsubheading Properties The rotaryEncoder object has the following public properties: - @table @asis - @item parent +@table @asis +@item parent The parent (arduino) for this device - @item pins +@item pins pins used by this object - @item ppr +@item ppr Number of pulses used per rotation - @end table +@end table - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c Arduino Rotary Encoder Functions @rotaryEncoder/subsref @c ----------------------------------------- @subsection @@rotaryEncoder/subsref @cindex subsref - @deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) +@deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) subref for rotaryEncoder - @xseealso{rotaryEncoder} - @end deftypefn +@xseealso{rotaryEncoder} +@end deftypefn @c --------------------------------------------------- @node Arduino Servo Functions @section Arduino Servo Functions @@ -1486,118 +1486,118 @@ @c ----------------------------------------- @subsection @@servo/delete @cindex delete - @deftypefn {} {} delete (@var{dev}) +@deftypefn {} {} delete (@var{dev}) Free resources of a servo object. - @subsubheading Inputs - @var{dev} - object to free +@subsubheading Inputs +@var{dev} - object to free - @xseealso{servo} - @end deftypefn +@xseealso{servo} +@end deftypefn @c Arduino Servo Functions @servo/display @c ----------------------------------------- @subsection @@servo/display @cindex display - @deftypefn {} {} display (@var{dev}) +@deftypefn {} {} display (@var{dev}) Display servo object. - @subsubheading Inputs - @var{dev} - device to display +@subsubheading Inputs +@var{dev} - device to display - @xseealso{servo} - @end deftypefn +@xseealso{servo} +@end deftypefn @c Arduino Servo Functions @servo/readPosition @c ----------------------------------------- @subsection @@servo/readPosition @cindex readPosition - @deftypefn {} {@var{position} = } readPosition (@var{servo}) +@deftypefn {} {@var{position} = } readPosition (@var{servo}) Read the position of a servo - @subsubheading Inputs - @var{servo} - servo object created from arduino.servo. +@subsubheading Inputs +@var{servo} - servo object created from arduino.servo. - @subsubheading Outputs - @var{position} - value between 0 .. 1 for the current servo position, +@subsubheading Outputs +@var{position} - value between 0 .. 1 for the current servo position, where 0 is the servo min position, 1 is the servo maximum position. - @xseealso{servo, writePosition} - @end deftypefn +@xseealso{servo, writePosition} +@end deftypefn @c Arduino Servo Functions @servo/servo @c ----------------------------------------- @subsection @@servo/servo @cindex servo - @deftypefn {} {@var{obj} = } servo (@var{arduinoobj}, @var{pin}) - @deftypefnx {} {@var{obj} = } servo (@var{arduinoobj}, @var{pin}, @var{propertyname}, @var{propertyvalue}) +@deftypefn {} {@var{obj} = } servo (@var{arduinoobj}, @var{pin}) +@deftypefnx {} {@var{obj} = } servo (@var{arduinoobj}, @var{pin}, @var{propertyname}, @var{propertyvalue}) Create a servo object using a specified pin on a arduino board. - @subsubheading Inputs - @var{obj} - servo object +@subsubheading Inputs +@var{obj} - servo object - @var{arduinoobj} - connected arduino object +@var{arduinoobj} - connected arduino object - @var{propertyname}, @var{propertyvalue} - name value pairs for properties to pass +@var{propertyname}, @var{propertyvalue} - name value pairs for properties to pass to the created servo object. Current properties are: - @table @asis - @item minpulseduration +@table @asis +@item minpulseduration min PWM pulse value in seconds. - @item maxpulseduration +@item maxpulseduration max PWM pulse value in seconds. - @end table +@end table - @subsubheading Outputs - @var{obj} - created servo object. +@subsubheading Outputs +@var{obj} - created servo object. - @subsubheading Example - @example +@subsubheading Example +@example # create arduino connection ar = arduino(); # create hobby servo (1 - 2 ms pulse range) servo = servo(ar, "d9", "minpulseduration", 1.0e-3, "maxpulseduration", 2e-3); # center the servo writePosition(servo, 0.5); - @end example +@end example - @subsubheading Properties +@subsubheading Properties The servo object has the following public properties: - @table @asis - @item parent +@table @asis +@item parent The parent (arduino) for this device - @item pins +@item pins pins used by this object - @item minpulseduration +@item minpulseduration minpulseduration set for object - @item maxpulseduration +@item maxpulseduration maxpulseduration set for object - @end table +@end table - @xseealso{arduino, readPosition, writePosition} - @end deftypefn +@xseealso{arduino, readPosition, writePosition} +@end deftypefn @c Arduino Servo Functions @servo/subsref @c ----------------------------------------- @subsection @@servo/subsref @cindex subsref - @deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) +@deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) subref for servo - @xseealso{servo} - @end deftypefn +@xseealso{servo} +@end deftypefn @c Arduino Servo Functions @servo/writePosition @c ----------------------------------------- @subsection @@servo/writePosition @cindex writePosition - @deftypefn {} {} writePosition (@var{servo}, @var{position}) +@deftypefn {} {} writePosition (@var{servo}, @var{position}) Write the position to a servo. - @subsubheading Inputs - @var{servo} - servo object created from arduino.servo. +@subsubheading Inputs +@var{servo} - servo object created from arduino.servo. - @var{position} - value between 0 .. 1 for the current servo position, +@var{position} - value between 0 .. 1 for the current servo position, where 0 is the servo min position, 1 is the servo maximum position. - @xseealso{servo, readPosition} - @end deftypefn +@xseealso{servo, readPosition} +@end deftypefn @c --------------------------------------------------- @node Arduino Shiftregister Functions @section Arduino Shiftregister Functions @@ -1606,145 +1606,145 @@ @c ----------------------------------------- @subsection @@shiftRegister/delete @cindex delete - @deftypefn {} {} delete (@var{dev}) +@deftypefn {} {} delete (@var{dev}) Free resources of a shiftRegister object. - @subsubheading Inputs - @var{dev} - object to free +@subsubheading Inputs +@var{dev} - object to free - @xseealso{shiftRegister} - @end deftypefn +@xseealso{shiftRegister} +@end deftypefn @c Arduino Shiftregister Functions @shiftRegister/display @c ----------------------------------------- @subsection @@shiftRegister/display @cindex display - @deftypefn {} {@var{retval} =} display (@var{register}) +@deftypefn {} {@var{retval} =} display (@var{register}) Display the register object in a verbose way, - @subsubheading Inputs - @var{register} - the arduino register object created with shiftRegister. +@subsubheading Inputs +@var{register} - the arduino register object created with shiftRegister. - @xseealso{shiftRegister} - @end deftypefn +@xseealso{shiftRegister} +@end deftypefn @c Arduino Shiftregister Functions @shiftRegister/read @c ----------------------------------------- @subsection @@shiftRegister/read @cindex read - @deftypefn {} {@var{retval} =} read (@var{register}) - @deftypefnx {} {@var{retval} =} read (@var{register}, @var{precision}) +@deftypefn {} {@var{retval} =} read (@var{register}) +@deftypefnx {} {@var{retval} =} read (@var{register}, @var{precision}) read a value from the shift register. - @subsubheading Inputs - @var{register} - shift register created from shiftRegister call. +@subsubheading Inputs +@var{register} - shift register created from shiftRegister call. - @var{precision} - optional precision of the data, where precision can be a +@var{precision} - optional precision of the data, where precision can be a number in a multiple of 8 (ie: 8,16,32) or can be a named integer type: 8 of 'uint8', 'uint16', 'uint32'. The default precision is 8. - @subsubheading Outputs - @var{retval} - returned data read from the register. +@subsubheading Outputs +@var{retval} - returned data read from the register. - @xseealso{shiftRegister, write} - @end deftypefn +@xseealso{shiftRegister, write} +@end deftypefn @c Arduino Shiftregister Functions @shiftRegister/reset @c ----------------------------------------- @subsection @@shiftRegister/reset @cindex reset - @deftypefn {} reset (@var{register}) +@deftypefn {} reset (@var{register}) clear the shift register value. - @subsubheading Inputs - @var{register} - shift register created from shiftRegister call. +@subsubheading Inputs +@var{register} - shift register created from shiftRegister call. - @xseealso{shiftRegister, read, write} - @end deftypefn +@xseealso{shiftRegister, read, write} +@end deftypefn @c Arduino Shiftregister Functions @shiftRegister/shiftRegister @c ----------------------------------------- @subsection @@shiftRegister/shiftRegister @cindex shiftRegister - @deftypefn {} {@var{register} =} shiftRegister (@var{ar}, @var{shifttype}, @var{dataPin}, @var{clockPin} ...) - @deftypefnx {} {@var{register} =} shiftRegister (@var{ar},'74hc164', @var{dataPin}, @var{clockPin}, @var{resetPin}) - @deftypefnx {} {@var{register} =} shiftRegister (@var{ar},'74hc165', @var{dataPin}, @var{clockPin}, @var{loadPin}, @var{clockEnablePin}) - @deftypefnx {} {@var{register} =} shiftRegister(@var{ar},'74hc595', @var{dataPin}, @var{clockPin}, @var{latchPin} , @var{resetPin}) +@deftypefn {} {@var{register} =} shiftRegister (@var{ar}, @var{shifttype}, @var{dataPin}, @var{clockPin} ...) +@deftypefnx {} {@var{register} =} shiftRegister (@var{ar},'74hc164', @var{dataPin}, @var{clockPin}, @var{resetPin}) +@deftypefnx {} {@var{register} =} shiftRegister (@var{ar},'74hc165', @var{dataPin}, @var{clockPin}, @var{loadPin}, @var{clockEnablePin}) +@deftypefnx {} {@var{register} =} shiftRegister(@var{ar},'74hc595', @var{dataPin}, @var{clockPin}, @var{latchPin} , @var{resetPin}) Create shift register of a given type, controlled by the input pins. - @subsubheading Inputs +@subsubheading Inputs Common function parameter definition: - @var{ar} - connected arduino object. +@var{ar} - connected arduino object. - @var{shifttype} - string name of the shift register type. +@var{shifttype} - string name of the shift register type. - @var{dataPin} - pin used for data in/out of the device. +@var{dataPin} - pin used for data in/out of the device. - @var{clockPin} - pin used for clocking data on the shiftRegister. +@var{clockPin} - pin used for clocking data on the shiftRegister. Other variables are dependent on the shift register type: - @table @asis - @item '74hc164' +@table @asis +@item '74hc164' Additional inputs: - @var{resetPin} - optional pin for resetting the shift register. +@var{resetPin} - optional pin for resetting the shift register. - @item '74hc165' +@item '74hc165' Additional inputs: - @var{loadPin} - load pin to the shift register. - @var{clockEnablePin} - clock enable pin. +@var{loadPin} - load pin to the shift register. +@var{clockEnablePin} - clock enable pin. - @item '74hc595' +@item '74hc595' Additional inputs: - @var{latchPin} - latching data to the shift register. - @var{resetPin} - optional pin for resetting the shift register. +@var{latchPin} - latching data to the shift register. +@var{resetPin} - optional pin for resetting the shift register. - @end table +@end table - @subsubheading Outputs - @var{register} - register object +@subsubheading Outputs +@var{register} - register object - @subsubheading Properties +@subsubheading Properties The shiftRegister object has the following public properties: - @table @asis - @item parent +@table @asis +@item parent The parent (arduino) for this device - @item pins +@item pins pins used by this object - @item model +@item model model set for object - @end table +@end table - @xseealso{arduino} - @end deftypefn +@xseealso{arduino} +@end deftypefn @c Arduino Shiftregister Functions @shiftRegister/subsref @c ----------------------------------------- @subsection @@shiftRegister/subsref @cindex subsref - @deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) +@deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) subref for shiftRegister - @xseealso{shiftRegister} - @end deftypefn +@xseealso{shiftRegister} +@end deftypefn @c Arduino Shiftregister Functions @shiftRegister/write @c ----------------------------------------- @subsection @@shiftRegister/write @cindex write - @deftypefn {} write (@var{register}, @var{dataIn}) - @deftypefnx {} write (@var{register}, @var{dataIn}, @var{precision}) +@deftypefn {} write (@var{register}, @var{dataIn}) +@deftypefnx {} write (@var{register}, @var{dataIn}, @var{precision}) Write a value to the shift register. - @subsubheading Inputs - @var{register} - shift register created from shiftRegister call. +@subsubheading Inputs +@var{register} - shift register created from shiftRegister call. - @var{dataIn} - data to clock into the shiftRegister. +@var{dataIn} - data to clock into the shiftRegister. - @var{precision} - optional precision of the data, where precision can be a +@var{precision} - optional precision of the data, where precision can be a number in a multiple of 8 (ie: 8,16,32) or can be a named integer type of 'uint8', 'uint16', 'uint32'. The default precision is 8. - @xseealso{shiftRegister, read} - @end deftypefn +@xseealso{shiftRegister, read} +@end deftypefn @c --------------------------------------------------- @node Arduino SPI Functions @section Arduino SPI Functions @@ -1753,155 +1753,155 @@ @c ----------------------------------------- @subsection @@device/delete @cindex delete - @deftypefn {} {} delete (@var{dev}) +@deftypefn {} {} delete (@var{dev}) Free resources of a device object. - @subsubheading Inputs - @var{dev} - object to free +@subsubheading Inputs +@var{dev} - object to free - @xseealso{device} - @end deftypefn +@xseealso{device} +@end deftypefn @c Arduino SPI Functions @device/display @c ----------------------------------------- @subsection @@device/display @cindex display - @deftypefn {} {} display (@var{dev}) +@deftypefn {} {} display (@var{dev}) Display device object. - @subsubheading Inputs - @var{dev} - device object to display +@subsubheading Inputs +@var{dev} - device object to display - @xseealso{device} - @end deftypefn +@xseealso{device} +@end deftypefn @c Arduino SPI Functions @device/subsref @c ----------------------------------------- @subsection @@device/subsref @cindex subsref - @deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) +@deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) subref for device - @xseealso{device} - @end deftypefn +@xseealso{device} +@end deftypefn @c Arduino SPI Functions @device/writeRead @c ----------------------------------------- @subsection @@device/writeRead @cindex writeRead - @deftypefn {} {@var{dataOut} =} readWrite (@var{spi}, @var{dataIn}) +@deftypefn {} {@var{dataOut} =} readWrite (@var{spi}, @var{dataIn}) Write uint8 data to spi device and return back clocked out response data of same size. - @subsubheading Inputs - @var{spi} - connected spi device on arduino +@subsubheading Inputs +@var{spi} - connected spi device on arduino - @var{dataIn} - uint8 sized data to send to spi device framed between SS frame. +@var{dataIn} - uint8 sized data to send to spi device framed between SS frame. - @subsubheading Outputs - @var{dataOut} - uint8 data clocked out during send to dataIn. +@subsubheading Outputs +@var{dataOut} - uint8 data clocked out during send to dataIn. - @xseealso{arduino, device} - @end deftypefn +@xseealso{arduino, device} +@end deftypefn @c Arduino SPI Functions @spidev/delete @c ----------------------------------------- @subsection @@spidev/delete @cindex delete - @deftypefn {} {} delete (@var{dev}) +@deftypefn {} {} delete (@var{dev}) Free resources of a spidev object. - @subsubheading Inputs - @var{dev} - spidev object to free +@subsubheading Inputs +@var{dev} - spidev object to free - @xseealso{spidev} - @end deftypefn +@xseealso{spidev} +@end deftypefn @c Arduino SPI Functions @spidev/display @c ----------------------------------------- @subsection @@spidev/display @cindex display - @deftypefn {} {} display (@var{dev}) +@deftypefn {} {} display (@var{dev}) Display spidev object. - @subsubheading Inputs - @var{dev} - spidev object to display +@subsubheading Inputs +@var{dev} - spidev object to display - @xseealso{spidev} - @end deftypefn +@xseealso{spidev} +@end deftypefn @c Arduino SPI Functions @spidev/spidev @c ----------------------------------------- @subsection @@spidev/spidev @cindex spidev - @deftypefn {} {@var{dev} =} spidev (@var{ar}, @var{cspin}) - @deftypefnx {} {@var{dev} =} spidev (@var{ar}, @var{cspin}, @var{propname}, @var{propvalue}) +@deftypefn {} {@var{dev} =} spidev (@var{ar}, @var{cspin}) +@deftypefnx {} {@var{dev} =} spidev (@var{ar}, @var{cspin}, @var{propname}, @var{propvalue}) - @code{spidev} is depreciated and will be removed in a future version. +@code{spidev} is depreciated and will be removed in a future version. Use @code{device} instead. Create an spidev object to communicate to the SPI port on a connected arduino. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{cspin} - chip select pin for attached spi device. +@var{cspin} - chip select pin for attached spi device. - @var{propname}, @var{propvalue} - property name/value pair for values to pass to devices. +@var{propname}, @var{propvalue} - property name/value pair for values to pass to devices. Currently known properties: - @table @asis - @item bitrate +@table @asis +@item bitrate bit rate speed in Mbs - @item bitorder +@item bitorder 'msbfirst' or 'lsbfirst' - @item mode +@item mode SPI mode 0 - 3. - @end table +@end table - @subsubheading Outputs - @var{dev} - created spidev object +@subsubheading Outputs +@var{dev} - created spidev object - @subsubheading Properties +@subsubheading Properties The spidev object has the following public properties: - @table @asis - @item parent +@table @asis +@item parent The parent (arduino) for this device - @item pins +@item pins pins used by this object - @item mode +@item mode mode used for created object - @item bitrate +@item bitrate Bitrate set for object - @item bitorder +@item bitorder Bitorder set for object - @item chipselectpin +@item chipselectpin Pin used for chipselect - @end table +@end table - @xseealso{arduino, readWrite} - @end deftypefn +@xseealso{arduino, readWrite} +@end deftypefn @c Arduino SPI Functions @spidev/subsref @c ----------------------------------------- @subsection @@spidev/subsref @cindex subsref - @deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) +@deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) subref for spidev - @xseealso{spidev} - @end deftypefn +@xseealso{spidev} +@end deftypefn @c Arduino SPI Functions @spidev/writeRead @c ----------------------------------------- @subsection @@spidev/writeRead @cindex writeRead - @deftypefn {} {@var{dataOut} =} readWrite (@var{spi}, @var{dataIn}) +@deftypefn {} {@var{dataOut} =} readWrite (@var{spi}, @var{dataIn}) Write uint8 data to spi device and return back clocked out response data of same size. - @subsubheading Inputs - @var{spi} - connected spi device on arduino +@subsubheading Inputs +@var{spi} - connected spi device on arduino - @var{dataIn} - uint8 sized data to send to spi device framed between SS frame. +@var{dataIn} - uint8 sized data to send to spi device framed between SS frame. - @subsubheading Outputs - @var{dataOut} - uint8 data clocked out during send to dataIn. +@subsubheading Outputs +@var{dataOut} - uint8 data clocked out during send to dataIn. - @xseealso{arduino, spidev} - @end deftypefn +@xseealso{arduino, spidev} +@end deftypefn @c --------------------------------------------------- @node Arduino Serial Functions @section Arduino Serial Functions @@ -1910,225 +1910,225 @@ @c ----------------------------------------- @subsection @@device/delete @cindex delete - @deftypefn {} {} delete (@var{dev}) +@deftypefn {} {} delete (@var{dev}) Free resources of a device object. - @subsubheading Inputs - @var{dev} - object to free +@subsubheading Inputs +@var{dev} - object to free - @xseealso{device} - @end deftypefn +@xseealso{device} +@end deftypefn @c Arduino Serial Functions @device/device @c ----------------------------------------- @subsection @@device/device @cindex device - @deftypefn {} {@var{dev} =} device (@var{ar}, 'I2CAddress', @var{address}) - @deftypefnx {} {@var{dev} =} device (@var{ar}, 'SPIChipSelectPin', @var{pin}) - @deftypefnx {} {@var{dev} =} device (@var{ar}, 'Serial', @var{serialid}) - @deftypefnx {} {@var{dev} =} device (..., @var{propname}, @var{propvalue}) +@deftypefn {} {@var{dev} =} device (@var{ar}, 'I2CAddress', @var{address}) +@deftypefnx {} {@var{dev} =} device (@var{ar}, 'SPIChipSelectPin', @var{pin}) +@deftypefnx {} {@var{dev} =} device (@var{ar}, 'Serial', @var{serialid}) +@deftypefnx {} {@var{dev} =} device (..., @var{propname}, @var{propvalue}) Create an i2c, spi or serial object to communicate on a connected arduino. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{propname}, @var{propvalue} - property name/value pair for values to pass to devices. +@var{propname}, @var{propvalue} - property name/value pair for values to pass to devices. A property of 'i2caddress', 'spichipselectpin' or 'serial' must be specified to denote the device type to create. - @var{i2caddress} - address to use for device on I2C bus. +@var{i2caddress} - address to use for device on I2C bus. - @var{pin} - pin to use for device SPI chip select. +@var{pin} - pin to use for device SPI chip select. - @var{serialid} - Serial port id to use +@var{serialid} - Serial port id to use Additional properties can also be specified for the device object Currently known input I2C properties values: - @table @asis - @item bus +@table @asis +@item bus bus number (when arduino board supports multiple I2C buses) with value of 0 or 1. - @item noprobe +@item noprobe Do not probe the existence of device on creation if set to 1 (default 0) - @item bitrate +@item bitrate bit rate speed in Mbs - default 100000 - @end table +@end table Currently known input SPI properties values: - @table @asis - @item bitrate +@table @asis +@item bitrate bit rate speed in Mbs - @item bitorder +@item bitorder 'msbfirst' or 'lsbfirst' - @item spimode +@item spimode SPI mode 0 - 3. - @end table +@end table Currently known input Serial properties values: - @table @asis - @item baudrate +@table @asis +@item baudrate baudrate value (default 9600) - @item databits +@item databits number of databits (5,6,7,8) (default 8) - @item stopbits +@item stopbits number of stopbits (1,2) (default 1) - @item parity +@item parity parity of device ('odd','even','none') (default 'none') - @end table +@end table - @subsubheading Outputs - @var{dev} - new created device object. +@subsubheading Outputs +@var{dev} - new created device object. - @subsubheading Properties +@subsubheading Properties The object has the following public properties: - @table @asis - @item parent +@table @asis +@item parent The parent (arduino) for this device - @item interface +@item interface The interface type for this device ("SPI" or "I2C" or "Serial") - @end table +@end table In addition, depending on type, the object will have these properties: - @subsubheading I2C Properties +@subsubheading I2C Properties The object has the following public properties: - @table @asis - @item bus +@table @asis +@item bus bus used for created object - @item i2caddress +@item i2caddress I2C address set for object - @item sclpin +@item sclpin the SCL pin of the device - @item sdapin +@item sdapin the SDA pin of the device - @item bitrate +@item bitrate bit rate for the i2c clock - @end table +@end table - @subsubheading SPI Properties +@subsubheading SPI Properties The object has the following public properties: - @table @asis - @item spimode +@table @asis +@item spimode mode used for created object - @item bitrate +@item bitrate Bitrate set for object - @item bitorder +@item bitorder Bitorder set for object - @item spichipselectpin +@item spichipselectpin Pin used for chipselect - @item mosipin +@item mosipin Pin used for mosi - @item misopin +@item misopin Pin used for miso - @item sckpin +@item sckpin Pin used for sckpin - @end table +@end table - @subsubheading Serial Properties +@subsubheading Serial Properties The object has the following public properties: - @table @asis - @item id +@table @asis +@item id serial port id - @item baudrate +@item baudrate baudrate - @item databits +@item databits number of databits (5,6,7,8) - @item stopbits +@item stopbits number of stopbits (1,2) - @item parity +@item parity parity of device ('odd','even','none') - @end table +@end table - @xseealso{arduino, i2cdev, spidev} - @end deftypefn +@xseealso{arduino, i2cdev, spidev} +@end deftypefn @c Arduino Serial Functions @device/display @c ----------------------------------------- @subsection @@device/display @cindex display - @deftypefn {} {} display (@var{dev}) +@deftypefn {} {} display (@var{dev}) Display device object. - @subsubheading Inputs - @var{dev} - device object to display +@subsubheading Inputs +@var{dev} - device object to display - @xseealso{device} - @end deftypefn +@xseealso{device} +@end deftypefn @c Arduino Serial Functions @device/flush @c ----------------------------------------- @subsection @@device/flush @cindex flush - @deftypefn {} {@var{data} =} flush (@var{dev}) - @deftypefnx {} {@var{data} =} flush (@var{dev}, "input") - @deftypefnx {} {@var{data} =} flush (@var{dev}, "output") +@deftypefn {} {@var{data} =} flush (@var{dev}) +@deftypefnx {} {@var{data} =} flush (@var{dev}, "input") +@deftypefnx {} {@var{data} =} flush (@var{dev}, "output") Flush the serial port buffers - @subsubheading Inputs - @var{dev} - connected serial device opened using device +@subsubheading Inputs +@var{dev} - connected serial device opened using device If an additional parameter is provided of "input" or "output", then only the input or output buffer will be flushed - @subsubheading Outputs +@subsubheading Outputs None - @xseealso{arduino, device, read} - @end deftypefn +@xseealso{arduino, device, read} +@end deftypefn @c Arduino Serial Functions @device/read @c ----------------------------------------- @subsection @@device/read @cindex read - @deftypefn {} {@var{data} =} read (@var{dev}, @var{numbytes}) - @deftypefnx {} {@var{data} =} read (@var{dev}, @var{numbytes}, @var{precision}) +@deftypefn {} {@var{data} =} read (@var{dev}, @var{numbytes}) +@deftypefnx {} {@var{data} =} read (@var{dev}, @var{numbytes}, @var{precision}) Read a specified number of bytes from a i2c or serial device object using optional precision for bytesize. - @subsubheading Inputs - @var{dev} - connected i2c or serial device opened using device +@subsubheading Inputs +@var{dev} - connected i2c or serial device opened using device - @var{numbytes} - number of bytes to read. +@var{numbytes} - number of bytes to read. - @var{precision} - Optional precision for the output data read data. +@var{precision} - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 - @subsubheading Outputs - @var{data} - data read from the device +@subsubheading Outputs +@var{data} - data read from the device - @xseealso{arduino, device} - @end deftypefn +@xseealso{arduino, device} +@end deftypefn @c Arduino Serial Functions @device/subsref @c ----------------------------------------- @subsection @@device/subsref @cindex subsref - @deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) +@deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) subref for device - @xseealso{device} - @end deftypefn +@xseealso{device} +@end deftypefn @c Arduino Serial Functions @device/write @c ----------------------------------------- @subsection @@device/write @cindex write - @deftypefn {} {} write (@var{dev}, @var{datain}) - @deftypefnx {} {} write (@var{dev}, @var{datain}, @var{precision}) +@deftypefn {} {} write (@var{dev}, @var{datain}) +@deftypefnx {} {} write (@var{dev}, @var{datain}, @var{precision}) Write data to a I2C or serial device object using optional precision for the data byte used for the data. - @subsubheading Inputs - @var{dev} - connected i2c or serial device opened using device +@subsubheading Inputs +@var{dev} - connected i2c or serial device opened using device - @var{datain} - data to write to device. Datasize should not exceed the constraints +@var{datain} - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. - @var{precision} - Optional precision for the input write data. +@var{precision} - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 - @xseealso{arduino, device, read} - @end deftypefn +@xseealso{arduino, device, read} +@end deftypefn @c --------------------------------------------------- @node Arduino Device Functions @section Arduino Device Functions @@ -2137,289 +2137,289 @@ @c ----------------------------------------- @subsection @@device/delete @cindex delete - @deftypefn {} {} delete (@var{dev}) +@deftypefn {} {} delete (@var{dev}) Free resources of a device object. - @subsubheading Inputs - @var{dev} - object to free +@subsubheading Inputs +@var{dev} - object to free - @xseealso{device} - @end deftypefn +@xseealso{device} +@end deftypefn @c Arduino Device Functions @device/device @c ----------------------------------------- @subsection @@device/device @cindex device - @deftypefn {} {@var{dev} =} device (@var{ar}, 'I2CAddress', @var{address}) - @deftypefnx {} {@var{dev} =} device (@var{ar}, 'SPIChipSelectPin', @var{pin}) - @deftypefnx {} {@var{dev} =} device (@var{ar}, 'Serial', @var{serialid}) - @deftypefnx {} {@var{dev} =} device (..., @var{propname}, @var{propvalue}) +@deftypefn {} {@var{dev} =} device (@var{ar}, 'I2CAddress', @var{address}) +@deftypefnx {} {@var{dev} =} device (@var{ar}, 'SPIChipSelectPin', @var{pin}) +@deftypefnx {} {@var{dev} =} device (@var{ar}, 'Serial', @var{serialid}) +@deftypefnx {} {@var{dev} =} device (..., @var{propname}, @var{propvalue}) Create an i2c, spi or serial object to communicate on a connected arduino. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{propname}, @var{propvalue} - property name/value pair for values to pass to devices. +@var{propname}, @var{propvalue} - property name/value pair for values to pass to devices. A property of 'i2caddress', 'spichipselectpin' or 'serial' must be specified to denote the device type to create. - @var{i2caddress} - address to use for device on I2C bus. +@var{i2caddress} - address to use for device on I2C bus. - @var{pin} - pin to use for device SPI chip select. +@var{pin} - pin to use for device SPI chip select. - @var{serialid} - Serial port id to use +@var{serialid} - Serial port id to use Additional properties can also be specified for the device object Currently known input I2C properties values: - @table @asis - @item bus +@table @asis +@item bus bus number (when arduino board supports multiple I2C buses) with value of 0 or 1. - @item noprobe +@item noprobe Do not probe the existence of device on creation if set to 1 (default 0) - @item bitrate +@item bitrate bit rate speed in Mbs - default 100000 - @end table +@end table Currently known input SPI properties values: - @table @asis - @item bitrate +@table @asis +@item bitrate bit rate speed in Mbs - @item bitorder +@item bitorder 'msbfirst' or 'lsbfirst' - @item spimode +@item spimode SPI mode 0 - 3. - @end table +@end table Currently known input Serial properties values: - @table @asis - @item baudrate +@table @asis +@item baudrate baudrate value (default 9600) - @item databits +@item databits number of databits (5,6,7,8) (default 8) - @item stopbits +@item stopbits number of stopbits (1,2) (default 1) - @item parity +@item parity parity of device ('odd','even','none') (default 'none') - @end table +@end table - @subsubheading Outputs - @var{dev} - new created device object. +@subsubheading Outputs +@var{dev} - new created device object. - @subsubheading Properties +@subsubheading Properties The object has the following public properties: - @table @asis - @item parent +@table @asis +@item parent The parent (arduino) for this device - @item interface +@item interface The interface type for this device ("SPI" or "I2C" or "Serial") - @end table +@end table In addition, depending on type, the object will have these properties: - @subsubheading I2C Properties +@subsubheading I2C Properties The object has the following public properties: - @table @asis - @item bus +@table @asis +@item bus bus used for created object - @item i2caddress +@item i2caddress I2C address set for object - @item sclpin +@item sclpin the SCL pin of the device - @item sdapin +@item sdapin the SDA pin of the device - @item bitrate +@item bitrate bit rate for the i2c clock - @end table +@end table - @subsubheading SPI Properties +@subsubheading SPI Properties The object has the following public properties: - @table @asis - @item spimode +@table @asis +@item spimode mode used for created object - @item bitrate +@item bitrate Bitrate set for object - @item bitorder +@item bitorder Bitorder set for object - @item spichipselectpin +@item spichipselectpin Pin used for chipselect - @item mosipin +@item mosipin Pin used for mosi - @item misopin +@item misopin Pin used for miso - @item sckpin +@item sckpin Pin used for sckpin - @end table +@end table - @subsubheading Serial Properties +@subsubheading Serial Properties The object has the following public properties: - @table @asis - @item id +@table @asis +@item id serial port id - @item baudrate +@item baudrate baudrate - @item databits +@item databits number of databits (5,6,7,8) - @item stopbits +@item stopbits number of stopbits (1,2) - @item parity +@item parity parity of device ('odd','even','none') - @end table +@end table - @xseealso{arduino, i2cdev, spidev} - @end deftypefn +@xseealso{arduino, i2cdev, spidev} +@end deftypefn @c Arduino Device Functions @device/display @c ----------------------------------------- @subsection @@device/display @cindex display - @deftypefn {} {} display (@var{dev}) +@deftypefn {} {} display (@var{dev}) Display device object. - @subsubheading Inputs - @var{dev} - device object to display +@subsubheading Inputs +@var{dev} - device object to display - @xseealso{device} - @end deftypefn +@xseealso{device} +@end deftypefn @c Arduino Device Functions @device/flush @c ----------------------------------------- @subsection @@device/flush @cindex flush - @deftypefn {} {@var{data} =} flush (@var{dev}) - @deftypefnx {} {@var{data} =} flush (@var{dev}, "input") - @deftypefnx {} {@var{data} =} flush (@var{dev}, "output") +@deftypefn {} {@var{data} =} flush (@var{dev}) +@deftypefnx {} {@var{data} =} flush (@var{dev}, "input") +@deftypefnx {} {@var{data} =} flush (@var{dev}, "output") Flush the serial port buffers - @subsubheading Inputs - @var{dev} - connected serial device opened using device +@subsubheading Inputs +@var{dev} - connected serial device opened using device If an additional parameter is provided of "input" or "output", then only the input or output buffer will be flushed - @subsubheading Outputs +@subsubheading Outputs None - @xseealso{arduino, device, read} - @end deftypefn +@xseealso{arduino, device, read} +@end deftypefn @c Arduino Device Functions @device/read @c ----------------------------------------- @subsection @@device/read @cindex read - @deftypefn {} {@var{data} =} read (@var{dev}, @var{numbytes}) - @deftypefnx {} {@var{data} =} read (@var{dev}, @var{numbytes}, @var{precision}) +@deftypefn {} {@var{data} =} read (@var{dev}, @var{numbytes}) +@deftypefnx {} {@var{data} =} read (@var{dev}, @var{numbytes}, @var{precision}) Read a specified number of bytes from a i2c or serial device object using optional precision for bytesize. - @subsubheading Inputs - @var{dev} - connected i2c or serial device opened using device +@subsubheading Inputs +@var{dev} - connected i2c or serial device opened using device - @var{numbytes} - number of bytes to read. +@var{numbytes} - number of bytes to read. - @var{precision} - Optional precision for the output data read data. +@var{precision} - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 - @subsubheading Outputs - @var{data} - data read from the device +@subsubheading Outputs +@var{data} - data read from the device - @xseealso{arduino, device} - @end deftypefn +@xseealso{arduino, device} +@end deftypefn @c Arduino Device Functions @device/readRegister @c ----------------------------------------- @subsection @@device/readRegister @cindex readRegister - @deftypefn {} {@var{data} =} readRegister (@var{dev}, @var{reg}, @var{numbytes}) - @deftypefnx {} {@var{data} =} readRegister (@var{dev}, @var{reg}, @var{numbytes}, @var{precision}) +@deftypefn {} {@var{data} =} readRegister (@var{dev}, @var{reg}, @var{numbytes}) +@deftypefnx {} {@var{data} =} readRegister (@var{dev}, @var{reg}, @var{numbytes}, @var{precision}) Read a specified number of bytes from a register of an i2cdev object using optional precision for bytesize. - @subsubheading Inputs - @var{dev} - connected i2c device opened using device +@subsubheading Inputs +@var{dev} - connected i2c device opened using device - @var{reg} - registry value number +@var{reg} - registry value number - @var{numbytes} - number of bytes to read. +@var{numbytes} - number of bytes to read. - @var{precision} - Optional precision for the output data read data. +@var{precision} - Optional precision for the output data read data. Currently known precision values are uint8 (default), int8, uint16, int16 - @subsubheading Output - @var{data} - data read from device. +@subsubheading Output +@var{data} - data read from device. - @xseealso{arduino, device} - @end deftypefn +@xseealso{arduino, device} +@end deftypefn @c Arduino Device Functions @device/subsref @c ----------------------------------------- @subsection @@device/subsref @cindex subsref - @deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) +@deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) subref for device - @xseealso{device} - @end deftypefn +@xseealso{device} +@end deftypefn @c Arduino Device Functions @device/write @c ----------------------------------------- @subsection @@device/write @cindex write - @deftypefn {} {} write (@var{dev}, @var{datain}) - @deftypefnx {} {} write (@var{dev}, @var{datain}, @var{precision}) +@deftypefn {} {} write (@var{dev}, @var{datain}) +@deftypefnx {} {} write (@var{dev}, @var{datain}, @var{precision}) Write data to a I2C or serial device object using optional precision for the data byte used for the data. - @subsubheading Inputs - @var{dev} - connected i2c or serial device opened using device +@subsubheading Inputs +@var{dev} - connected i2c or serial device opened using device - @var{datain} - data to write to device. Datasize should not exceed the constraints +@var{datain} - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. - @var{precision} - Optional precision for the input write data. +@var{precision} - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 - @xseealso{arduino, device, read} - @end deftypefn +@xseealso{arduino, device, read} +@end deftypefn @c Arduino Device Functions @device/writeRead @c ----------------------------------------- @subsection @@device/writeRead @cindex writeRead - @deftypefn {} {@var{dataOut} =} readWrite (@var{spi}, @var{dataIn}) +@deftypefn {} {@var{dataOut} =} readWrite (@var{spi}, @var{dataIn}) Write uint8 data to spi device and return back clocked out response data of same size. - @subsubheading Inputs - @var{spi} - connected spi device on arduino +@subsubheading Inputs +@var{spi} - connected spi device on arduino - @var{dataIn} - uint8 sized data to send to spi device framed between SS frame. +@var{dataIn} - uint8 sized data to send to spi device framed between SS frame. - @subsubheading Outputs - @var{dataOut} - uint8 data clocked out during send to dataIn. +@subsubheading Outputs +@var{dataOut} - uint8 data clocked out during send to dataIn. - @xseealso{arduino, device} - @end deftypefn +@xseealso{arduino, device} +@end deftypefn @c Arduino Device Functions @device/writeRegister @c ----------------------------------------- @subsection @@device/writeRegister @cindex writeRegister - @deftypefn {} {} writeRegister (@var{dev}, @var{reg}, @var{datain}) - @deftypefnx {} {} writeRegister (@var{dev}, @var{dev}, @var{datain}, @var{precision}) +@deftypefn {} {} writeRegister (@var{dev}, @var{reg}, @var{datain}) +@deftypefnx {} {} writeRegister (@var{dev}, @var{dev}, @var{datain}, @var{precision}) Write data to i2c device object at a given registry position using optional precision for the data byte used for the data. - @subsubheading Inputs - @var{dev} - connected i2c device opened using device +@subsubheading Inputs +@var{dev} - connected i2c device opened using device - @var{reg} - registry position to write to. +@var{reg} - registry position to write to. - @var{datain} - data to write to device. Datasize should not exceed the constraints +@var{datain} - data to write to device. Datasize should not exceed the constraints of the data type specified for the precision. - @var{precision} - Optional precision for the input write data. +@var{precision} - Optional precision for the input write data. Currently known precision values are uint8 (default), int8, uint16, int16 - @xseealso{arduino, device, read} - @end deftypefn +@xseealso{arduino, device, read} +@end deftypefn @c --------------------------------------------------- @node Arduino Ultrasonic Functions @section Arduino Ultrasonic Functions @@ -2428,109 +2428,109 @@ @c ----------------------------------------- @subsection @@ultrasonic/delete @cindex delete - @deftypefn {} {} delete (@var{dev}) +@deftypefn {} {} delete (@var{dev}) Free resources of a ultrasonic object. - @subsubheading Inputs - @var{dev} - ultrasonic object to free +@subsubheading Inputs +@var{dev} - ultrasonic object to free - @xseealso{ultrasonic} - @end deftypefn +@xseealso{ultrasonic} +@end deftypefn @c Arduino Ultrasonic Functions @ultrasonic/display @c ----------------------------------------- @subsection @@ultrasonic/display @cindex display - @deftypefn {} {} display (@var{dev}) +@deftypefn {} {} display (@var{dev}) Display ultrasonic object. - @subsubheading Inputs - @var{dev} - ultrasonic object to display +@subsubheading Inputs +@var{dev} - ultrasonic object to display - @xseealso{ultrasonic} - @end deftypefn +@xseealso{ultrasonic} +@end deftypefn @c Arduino Ultrasonic Functions @ultrasonic/readDistance @c ----------------------------------------- @subsection @@ultrasonic/readDistance @cindex readDistance - @deftypefn {} {@var{distance} =} readDistance (@var{dev}) +@deftypefn {} {@var{distance} =} readDistance (@var{dev}) Read the distance from a ultrasonic device - @subsubheading Inputs - @var{dev} - connected ultrasonic device opened using ultrasonic +@subsubheading Inputs +@var{dev} - connected ultrasonic device opened using ultrasonic - @subsubheading Outputs - @var{distance} - distance value in meters from the ultrasonic device, or Inf if out of sensor range +@subsubheading Outputs +@var{distance} - distance value in meters from the ultrasonic device, or Inf if out of sensor range - @xseealso{arduino, ultrasonic} - @end deftypefn +@xseealso{arduino, ultrasonic} +@end deftypefn @c Arduino Ultrasonic Functions @ultrasonic/readEchoTime @c ----------------------------------------- @subsection @@ultrasonic/readEchoTime @cindex readEchoTime - @deftypefn {} {@var{time} =} readEchoTime (@var{dev}) +@deftypefn {} {@var{time} =} readEchoTime (@var{dev}) Measure the time for waves to reflect back to the ultrasonic device - @subsubheading Inputs - @var{dev} - connected ultrasonic device opened using ultrasonic() +@subsubheading Inputs +@var{dev} - connected ultrasonic device opened using ultrasonic() - @subsubheading Outputs - @var{time} - time in seconds, or Inf if out of sensor range +@subsubheading Outputs +@var{time} - time in seconds, or Inf if out of sensor range - @xseealso{arduino, ultrasonic} - @end deftypefn +@xseealso{arduino, ultrasonic} +@end deftypefn @c Arduino Ultrasonic Functions @ultrasonic/subsref @c ----------------------------------------- @subsection @@ultrasonic/subsref @cindex subsref - @deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) +@deftypefn {} {@var{val} = } subsref (@var{dev}, @var{sub}) subref for ultrasonic - @xseealso{ultrasonic} - @end deftypefn +@xseealso{ultrasonic} +@end deftypefn @c Arduino Ultrasonic Functions @ultrasonic/ultrasonic @c ----------------------------------------- @subsection @@ultrasonic/ultrasonic @cindex ultrasonic - @deftypefn {} {@var{dev} =} ultrasonic (@var{ar}, @var{triggerpin}) - @deftypefnx {} {@var{dev} =} ultrasonic (@var{ar}, @var{triggerpin}, @var{echopin}) - @deftypefnx {} {@var{dev} =} ultrasonic (@var{ar}, @var{triggerpin}, @var{echopin}, @var{propname}, @var{propvalue}) +@deftypefn {} {@var{dev} =} ultrasonic (@var{ar}, @var{triggerpin}) +@deftypefnx {} {@var{dev} =} ultrasonic (@var{ar}, @var{triggerpin}, @var{echopin}) +@deftypefnx {} {@var{dev} =} ultrasonic (@var{ar}, @var{triggerpin}, @var{echopin}, @var{propname}, @var{propvalue}) Create an ultrasonic object to communicate to a connected ultrasonic device - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{triggerpin} - trigger pin for attached device. +@var{triggerpin} - trigger pin for attached device. - @var{echopin} - trigger pin for attached device. +@var{echopin} - trigger pin for attached device. - @var{propname}, @var{propvalue} - property name/value pair for values to pass to devices. +@var{propname}, @var{propvalue} - property name/value pair for values to pass to devices. Currently known properties: - @table @asis - @item outputformat +@table @asis +@item outputformat string designating number format for output ('double') - @end table +@end table - @subsubheading Outputs - @var{dev} - created ultrasonic object +@subsubheading Outputs +@var{dev} - created ultrasonic object - @subsubheading Properties +@subsubheading Properties The ultrasonic object has the following public properties: - @table @asis - @item parent +@table @asis +@item parent The parent (arduino) for this device - @item pins +@item pins pins used by this object - @item triggerpin +@item triggerpin trigger used for created object - @item echopin +@item echopin Echo pin set for object - @item outputformat +@item outputformat Output format for the created object - @end table +@end table - @xseealso{arduino, readDistance, readEchoTime} - @end deftypefn +@xseealso{arduino, readDistance, readEchoTime} +@end deftypefn @c --------------------------------------------------- @node Arduino Addons @section Arduino Addons @@ -2539,129 +2539,129 @@ @c ----------------------------------------- @subsection addon @cindex addon - @deftypefn {} {@var{retval} =} addon (@var{ar}, @var{addonname}) - @deftypefnx {} {@var{retval} =} addon (@var{ar}, @var{addonname}, varargs) +@deftypefn {} {@var{retval} =} addon (@var{ar}, @var{addonname}) +@deftypefnx {} {@var{retval} =} addon (@var{ar}, @var{addonname}, varargs) Create an addon object using the addon named class. - @subsubheading Inputs - @var{ar} - connected arduino object +@subsubheading Inputs +@var{ar} - connected arduino object - @var{addonname} - the name of the addon to create. The addon name can be a user +@var{addonname} - the name of the addon to create. The addon name can be a user addon or an inbuilt addon, however must appear in the listArduinoLibraries output and have been programmed onto the arduino. - @var{varargs} - optional values that will be provided verbatim to the +@var{varargs} - optional values that will be provided verbatim to the the addon class constructor. - @subsubheading Outputs - @var{retval} - cell array of string library names. +@subsubheading Outputs +@var{retval} - cell array of string library names. - @xseealso{arduino, arduinosetup, listArduinoLibraries} - @end deftypefn +@xseealso{arduino, arduinosetup, listArduinoLibraries} +@end deftypefn @c Arduino Addons arduinoioaddons.EEPRomAddon.EEPRom @c ----------------------------------------- @subsection arduinoioaddons.EEPRomAddon.EEPRom @cindex EEPRom - @deftypefn {} {} arduinoioaddons.EEPRomAddon.EEPRom +@deftypefn {} {} arduinoioaddons.EEPRomAddon.EEPRom EEPROM addon for arduino Allows read and write of uint8 data to the onboard arduino EEPROM. - @subsubheading Example +@subsubheading Example Assuming eeprom addon has been programmed into the Arduino: - @example +@example a = arduino (); e = addon (a, "eepromaddon/eeprom"); write (e, 0, uint8("hello world")); str = uint8( read(e, 0, 11) ) - @end example +@end example - @xseealso{addon} - @end deftypefn +@xseealso{addon} +@end deftypefn - @subsubheading Properties - @var{length} - Size of the EEPROM. +@subsubheading Properties +@var{length} - Size of the EEPROM. - @subheading Methods - @deftypefn {} {@var{eeprom} =} EEPRom () +@subheading Methods +@deftypefn {} {@var{eeprom} =} EEPRom () Constructor to create EEPROM device. - @subsubheading Outputs - @var{eeprom} - created EEPROM device. - @end deftypefn +@subsubheading Outputs +@var{eeprom} - created EEPROM device. +@end deftypefn - @deftypefn {} {} erase () +@deftypefn {} {} erase () Erase all values in EEPROM (Effectively setting the 0xFF) - @end deftypefn +@end deftypefn - @deftypefn {} {} write (@var{address}, @var{uintdata}) +@deftypefn {} {} write (@var{address}, @var{uintdata}) Write data to EEPROM at the provided address. - @subsubheading Inputs - @var{address} - start address to write data to, should be an +@subsubheading Inputs +@var{address} - start address to write data to, should be an integer between 0 and the size of the EEPROM. - @var{uintdata} a value or array of uint8 data to write to EEPROM. - @end deftypefn +@var{uintdata} a value or array of uint8 data to write to EEPROM. +@end deftypefn - @deftypefn {} {@var{data} =} read (@var{address}) - @deftypefnx {} {@var{data} =} read (@var{address}, @var{count}) +@deftypefn {} {@var{data} =} read (@var{address}) +@deftypefnx {} {@var{data} =} read (@var{address}, @var{count}) Read data from starting address of EEPROM. - @subsubheading Inputs - @var{address} - start address to read data from, should be an +@subsubheading Inputs +@var{address} - start address to read data from, should be an integer between 0 and the size of the EEPROM. - @var{count} - Number of uint8 values to read from the EEPROM (default is 1) +@var{count} - Number of uint8 values to read from the EEPROM (default is 1) - @subsubheading Outputs - @var{data} a value or array of uint8 data read from the EEPROM. - @end deftypefn +@subsubheading Outputs +@var{data} a value or array of uint8 data read from the EEPROM. +@end deftypefn @c Arduino Addons arduinoioaddons.ExampleAddon.Echo @c ----------------------------------------- @subsection arduinoioaddons.ExampleAddon.Echo @cindex Echo - @deftypefn {} {} arduinoioaddons.ExampleAddon.Echo +@deftypefn {} {} arduinoioaddons.ExampleAddon.Echo Basic Example matlab/octave code to illustrate creating a user addon. - @xseealso{addon} - @end deftypefn +@xseealso{addon} +@end deftypefn - @subsubheading Properties - @var{Parent} - the parent arduino object. +@subsubheading Properties +@var{Parent} - the parent arduino object. - @var{Pins} - the pins allocated the addon. +@var{Pins} - the pins allocated the addon. - @subheading Methods - @deftypefn {} {@var{obj} =} Echo(arObj) +@subheading Methods +@deftypefn {} {@var{obj} =} Echo(arObj) Constructor to create Echo addon - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @subsubheading Outputs - @var{obj} - created Echo object - @end deftypefn +@subsubheading Outputs +@var{obj} - created Echo object +@end deftypefn - @deftypefn {} {@var{response} = } shout(@var{text}) +@deftypefn {} {@var{response} = } shout(@var{text}) Send text to arduino and receive back the echoed reply - @subsubheading Inputs - @var{text} - text to send to arduino +@subsubheading Inputs +@var{text} - text to send to arduino - @subsubheading Outputs - @var{response} - response from the arduino, which should be the same as +@subsubheading Outputs +@var{response} - response from the arduino, which should be the same as the input text. - @end deftypefn +@end deftypefn @c Arduino Addons arduinoioaddons.ExampleLCD.LCD @c ----------------------------------------- @subsection arduinoioaddons.ExampleLCD.LCD @cindex LCD - @deftypefn {} {} arduinoioaddons.LCDAddon.LCD +@deftypefn {} {} arduinoioaddons.LCDAddon.LCD Basic Example octave addon for LCD Allows basic manipulation of an LCD as a illustration of using the addon functionality. - @subsubheading Example +@subsubheading Example Assuming the arduino has been programmed with the lcd addon: - @example +@example a = arduino(); lcd = addon(a, "examplelcd/lcd", "d8", "d9", "d4", "d5", "d6", "d7") clearLCD(lcd); @@ -2669,570 +2669,570 @@ # go to next line gotoLCD(lcd, 0, 1); printLCD(lcd, "World"); - @end example - @xseealso{addon} - @end deftypefn +@end example +@xseealso{addon} +@end deftypefn - @subsubheading Properties - @var{Pins} - the pins allocated the LCD display. +@subsubheading Properties +@var{Pins} - the pins allocated the LCD display. - @subheading Methods - @deftypefn {} {@var{lcd} =} LCD(arObj, rs, enable, d0, d1, d2, d3) +@subheading Methods +@deftypefn {} {@var{lcd} =} LCD(arObj, rs, enable, d0, d1, d2, d3) Constructor to create LCD device - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{rs} - the pin to use for the rs line. +@var{rs} - the pin to use for the rs line. - @var{enable} - the pin to use for the enable line. +@var{enable} - the pin to use for the enable line. - @var{d0} - the pin to use for the d0 line. +@var{d0} - the pin to use for the d0 line. - @var{d1} - the pin to use for the d1 line. +@var{d1} - the pin to use for the d1 line. - @var{d2} - the pin to use for the d2 line. +@var{d2} - the pin to use for the d2 line. - @var{d3} - the pin to use for the d3 line. +@var{d3} - the pin to use for the d3 line. - @subsubheading Outputs - @var{lcd} - created LCD object - @end deftypefn +@subsubheading Outputs +@var{lcd} - created LCD object +@end deftypefn - @deftypefn {} {} freeLCD() +@deftypefn {} {} freeLCD() Free the LCD Should be called before discarding the LCD - @subsubheading Inputs +@subsubheading Inputs None. - @subsubheading Outputs +@subsubheading Outputs None. - @end deftypefn +@end deftypefn - @deftypefn {} {} clearLCD() +@deftypefn {} {} clearLCD() Clear the LCD display and set the cursor position to the home position. - @subsubheading Inputs +@subsubheading Inputs None. - @subsubheading Outputs +@subsubheading Outputs None. - @end deftypefn +@end deftypefn - @deftypefn {} {} printLCD(@var{text}) +@deftypefn {} {} printLCD(@var{text}) Display text on LCD starting at the current cursor position. - @subsubheading Inputs - @var{text} - text to display on LCD +@subsubheading Inputs +@var{text} - text to display on LCD - @subsubheading Outputs +@subsubheading Outputs None. - @end deftypefn +@end deftypefn - @deftypefn {} {} gotoLCD(@var{col}, @var{row}) +@deftypefn {} {} gotoLCD(@var{col}, @var{row}) Set the cursor position to row, col - @subsubheading Inputs - @var{col} - 0 indexed LCD column to position to. +@subsubheading Inputs +@var{col} - 0 indexed LCD column to position to. - @var{row} - 0 indexed LCD row to position to. +@var{row} - 0 indexed LCD row to position to. - @subsubheading Outputs +@subsubheading Outputs None. - @end deftypefn +@end deftypefn @c Arduino Addons arduinoioaddons.RTCAddon.DS1307 @c ----------------------------------------- @subsection arduinoioaddons.RTCAddon.DS1307 @cindex DS1307 - @deftypefn {} {} arduinoioaddons.RTCAddon.DS1307 +@deftypefn {} {} arduinoioaddons.RTCAddon.DS1307 DS1307 addon - @xseealso{addon} - @end deftypefn +@xseealso{addon} +@end deftypefn - @subsubheading Properties - @var{Parent} - the parent arduino object. +@subsubheading Properties +@var{Parent} - the parent arduino object. - @var{Pins} - the pins allocated the addon. +@var{Pins} - the pins allocated the addon. - @subheading Methods - @deftypefn {} {@var{obj} =} DS1307(@var{arObj}) - @deftypefnx {} {@var{obj} =} DS1307(@var{arObj}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} DS1307(@var{arObj}) +@deftypefnx {} {@var{obj} =} DS1307(@var{arObj}, @var{propertyname, propertyvalue} ....) Constructor to create DS1307 addon - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{propertyname, propertyvalue} - optional property name, value pairs. +@var{propertyname, propertyvalue} - optional property name, value pairs. Current known properties are: - @table @asis - @item address +@table @asis +@item address I2C address of the DS1307 (default 0x68) - @end table +@end table - @subsubheading Outputs - @var{obj} - created DS1307 object +@subsubheading Outputs +@var{obj} - created DS1307 object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() rtc = addon(a, "rtcaddon/ds1307") } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {@var{date} =} clock(@var{dsObj}) - @deftypefnx {} {} clock(@var{dsObj}, @var{date}) +@deftypefn {} {@var{date} =} clock(@var{dsObj}) +@deftypefnx {} {} clock(@var{dsObj}, @var{date}) Get/set the DS1307 clock - @subsubheading Inputs - @var{dsObj} - the ds1307 object +@subsubheading Inputs +@var{dsObj} - the ds1307 object - @var{date} - a date vector in same format as datevec and clock +@var{date} - a date vector in same format as datevec and clock - @subsubheading Outputs - @var{date} - a date vector in same format as datevec and clock +@subsubheading Outputs +@var{date} - a date vector in same format as datevec and clock - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() rtc = addon(a, "rtcaddon/ds1307") # get and display rtc time as a date string datestr(rtc.clock) } - @end example - @xseealso{datevec} - @end deftypefn +@end example +@xseealso{datevec} +@end deftypefn - @deftypefn {} {@var{ctrl} =} control(@var{dsObj}) - @deftypefnx {} {} control(@var{dsObj}, @var{ctrl}) +@deftypefn {} {@var{ctrl} =} control(@var{dsObj}) +@deftypefnx {} {} control(@var{dsObj}, @var{ctrl}) Get/set the DS1307 clock - @subsubheading Inputs - @var{dsObj} - the ds1307 object +@subsubheading Inputs +@var{dsObj} - the ds1307 object - @var{ctrl} - a structure containing the control bit fields. +@var{ctrl} - a structure containing the control bit fields. - @subsubheading Outputs - @var{ctrl} - a structure containing the control bit fields. +@subsubheading Outputs +@var{ctrl} - a structure containing the control bit fields. Control structure fields are: Current properties are: - @table @asis - @item out +@table @asis +@item out Out bit in the control register - @item sqwe +@item sqwe Square wave enable bit in control register - @item rs +@item rs The combined RS0, RS1 value - @end table +@end table - @end deftypefn +@end deftypefn - @deftypefn {} {@var{YN} =} isstarted(@var{dsObj}) +@deftypefn {} {@var{YN} =} isstarted(@var{dsObj}) Get whether the RTC clock is currently counting time - @subsubheading Inputs - @var{dsObj} - the ds1307 object +@subsubheading Inputs +@var{dsObj} - the ds1307 object - @subsubheading Outputs - @var{YN} - returns true if the RTC is counting +@subsubheading Outputs +@var{YN} - returns true if the RTC is counting - @xseealso{start, stop} - @end deftypefn +@xseealso{start, stop} +@end deftypefn - @deftypefn {} {} start(@var{dsObj}) +@deftypefn {} {} start(@var{dsObj}) Start the RTC counting - @subsubheading Inputs - @var{dsObj} - the ds1307 object +@subsubheading Inputs +@var{dsObj} - the ds1307 object - @subsubheading Outputs +@subsubheading Outputs None - @xseealso{datevec} - @end deftypefn +@xseealso{datevec} +@end deftypefn - @deftypefn {} {} stop(@var{dsObj}) +@deftypefn {} {} stop(@var{dsObj}) Stop the RTC counting - @subsubheading Inputs - @var{dsObj} - the ds1307 object +@subsubheading Inputs +@var{dsObj} - the ds1307 object - @subsubheading Outputs +@subsubheading Outputs None - @xseealso{datevec} - @end deftypefn +@xseealso{datevec} +@end deftypefn @c Arduino Addons arduinoioaddons.SimpleStepper.SimpleStepper @c ----------------------------------------- @subsection arduinoioaddons.SimpleStepper.SimpleStepper @cindex SimpleStepper - @deftypefn {} {} arduinoioaddons.SimpleStepper +@deftypefn {} {} arduinoioaddons.SimpleStepper Stepper class for stepper control using ULN2003 and compatible drivers - @end deftypefn +@end deftypefn - @subsubheading Properties - @table @asis - @item @var{Id} +@subsubheading Properties +@table @asis +@item @var{Id} Id of the stepper (Read only) - @item @var{Speed} +@item @var{Speed} Number of steps to do per second. - @item Status +@item Status Status of stepper (Read only). 0 = not moving, 1 = moving, 2 = rotating - @item Parent +@item Parent the Arduino parent (read only) - @item Pins +@item Pins the pins used for the stepper (read only) - @end table +@end table - @subheading Methods - @deftypefn {} {@var{obj} =} SimpleStepper(@var{aObj}, @var{pin1}, @var{pin2}, @var{pin3}, @var{pin4}) - @deftypefnx {} {@var{obj} =} SimpleStepper(@var{aObj}, @var{pin1}, @var{pin2}, @var{pin3}, @var{pin4}, @var{pin5}) +@subheading Methods +@deftypefn {} {@var{obj} =} SimpleStepper(@var{aObj}, @var{pin1}, @var{pin2}, @var{pin3}, @var{pin4}) +@deftypefnx {} {@var{obj} =} SimpleStepper(@var{aObj}, @var{pin1}, @var{pin2}, @var{pin3}, @var{pin4}, @var{pin5}) Constructor to create a stepper object - @subsubheading Inputs - @var{aObj} - The arduino +@subsubheading Inputs +@var{aObj} - The arduino - @var{pin1} - The first pin of the controller +@var{pin1} - The first pin of the controller - @var{pin2} - The second pin of the controller +@var{pin2} - The second pin of the controller - @var{pin3} - The third pin of the controller +@var{pin3} - The third pin of the controller - @var{pin4} - The fourth pin of the controller +@var{pin4} - The fourth pin of the controller - @var{pin5} - The fifth pin of the controller +@var{pin5} - The fifth pin of the controller - @subsubheading Outputs - @var{s} - a simplestepper object +@subsubheading Outputs +@var{s} - a simplestepper object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() # create stepper object s = addon(a, "simplestepper/simplestepper", "d2", "d3", "d4", "d5") # start rotating left s.rotate(-1); } - @end example +@end example - @xseealso{addon} - @end deftypefn +@xseealso{addon} +@end deftypefn - @deftypefn {} {} move(@var{sObj}, @var{steps}) +@deftypefn {} {} move(@var{sObj}, @var{steps}) Move the motor the specified number of steps using the configured Speed. - @subsubheading Inputs - @var{sObj} - the stepper object +@subsubheading Inputs +@var{sObj} - the stepper object - @var{steps} - the number of steps to move. steps less than 0 will be moving left. +@var{steps} - the number of steps to move. steps less than 0 will be moving left. - @subsubheading Outputs +@subsubheading Outputs None - @xseealso{rotate} - @end deftypefn +@xseealso{rotate} +@end deftypefn - @deftypefn {} {} rotate(@var{sObj}, @var{dir}) +@deftypefn {} {} rotate(@var{sObj}, @var{dir}) Start steppermotor moving in the specified direction using the configured Speed. - @subsubheading Inputs - @var{sObj} - the stepper object +@subsubheading Inputs +@var{sObj} - the stepper object - @var{dir} - Direction to move. -1 = left, 0 = stop, 1 = right. +@var{dir} - Direction to move. -1 = left, 0 = stop, 1 = right. - @subsubheading Outputs +@subsubheading Outputs None - @xseealso{move} - @end deftypefn +@xseealso{move} +@end deftypefn - @deftypefn {} {} release(@var{sObj}) +@deftypefn {} {} release(@var{sObj}) Release this stepper motor - @subsubheading Inputs - @var{sObj} - the stepper object +@subsubheading Inputs +@var{sObj} - the stepper object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn @c Arduino Addons arduinoioaddons.adafruit.dcmotorv2 @c ----------------------------------------- @subsection arduinoioaddons.adafruit.dcmotorv2 @cindex dcmotorv2 - @deftypefn {} {} arduinoioaddons.adafruit.dcmotorv2 +@deftypefn {} {} arduinoioaddons.adafruit.dcmotorv2 DC Motor class for dc motor control on the adafruit motor shield - @xseealso{arduinoioaddons.adafruit.motorshieldv2} - @end deftypefn +@xseealso{arduinoioaddons.adafruit.motorshieldv2} +@end deftypefn - @subsubheading Properties - @var{Speed} - The speed value set for the motor +@subsubheading Properties +@var{Speed} - The speed value set for the motor - @var{Parent} - The parent shield for object (read only) +@var{Parent} - The parent shield for object (read only) - @var{MotorNumber} - The motor number (read only) values 1-4 +@var{MotorNumber} - The motor number (read only) values 1-4 - @var{IsRunning} - boolean for if the motor is started (read only) +@var{IsRunning} - boolean for if the motor is started (read only) - @subheading Methods - @deftypefn {} {@var{obj} =} dcmotorv2(@var{mObj}, @var{mnum}) - @deftypefnx {} {@var{obj} =} dcmotorv2(@var{mObj}, @var{mnum}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} dcmotorv2(@var{mObj}, @var{mnum}) +@deftypefnx {} {@var{obj} =} dcmotorv2(@var{mObj}, @var{mnum}, @var{propertyname, propertyvalue} ....) Constructor to create dcmotor object - @subsubheading Inputs - @var{mObj} - the motor shield object +@subsubheading Inputs +@var{mObj} - the motor shield object - @var{mnum} - The motor number (1 - 4) +@var{mnum} - The motor number (1 - 4) - @var{propertyname, propertyvalue} - Optional property name/value +@var{propertyname, propertyvalue} - Optional property name/value pairs to pass to motor object. Current known properties are: - @table @asis - @item Speed +@table @asis +@item Speed Initial speed (default 0). Should be a value between -1 and 1. - @end table +@end table - @subsubheading Outputs - @var{s} - a dcmotorv2 object +@subsubheading Outputs +@var{s} - a dcmotorv2 object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() ms = addon(a, "adafruit/motorshieldv2") mtr = dcmotor(ms, 1) } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {} start(@var{dcObj}) +@deftypefn {} {} start(@var{dcObj}) Start the motor moving in previously set speed/direction - @subsubheading Inputs - @var{dcObj} - the dcmotor object +@subsubheading Inputs +@var{dcObj} - the dcmotor object - @subsubheading Outputs +@subsubheading Outputs None - @xseealso{adafruit.motorshieldv2} - @end deftypefn +@xseealso{adafruit.motorshieldv2} +@end deftypefn - @deftypefn {} {} stop(@var{dcObj}) +@deftypefn {} {} stop(@var{dcObj}) Stop the motor moving - @subsubheading Inputs - @var{dcObj} - the dcmotor object +@subsubheading Inputs +@var{dcObj} - the dcmotor object - @subsubheading Outputs +@subsubheading Outputs None - @xseealso{adafruit.motorshieldv2} - @end deftypefn +@xseealso{adafruit.motorshieldv2} +@end deftypefn @c Arduino Addons arduinoioaddons.adafruit.motorshieldv2 @c ----------------------------------------- @subsection arduinoioaddons.adafruit.motorshieldv2 @cindex motorshieldv2 - @deftypefn {} {} arduinoioaddons.adafruit.motorshieldv2 +@deftypefn {} {} arduinoioaddons.adafruit.motorshieldv2 Adafruit motor shield addon - @xseealso{addon} - @end deftypefn +@xseealso{addon} +@end deftypefn - @subsubheading Properties - @var{Parent} - the parent arduino object. +@subsubheading Properties +@var{Parent} - the parent arduino object. - @var{Pins} - the pins allocated the addon. +@var{Pins} - the pins allocated the addon. - @var{I2CAddress} - the i2c address used for accessing this shield. +@var{I2CAddress} - the i2c address used for accessing this shield. - @var{PWMFrequency} - the set PWM frequency for this shield. +@var{PWMFrequency} - the set PWM frequency for this shield. - @subheading Methods - @deftypefn {} {@var{obj} =} motorshieldv2(@var{arObj}) - @deftypefnx {} {@var{obj} =} motorshieldv2(@var{arObj}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} motorshieldv2(@var{arObj}) +@deftypefnx {} {@var{obj} =} motorshieldv2(@var{arObj}, @var{propertyname, propertyvalue} ....) Constructor to create motorshieldv2 addon object - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{propertyname, propertyvalue} - optional property name, value pairs. +@var{propertyname, propertyvalue} - optional property name, value pairs. Current known properties are: - @table @asis - @item address +@table @asis +@item address I2C address of the motor shield (default 0x60) - @item pwmfrequency +@item pwmfrequency PWM Frequency to set on shield (default 1600) - @end table +@end table - @subsubheading Outputs - @var{obj} - created motorshieldv2 object +@subsubheading Outputs +@var{obj} - created motorshieldv2 object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() mtr = addon(a, "adafruit/motorshieldv2") } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {@var{s} =} servo(@var{mObj}, @var{mtrnum}) - @deftypefnx {} {@var{s} =} servo(@var{mObj}, @var{mtrnum}, @var{propertyname}, @var{propertyvalue} ...) +@deftypefn {} {@var{s} =} servo(@var{mObj}, @var{mtrnum}) +@deftypefnx {} {@var{s} =} servo(@var{mObj}, @var{mtrnum}, @var{propertyname}, @var{propertyvalue} ...) Create a servo object - @subsubheading Inputs - @var{mObj} - the motor shield object +@subsubheading Inputs +@var{mObj} - the motor shield object - @var{mtrnum} - The servo motor number, where 1 is servo on +@var{mtrnum} - The servo motor number, where 1 is servo on pin "d10" and 2 is a servo on pin "d9" - @var{propertyname}, @var{propertyvalue} - Optional property +@var{propertyname}, @var{propertyvalue} - Optional property name/value pairs to pass to servo object. Properties are the same as the base servo object. - @subsubheading Outputs - @var{s} - a servo object +@subsubheading Outputs +@var{s} - a servo object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() ms = addon(a, "adafruit/motorshieldv2") # get servo 1 (servo on pin D10) s = ms.servo(1) } - @end example +@end example The function if the equivalent of calling the arduino.servo with the D9 or D10 pin has the input pin. - @xseealso{servo} - @end deftypefn +@xseealso{servo} +@end deftypefn - @deftypefn {} {@var{s} =} stepper(@var{mObj}, @var{mtrnum}, @var{stepsperrev}) - @deftypefnx {} {@var{s} =} stepper(@var{mObj}, @var{mtrnum}, @var{stepsperrev}, @var{propertyname}, @var{propertyvalue} ...) +@deftypefn {} {@var{s} =} stepper(@var{mObj}, @var{mtrnum}, @var{stepsperrev}) +@deftypefnx {} {@var{s} =} stepper(@var{mObj}, @var{mtrnum}, @var{stepsperrev}, @var{propertyname}, @var{propertyvalue} ...) Create a stepper motor object - @subsubheading Inputs - @var{mObj} - the motor shield object +@subsubheading Inputs +@var{mObj} - the motor shield object - @var{mtrnum} - The stepper motor number (1 or 2) +@var{mtrnum} - The stepper motor number (1 or 2) - @var{stepsperrev} - Number of steps per revolution. +@var{stepsperrev} - Number of steps per revolution. - @var{propertyname}, @var{propertyvalue} - Optional property +@var{propertyname}, @var{propertyvalue} - Optional property name/value pairs to pass to stepper object. - @subsubheading Outputs - @var{s} - a stepper object +@subsubheading Outputs +@var{s} - a stepper object - @end deftypefn +@end deftypefn - @deftypefn {} {@var{s} =} dcmotor(@var{mObj}, @var{mtrnum}) - @deftypefnx {} {@var{s} =} dcmotor(@var{mObj}, @var{mtrnum}, @var{propertyname}, @var{propertyvalue} ...) +@deftypefn {} {@var{s} =} dcmotor(@var{mObj}, @var{mtrnum}) +@deftypefnx {} {@var{s} =} dcmotor(@var{mObj}, @var{mtrnum}, @var{propertyname}, @var{propertyvalue} ...) Create a dcmotor motor object - @subsubheading Inputs - @var{mObj} - the motor shield object +@subsubheading Inputs +@var{mObj} - the motor shield object - @var{mtrnum} - The motor number (1 - 4) +@var{mtrnum} - The motor number (1 - 4) - @var{propertyname}, @var{propertyvalue} - Optional property +@var{propertyname}, @var{propertyvalue} - Optional property name/value pairs to pass to motor object. - @subsubheading Outputs - @var{s} - a dcmotorv2 object +@subsubheading Outputs +@var{s} - a dcmotorv2 object - @end deftypefn +@end deftypefn @c Arduino Addons arduinoioaddons.adafruit.stepper @c ----------------------------------------- @subsection arduinoioaddons.adafruit.stepper @cindex stepper - @deftypefn {} {} arduinoioaddons.adafruit.stepper +@deftypefn {} {} arduinoioaddons.adafruit.stepper Stepper class for stepper control on the adafruit motor shield - @xseealso{arduinoioaddons.adafruit.motorshieldv2} - @end deftypefn +@xseealso{arduinoioaddons.adafruit.motorshieldv2} +@end deftypefn - @subsubheading Properties - @table @asis - @item @var{RPM} +@subsubheading Properties +@table @asis +@item @var{RPM} The rpm value set for the stepper motor - @item StepType +@item StepType the StepType for the stepper (string) which can be "single", "double", "interleave" or "microstep" - @item StepsPerRevolution +@item StepsPerRevolution the StepsPerRevoluion for the stepper (read only) - @item MotorNumber +@item MotorNumber the motor number for the stepper (read only) value will be 1 or 2. - @item Parent +@item Parent the parent shield of this stepper (read only) - @end table +@end table - @subheading Methods - @deftypefn {} {@var{obj} =} stepper(@var{mObj}, @var{mnum}, @var{stepsperrev}) - @deftypefnx {} {@var{obj} =} stepper(@var{mObj}, @var{mnum}, @var{stepsperrev}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} stepper(@var{mObj}, @var{mnum}, @var{stepsperrev}) +@deftypefnx {} {@var{obj} =} stepper(@var{mObj}, @var{mnum}, @var{stepsperrev}, @var{propertyname, propertyvalue} ....) Constructor to create dcmotor object - @subsubheading Inputs - @var{mObj} - the motor shield object +@subsubheading Inputs +@var{mObj} - the motor shield object - @var{mnum} - The motor number (1 or 2) +@var{mnum} - The motor number (1 or 2) - @var{stepsperrev} - Number of steps per revolution. +@var{stepsperrev} - Number of steps per revolution. - @var{propertyname, propertyvalue} - Optional property +@var{propertyname, propertyvalue} - Optional property name/value pairs to pass to motor object. Current known properties are: - @table @asis - @item RPM +@table @asis +@item RPM the RPM for the stepper (revolutions per minute) - @item StepType +@item StepType the StepType for the stepper (string) which can be "single", "double", "interleave" or "microstep" - @end table +@end table - @subsubheading Outputs - @var{s} - a stepper object +@subsubheading Outputs +@var{s} - a stepper object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() ms = addon(a, "adafruit/motorshieldv2") mtr = stepper(ms, 1, 200) } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {} move(@var{sObj}, @var{steps}) +@deftypefn {} {} move(@var{sObj}, @var{steps}) Move the motor moving in the specified steps using the configured RPM. - @subsubheading Inputs - @var{sObj} - the stepper object +@subsubheading Inputs +@var{sObj} - the stepper object - @subsubheading Outputs +@subsubheading Outputs None - @xseealso{adafruit.motorshieldv2} - @end deftypefn +@xseealso{adafruit.motorshieldv2} +@end deftypefn - @deftypefn {} {} release(@var{sObj}) +@deftypefn {} {} release(@var{sObj}) Release this motor - @subsubheading Inputs - @var{sObj} - the stepper object +@subsubheading Inputs +@var{sObj} - the stepper object - @subsubheading Outputs +@subsubheading Outputs None - @xseealso{adafruit.motorshieldv2} - @end deftypefn +@xseealso{adafruit.motorshieldv2} +@end deftypefn @c --------------------------------------------------- @node Arduino Sensors @section Arduino Sensors @@ -3241,335 +3241,335 @@ @c ----------------------------------------- @subsection arduinosensor.DS1307 @cindex DS1307 - @deftypefn {} {} arduinosensor.DS1307 +@deftypefn {} {} arduinosensor.DS1307 DS1307 realtime clock sensor - @end deftypefn +@end deftypefn - @subheading Methods - @deftypefn {} {@var{obj} =} DS1307(@var{arObj}) - @deftypefnx {} {@var{obj} =} DS1307(@var{arObj}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} DS1307(@var{arObj}) +@deftypefnx {} {@var{obj} =} DS1307(@var{arObj}, @var{propertyname, propertyvalue} ....) Constructor to create DS1307 sensor - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{propertyname, propertyvalue} - optional property name, value pairs. +@var{propertyname, propertyvalue} - optional property name, value pairs. Current known properties are: Current properties are: - @table @asis - @item i2caddress +@table @asis +@item i2caddress I2C address of the DS1307 (default 0x68) - @end table +@end table - @subsubheading Outputs - @var{obj} - created DS1307 object +@subsubheading Outputs +@var{obj} - created DS1307 object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() rtc = arduinosensor.DS1307(a) } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {@var{date} =} clock(@var{dsObj}) - @deftypefnx {} {} clock(@var{dsObj}, @var{date}) +@deftypefn {} {@var{date} =} clock(@var{dsObj}) +@deftypefnx {} {} clock(@var{dsObj}, @var{date}) Get/set the DS1307 clock - @subsubheading Inputs - @var{dsObj} - the ds1307 object +@subsubheading Inputs +@var{dsObj} - the ds1307 object - @var{date} - a date vector in same format as datevec and clock +@var{date} - a date vector in same format as datevec and clock - @subsubheading Outputs - @var{date} - a date vector in same format as datevec and clock +@subsubheading Outputs +@var{date} - a date vector in same format as datevec and clock - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() rtc = arduinosensor.DS1307(a) # get and display rtc time as a date string datestr(rtc.clock) } - @end example - @xseealso{datevec} - @end deftypefn +@end example +@xseealso{datevec} +@end deftypefn - @deftypefn {} {@var{ctrl} =} control(@var{dsObj}) - @deftypefnx {} {} control(@var{dsObj}, @var{ctrl}) +@deftypefn {} {@var{ctrl} =} control(@var{dsObj}) +@deftypefnx {} {} control(@var{dsObj}, @var{ctrl}) Get/set the DS1307 clock - @subsubheading Inputs - @var{dsObj} - the ds1307 object +@subsubheading Inputs +@var{dsObj} - the ds1307 object - @var{ctrl} - a structure containing the control bit fields. +@var{ctrl} - a structure containing the control bit fields. - @subsubheading Outputs - @var{ctrl} - a structure containing the control bit fields. +@subsubheading Outputs +@var{ctrl} - a structure containing the control bit fields. Control structure fields are: Current properties are: - @table @asis - @item out +@table @asis +@item out Out bit in the control register - @item sqwe +@item sqwe Square wave enable bit in control register - @item rs +@item rs The combined RS0, RS1 value - @end table +@end table - @end deftypefn +@end deftypefn - @deftypefn {} {@var{YN} =} isstarted(@var{dsObj}) +@deftypefn {} {@var{YN} =} isstarted(@var{dsObj}) Get whether the RTC clock is currently counting time - @subsubheading Inputs - @var{dsObj} - the ds1307 object +@subsubheading Inputs +@var{dsObj} - the ds1307 object - @subsubheading Outputs - @var{YN} - returns true if the RTC is counting +@subsubheading Outputs +@var{YN} - returns true if the RTC is counting - @xseealso{start, stop} - @end deftypefn +@xseealso{start, stop} +@end deftypefn - @deftypefn {} {} start(@var{dsObj}) +@deftypefn {} {} start(@var{dsObj}) Start the RTC counting - @subsubheading Inputs - @var{dsObj} - the ds1307 object +@subsubheading Inputs +@var{dsObj} - the ds1307 object - @subsubheading Outputs +@subsubheading Outputs None - @xseealso{datevec} - @end deftypefn +@xseealso{datevec} +@end deftypefn - @deftypefn {} {} stop(@var{dsObj}) +@deftypefn {} {} stop(@var{dsObj}) Stop the RTC counting - @subsubheading Inputs - @var{dsObj} - the ds1307 object +@subsubheading Inputs +@var{dsObj} - the ds1307 object - @subsubheading Outputs +@subsubheading Outputs None - @xseealso{datevec} - @end deftypefn +@xseealso{datevec} +@end deftypefn @c Arduino Sensors arduinosensor.GUVAS12SD @c ----------------------------------------- @subsection arduinosensor.GUVAS12SD @cindex GUVAS12SD - @deftypefn {} {} arduinosensor.GUVAS12SD +@deftypefn {} {} arduinosensor.GUVAS12SD A thin wrapper for the GUVAS12SD analog UV-B sensor - @end deftypefn +@end deftypefn - @subheading Methods - @deftypefn {} {@var{obj} =} GUVAS12SD(@var{arObj}, @var{pin}) +@subheading Methods +@deftypefn {} {@var{obj} =} GUVAS12SD(@var{arObj}, @var{pin}) Constructor to create GUVAS12SD sensor - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{pin} - the analog pin that the sensor is connected to +@var{pin} - the analog pin that the sensor is connected to - @subsubheading Outputs - @var{obj} - created GUVAS12SD object +@subsubheading Outputs +@var{obj} - created GUVAS12SD object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() # create sensor attached to pin a0. sensor = arduinosensor.GUVAS12SD(a, "a0") } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {@var{V} =} read(@var{dsObj}) +@deftypefn {} {@var{V} =} read(@var{dsObj}) Read the voltage of the sensor - @subsubheading Inputs - @var{dsObj} - the GUVAS12SD object +@subsubheading Inputs +@var{dsObj} - the GUVAS12SD object - @subsubheading Outputs - @var{V} - read voltage - effectively equivalent to +@subsubheading Outputs +@var{V} - read voltage - effectively equivalent to readAnalogPin(arObj, pin). - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() s = arduinosensor.GUVAS12SD(a) # voltage volts = s.read } - @end example - @xseealso{arduinosensor.GUVAS12SD} - @end deftypefn +@end example +@xseealso{arduinosensor.GUVAS12SD} +@end deftypefn - @deftypefn {} {@var{Idx} =} readIndex(@var{dsObj}) +@deftypefn {} {@var{Idx} =} readIndex(@var{dsObj}) Read the UV index - @subsubheading Inputs - @var{dsObj} - the GUVAS12SD object +@subsubheading Inputs +@var{dsObj} - the GUVAS12SD object - @subsubheading Outputs - @var{Idx} - the sensor reading as a UV index reading - @end deftypefn +@subsubheading Outputs +@var{Idx} - the sensor reading as a UV index reading +@end deftypefn - @deftypefn {} {@var{uA} =} readuA(@var{dsObj}) +@deftypefn {} {@var{uA} =} readuA(@var{dsObj}) Read the uA of the sensor - @subsubheading Inputs - @var{dsObj} - the GUVAS12SD object +@subsubheading Inputs +@var{dsObj} - the GUVAS12SD object - @subsubheading Outputs - @var{uA} - the sensor reading as a uAmp value - @end deftypefn +@subsubheading Outputs +@var{uA} - the sensor reading as a uAmp value +@end deftypefn @c Arduino Sensors arduinosensor.MPC3002 @c ----------------------------------------- @subsection arduinosensor.MPC3002 @cindex MPC3002 - @deftypefn {} {} arduinosensor.MPC3002 +@deftypefn {} {} arduinosensor.MPC3002 MCP3002 ADC sensor - @end deftypefn +@end deftypefn - @subheading Methods - @deftypefn {} {@var{obj} =} MPC3002(@var{arObj}, @var{selectPin}) - @deftypefnx {} {@var{obj} =} MPC3002(@var{arObj}, @var{selectPin}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} MPC3002(@var{arObj}, @var{selectPin}) +@deftypefnx {} {@var{obj} =} MPC3002(@var{arObj}, @var{selectPin}, @var{propertyname, propertyvalue} ....) Constructor to create MPC3002 sensor - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{selectPin} - the SPI cs select pin +@var{selectPin} - the SPI cs select pin - @var{propertyname, propertyvalue} - optional property name, value pairs. +@var{propertyname, propertyvalue} - optional property name, value pairs. Current properties are: - @table @asis - @item referenceVoltage +@table @asis +@item referenceVoltage Reference voltage for scaling the ADC inputs (default 5.0) - @end table +@end table - @subsubheading Outputs - @var{obj} - created MCP3002 object +@subsubheading Outputs +@var{obj} - created MCP3002 object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() sensor = arduinosensor.MPC3002(a, "d10") } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {@var{voltage} =} readVoltage(@var{dsObj}, @var{chan}) +@deftypefn {} {@var{voltage} =} readVoltage(@var{dsObj}, @var{chan}) Read the voltage from a channel - @subsubheading Inputs - @var{dsObj} - the MPC3002 object +@subsubheading Inputs +@var{dsObj} - the MPC3002 object - @var{chan} - the channel to read (0 or 1) +@var{chan} - the channel to read (0 or 1) - @subsubheading Outputs - @var{voltage} - read voltage. +@subsubheading Outputs +@var{voltage} - read voltage. - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() s = arduinosensor.MPC3002(a, "d10") volts = readVoltage(s, 0) } - @end example - @xseealso{arduinosensor.MPC3002} - @end deftypefn +@end example +@xseealso{arduinosensor.MPC3002} +@end deftypefn @c Arduino Sensors arduinosensor.SI7021 @c ----------------------------------------- @subsection arduinosensor.SI7021 @cindex SI7021 - @deftypefn {} {} arduinosensor.SI7021 +@deftypefn {} {} arduinosensor.SI7021 SI7021 temperature and humidity sensor - @end deftypefn +@end deftypefn - @subheading Methods - @deftypefn {} {@var{obj} =} SI7021(@var{arObj}) - @deftypefnx {} {@var{obj} =} SI7021(@var{arObj}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} SI7021(@var{arObj}) +@deftypefnx {} {@var{obj} =} SI7021(@var{arObj}, @var{propertyname, propertyvalue} ....) Constructor to create SI7021 sensor - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{propertyname, propertyvalue} - optional property name, value pairs. +@var{propertyname, propertyvalue} - optional property name, value pairs. Current known properties are: Current properties are: - @table @asis - @item i2caddress +@table @asis +@item i2caddress I2C address of the SI7021 (default 0x40) - @end table +@end table - @subsubheading Outputs - @var{obj} - created SI7020 object +@subsubheading Outputs +@var{obj} - created SI7020 object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() sensor = arduinosensor.SI7021(a) } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {@var{C} =} temperature(@var{dsObj}) +@deftypefn {} {@var{C} =} temperature(@var{dsObj}) Read the temperature - @subsubheading Inputs - @var{dsObj} - the si7021 object +@subsubheading Inputs +@var{dsObj} - the si7021 object - @subsubheading Outputs - @var{C} - read temperature in deg C. +@subsubheading Outputs +@var{C} - read temperature in deg C. - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() s = arduinosensor.SI7021(a) # get temp temp = s.temperature } - @end example - @xseealso{arduinosensor.SI7021} - @end deftypefn +@end example +@xseealso{arduinosensor.SI7021} +@end deftypefn - @deftypefn {} {@var{relH} =} humidity(@var{dsObj}) +@deftypefn {} {@var{relH} =} humidity(@var{dsObj}) Read the relative humidity - @subsubheading Inputs - @var{dsObj} - the si7021 object +@subsubheading Inputs +@var{dsObj} - the si7021 object - @subsubheading Outputs - @var{relH} - relative humidity as a percentage (0 - 100.0) - @end deftypefn +@subsubheading Outputs +@var{relH} - relative humidity as a percentage (0 - 100.0) +@end deftypefn - @deftypefn {} {@var{relH} =} info(@var{dsObj}) +@deftypefn {} {@var{relH} =} info(@var{dsObj}) Read the sensor info - @subsubheading Inputs - @var{dsObj} - the si7021 object +@subsubheading Inputs +@var{dsObj} - the si7021 object - @subsubheading Outputs - @var{inf} - structure containing the sensor information. +@subsubheading Outputs +@var{inf} - structure containing the sensor information. Structure fields are: - @table @asis - @item version +@table @asis +@item version Chip firmware version - @item id +@item id sensor id1,id2 value - @item type +@item type String for detected chip type - @end table +@end table - @end deftypefn +@end deftypefn @c --------------------------------------------------- @node Arduino I/O package @section Arduino I/O package @@ -3578,173 +3578,173 @@ @c ----------------------------------------- @subsection arduinoio.AddonBase @cindex AddonBase - @deftypefn {} {} arduinoio.AddonBase +@deftypefn {} {} arduinoio.AddonBase Base class used for arduino library sensors - @xseealso{arduinoio.LibraryBase} - @end deftypefn +@xseealso{arduinoio.LibraryBase} +@end deftypefn - @subheading Properties +@subheading Properties Base properties are expected to be inherited and overwritten in inherited classes. and are constant in order to query through the metaobject mechanism. - @var{Parent} - parent librarybase object +@var{Parent} - parent librarybase object - @subheading Methods - @deftypefn {} {@var{ab} =} AddonBase () +@subheading Methods +@deftypefn {} {@var{ab} =} AddonBase () Constructor of base class - @subsubheading Outputs +@subsubheading Outputs The return value @var{ab} is an object of the arduinio.AddonBase class. - @xseealso{arduino, addon} - @end deftypefn +@xseealso{arduino, addon} +@end deftypefn - @deftypefn {} {} display () +@deftypefn {} {} display () Display the addon in a verbose way. - @end deftypefn +@end deftypefn @c Arduino I/O package arduinoio.FilePath @c ----------------------------------------- @subsection arduinoio.FilePath @cindex FilePath - @deftypefn {} {@var{retval} =} arduinoio.FilePath (@var{fullpathname}) +@deftypefn {} {@var{retval} =} arduinoio.FilePath (@var{fullpathname}) Get the directory component of a pathname. - @subsubheading Inputs - @var{fullpathname} filepath to get directory component of. +@subsubheading Inputs +@var{fullpathname} filepath to get directory component of. - @subsubheading Outputs - @var{retval} the directory part of the filename. - @end deftypefn +@subsubheading Outputs +@var{retval} the directory part of the filename. +@end deftypefn @c Arduino I/O package arduinoio.LibFiles @c ----------------------------------------- @subsection arduinoio.LibFiles @cindex LibFiles - @deftypefn {} {@var{filelist} =} arduinoio.LibFiles () +@deftypefn {} {@var{filelist} =} arduinoio.LibFiles () Get the list of files used for the building arduino library - @subsubheading Outputs - @var{filelist} - string cell array of files for the arduino project - @end deftypefn +@subsubheading Outputs +@var{filelist} - string cell array of files for the arduino project +@end deftypefn @c Arduino I/O package arduinoio.LibraryBase @c ----------------------------------------- @subsection arduinoio.LibraryBase @cindex LibraryBase - @deftypefn {} {} arduinoio.LibraryBase +@deftypefn {} {} arduinoio.LibraryBase Base class used for arduino library plugins - @xseealso{arduino, listArduinoLibraries, addon} - @end deftypefn +@xseealso{arduino, listArduinoLibraries, addon} +@end deftypefn - @subheading Properties +@subheading Properties Base properties are expected to be inherited and overwritten in inherited classes and are constant in order to query through the metaobject mechanism. - @var{LibraryName} - name of the addon library +@var{LibraryName} - name of the addon library - @var{DependentLibraries} - array of dependent library names that +@var{DependentLibraries} - array of dependent library names that must be included when installing this plugin. - @var{CppHeaderFile} - name (if any) of header file that will be +@var{CppHeaderFile} - name (if any) of header file that will be included into the arduino project when adding this library. - @var{CppSourceFile} - name (if any) of source file that will be +@var{CppSourceFile} - name (if any) of source file that will be included into the arduino project when adding this library. - @var{CppClassName} - name of the cpp class for the addon library. +@var{CppClassName} - name of the cpp class for the addon library. project when adding this library. - @var{Pins} - pins allocated to the addon +@var{Pins} - pins allocated to the addon - @var{Parent} - parent arduino object. +@var{Parent} - parent arduino object. - @subheading Methods - @deftypefn {} {@var{lb} =} LibraryBase () +@subheading Methods +@deftypefn {} {@var{lb} =} LibraryBase () Constructor of base class The constructor is usually not called but called indirectly from the addon function. - @subsubheading Outputs +@subsubheading Outputs The return value @var{lb} is an object of the arduinio.LibraryBase class. - @xseealso{arduino, listArduinoLibraries, addon} - @end deftypefn +@xseealso{arduino, listArduinoLibraries, addon} +@end deftypefn - @deftypefn {} {} display () +@deftypefn {} {} display () Display the addon in a verbose way. - @end deftypefn +@end deftypefn @c Arduino I/O package arduinoio.getBoardConfig @c ----------------------------------------- @subsection arduinoio.getBoardConfig @cindex getBoardConfig - @deftypefn {} {@var{retval} =} arduinoio.getBoardConfig (@var{boardname}) +@deftypefn {} {@var{retval} =} arduinoio.getBoardConfig (@var{boardname}) Return the configuration for a known arduino board type Function is used to get the expected pin/board configuration for a named board type which is used to verify and identify the functionality of the board. - @subsubheading Inputs - @var{boardname} - name of board to get configuration of ie: "uno" +@subsubheading Inputs +@var{boardname} - name of board to get configuration of ie: "uno" - @subsubheading Outputs - @var{retval} configuration struct. - @end deftypefn +@subsubheading Outputs +@var{retval} configuration struct. +@end deftypefn @c --------------------------------------------------- -@node Matlab Compatability Classes -@section Matlab Compatability Classes -@cindex Matlab Compatability Classes -@c Matlab Compatability Classes matlabshared.addon.LibraryBase +@node Matlab Compatibility Classes +@section Matlab Compatibility Classes +@cindex Matlab Compatibility Classes +@c Matlab Compatibility Classes matlabshared.addon.LibraryBase @c ----------------------------------------- @subsection matlabshared.addon.LibraryBase @cindex LibraryBase - @deftypefn {} {} matlabshared.addon.LibraryBase +@deftypefn {} {} matlabshared.addon.LibraryBase Compatability class used for arduino library plugins using matlabshared.addons.LibraryBase - @xseealso{arduinoio.LibraryBase, arduino, listArduinoLibraries, addon} - @end deftypefn +@xseealso{arduinoio.LibraryBase, arduino, listArduinoLibraries, addon} +@end deftypefn - @subheading Properties +@subheading Properties Base properties are expected to be inherited and overwritten in inherited classes and are constant in order to query through the metaobject mechanism. - @var{LibraryName} - name of the addon library +@var{LibraryName} - name of the addon library - @var{DependentLibraries} - array of dependent library names that +@var{DependentLibraries} - array of dependent library names that must be included when installing this plugin. - @var{CppHeaderFile} - name (if any) of header file that will be +@var{CppHeaderFile} - name (if any) of header file that will be included into the arduino project when adding this library. - @var{CppSourceFile} - name (if any) of source file that will be +@var{CppSourceFile} - name (if any) of source file that will be included into the arduino project when adding this library. - @var{CppClassName} - name of the cpp class for the addon library. +@var{CppClassName} - name of the cpp class for the addon library. project when adding this library. - @var{Pins} - pins allocated to the addon +@var{Pins} - pins allocated to the addon - @var{Parent} - parent arduino object. +@var{Parent} - parent arduino object. - @subheading Methods - @deftypefn {} {@var{lb} =} LibraryBase () +@subheading Methods +@deftypefn {} {@var{lb} =} LibraryBase () Constructor of base class The constructor is usually not called but called indirectly from the addon function. - @subsubheading Outputs +@subsubheading Outputs The return value @var{lb} is an object of the matlabshare.addons.LibraryBase class. - @xseealso{arduino, listArduinoLibraries, addon} - @end deftypefn +@xseealso{arduino, listArduinoLibraries, addon} +@end deftypefn - @deftypefn {} {} display () +@deftypefn {} {} display () Display the addon in a verbose way. - @end deftypefn +@end deftypefn @c --------------------------------------------------- @node Sensors @section Sensors @@ -3753,1000 +3753,1000 @@ @c ----------------------------------------- @subsection bme280 @cindex bme280 - @deftypefn {} {} bme280 +@deftypefn {} {} bme280 BME280 pressure, temperature and humidity sensor - @end deftypefn +@end deftypefn - @subheading Methods - @deftypefn {} {@var{obj} =} bme280(@var{arObj}) - @deftypefnx {} {@var{obj} =} bme280(@var{arObj}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} bme280(@var{arObj}) +@deftypefnx {} {@var{obj} =} bme280(@var{arObj}, @var{propertyname, propertyvalue} ....) Constructor to create BME280 sensor - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{propertyname, propertyvalue} - optional property name, value pairs. +@var{propertyname, propertyvalue} - optional property name, value pairs. Current known properties are: Current properties are: - @table @asis - @item I2CAddress +@table @asis +@item I2CAddress I2C address of the sensor (default 0x40) - @item Bus +@item Bus I2C bus - 0 or 1 (default 0) - @end table +@end table - @subsubheading Outputs - @var{obj} - created object +@subsubheading Outputs +@var{obj} - created object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() sensor = bme280(a) } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {[@var{C}, @var{timestamp}] =} readTemperature(@var{obj}) +@deftypefn {} {[@var{C}, @var{timestamp}] =} readTemperature(@var{obj}) Read the temperature - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{C} - read temperature in deg C. +@subsubheading Outputs +@var{C} - read temperature in deg C. - @var{timestamp} - timestamp when read +@var{timestamp} - timestamp when read - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() s = bme280(a) # get temp temp = s.readTemperature } - @end example - @xseealso{bme280} - @end deftypefn +@end example +@xseealso{bme280} +@end deftypefn - @deftypefn {} {[@var{relH}, @var{timestamp}] =} readHumidity(@var{obj}) +@deftypefn {} {[@var{relH}, @var{timestamp}] =} readHumidity(@var{obj}) Read the relative humidity - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{relH} - relative humidity as a percentage (0 - 100.0) +@subsubheading Outputs +@var{relH} - relative humidity as a percentage (0 - 100.0) - @var{timestamp} - timestamp when read - @end deftypefn +@var{timestamp} - timestamp when read +@end deftypefn - @deftypefn {} {[@var{P}, @var{timestamp}] =} readPressure(@var{obj}) +@deftypefn {} {[@var{P}, @var{timestamp}] =} readPressure(@var{obj}) Read the pressure - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{P} - pressure reading from sensor. +@subsubheading Outputs +@var{P} - pressure reading from sensor. - @var{timestamp} - timestamp when read - @end deftypefn +@var{timestamp} - timestamp when read +@end deftypefn - @deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) - @deftypefnx {} {[@var{P}, @var{H}, @var{C}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) +@deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) +@deftypefnx {} {[@var{P}, @var{H}, @var{C}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) Read the sensor data - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{P} - pressure reading from sensor. +@subsubheading Outputs +@var{P} - pressure reading from sensor. - @var{H} - humidity reading from sensor. +@var{H} - humidity reading from sensor. - @var{C} - temperature reading from sensor. +@var{C} - temperature reading from sensor. - @var{timestamp} - timestamp when read +@var{timestamp} - timestamp when read - @var{overrun} - overrun flag. +@var{overrun} - overrun flag. - @var{readings} - table structure with fields for Timestamp, Pressure, Temperature and Humidity. - @end deftypefn +@var{readings} - table structure with fields for Timestamp, Pressure, Temperature and Humidity. +@end deftypefn - @deftypefn {} {@var{inf} =} info(@var{obj}) +@deftypefn {} {@var{inf} =} info(@var{obj}) Read the sensor info - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{inf} - structure containing the sensor information. +@subsubheading Outputs +@var{inf} - structure containing the sensor information. Structure fields are: - @table @asis - @item Version +@table @asis +@item Version Chip firmware version - @item SensorId +@item SensorId sensor id value - @item Type +@item Type sensor type 'bme280' - @item Status +@item Status Status value read from sensor - @end table +@end table - @end deftypefn +@end deftypefn - @deftypefn {} {} flush(@var{obj}) +@deftypefn {} {} flush(@var{obj}) Flush sensor data - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn - @deftypefn {} {} release(@var{obj}) +@deftypefn {} {} release(@var{obj}) Release the resources of the sensor - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn @c Sensors bno055 @c ----------------------------------------- @subsection bno055 @cindex bno055 - @deftypefn {} {} bno055 +@deftypefn {} {} bno055 BNO055 9 axis orientation sensor - @end deftypefn +@end deftypefn - @subheading Methods - @deftypefn {} {@var{obj} =} bno055(@var{arObj}) - @deftypefnx {} {@var{obj} =} bno055(@var{arObj}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} bno055(@var{arObj}) +@deftypefnx {} {@var{obj} =} bno055(@var{arObj}, @var{propertyname, propertyvalue} ....) Constructor to create BME280 sensor - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{propertyname, propertyvalue} - optional property name, value pairs. +@var{propertyname, propertyvalue} - optional property name, value pairs. Current known properties are: Current properties are: - @table @asis - @item I2CAddress +@table @asis +@item I2CAddress I2C address of the sensor (default 0x40) - @item Bus +@item Bus I2C bus - 0 or 1 (default 0) - @item OperatingMode +@item OperatingMode Operating mode 'ndof' or 'amg' - @end table +@end table - @subsubheading Outputs - @var{obj} - created object +@subsubheading Outputs +@var{obj} - created object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() sensor = bno055(a) } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {[@var{C}, @var{timestamp}] =} readTemperature(@var{obj}) +@deftypefn {} {[@var{C}, @var{timestamp}] =} readTemperature(@var{obj}) Read the temperature - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{C} - read temperature in deg C. +@subsubheading Outputs +@var{C} - read temperature in deg C. - @var{timestamp} - timestamp when read +@var{timestamp} - timestamp when read - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() s = bno055(a) # get temp temp = s.readTemperature } - @end example - @xseealso{bno055} - @end deftypefn +@end example +@xseealso{bno055} +@end deftypefn - @deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAcceleration(@var{obj}) +@deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAcceleration(@var{obj}) Read the acceleration rate - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{readVal} - the 3 acceleration values +@subsubheading Outputs +@var{readVal} - the 3 acceleration values - @var{timestamp} - timestamp when read - @end deftypefn +@var{timestamp} - timestamp when read +@end deftypefn - @deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAngularVelocity(@var{obj}) +@deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAngularVelocity(@var{obj}) Read the angular velocity - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{readVal} - the 3 angular velocity values +@subsubheading Outputs +@var{readVal} - the 3 angular velocity values - @var{timestamp} - timestamp when read - @end deftypefn +@var{timestamp} - timestamp when read +@end deftypefn - @deftypefn {} {[@var{readVal}, @var{timestamp}] =} readMagneticField(@var{obj}) +@deftypefn {} {[@var{readVal}, @var{timestamp}] =} readMagneticField(@var{obj}) Read the magnetic field components - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{readVal} - the 3 magnetic field values +@subsubheading Outputs +@var{readVal} - the 3 magnetic field values - @var{timestamp} - timestamp when read - @end deftypefn +@var{timestamp} - timestamp when read +@end deftypefn - @deftypefn {} {[@var{readVal}, @var{timestamp}] =} readOrientation(@var{obj}) +@deftypefn {} {[@var{readVal}, @var{timestamp}] =} readOrientation(@var{obj}) Read the oriientation components - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{readVal} - the 3 orientation values +@subsubheading Outputs +@var{readVal} - the 3 orientation values - @var{timestamp} - timestamp when read - @end deftypefn +@var{timestamp} - timestamp when read +@end deftypefn - @deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) - @deftypefnx {} {[@var{accel}, @var{gyro}, @var{mag}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) - @deftypefnx {} {[@var{accel}, @var{gyro}, @var{mag}, @var{orientation}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) +@deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) +@deftypefnx {} {[@var{accel}, @var{gyro}, @var{mag}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) +@deftypefnx {} {[@var{accel}, @var{gyro}, @var{mag}, @var{orientation}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) Read the sensor data - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{accel} - acceleration reading from sensor. +@subsubheading Outputs +@var{accel} - acceleration reading from sensor. - @var{gyro} - angular acceleration reading from sensor. +@var{gyro} - angular acceleration reading from sensor. - @var{mag} - magnetic field reading from sensor. +@var{mag} - magnetic field reading from sensor. - @var{orientation} - orientation reading from sensor. +@var{orientation} - orientation reading from sensor. - @var{timestamp} - timestamp when read +@var{timestamp} - timestamp when read - @var{overrun} - overrun flag. +@var{overrun} - overrun flag. - @var{readings} - table structure with fields for Timestamp, Acceleration, AngularVelocity, MagneticField, Orientation. - @end deftypefn +@var{readings} - table structure with fields for Timestamp, Acceleration, AngularVelocity, MagneticField, Orientation. +@end deftypefn - @deftypefn {} {@var{inf} =} readCalibrationStatus(@var{obj}) +@deftypefn {} {@var{inf} =} readCalibrationStatus(@var{obj}) Read the sensor calibration status - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{status} - structure containing the calibration information. +@subsubheading Outputs +@var{status} - structure containing the calibration information. Structure fields are: - @table @asis - @item System +@table @asis +@item System System calibrarion - @item Accelerometer +@item Accelerometer Accelerometer calibration status - @item Gyroscope +@item Gyroscope Gyroscope calibration status - @item Magnetometer +@item Magnetometer Magnetometer calibration status - @end table +@end table Values for each will be either 'uncalibrated', 'partial' or 'full'. - @end deftypefn +@end deftypefn - @deftypefn {} {@var{inf} =} info(@var{obj}) +@deftypefn {} {@var{inf} =} info(@var{obj}) Read the sensor info - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{inf} - structure containing the sensor information. +@subsubheading Outputs +@var{inf} - structure containing the sensor information. Structure fields are: - @table @asis - @item Version +@table @asis +@item Version Software firmware version - @item SensorId +@item SensorId sensor id value - @item Type +@item Type sensor type 'bno055' - @end table +@end table - @end deftypefn +@end deftypefn - @deftypefn {} {} flush(@var{obj}) +@deftypefn {} {} flush(@var{obj}) Flush sensor data - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn - @deftypefn {} {} release(@var{obj}) +@deftypefn {} {} release(@var{obj}) Release the resources of the sensor - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn @c Sensors lis3dh @c ----------------------------------------- @subsection lis3dh @cindex lis3dh - @deftypefn {} {} lis3dh +@deftypefn {} {} lis3dh LIS3DH 3 degrees sensor - @end deftypefn +@end deftypefn - @subheading Methods - @deftypefn {} {@var{obj} =} lis3dh(@var{arObj}) - @deftypefnx {} {@var{obj} =} lis3dh(@var{arObj}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} lis3dh(@var{arObj}) +@deftypefnx {} {@var{obj} =} lis3dh(@var{arObj}, @var{propertyname, propertyvalue} ....) Constructor to create LIS3DH sensor - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{propertyname, propertyvalue} - optional property name, value pairs. +@var{propertyname, propertyvalue} - optional property name, value pairs. Current known properties are: Current properties are: - @table @asis - @item I2CAddress +@table @asis +@item I2CAddress I2C address of the sensor (default 0x40) - @item Bus +@item Bus I2C bus - 0 or 1 (default 0) - @end table +@end table - @subsubheading Outputs - @var{obj} - created object +@subsubheading Outputs +@var{obj} - created object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() sensor = lis3dh(a) } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAcceleration(@var{obj}) +@deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAcceleration(@var{obj}) Read the acceleration rate - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{readVal} - the 3 acceleration values +@subsubheading Outputs +@var{readVal} - the 3 acceleration values - @var{timestamp} - timestamp when read - @end deftypefn +@var{timestamp} - timestamp when read +@end deftypefn - @deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) - @deftypefnx {} {[@var{accel}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) +@deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) +@deftypefnx {} {[@var{accel}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) Read the sensor data - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{accel} - acceleration reading from sensor. +@subsubheading Outputs +@var{accel} - acceleration reading from sensor. - @var{timestamp} - timestamp when read +@var{timestamp} - timestamp when read - @var{overrun} - overrun flag. +@var{overrun} - overrun flag. - @var{readings} - table structure with fields for Timestamp, Acceleration. - @end deftypefn +@var{readings} - table structure with fields for Timestamp, Acceleration. +@end deftypefn - @deftypefn {} {@var{inf} =} info(@var{obj}) +@deftypefn {} {@var{inf} =} info(@var{obj}) Read the sensor info - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{inf} - structure containing the sensor information. +@subsubheading Outputs +@var{inf} - structure containing the sensor information. Structure fields are: - @table @asis - @item SensorId +@table @asis +@item SensorId sensor id value - @item Type +@item Type sensor type 'lis3dh' - @item Status +@item Status sensor status value - @end table +@end table - @end deftypefn +@end deftypefn - @deftypefn {} {} flush(@var{obj}) +@deftypefn {} {} flush(@var{obj}) Flush sensor data - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn - @deftypefn {} {} release(@var{obj}) +@deftypefn {} {} release(@var{obj}) Release the resources of the sensor - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn @c Sensors lps22hb @c ----------------------------------------- @subsection lps22hb @cindex lps22hb - @deftypefn {} {} lps22hb +@deftypefn {} {} lps22hb LPS22HB absolute pressure and temperature sensor - @end deftypefn +@end deftypefn - @subheading Methods - @deftypefn {} {@var{obj} =} lps22hb(@var{arObj}) - @deftypefnx {} {@var{obj} =} lps22hb(@var{arObj}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} lps22hb(@var{arObj}) +@deftypefnx {} {@var{obj} =} lps22hb(@var{arObj}, @var{propertyname, propertyvalue} ....) Constructor to create LPS22HB sensor - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{propertyname, propertyvalue} - optional property name, value pairs. +@var{propertyname, propertyvalue} - optional property name, value pairs. Current known properties are: Current properties are: - @table @asis - @item I2CAddress +@table @asis +@item I2CAddress I2C address of the sensor (default 0x5C) - @item Bus +@item Bus I2C bus - 0 or 1 (default 0) - @end table +@end table - @subsubheading Outputs - @var{obj} - created object +@subsubheading Outputs +@var{obj} - created object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() sensor = lps22hb(a) } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {[@var{C}, @var{timestamp}] =} readTemperature(@var{obj}) +@deftypefn {} {[@var{C}, @var{timestamp}] =} readTemperature(@var{obj}) Read the temperature - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{C} - read temperature in deg C. +@subsubheading Outputs +@var{C} - read temperature in deg C. - @var{timestamp} - timestamp when read +@var{timestamp} - timestamp when read - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() s = lps22hb(a) # get temp temp = s.readTemperature } - @end example - @xseealso{lps22hb} - @end deftypefn +@end example +@xseealso{lps22hb} +@end deftypefn - @deftypefn {} {[@var{P}, @var{timestamp}] =} readPressure(@var{obj}) +@deftypefn {} {[@var{P}, @var{timestamp}] =} readPressure(@var{obj}) Read the pressure - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{P} - pressure reading from sensor. +@subsubheading Outputs +@var{P} - pressure reading from sensor. - @var{timestamp} - timestamp when read - @end deftypefn +@var{timestamp} - timestamp when read +@end deftypefn - @deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) - @deftypefnx {} {[@var{P}, @var{C}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) +@deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) +@deftypefnx {} {[@var{P}, @var{C}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) Read the sensor data - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{P} - pressure reading from sensor. +@subsubheading Outputs +@var{P} - pressure reading from sensor. - @var{C} - temperature reading from sensor. +@var{C} - temperature reading from sensor. - @var{timestamp} - timestamp when read +@var{timestamp} - timestamp when read - @var{overrun} - overrun flag. +@var{overrun} - overrun flag. - @var{readings} - table structure with fields for Timestamp, Pressure, Temperature and Humidity. - @end deftypefn +@var{readings} - table structure with fields for Timestamp, Pressure, Temperature and Humidity. +@end deftypefn - @deftypefn {} {@var{inf} =} info(@var{obj}) +@deftypefn {} {@var{inf} =} info(@var{obj}) Read the sensor info - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{inf} - structure containing the sensor information. +@subsubheading Outputs +@var{inf} - structure containing the sensor information. Structure fields are: - @table @asis - @item Version +@table @asis +@item Version Chip firmware version - @item SensorId +@item SensorId sensor id value - @item Type +@item Type sensor type 'lps22hb' - @item Status +@item Status Status value read from sensor - @end table +@end table - @end deftypefn +@end deftypefn - @deftypefn {} {} flush(@var{obj}) +@deftypefn {} {} flush(@var{obj}) Flush sensor data - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn - @deftypefn {} {} release(@var{obj}) +@deftypefn {} {} release(@var{obj}) Release the resources of the sensor - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn @c Sensors lsm6dso @c ----------------------------------------- @subsection lsm6dso @cindex lsm6dso - @deftypefn {} {} lsm6dso +@deftypefn {} {} lsm6dso LSM6DSO 6 degrees sensor - @end deftypefn +@end deftypefn - @subheading Methods - @deftypefn {} {@var{obj} =} lsm6dso(@var{arObj}) - @deftypefnx {} {@var{obj} =} lsm6dso(@var{arObj}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} lsm6dso(@var{arObj}) +@deftypefnx {} {@var{obj} =} lsm6dso(@var{arObj}, @var{propertyname, propertyvalue} ....) Constructor to create LSM6DSO sensor - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{propertyname, propertyvalue} - optional property name, value pairs. +@var{propertyname, propertyvalue} - optional property name, value pairs. Current known properties are: Current properties are: - @table @asis - @item I2CAddress +@table @asis +@item I2CAddress I2C address of the sensor (default 0x40) - @item Bus +@item Bus I2C bus - 0 or 1 (default 0) - @end table +@end table - @subsubheading Outputs - @var{obj} - created object +@subsubheading Outputs +@var{obj} - created object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() sensor = lsm6dso(a) } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {[@var{C}, @var{timestamp}] =} readTemperature(@var{obj}) +@deftypefn {} {[@var{C}, @var{timestamp}] =} readTemperature(@var{obj}) Read the temperature - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{C} - read temperature in deg C. +@subsubheading Outputs +@var{C} - read temperature in deg C. - @var{timestamp} - timestamp when read +@var{timestamp} - timestamp when read - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() s = lsm6dso(a) # get temp temp = s.readTemperature } - @end example - @xseealso{lsm6dso} - @end deftypefn +@end example +@xseealso{lsm6dso} +@end deftypefn - @deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAcceleration(@var{obj}) +@deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAcceleration(@var{obj}) Read the acceleration rate - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{readVal} - the 3 acceleration values +@subsubheading Outputs +@var{readVal} - the 3 acceleration values - @var{timestamp} - timestamp when read - @end deftypefn +@var{timestamp} - timestamp when read +@end deftypefn - @deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAngularVelocity(@var{obj}) +@deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAngularVelocity(@var{obj}) Read the angular velocity - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{readVal} - the 3 angular velocity values +@subsubheading Outputs +@var{readVal} - the 3 angular velocity values - @var{timestamp} - timestamp when read - @end deftypefn +@var{timestamp} - timestamp when read +@end deftypefn - @deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) - @deftypefnx {} {[@var{accel}, @var{gyro}, @var{mag}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) +@deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) +@deftypefnx {} {[@var{accel}, @var{gyro}, @var{mag}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) Read the sensor data - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{accel} - acceleration reading from sensor. +@subsubheading Outputs +@var{accel} - acceleration reading from sensor. - @var{gyro} - angular acceleration reading from sensor. +@var{gyro} - angular acceleration reading from sensor. - @var{timestamp} - timestamp when read +@var{timestamp} - timestamp when read - @var{overrun} - overrun flag. +@var{overrun} - overrun flag. - @var{readings} - table structure with fields for Timestamp, Acceleration, AngularVelocity. - @end deftypefn +@var{readings} - table structure with fields for Timestamp, Acceleration, AngularVelocity. +@end deftypefn - @deftypefn {} {@var{inf} =} info(@var{obj}) +@deftypefn {} {@var{inf} =} info(@var{obj}) Read the sensor info - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{inf} - structure containing the sensor information. +@subsubheading Outputs +@var{inf} - structure containing the sensor information. Structure fields are: - @table @asis - @item SensorId +@table @asis +@item SensorId sensor id value - @item Type +@item Type sensor type 'lsm6dso' - @end table +@end table - @end deftypefn +@end deftypefn - @deftypefn {} {} flush(@var{obj}) +@deftypefn {} {} flush(@var{obj}) Flush sensor data - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn - @deftypefn {} {} release(@var{obj}) +@deftypefn {} {} release(@var{obj}) Release the resources of the sensor - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn @c Sensors mpu6050 @c ----------------------------------------- @subsection mpu6050 @cindex mpu6050 - @deftypefn {} {} mpu6050 +@deftypefn {} {} mpu6050 MPU-6050 6 degrees sensor - @end deftypefn +@end deftypefn - @subheading Methods - @deftypefn {} {@var{obj} =} mpu6050(@var{arObj}) - @deftypefnx {} {@var{obj} =} mpu6050(@var{arObj}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} mpu6050(@var{arObj}) +@deftypefnx {} {@var{obj} =} mpu6050(@var{arObj}, @var{propertyname, propertyvalue} ....) Constructor to create MPU-6050 sensor - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{propertyname, propertyvalue} - optional property name, value pairs. +@var{propertyname, propertyvalue} - optional property name, value pairs. Current known properties are: Current properties are: - @table @asis - @item I2CAddress +@table @asis +@item I2CAddress I2C address of the sensor (default 0x40) - @item Bus +@item Bus I2C bus - 0 or 1 (default 0) - @end table +@end table - @subsubheading Outputs - @var{obj} - created object +@subsubheading Outputs +@var{obj} - created object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() sensor = mpu6050(a) } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {[@var{C}, @var{timestamp}] =} readTemperature(@var{obj}) +@deftypefn {} {[@var{C}, @var{timestamp}] =} readTemperature(@var{obj}) Read the temperature - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{C} - read temperature in deg C. +@subsubheading Outputs +@var{C} - read temperature in deg C. - @var{timestamp} - timestamp when read +@var{timestamp} - timestamp when read - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() s = mpu6050(a) # get temp temp = s.readTemperature } - @end example - @xseealso{mpu6050} - @end deftypefn +@end example +@xseealso{mpu6050} +@end deftypefn - @deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAcceleration(@var{obj}) +@deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAcceleration(@var{obj}) Read the acceleration rate - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{readVal} - the 3 acceleration values +@subsubheading Outputs +@var{readVal} - the 3 acceleration values - @var{timestamp} - timestamp when read - @end deftypefn +@var{timestamp} - timestamp when read +@end deftypefn - @deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAngularVelocity(@var{obj}) +@deftypefn {} {[@var{readVal}, @var{timestamp}] =} readAngularVelocity(@var{obj}) Read the angular velocity - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{readVal} - the 3 angular velocity values +@subsubheading Outputs +@var{readVal} - the 3 angular velocity values - @var{timestamp} - timestamp when read - @end deftypefn +@var{timestamp} - timestamp when read +@end deftypefn - @deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) - @deftypefnx {} {[@var{accel}, @var{gyro}, @var{mag}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) +@deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) +@deftypefnx {} {[@var{accel}, @var{gyro}, @var{mag}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) Read the sensor data - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{accel} - acceleration reading from sensor. +@subsubheading Outputs +@var{accel} - acceleration reading from sensor. - @var{gyro} - angular acceleration reading from sensor. +@var{gyro} - angular acceleration reading from sensor. - @var{timestamp} - timestamp when read +@var{timestamp} - timestamp when read - @var{overrun} - overrun flag. +@var{overrun} - overrun flag. - @var{readings} - table structure with fields for Timestamp, Acceleration, AngularVelocity. - @end deftypefn +@var{readings} - table structure with fields for Timestamp, Acceleration, AngularVelocity. +@end deftypefn - @deftypefn {} {@var{inf} =} info(@var{obj}) +@deftypefn {} {@var{inf} =} info(@var{obj}) Read the sensor info - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs - @var{inf} - structure containing the sensor information. +@subsubheading Outputs +@var{inf} - structure containing the sensor information. Structure fields are: - @table @asis - @item SensorId +@table @asis +@item SensorId sensor id value - @item Type +@item Type sensor type 'mpu6050' - @end table +@end table - @end deftypefn +@end deftypefn - @deftypefn {} {} flush(@var{obj}) +@deftypefn {} {} flush(@var{obj}) Flush sensor data - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn - @deftypefn {} {} release(@var{obj}) +@deftypefn {} {} release(@var{obj}) Release the resources of the sensor - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn @c Sensors si7021 @c ----------------------------------------- @subsection si7021 @cindex si7021 - @deftypefn {} {} si7021 +@deftypefn {} {} si7021 SI7021 temperature and humidity sensor - @end deftypefn +@end deftypefn - @subheading Methods - @deftypefn {} {@var{obj} =} si7021(@var{arObj}) - @deftypefnx {} {@var{obj} =} si7021(@var{arObj}, @var{propertyname, propertyvalue} ....) +@subheading Methods +@deftypefn {} {@var{obj} =} si7021(@var{arObj}) +@deftypefnx {} {@var{obj} =} si7021(@var{arObj}, @var{propertyname, propertyvalue} ....) Constructor to create si7021 sensor - @subsubheading Inputs - @var{arObj} - the arduino parent object +@subsubheading Inputs +@var{arObj} - the arduino parent object - @var{propertyname, propertyvalue} - optional property name, value pairs. +@var{propertyname, propertyvalue} - optional property name, value pairs. Current known properties are: Current properties are: - @table @asis - @item I2Caddress +@table @asis +@item I2Caddress I2C address of the si7021 (default 0x40) - @item Bus +@item Bus I2C bus (default 0) - @end table +@end table - @subsubheading Outputs - @var{obj} - created SI7020 object +@subsubheading Outputs +@var{obj} - created SI7020 object - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() sensor = si7021(a) } - @end example - @end deftypefn +@end example +@end deftypefn - @deftypefn {} {[@var{C}, @var{timestamp}] =} readTemperature(@var{obj}) +@deftypefn {} {[@var{C}, @var{timestamp}] =} readTemperature(@var{obj}) Read the temperature - @subsubheading Inputs - @var{obj} - the si7021 object +@subsubheading Inputs +@var{obj} - the si7021 object - @subsubheading Outputs - @var{C} - read temperature in deg C. +@subsubheading Outputs +@var{C} - read temperature in deg C. - @var{timestamp} - timestamp when read +@var{timestamp} - timestamp when read - @subsubheading Example - @example - @code { +@subsubheading Example +@example +@code { a = arduino() s = si7021(a) # get temp temp = s.readTemperature() } - @end example - @xseealso{si7021} - @end deftypefn +@end example +@xseealso{si7021} +@end deftypefn - @deftypefn {} {[@var{relH}, @var{timestamp}] =} readHumidity(@var{obj}) +@deftypefn {} {[@var{relH}, @var{timestamp}] =} readHumidity(@var{obj}) Read the relative humidity - @subsubheading Inputs - @var{obj} - the si7021 object +@subsubheading Inputs +@var{obj} - the si7021 object - @subsubheading Outputs - @var{relH} - relative humidity as a percentage (0 - 100.0) +@subsubheading Outputs +@var{relH} - relative humidity as a percentage (0 - 100.0) - @var{timestamp} - timestamp when read - @end deftypefn +@var{timestamp} - timestamp when read +@end deftypefn - @deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) - @deftypefnx {} {[@var{H}, @var{C}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) +@deftypefn {} {[@var{readings}, @var{overrun}] =} read(@var{obj}) +@deftypefnx {} {[@var{H}, @var{C}, @var{timestamp}, @var{overrun}] =} read(@var{obj}) Read the sensor data - @subsubheading Inputs - @var{obj} - the si2071 sensor object +@subsubheading Inputs +@var{obj} - the si2071 sensor object - @subsubheading Outputs - @var{H} - humidity reading from sensor. +@subsubheading Outputs +@var{H} - humidity reading from sensor. - @var{C} - temperature reading from sensor. +@var{C} - temperature reading from sensor. - @var{timestamp} - timestamp when read +@var{timestamp} - timestamp when read - @var{overrun} - overrun flag. +@var{overrun} - overrun flag. - @var{readings} - table structure with fields for Timestamp, Temperature and Humidity. - @end deftypefn +@var{readings} - table structure with fields for Timestamp, Temperature and Humidity. +@end deftypefn - @deftypefn {} {@var{relH} =} info(@var{dsObj}) +@deftypefn {} {@var{relH} =} info(@var{dsObj}) Read the sensor info - @subsubheading Inputs - @var{dsObj} - the si7021 object +@subsubheading Inputs +@var{dsObj} - the si7021 object - @subsubheading Outputs - @var{inf} - structure containing the sensor information. +@subsubheading Outputs +@var{inf} - structure containing the sensor information. Structure fields are: - @table @asis - @item Version +@table @asis +@item Version Chip firmware version - @item SensorDd +@item SensorDd sensor id value - @item Type +@item Type String for detected chip type - @end table +@end table - @end deftypefn +@end deftypefn - @deftypefn {} {} flush(@var{obj}) +@deftypefn {} {} flush(@var{obj}) Flush sensor data - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn - @deftypefn {} {} release(@var{obj}) +@deftypefn {} {} release(@var{obj}) Release the resources of the sensor - @subsubheading Inputs - @var{obj} - the sensor object +@subsubheading Inputs +@var{obj} - the sensor object - @subsubheading Outputs +@subsubheading Outputs None - @end deftypefn +@end deftypefn @c --------------------------------------------------- @node Test Functions @section Test Functions @@ -4755,29 +4755,29 @@ @c ----------------------------------------- @subsection arduino_bistsetup @cindex arduino_bistsetup - @deftypefn {} {@var{retval} =} arduino_bistsetup () - @deftypefnx {} {@var{retval} =} arduino_bistsetup (@var{propertyname}, @var{propertyvalue}) +@deftypefn {} {@var{retval} =} arduino_bistsetup () +@deftypefnx {} {@var{retval} =} arduino_bistsetup (@var{propertyname}, @var{propertyvalue}) Install on an arduino the required core libraries to run the BIST tests As part of the setup, the arduino IDE will be opened to allow programming the arduino board. - @subsubheading Inputs +@subsubheading Inputs - @var{propertyname}, @var{propertyvalue} - A sequence of property name/value pairs can be given +@var{propertyname}, @var{propertyvalue} - A sequence of property name/value pairs can be given to set defaults while programming. Currently the following properties can be set: - @table @asis - @item arduinobinary +@table @asis +@item arduinobinary The value should be the name/path of the arduino IDE binary for programming. If not specified, the function will attempt to find the binary itself. - @item debug +@item debug Set the debug flag when checking the arduino - @end table +@end table - @subsubheading Outputs - @var{retval} - return 1 if everything installed ok +@subsubheading Outputs +@var{retval} - return 1 if everything installed ok - @xseealso{arduino, arduinosetup} - @end deftypefn +@xseealso{arduino, arduinosetup} +@end deftypefn diff --git a/doc/version.texi b/doc/version.texi new file mode 100644 index 0000000..d1654d0 --- /dev/null +++ b/doc/version.texi @@ -0,0 +1,4 @@ +@c autogenerated from Makefile +@set VERSION 0.11.0 +@set PACKAGE arduino +@set DATE 2023-07-19 diff --git a/inst/+arduinoio/+config/config_uno_minima_r4.m b/inst/+arduinoio/+config/config_uno_minima_r4.m new file mode 100644 index 0000000..27f11fc --- /dev/null +++ b/inst/+arduinoio/+config/config_uno_minima_r4.m @@ -0,0 +1,38 @@ + +function retval = config_uno_minima_r4 (initdata) + retval = {}; + + retval.board = 'uno_minima_r4'; + retval.mcu = ''; + retval.voltref = 0; + retval.libs = {}; + retval.port = ''; + + # info expected to be provided by config. + retval.description = 'Arduino Uno Minima R4 Board'; + + # pin config + retval.pins = {}; + retval.pins{end+1} = arduinoio.config.pin_info('D0', 0, { 'digital', 'uart_rx' }); + retval.pins{end+1} = arduinoio.config.pin_info('D1', 1, { 'digital', 'uart_tx' }); + retval.pins{end+1} = arduinoio.config.pin_info('D2', 2, { 'digital' }); + retval.pins{end+1} = arduinoio.config.pin_info('D3', 3, { 'digital', 'pwm' }); + retval.pins{end+1} = arduinoio.config.pin_info('D4', 4, { 'digital', 'can0_tx' }); + retval.pins{end+1} = arduinoio.config.pin_info('D5', 5, { 'digital', 'can0_rx', 'pwm' }); + retval.pins{end+1} = arduinoio.config.pin_info('D6', 6, { 'digital', 'pwm' }); + retval.pins{end+1} = arduinoio.config.pin_info('D7', 7, { 'digital' }); + retval.pins{end+1} = arduinoio.config.pin_info('D8', 8, { 'digital' }); + retval.pins{end+1} = arduinoio.config.pin_info('D9', 9, { 'digital', 'pwm' }); + retval.pins{end+1} = arduinoio.config.pin_info('D10', 10, { 'digital', 'spi_ss', 'pwm' }); + retval.pins{end+1} = arduinoio.config.pin_info('D11', 11, { 'digital', 'spi_mosi', 'pwm' }); + retval.pins{end+1} = arduinoio.config.pin_info('D12', 12, { 'digital', 'spi_miso' }); + retval.pins{end+1} = arduinoio.config.pin_info('D13', 13, { 'digital', 'led', 'spi_sck' }); + retval.pins{end+1} = arduinoio.config.pin_info('A0', 14, { 'digital', 'analog' }); + retval.pins{end+1} = arduinoio.config.pin_info('A1', 15, { 'digital', 'analog' }); + retval.pins{end+1} = arduinoio.config.pin_info('A2', 16, { 'digital', 'analog' }); + retval.pins{end+1} = arduinoio.config.pin_info('A3', 17, { 'digital', 'analog' }); + retval.pins{end+1} = arduinoio.config.pin_info('A4', 18, { 'digital', 'analog', 'i2c_sda' }); + retval.pins{end+1} = arduinoio.config.pin_info('A5', 19, { 'digital', 'analog' 'i2c_scl' }); + retval.pins{end+1} = arduinoio.config.pin_info('D20', 20, { 'digital' }); + retval.pins{end+1} = arduinoio.config.pin_info('D21', 21, { 'digital' }); +endfunction diff --git a/inst/+arduinoio/+config/config_uno_wifi_r4.m b/inst/+arduinoio/+config/config_uno_wifi_r4.m new file mode 100644 index 0000000..bbac523 --- /dev/null +++ b/inst/+arduinoio/+config/config_uno_wifi_r4.m @@ -0,0 +1,66 @@ +## Copyright (C) 2023 John Donoghue <john.donoghue@ieee.org> +## +## This program is free software: you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation, either version 3 of the License, or +## (at your option) any later version. +## +## This program is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program. If not, see +## <https://www.gnu.org/licenses/>. + +## -*- texinfo -*- +## @deftypefn {} {@var{retval} =} config_uno_wifi_r4 (@var{initdata}) +## Private function for setting allowed modes of uno board pins +## @end deftypefn + +function retval = config_uno_wifi_r4 (initdata) + retval = {}; + + retval.board = 'uno_wifi_r4'; + retval.mcu = 'Renesis RA4M1'; + retval.voltref = 0; + retval.libs = {}; + retval.port = ''; + + # info expected to be provided by config. + retval.description = 'Arduino Uno WIFI R4 Board'; + + # pin config + retval.pins = {}; + retval.pins{end+1} = arduinoio.config.pin_info('D0', 0, { 'digital', 'uart2_tx' }); + retval.pins{end+1} = arduinoio.config.pin_info('D1', 1, { 'digital', 'uart2_rx' }); + retval.pins{end+1} = arduinoio.config.pin_info('D2', 2, { 'digital' }); + retval.pins{end+1} = arduinoio.config.pin_info('D3', 3, { 'digital', 'pwm' }); + retval.pins{end+1} = arduinoio.config.pin_info('D4', 4, { 'digital' }); + retval.pins{end+1} = arduinoio.config.pin_info('D5', 5, { 'digital', 'pwm' }); + retval.pins{end+1} = arduinoio.config.pin_info('D6', 6, { 'digital', 'pwm' }); + retval.pins{end+1} = arduinoio.config.pin_info('D7', 7, { 'digital' }); + retval.pins{end+1} = arduinoio.config.pin_info('D8', 8, { 'digital' }); + retval.pins{end+1} = arduinoio.config.pin_info('D9', 9, { 'digital', 'pwm' }); + retval.pins{end+1} = arduinoio.config.pin_info('D10', 10, { 'digital', 'spi_ss', 'can0_tx', 'pwm' }); + retval.pins{end+1} = arduinoio.config.pin_info('D11', 11, { 'digital', 'spi_mosi', 'pwm' }); + retval.pins{end+1} = arduinoio.config.pin_info('D12', 12, { 'digital', 'spi_miso' }); + retval.pins{end+1} = arduinoio.config.pin_info('D13', 13, { 'digital', 'led', 'spi_sck', 'can0_rx' }); + retval.pins{end+1} = arduinoio.config.pin_info('A0', 14, { 'digital', 'analog' }); + retval.pins{end+1} = arduinoio.config.pin_info('A1', 15, { 'digital', 'analog' }); + retval.pins{end+1} = arduinoio.config.pin_info('A2', 16, { 'digital', 'analog' }); + retval.pins{end+1} = arduinoio.config.pin_info('A3', 17, { 'digital', 'analog' }); + retval.pins{end+1} = arduinoio.config.pin_info('A4', 18, { 'digital', 'analog', 'i2c_sda' }); + retval.pins{end+1} = arduinoio.config.pin_info('A5', 19, { 'digital', 'analog', 'i2c_scl' }); + retval.pins{end+1} = arduinoio.config.pin_info('D20', 20, { 'digital' }); + retval.pins{end+1} = arduinoio.config.pin_info('D21', 21, { 'digital' }); + + retval.pins{end+1} = arduinoio.config.pin_info('D22', 22, { 'uart1_tx' }); + retval.pins{end+1} = arduinoio.config.pin_info('D23', 23, { 'uart1_rx' }); + retval.pins{end+1} = arduinoio.config.pin_info('D24', 24, { 'uart3_tx' }); + retval.pins{end+1} = arduinoio.config.pin_info('D25', 25, { 'uart3_rx' }); + + retval.pins{end+1} = arduinoio.config.pin_info('D26', 26, { 'i2c1_scl' }); + retval.pins{end+1} = arduinoio.config.pin_info('D27', 27, { 'i2c1_sda' }); +endfunction diff --git a/inst/+arduinoio/boardTypeString.m b/inst/+arduinoio/boardTypeString.m index 9a46fd9..b78b284 100644 --- a/inst/+arduinoio/boardTypeString.m +++ b/inst/+arduinoio/boardTypeString.m @@ -67,6 +67,10 @@ function retval = boardTypeString (id) retval = "nano_rp2040_connect"; case 111 retval = "esp32_dev"; + case 112 + retval = "uno_wifi_r4"; + case 113 + retval = "uno_minima_r4"; otherwise retval = "unknown"; endswitch diff --git a/inst/+arduinoio/lib/LibraryBase.cpp b/inst/+arduinoio/lib/LibraryBase.cpp index 4a65897..c0c4df3 100644 --- a/inst/+arduinoio/lib/LibraryBase.cpp +++ b/inst/+arduinoio/lib/LibraryBase.cpp @@ -31,7 +31,7 @@ #define STATE_EOM 5 #if defined(OCTAVE_USE_WIFI_COMMS) -# ifdef ARDUINO_ARCH_ESP32 +# if defined(ARDUINO_ARCH_ESP32) || defined(ARDUINO_ARCH_RENESAS) #include <WiFi.h> # else #include <WiFiNINA.h> diff --git a/inst/+arduinoio/lib/LibraryBase.h b/inst/+arduinoio/lib/LibraryBase.h index b9d9083..69edced 100644 --- a/inst/+arduinoio/lib/LibraryBase.h +++ b/inst/+arduinoio/lib/LibraryBase.h @@ -22,7 +22,7 @@ #include <Arduino.h> #define VERSION_MAJOR 0 -#define VERSION_MINOR 10 +#define VERSION_MINOR 11 #define VERSION_PATCH 0 #if defined(ARDUINO_SAM_DUE) diff --git a/inst/+arduinoio/lib/OctaveCoreLibrary.cpp b/inst/+arduinoio/lib/OctaveCoreLibrary.cpp index fae1182..4b12d2e 100644 --- a/inst/+arduinoio/lib/OctaveCoreLibrary.cpp +++ b/inst/+arduinoio/lib/OctaveCoreLibrary.cpp @@ -100,6 +100,10 @@ #elif defined(ARDUINO_ESP32_DEV) #define BOARD_ID 111 #define BOARD_VOLTAGE 33 +#elif defined(ARDUINO_UNOR4_WIFI) + #define BOARD_ID 112 +#elif defined(ARDUINO_UNOR4_MINIMA) + #define BOARD_ID 113 #else #error "Unknown board type" #endif @@ -164,7 +168,7 @@ reset () wdt_enable (WDTO_1S); while(1) {} } -#elif defined (ARDUINO_ARCH_SAMD) || defined (ARDUINO_ARCH_NRF52840) || defined (ARDUINO_ARCH_SAM) || defined (ARDUINO_ARCH_RP2040) +#elif defined (ARDUINO_ARCH_SAMD) || defined (ARDUINO_ARCH_NRF52840) || defined (ARDUINO_ARCH_SAM) || defined (ARDUINO_ARCH_RP2040) || defined(ARDUINO_ARCH_RENESAS) void reset () { diff --git a/inst/+arduinoio/lib/OctaveI2CLibrary.cpp b/inst/+arduinoio/lib/OctaveI2CLibrary.cpp index 7eeda0f..3cff952 100644 --- a/inst/+arduinoio/lib/OctaveI2CLibrary.cpp +++ b/inst/+arduinoio/lib/OctaveI2CLibrary.cpp @@ -40,7 +40,11 @@ static uint8_t i2c_address = 0; # if defined(ARDUINO_ARDUINO_NANO33BLE) # define WIRE_INTERFACES_COUNT 2 # else -# define WIRE_INTERFACES_COUNT 1 +# if defined(WIRE_HOWMANY) +# define WIRE_INTERFACES_COUNT WIRE_HOWMANY +# else +# define WIRE_INTERFACES_COUNT 1 +# endif # endif #endif |