beaglebone 1.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b19c474402f31c4baf1e2965ba0f49327cb40ba8
-  data.tar.gz: 2b05ac032cefc71bfc53561c82b1bdf62ed02ce6
+  metadata.gz: e1e67c458b2531e22e6448a1a7f48cefbc6fb938
+  data.tar.gz: 4b01929c1291294281617ad65f49ace68a8e3497
 SHA512:
-  metadata.gz: 8f5ab52cdace0e05a025c9b43fdaeb9133e52ef0ca941f374dbed18fc695a7c97c0d65e48d548125e88a561b8e5be361c6d8fa7cbc75ffd2f852b9d233220cfc
-  data.tar.gz: 67586adfc78e6d4ba5c719a8d53e657bed0608933c643349c407b522ae908fd51467d18eff86aef564e910e4d2f0ca00da442e2e5ed161d7fd769aad66f75c2d
+  metadata.gz: 4c200e3754b49ab4e4870453faa28c7c6bc7b6b16895ce6df9dcd8c16e16bfdbf42aadfc7c6ac3c03b8ac2b6025686b6f611e123a1d47e30ab17994473169382
+  data.tar.gz: d17903bf3d475051bb24ceb0efaaff537c2a55e1852155903e397186eb073d1f9e04fb033636b6eb62ed209359231054970c1c64e2bc5c1ab1fe8ee305199d94

data/README.md

@@ -1,5 +1,4 @@
 # Beaglebone Ruby Library
