Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mainshayne233/ruby_pins
https://github.com/mainshayne233/ruby_pins
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mainshayne233/ruby_pins
- Owner: MainShayne233
- License: mit
- Created: 2016-07-08T02:16:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-07-12T03:39:54.000Z (over 8 years ago)
- Last Synced: 2024-10-12T03:27:25.688Z (about 1 month ago)
- Language: Ruby
- Size: 56.6 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# RubyPins
RubyPins! The simple way to control your Raspberry Pi's GPIO pins, with Ruby!
Tested operating systems: Raspian
To install, from a terminal, run:
```bash
gem install ruby_pins
```
If you are using a Gemfile, such as with a Ruby on Rails application add:
```ruby
gem 'ruby_pins'
```
to your Gemfile, and run
```bash
bundle
```
# Usage
## Basic pin
Create a new pin:
```ruby
# Pins accept a pin #, a state (:on, :off), a name, and a host.
# If you running the code on the PI itself, the pin just needs a pin number!
# The default state is off
pin = RubyPins::Pin.new pin: 17
```
Turn the pin on:
```ruby
pin.on
```
Turn the pin off:
```ruby
pin.off
```
## Remote pin
Say what? You wanna control a Pi on your network, but run the code from a different computer?
ruby_pins has you covered!
Create a host:
```ruby
pi_host = RubyPins::Host.new address: ,
user: ,
password:
```
Add this host to your pin
```ruby
pin.host = pi_host
```
Turn the pin on:
```ruby
pin.on
```
Turn the pin off:
```ruby
pin.off
```
Now rewire your whole house to be interfaced from your Ruby app!
## Note about pin numbers
ruby_pins expects the pin number to be the pin's GPIO number.
For example, when looking at the following pinout chart, if you wanted to
set your pin number to the 11th pin, or GPIO17, you would pass in
```ruby
pin: 17
```
Pinout chart:
https://www.element14.com/community/servlet/JiveServlet/previewBody/73950-102-10-339300/pi3_gpio.png
## Installing Ruby (and Rails)
This is the guide I use to install Ruby and Ruby on Rails on my Pis:
http://elinux.org/RPi_Ruby_on_Rails
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby_pins. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).