ruby_pins 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79f3b3659b23135b0f5f99bab04bdb6eae95aee9
-  data.tar.gz: e4d3294203d73744ecb3a000d3f1dda280c5967e
+  metadata.gz: e7e272be6fcee3162904989970bb34925ddd8d83
+  data.tar.gz: eba0917f3a811475a6661c6b82480abdf24b9080
 SHA512:
-  metadata.gz: 63e300e605e62b20fc836d1765d46d272a35d27fc05e614a06150ba9d05a57b11d7afb86744cac4d3a7fa944d0e36b52a01c855d787723ef0c0bb45b29cc5e18
-  data.tar.gz: df6fe7a074a7d72c71c94a623b3f22976456874368c088ef06f1e4665336f7af09076b190a00c21a6a43e9538aab51f600023b9837cea55327bfff189cfa7914
+  metadata.gz: 76eba6e2779cf371d9aa1e5f49558071fac48ef61296a25e340455496611acf16bb0a6aae728b6a825c5912f45d460e68cdb020db7f12715e1e62d3c9cda426d
+  data.tar.gz: 72e5cd4d2486f81d804c1f55feeca07071d945f61fd9a7575061b7e44cb92a52ca0283a6b64528a6198d8d0b83d2232a58e586a232f88a807f14be5e326d8c7b

data/.byebug_history

@@ -0,0 +1,4 @@
+q!
+c
+n
+commands

data/README.md

@@ -22,14 +22,48 @@ to your Gemfile, and run
 bundle
 ```
 
-## Usage
+# Usage
+
+## Basic pin
 
 Create a new pin:
 
 ```ruby
-# All arguments are optional, including the pin number!
-# Not much can be done without a pin number though!
-pin = RubyPins::Pin.new pin: 17, name: 'My Cool Pin!', state: :off
+# 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: <ip_address>,
+                             user: <unix_user(probably 'pi')>,
+                             password: <unix password>
+```
+
+Add this host to your pin
+
+```ruby
+pin.host = pi_host
 ```
 
 Turn the pin on:
@@ -46,6 +80,17 @@ 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:
@@ -61,4 +106,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/.byebug_history

@@ -1 +1,13 @@
 q!
+s
+script
+s
+n
+turn_on
+set_out
+export
+c
+script
+s
+c
+q!

data/lib/ruby_pins/host.rb

@@ -0,0 +1,12 @@
+module RubyPins
+
+  class Host
+    attr_accessor :address, :user, :password
+
+    def initialize args
+      args.each {|k, v| self.send "#{k}=", v}
+    end
+  end
+
+
+end

data/lib/ruby_pins/pin.rb

@@ -0,0 +1,79 @@
+module RubyPins
+
+  class Pin
+    attr_accessor :pin, :name, :state, :pinset, :host
+
+    def initialize args
+      args.each {|k, v| self.send "#{k}=", v}
+      self.state= :off unless self.state
+      self.host ||= :local
+    end
+
+    def state= state
+      self.send state
+    end
+
+    def pin= pin
+      unexport if self.pin
+      @pin = pin
+    end
+
+    def on
+      @state = :on
+      run export, set_out, turn_on
+    end
+
+    def off
+      @state = :off
+      run(unexport) if exported?
+    end
+
+    def run *commands
+      std_out = ''
+      if host == :local
+        commands.each {|cmd| std_out << %x(#{cmd})}
+      else
+        commands.each do |cmd|
+          Net::SSH.start(self.host.address, self.host.user, password: self.host.password) do |ssh|
+            std_out << ssh.exec!(cmd)
+          end
+        end
+      end
+      std_out
+    end
+
+    def turn_on
+      set_value 1
+    end
+
+    def set_out
+      set_direction 'out'
+    end
+
+    def send_in
+      set_direction 'in'
+    end
+
+    def set_direction dir
+      "echo #{dir} > /sys/class/gpio/gpio#{self.pin}/direction"
+    end
+
+    def set_value val
+      "echo #{val} > /sys/class/gpio/gpio#{self.pin}/value"
+    end
+
+    def export
+      "echo #{self.pin} > /sys/class/gpio/export"
+    end
+
+    def unexport
+      "echo #{self.pin} > /sys/class/gpio/unexport"
+    end
+
+    def exported?
+      run("ls /sys/class/gpio/").include? "#{self.pin}"
+    end
+
+  end
+
+end

data/lib/ruby_pins/version.rb

@@ -1,3 +1,3 @@
 module RubyPins
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/ruby_pins.rb

@@ -1,70 +1,9 @@
-require "ruby_pins/version"
+require 'ruby_pins/version'
+require 'ruby_pins/pin'
+require 'ruby_pins/host'
+require 'net/ssh'
+require 'byebug'
 
 module RubyPins
 
-  class Pin
-    attr_accessor :pin, :name, :state
-
-    def initialize args
-      args.each {|k, v| self.send "#{k}=", v}
-      self.state= :off unless self.state
-    end
-
-    def state= state
-      self.send state
-    end
-
-    def pin= pin
-      unexport if self.pin
-      @pin = pin
-    end
-
-    def on
-      @state = :on
-      export
-      set_out
-      turn_on
-    end
-
-    def off
-      @state = :off
-      unexport if exported?
-    end
-
-    def turn_on
-      set_value 1
-    end
-
-    def set_out
-      set_direction 'out'
-    end
-
-    def send_in
-      set_direction 'in'
-    end
-
-    def set_direction dir
-      `echo #{dir} > /sys/class/gpio/gpio#{self.pin}/direction`
-    end
-
-    def set_value val
-      `echo #{val} > /sys/class/gpio/gpio#{self.pin}/value`
-    end
-
-    def export
-      `echo #{self.pin} > /sys/class/gpio/export`
-    end
-
-    def unexport
-      `echo #{self.pin} > /sys/class/gpio/unexport`
-    end
-
-    def exported?
-      File.directory? "/sys/class/gpio/gpio#{self.pin}"
-    end
-
-  end
-
 end
-
-

data/ruby_pins.gemspec

@@ -4,22 +4,23 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ruby_pins/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ruby_pins"
+  spec.name          = 'ruby_pins'
   spec.version       = RubyPins::VERSION
-  spec.authors       = ["MainShayne233"]
-  spec.email         = ["shaynetremblay@hotmail.com"]
+  spec.authors       = ['MainShayne233']
+  spec.email         = ['shaynetremblay@hotmail.com']
 
   spec.summary       = "Ridiculously simple way to interact with your Raspberry Pi's GPIO pins, with Ruby!"
   spec.homepage      = 'https://github.com/MainShayne233/ruby_pins'
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
 
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'net-ssh', '~> 3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_pins
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - MainShayne233
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-08 00:00:00.000000000 Z
+date: 2016-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: 
 email:
 - shaynetremblay@hotmail.com
@@ -59,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -71,6 +86,8 @@ files:
 - bin/setup
 - lib/.byebug_history
 - lib/ruby_pins.rb
+- lib/ruby_pins/host.rb
+- lib/ruby_pins/pin.rb
 - lib/ruby_pins/version.rb
 - ruby_pins.gemspec
 homepage: https://github.com/MainShayne233/ruby_pins