-Documentation is in progress and will be completed shortly.
 
 **Table of Contents**
 - [Overview](#overview)
@@ -7,7 +6,14 @@ Documentation is in progress and will be completed shortly.
   - [Installing Ruby](#installing-ruby)
   - [Installing Beaglebone Gem](#installing-beaglebone-gem)
 - [Usage](#usage)
-- [Reference](#reference)
+- [Pin Information](#pin-information)
+  - [GPIO Pins](#gpio-pins)
+  - [Analog Pins](#analog-pins)
+  - [PWM Pins](#pwm-pins)
+  - [UART Pins](#uart-pins)
+  - [I2C Pins](#i2c-pins)
+  - [SPI Pins](#spi-pins)
+- [Source Code Reference](#source-code-reference)
 - [Examples (Object Oriented)](#examples-object-oriented)
   - [GPIO](#gpio)
     - [GPIO Writing](#gpio-writing)
@@ -36,7 +42,6 @@ Documentation is in progress and will be completed shortly.
     - [SPI Data Transfer](#spi-data-transfer)
     - [MCP3008 Example](#mcp3008-example)
 - [Examples (Procedural)](#examples-procedural)
-- [Pin Reference](#pin-reference)
 - [License](#license)
 
 ## Overview
@@ -66,8 +71,44 @@ require 'beaglebone'
 include Beaglebone
 ```
 
-## Rereference
-A full reference is available [here](http://rubydoc.info/gems/beaglebone/1.0.5/frames).
+## Pin Information
+The Beaglebone has two headers of IO pins.  Documentation on these pins is available [here](http://beagleboard.org/Support/bone101#headers).
+
+### GPIO Pins
+The beaglebone has a large number of GPIO pins.  These pins function at 3.3v.  Do not provide more than 3.3v to any GPIO pin or risk damaging the hardware.
+
+Not all GPIO pins will be usable.  Currently there is a bug affecting P9_17 and P9_18.  They do not function in the latest Debian image.
+
+There are built in _capes_ that have priority over the GPIO pins unless disabled.  These are for HDMI and the onboard eMMC.  It is documented [here](http://beagleboard.org/Support/bone101#headers-black).  It is possible to disable these _capes_ if you are not using them.
+
+### Analog Pins
+The beaglebone has 7 Analog inputs.  Documentation on these pins is available [here](http://beagleboard.org/Support/bone101#headers-analog).  These pins function at 1.8v.  Do not provide more than 1.8v to any Analog pin or risk damaging the hardware.  The header has pins available to provide a 1.8v for analog devices as well as a dedicated analog ground.
+
+### PWM Pins
+The beaglebone has 8 PWM pins.  Documentation on these pins is available [here](http://beagleboard.org/Support/bone101#headers-pwm).  These pins function at 3.3v.
+
+Not all 8 pins may be used at the same time. You may use the following pins.
+
+- P8_13 or P8_19
+- P9_14 or P9_16
+- P9_21 or P9_22
+- P9_28 and P9_42
+
+### UART Pins
+The beaglebone has 5 UART devices available.  Documentation on these pins is available [here](http://beagleboard.org/Support/bone101#headers-serial).  These pins function at 3.3v.  Do not provide more than 3.3v to any UART pin or risk damaging the hardware.
+
+UART3 only has a TX pin available.
+
+UART5 TX and RX pins are unavailable by default, as the HDMI _cape_ claims those pins unless disabled.
+
+### I2C Pins
+The beaglebone has 2 I2C devices available.  Documentation on these pins is available [here](http://beagleboard.org/Support/bone101#headers-i2c).  These pins function at 3.3v.  Do not provide more than 3.3v to any I2C pin or risk damaging the hardware.
+
+### SPI Pins
+The beaglebone has 2 SPI devices available.  Documentation on these pins is available [here](http://beagleboard.org/Support/bone101#headers-spi).  These pins function at 3.3v.  Do not provide more than 3.3v to any SPI pin or risk damaging the hardware.
+
+## Source Code Reference
+A full Source Code reference is available [here](http://rubydoc.info/gems/beaglebone/1.0.5/frames).
 
 ## Examples (Object Oriented)
 These examples will show the various ways to interact with the Beaglebones IO hardware.  They will need to be executed as root in order to function correctly.
@@ -148,7 +189,7 @@ end
 ```
 
 #### Edge Triggers
-The Beaglebone can also monitor for changes on a GPIO pin.  This is called an edge trigger.  Since this is interrupt based on the Beaglebone, waiting for a change does not waste CPU cycles by constantly polling the pin.
+The Beaglebone can monitor for changes on a GPIO pin.  This is called an edge trigger.  Since this is interrupt based on the Beaglebone, waiting for a change does not waste CPU cycles by constantly polling the pin.
 
 The following trigger types are supported
 - Rising: Triggered when the state goes from low to high
@@ -208,7 +249,7 @@ p9_11.set_gpio_edge(:RISING)
 ```
 
 #### Shift Registers
-This library will also support writing to shift registers using GPIO pins.  Create a **ShiftRegister** object by initializing it with the latch pin, clock pin, and data pin.
+This library will support writing to shift registers using GPIO pins.  Create a **ShiftRegister** object by initializing it with the latch pin, clock pin, and data pin.
 
 This example will trigger 8 pins of a shift register.
 
@@ -391,6 +432,12 @@ p9_14.set_duty_cycle_ns(31250000)
 # Invert the output signal
 p9_14.set_polarity(:INVERTED)
 
+# Stop the output signal
+p9_14.stop
+
+# Resume the output signal
+p9_14.run
+
 # Disable the output signal
 p9_14.disable_pwm_pin
 ```
@@ -527,6 +574,10 @@ To read from an I2C device, the method **#read** is used.
 This example communicates with an [LSM303DLHC](https://www.adafruit.com/products/1120) Accelerometer/Compass/Thermometer device.
 
 ```ruby
+#!/usr/bin/env ruby
+require 'beaglebone'
+include Beaglebone
+
 # Initialize I2C device I2C2
 i2c = I2CDevice.new(:I2C2)
 
@@ -579,7 +630,7 @@ The beaglebone has a number of SPI devices.  These operate at 3.3v.  Do not prov
 
 To initialize the SPI device **SPI0**, pass the symbol for that device to the **SPIDevice** constructor.
 
-The optional arguments are also available
+The optional arguments are available
 - mode: SPI mode, :SPI_MODE_0 through :SPI_MODE_3
 - speed: Speed of the SPI device
 - bpw: Bits per word
@@ -603,7 +654,7 @@ spi.set_bpw(10)
 spi.disable
 ```
 
-#### SPI Data Tramsfer
+#### SPI Data Transfer
 To transfer data to an SPI device, the method **#xfer** is used.
 
 **#xfer** takes the following arguments
@@ -613,12 +664,16 @@ To transfer data to an SPI device, the method **#xfer** is used.
 - delay: (optional) delay
 - bpw: (optonal) bits per word
 
-**#xfer** returns the bytes read from the SPI device.
+**#xfer** returns the data read from the SPI device.
 
 #### MCP3008 Example
 This example communicates with an [MCP3008](http://www.adafruit.com/products/856) ADC device.
 
 ```ruby
+#!/usr/bin/env ruby
+require 'beaglebone'
+include Beaglebone
+
 # Initialize SPI device SPI0
 spi = SPIDevice.new(:SPI0)
 
@@ -629,7 +684,7 @@ spi = SPIDevice.new(:SPI0)
 # Read value from channel 0
 raw = spi.xfer([ 0b00000001, 0b10000000, 0].pack("C*"))
 
-# split data read into an array of characters
+# Split data read into an array of characters
 data = raw.unpack("C*")
 
 # The returned data is stored starting at the last two bits of the second byte
@@ -641,7 +696,7 @@ puts "Value of channel 0: #{val}"
 # Read value from channel 1
 raw = spi.xfer([ 0b00000001, 0b10010000, 0].pack("C*"))
 
-# split data read into an array of characters
+# Split data read into an array of characters
 data = raw.unpack("C*")
 
 # The returned data is stored starting at the last two bits of the second byte
@@ -649,12 +704,40 @@ val = ((data[1] & 0b00000011) << 8 ) | data[2]
 
 # Display the value of channel 1
 puts "Value of channel 1: #{val}"
+
+# Disable SPI device
+spi.disable
 ```
 
 ## Examples (Procedural)
+This library supports _procedural_ methods as well as _objet oriented_ methods.  They are virtually identical to the _object oriented_ methods, except the first argument they take is the pin.  If a callback is required, it is still passed first, before the pin.  The examples directory has sample code in both formats.
+
+The procedural versions of the examples are available in the file [procedural-examples.md](procedural-examples.md).
 
+Instead of constructors, the following methods are used to initialize the pins and devices on the Beaglebone.
 
-## Pin Reference
+```ruby
+# GPIOPin.new becomes
+GPIO.pin_mode(:P9_12, :OUT)
+
+# To set the state of the pin
+GPIO.digital_write(:P9_12, :OUT)
+
+# Analog pins do not require setup, and can be read at any time
+AIN.read(:P9_33)
+
+# PWMPin.new becomes
+PWM.start(:P9_14, 90, 10, :NORMAL)
+
+# UARTDevice.new becomes
+UART.setup(:UART1, 9600)
+
+# I2CDevice.new becomes
+I2C.setup(:I2C2)
+
+# SPIDevice.new becomes
+SPI.setup(:SPI0)
+```
 
 ## License
-Copyright (c) 2014 Rob Mosher.  Distributed under the GPL-v3 License.  See LICENSE for more information.
+Copyright (c) 2014 Rob Mosher.  Distributed under the GPL-v3 License.  See [LICENSE](LICENSE) for more information.

data/beaglebone.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'beaglebone'
-  s.version     = '1.0.6'
+  s.version     = '1.1.0'
   s.date        = '2014-04-13'
   s.summary     = 'Beaglebone IO Gem'
   s.description = 'A Full Featured Beaglebone IO Gem'