forked from WiringPi/WiringPi-Ruby
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update and rename README to README.md
- Loading branch information
1 parent
73e90d8
commit e35d933
Showing
2 changed files
with
43 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# WiringPi | ||
WiringPi is an implementation of most of the Arduino Wiring functions for the Raspberry Pi, this gem is a wrapper for the main wiringpi library and provides a nice OO interface with a few other handy helpers. | ||
|
||
## Installation | ||
Install with `gem install wiringpi2` or use bundler's Gemfile | ||
``` | ||
source 'https://rubygems.org' | ||
gem 'wiringpi2' # https://github.com/WiringPi/WiringPi-Ruby | ||
``` | ||
then: `bundle install` | ||
|
||
## Example | ||
``` | ||
#!/usr/bin/env ruby | ||
require 'bundler' | ||
Bundler.setup | ||
Bundler.require | ||
io = WiringPi::GPIO.new do |gpio| | ||
gpio.pin_mode(0, WiringPi::OUTPUT) | ||
gpio.pin_mode(1, WiringPi::INPUT) | ||
end | ||
pin_state = io.digital_read(1) # Read from pin 1 | ||
puts pin_state | ||
io.digital_write(0, WiringPi::HIGH) # Turn pin 0 on | ||
io.delay(100) # Wait | ||
io.digital_write(0, WiringPi::LOW) # Turn pin 0 off | ||
``` | ||
You will need to run your scripts as root because WiringPi accesses `/dev/mem` | ||
|
||
## Reference | ||
|
||
### Pins | ||
For a complete run-down see the [pins page](http://wiringpi.com/pins/) of the [wiringpi website](http://wiringpi.com/). | ||
![alt text](http://wiringpi.com/wp-content/uploads/2013/03/gpio1.png "The main GPIO connector") | ||
![alt text](http://wiringpi.com/wp-content/uploads/2013/03/gpio21.png "The secondary GPIO connector") | ||
|
||
### More | ||
Full details on the [wiringpi website](http://wiringpi.com/). |