raspi-gpio 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ad59ed3ff2152b5b518c09e5a1c174aa345645fe28a59e46e10c4a1b9d02830
-  data.tar.gz: fb9f1fbac3770add6a2100e947c07657913444ea8c35a85806e276c7a0c78f4d
+  metadata.gz: 4090a815424c69468a90e4967471b31fdad4b546101146c1defda003400a8faa
+  data.tar.gz: 6d90479e68bec065740ab4ffcd18e065ce21e0ba98db2b868620ae5ee6cb1efa
 SHA512:
-  metadata.gz: dbc135c394dd882cfca0169856a2f6994628bc129f38f6d4af0ff03e235a2e4ed113a052fef3c772584bded10b4f238c3972dd80cc37ad11256fdede336380e0
-  data.tar.gz: 2120f9206a0ba4236a0280252ac4c4f1b33a4d66f88bfd19ca218ba9a3d7e2c5866136781dba9e06f9b309d1c95354ed7e8b8102891a2e1acf28b785520714b8
+  metadata.gz: 85656902aa5de465d735d7bba0954164ae5f9d8e736957f1b14688f4ff0387550b570f37a30ebe78f3228334290a0f40c9dc7ca1ef37a0e98a336bd8fc62ec79
+  data.tar.gz: 26ce7953054d037975ef57780af70f1162677e9f824f67bfdc7ce4552104122944c0f2355d71563ef5b20ae985de67806eb67867f1d3631fdee63fb2617cb522

data/lib/raspi-gpio.rb

@@ -1,46 +1,62 @@
+# raspi-gpio - A simple and light interface to interact with GPIO pins of the Raspberry Pi.
+#   Guide and source code : https://github.com/exybore/raspi-gpio-rb
+#   Documentation : https://rubydoc.info/gems/raspi-gpio
+#
+# @author exybore
+
 # GPIO core library path
 LIB_PATH = '/sys/class/gpio'
 
-# Shortcuts for pin values
+# Shortcut for low pin value (0)
 LOW = 0
+
+# Shortcut for high pin value (1)
 HIGH = 1
 
+# Shortcut for 'in' pin mode
 IN = 'in'
+
+# Shortcut for 'out' pin mode
 OUT = 'out'
 
-# Exception to handle unknown pin mode (not 'in' or 'out')
+# Exception to handle unknown pin mode (not IN or OUT)
 class UnknownMode < StandardError
 end
 
+# Exception to handle pin writing when not in OUT mode
 class NotOutMode < StandardError
 end
 
-# Exception to handle bad pin value (not 0 or 1)
+# Exception to handle bad pin value (not LOW or HIGH)
 class BadValue < StandardError
 end
 
-# GPIO class
+# Main class, to manage GPIO pins
 class GPIO
 
   # Initialize the GPIO pin
   #
-  # @param pin [Integer] GPIO pin to use
-  # @param mode [String, nil] pin mode ('in' or 'out')
+  # @param pin [Integer] GPIO pin number to use
+  # @param mode [String] pin mode : IN or OUT
   def initialize(pin, mode = OUT)
     @pin = pin
     begin
-      File.open("#{LIB_PATH}/export", 'w') do |file|
+      File.open("#{LIB_PATH}/unexport", 'w') do |file|
         file.write(@pin)
       end
-    rescue Errno::EBUSY
-      # -
+    rescue Errno::EINVAL
+      # Do nothing - the pin is already unexported
+    end
+    File.open("#{LIB_PATH}/export", 'w') do |file|
+      file.write(@pin)
     end
     @mode = mode
   end
 
   # Set the pin mode
   #
-  # @param mode [String] pin mode ('in' or 'out')
+  # @param mode [String] pin mode : IN or OUT
+  # @raise [UnknownMode] if the mode isn't IN or OUT
   def set_mode(mode)
     raise UnknownMode, "gpio error : unknown mode #{mode}" unless mode == IN or mode == OUT
     File.open("#{LIB_PATH}/gpio#{@pin}/direction", 'w') do |file|
@@ -51,14 +67,17 @@ class GPIO
 
   # Read the value of the pin
   #
-  # @return [Boolean]
+  # @return [Integer] pin's value : 0 or 1
   def get_value
     File.open("#{LIB_PATH}/gpio#{@pin}/value", 'r').read
   end
 
   # Set a value to the pin
+  #   This method can only be used when the pin is in OUT mode
   #
-  # @param v [Integer] the value (0 or 1)
+  # @param v [Integer] the value : LOW or HIGH
+  # @raise [NotOutMode] if the pin isn't in OUT mode
+  # @raise [BadValue] if the provided value isn't LOW or HIGH
   def set_value(v)
     raise NotOutMode, "error : mode isn't OUT" unless @mode == OUT
     raise BadValue, "error : bad pin value" unless v.between? 0,1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raspi-gpio
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Exybore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-20 00:00:00.000000000 Z
+date: 2019-02-21 00:00:00.000000000 Z
 dependencies: []
 description: A simple and light interface to interact with GPIO pins of the Raspberry
   Pi.
@@ -41,5 +41,5 @@ requirements: []
 rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
-summary: Simple & light Raspberry Pi GPIO interface.
+summary: "\U0001F50C Simple & light Raspberry Pi GPIO interface."
 test_files: []