object_oriented_beaglebone_black 0.2.2 → 0.3.0

data/examples/object_oriented_beaglebone_black_examples/voltage_measurement/voltage_input.rb

@@ -0,0 +1,26 @@
+require 'bigdecimal'
+
+module ObjectOrientedBeagleboneBlackExamples
+  module VoltageMeasurement
+    class VoltageInput
+
+      def initialize(pin_key, higher_side_resistor_resistance: nil, lower_side_resistor_resistance: nil)
+        @analog_input = ObjectOrientedBeagleboneBlack::AnalogInput.new(pin_key)
+
+        @voltage_current_calculation = VoltageCurrentCalculation.new
+        @higher_side_resistor_resistance = higher_side_resistor_resistance
+        @lower_side_resistor_resistance = lower_side_resistor_resistance
+      end
+
+      def value
+        raw_analog_reading = BigDecimal(@analog_input.raw_value.to_s)
+        voltage_in_bigdecimal = @voltage_current_calculation.voltage(raw_analog_reading, 
+                                                                     higher_side_resistor_resistance: @higher_side_resistor_resistance, 
+                                                                     lower_side_resistor_resistance: @lower_side_resistor_resistance)
+
+        voltage_in_bigdecimal.to_f
+      end
+
+    end
+  end
+end

data/examples/object_oriented_beaglebone_black_examples/voltage_measurement.rb

@@ -0,0 +1,7 @@
+require 'object_oriented_beaglebone_black_examples/voltage_measurement/voltage_input'
+
+module ObjectOrientedBeagleboneBlackExamples
+  module VoltageMeasurement
+    # Your code goes here...
+  end
+end

data/examples/object_oriented_beaglebone_black_examples.rb

@@ -0,0 +1,10 @@
+require 'object_oriented_beaglebone_black'
+
+require 'object_oriented_beaglebone_black_examples/voltage_current_calculation'
+require 'object_oriented_beaglebone_black_examples/current_measurement'
+require 'object_oriented_beaglebone_black_examples/voltage_measurement'
+require 'object_oriented_beaglebone_black_examples/uart_connection_to_arduino'
+
+module ObjectOrientedBeagleboneBlackExamples
+  # Your code goes here...
+end

data/lib/object_oriented_beaglebone_black/analog_input.rb

@@ -4,6 +4,8 @@ module ObjectOrientedBeagleboneBlack
   class AnalogInput
     include ObjectOrientedBeagleboneBlack::PinMappings
 
+    ANALOG_INPUT_DEVICE_TREE_OVERLAY_PARAMETER = "cape-bone-iio"
+
     def initialize(pin_key)
       @pin_key = pin_key
       @slots_file_path = File.join(File.join(OBJECT_ORIENTED_BEAGLEBONE_BLACK_CONFIG["slots_directory"], "slots"))
@@ -14,11 +16,37 @@ module ObjectOrientedBeagleboneBlack
     def activate_device_tree_overlays
       # Note: Since slots file acts as an interface to activate Device Tree Overlay, simply writing to it does what needs to be done. 
       #       I'm using appending here so that testing in a local environment becomes straightfoward. 
-      # Note: Closing this file caused an error in BeagleBone Black:
+
+      puts "This can take a few seconds for necessary setups..."
+
+      slots_file = File.open(@slots_file_path, "a+")
+      slots_file_content = slots_file.read
+
+      unless slots_file_content.include? ANALOG_INPUT_DEVICE_TREE_OVERLAY_PARAMETER
+      # until slots_file_content.include? ANALOG_INPUT_DEVICE_TREE_OVERLAY_PARAMETER
+
+        # Just in case where the previous read operation is not fully terminated.
+        sleep 1
+
+        slots_file.write(ANALOG_INPUT_DEVICE_TREE_OVERLAY_PARAMETER)
+
+        # Just in case where it takes time to load device tree overlay.
+        sleep 1
+
+        # Note: Sometime, the file pointer seems to be at the end of the file and doesn't read the file content before that.
+        # slots_file_content = slots_file.read
+      end
+
+      # Note: Closing this file sometimes causes an error in BeagleBone Black:
       #       Errno::EEXIST: File exists @ fptr_finalize - /sys/devices/bone_capemgr.9/slots
-      #       So modified the code not to close the file. 
-      # File.open(@slots_file_path, "a") { |file| file.write("cape-bone-iio") }
-      File.open(@slots_file_path, "a").write("cape-bone-iio")
+      begin
+        slots_file.close if File.exist?(@slots_file_path) && !slots_file.closed?
+      rescue SystemCallError => system_call_error_message
+        puts "Error happened while closing #{@slots_file_path} with the message: #{system_call_error_message}"
+      end
+
+      puts "Setups done."
+
     end
 
     def raw_value

data/lib/object_oriented_beaglebone_black/pin_mappings.rb

@@ -5,7 +5,7 @@ module ObjectOrientedBeagleboneBlack
   module PinMappings
     
     def load_pin_index_array
-      # In order not to use activesupport (since Beaglebone Black that is used currently doesn't have Internet access to download it), Hash#deep_symbolize_keys! is not used.
+      # In order not to use activesupport (since Beaglebone Black didn't have Internet access to download it previously), Hash#deep_symbolize_keys! is not used.
       # ::OBJECT_ORIENTED_BEAGLEBONE_BLACK_PIN_INDEX_ARRAY ||= JSON.load(File.read(File.join(OBJECT_ORIENTED_BEAGLEBONE_BLACK_ROOT, "config", "pin_index.json")))["pinIndex"].each { |property_hash| property_hash.deep_symbolize_keys! }
       ::OBJECT_ORIENTED_BEAGLEBONE_BLACK_PIN_INDEX_ARRAY ||= JSON.load(File.read(File.join(OBJECT_ORIENTED_BEAGLEBONE_BLACK_ROOT, "config", "pin_index.json")))["pinIndex"]
     end
@@ -14,9 +14,9 @@ module ObjectOrientedBeagleboneBlack
       load_pin_index_array
 
       if !name.nil?
-        ::OBJECT_ORIENTED_BEAGLEBONE_BLACK_PIN_INDEX_ARRAY.select { |property_hash| property_hash["name"] == name }.first
+        ::OBJECT_ORIENTED_BEAGLEBONE_BLACK_PIN_INDEX_ARRAY.find { |property_hash| property_hash["name"] == name }
       elsif !key.nil?
-        ::OBJECT_ORIENTED_BEAGLEBONE_BLACK_PIN_INDEX_ARRAY.select { |property_hash| property_hash["key"] == key }.first
+        ::OBJECT_ORIENTED_BEAGLEBONE_BLACK_PIN_INDEX_ARRAY.find { |property_hash| property_hash["key"] == key }
       end
 
     end

data/lib/object_oriented_beaglebone_black/pwm.rb

@@ -3,6 +3,8 @@ require 'bigdecimal'
 module ObjectOrientedBeagleboneBlack
   class Pwm
 
+    PWM_DEVICE_TREE_OVERLAY_PARAMETER = "am33xx_pwm"
+
     module Polarity
       DIRECT = 0
       INVERSE = 1
@@ -18,16 +20,72 @@ module ObjectOrientedBeagleboneBlack
     def activate_device_tree_overlays
       # Note: Since slots file acts as an interface to activate Device Tree Overlay, simply writing to it does what needs to be done. 
       #       I'm using appending here so that testing in a local environment becomes straightfoward. 
-      # Note: Closing this file caused an error in BeagleBone Black:
-      #       Errno::ENOENT:
-      #         No such file or directory @ fptr_finalize - /sys/devices/bone_capemgr.9/slots
-      #       So modified the code not to close the file. 
-      # File.open(@slots_file_path, "a") do |file| 
-      #   file.write("am33xx_pwm")
-      #   file.write("bone_pwm_#{@pin_key}")
-      # end
-      File.open(@slots_file_path, "a").write("am33xx_pwm")
-      File.open(@slots_file_path, "a").write("bone_pwm_#{@pin_key}")      
+
+      puts "This can take several seconds for necessary setups..."
+
+      slots_file = File.open(@slots_file_path, "a+")
+      slots_file_content = slots_file.read
+
+      unless slots_file_content.include? PWM_DEVICE_TREE_OVERLAY_PARAMETER
+      # until slots_file_content.include? PWM_DEVICE_TREE_OVERLAY_PARAMETER
+
+        # Just in case where the previous read session is not fully completed.
+        sleep 1
+
+        slots_file.write(PWM_DEVICE_TREE_OVERLAY_PARAMETER)
+
+        # It seems to take a time to load the device tree overlay. Wait for two seconds.
+        sleep 2
+
+        # Note: Sometime, the file pointer seems to be at the end of the file and doesn't read the file content before that. 
+        # slots_file_content = slots_file.read
+
+      end
+
+      # Note: Closing this file sometimes causes an error in BeagleBone Black:
+      #   Errno::ENOENT: No such file or directory @ fptr_finalize - /sys/devices/bone_capemgr.9/slots
+      begin
+        slots_file.close if File.exist?(@slots_file_path) && !slots_file.closed?
+      rescue SystemCallError => system_call_error_message
+        puts "Error happened while closing #{@slots_file_path} with the message: #{system_call_error_message}"
+      end
+
+      # Just in case
+      sleep 1
+
+      puts "First step of setups done."
+
+      pwm_pin_device_tree_overlay_parameter = "bone_pwm_#{@pin_key}"
+
+      slots_file = File.open(@slots_file_path, "a+")
+      slots_file_content = slots_file.read
+
+      unless slots_file_content.include? pwm_pin_device_tree_overlay_parameter
+      # until slots_file_content.include? pwm_pin_device_tree_overlay_parameter
+
+        # Just in case where the previous read session is not fully completed.
+        sleep 1
+
+        slots_file.write(pwm_pin_device_tree_overlay_parameter)
+
+        # It seems to take a time to load the device tree overlay. Wait for one second.
+        sleep 2
+
+        # Note: Sometime, the file pointer seems to be at the end of the file and doesn't read the file content before that.
+        # slots_file_content = slots_file.read
+
+      end
+
+      # Note: Closing this file sometimes causes an error in BeagleBone Black:
+      #   Errno::ENOENT: No such file or directory @ fptr_finalize - /sys/devices/bone_capemgr.9/slots
+      begin
+        slots_file.close if File.exist?(@slots_file_path) && !slots_file.closed?
+      rescue SystemCallError => system_call_error_message
+        puts "Error happened while closing #{@slots_file_path} with the message: #{system_call_error_message}"
+      end
+
+      puts "Setups done."
+
     end
 
     # duty_cycle (value between 0 and 1)

data/lib/object_oriented_beaglebone_black/uart_connection.rb

@@ -0,0 +1,95 @@
+require 'serialport'
+
+module ObjectOrientedBeagleboneBlack
+  class UartConnection
+    include ObjectOrientedBeagleboneBlack::UartMappings
+
+    PARITY = SerialPort::NONE
+
+    def initialize(uart_id)
+      @uart_id = uart_id
+      @slots_file_path = File.join(File.join(OBJECT_ORIENTED_BEAGLEBONE_BLACK_CONFIG["slots_directory"], "slots"))
+
+      activate_device_tree_overlays      
+    end 
+
+    def activate_device_tree_overlays
+      # Note: Since slots file acts as an interface to activate Device Tree Overlay, simply writing to it does what needs to be done. 
+      #       I'm using appending here so that testing in a local environment becomes straightfoward. 
+
+      puts "This can take a few seconds for necessary setups..."
+
+      slots_file = File.open(@slots_file_path, "a+")
+      slots_file_content = slots_file.read
+
+      unless slots_file_content.include? device_tree_overlay_parameter
+
+        # Just in case where the previous read operation is not fully terminated.
+        sleep 1
+
+        slots_file.write(device_tree_overlay_parameter)
+
+        # Just in case where it takes time to load device tree overlay.
+        sleep 1
+
+      end
+
+      # Note: Closing this file sometimes causes an error in BeagleBone Black:
+      #       Errno::EEXIST: File exists @ fptr_finalize - /sys/devices/bone_capemgr.9/slots
+      begin
+        slots_file.close if File.exist?(@slots_file_path) && !slots_file.closed?
+      rescue SystemCallError => system_call_error_message
+        puts "Error happened while closing #{@slots_file_path} with the message: #{system_call_error_message}"
+      end
+
+      puts "Setups done."
+
+    end
+
+    def read(serial_baud_rate: 9600, serial_data_bits: 8, serial_stop_bits: 1, communication_command: 's')
+
+      data = nil
+
+      SerialPort.open(teletype_device_path, 
+                      serial_baud_rate, 
+                      serial_data_bits, 
+                      serial_stop_bits, 
+                      PARITY) do |serial_port|
+        serial_port.sync = true
+
+        serial_port.putc(communication_command)
+
+        data = serial_port.gets
+      end   
+
+      data.strip
+
+    end
+
+    def write(serial_baud_rate: 9600, serial_data_bits: 8, serial_stop_bits: 1, communication_command: 's')
+
+      data = nil
+
+      SerialPort.open(teletype_device_path, 
+                      serial_baud_rate, 
+                      serial_data_bits, 
+                      serial_stop_bits, 
+                      PARITY) do |serial_port|
+        serial_port.sync = true
+
+        serial_port.puts(communication_command)
+      end
+
+    end    
+
+    private
+      def device_tree_overlay_parameter
+        @device_tree_overlay_parameter ||= property_hash(id: @uart_id)["devicetree"]
+      end
+
+      def teletype_device_path
+        @teletype_device_path ||= property_hash(id: @uart_id)["teletype_device_path"]
+      end
+
+  end
+end

data/lib/object_oriented_beaglebone_black/uart_mappings.rb

@@ -0,0 +1,29 @@
+require 'json'
+# require 'active_support/core_ext/hash/keys'
+
+module ObjectOrientedBeagleboneBlack
+  module UartMappings
+
+    ID_TELETYPE_DEVICE_PATH_MAPPING = { "UART0" => "/dev/ttyO0", "UART1" => "/dev/ttyO1", "UART2" => "/dev/ttyO2", "UART3" => "/dev/ttyO3", "UART4" => "/dev/ttyO4", "UART5" => "/dev/ttyO5" }
+    
+    def load_uarts_array
+      ::OBJECT_ORIENTED_BEAGLEBONE_BLACK_UARTS_HASH ||= JSON.load(File.read(File.join(OBJECT_ORIENTED_BEAGLEBONE_BLACK_ROOT, "config", "uarts.json")))["uarts"]
+    end
+
+    def property_hash(id: nil)
+      load_uarts_array
+
+      uart_hash = {}
+
+      if !id.nil?
+        teletype_device_path = ID_TELETYPE_DEVICE_PATH_MAPPING[id]
+        uart_hash = ::OBJECT_ORIENTED_BEAGLEBONE_BLACK_UARTS_HASH[teletype_device_path]
+        uart_hash["teletype_device_path"] = teletype_device_path
+      end
+
+      uart_hash
+
+    end
+
+  end
+end

data/lib/object_oriented_beaglebone_black/version.rb

@@ -1,3 +1,3 @@
 module ObjectOrientedBeagleboneBlack
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/object_oriented_beaglebone_black.rb

@@ -14,6 +14,7 @@ OBJECT_ORIENTED_BEAGLEBONE_BLACK_CONFIG = YAML.load(ERB.new(File.read(File.join(
 # OBJECT_ORIENTED_BEAGLEBONE_BLACK_CONFIG.deep_symbolize_keys!
 
 require 'object_oriented_beaglebone_black/pin_mappings'
+require 'object_oriented_beaglebone_black/uart_mappings'
 require 'object_oriented_beaglebone_black/io'
 require 'object_oriented_beaglebone_black/io/direction'
 require 'object_oriented_beaglebone_black/io/value'
@@ -21,6 +22,7 @@ require 'object_oriented_beaglebone_black/gpio'
 require 'object_oriented_beaglebone_black/led'
 require 'object_oriented_beaglebone_black/pwm'
 require 'object_oriented_beaglebone_black/analog_input'
+require 'object_oriented_beaglebone_black/uart_connection'
 
 module ObjectOrientedBeagleboneBlack
   # Your code goes here...

data/object_orieted_beaglebone_black.gemspec

@@ -1,6 +1,8 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+examples = File.expand_path('../examples', __FILE__)
+$LOAD_PATH.unshift(examples) unless $LOAD_PATH.include?(examples)
 require 'object_oriented_beaglebone_black/version'
 
 Gem::Specification.new do |spec|
@@ -20,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib", "examples"]
 
   # spec.add_dependency "activesupport"
+  spec.add_dependency "serialport"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/spec/examples/{current_measurement → object_oriented_beaglebone_black_examples/current_measurement}/current_input_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'current_measurement'
 require 'bigdecimal'
 
 describe "Current measurement by ACS712 Breakout", analog_input: true do
@@ -28,10 +27,12 @@ describe "Current measurement by ACS712 Breakout", analog_input: true do
   it "should calculated the measured current" do
 
     pin_key = "P9_40"
+    voltage_current_ratio_for_current_measurement = BigDecimal("0.185") # 185 [mV/A] for ACS712
+
     expected_current = BigDecimal("10").to_f
     expected_raw_value = (BigDecimal(expected_current.to_s) * BigDecimal("0.185")).to_f
 
-    current_input = CurrentMeasurement::CurrentInput.new(pin_key)
+    current_input = ObjectOrientedBeagleboneBlackExamples::CurrentMeasurement::CurrentInput.new(pin_key, voltage_current_ratio_for_current_measurement: voltage_current_ratio_for_current_measurement)
 
     # Since the real "slots" file creates a directory structure when a device tree overlay is written to it, 
     # in the "test" environment with a regular file, it is mimiced here.

data/spec/examples/object_oriented_beaglebone_black_examples/uart_connection_to_arduino/pwm_output_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'fileutils'
+require 'bigdecimal'
+
+describe "Convert duty cycle and sent to Arduino Due through UART connection" do
+
+  before(:each) do
+
+    @slots_directory = OBJECT_ORIENTED_BEAGLEBONE_BLACK_CONFIG["slots_directory"]
+
+    # In order to run this spec example in the real environment, the directories and files that already exist there are not created in that case. 
+    if ENV["OBJECT_ORIENTED_BEAGLEBONE_BLACK_ENV"] == 'test'
+      FileUtils.mkdir_p(@slots_directory, mode: 0700) unless Dir.exists?(@slots_directory)
+      FileUtils.touch(File.join(@slots_directory, "slots"))
+      File.chmod(0700, File.join(@slots_directory, "slots"))
+    end
+  end
+
+  after(:each) do
+    if ENV["OBJECT_ORIENTED_BEAGLEBONE_BLACK_ENV"] == 'test'
+      File.open(File.join(@slots_directory, "slots"), 'w') {|file| file.truncate(0) }
+    end
+  end
+  
+  it "should sent the value through the specified UART connection" do
+
+    uart_id = "UART4"
+    # The parameters for Arduino Due:
+    pwm_steps = BigDecimal("255")
+
+    uart_connection_double = double(uart_id)
+    
+    pwm_output = ObjectOrientedBeagleboneBlackExamples::UartConnectionToArduino::PwmOutput.new(uart_connection_double, pwm_steps)
+
+    expect(uart_connection_double).to receive(:write).with(serial_baud_rate: 9600, serial_data_bits: 8, serial_stop_bits: 1, communication_command: 'p127')
+
+    pwm_output.send(0.5)
+
+  end
+
+end

data/spec/examples/object_oriented_beaglebone_black_examples/uart_connection_to_arduino/voltage_current_input_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'fileutils'
+require 'bigdecimal'
+
+describe "Extract voltage and current from the measured values by Arduino Due through UART connection" do
+
+  before(:each) do
+
+    @slots_directory = OBJECT_ORIENTED_BEAGLEBONE_BLACK_CONFIG["slots_directory"]
+
+    # In order to run this spec example in the real environment, the directories and files that already exist there are not created in that case. 
+    if ENV["OBJECT_ORIENTED_BEAGLEBONE_BLACK_ENV"] == 'test'
+      FileUtils.mkdir_p(@slots_directory, mode: 0700) unless Dir.exists?(@slots_directory)
+      FileUtils.touch(File.join(@slots_directory, "slots"))
+      File.chmod(0700, File.join(@slots_directory, "slots"))
+    end
+  end
+
+  after(:each) do
+    if ENV["OBJECT_ORIENTED_BEAGLEBONE_BLACK_ENV"] == 'test'
+      File.open(File.join(@slots_directory, "slots"), 'w') {|file| file.truncate(0) }
+    end
+  end
+  
+  it "should read the value through the specified UART connection" do
+
+    uart_id = "UART4"
+    # The parameters for Arduino Due:
+    analog_steps = BigDecimal("4095")
+    reference_voltage = BigDecimal("3.3")
+
+    uart_connection_double = double(uart_id)
+    
+    voltage_current_input = ObjectOrientedBeagleboneBlackExamples::UartConnectionToArduino::VoltageCurrentInput.new(uart_connection_double, analog_steps, reference_voltage)
+
+    expect(uart_connection_double).to receive(:read).with(serial_baud_rate: 9600, serial_data_bits: 8, serial_stop_bits: 1, communication_command: 'm') do
+                                        "{\"raw_reading_for_input_voltage\": 534, \"raw_reading_for_input_current\": 5, \"raw_reading_for_output_voltage\": 281}" 
+                                      end
+
+    voltage_current_input.measure
+
+    # higher_side_resistor_resistance: 100[kΩ], lower_side_resistor_resistance: 8.2[kΩ]
+    input_voltage = voltage_current_input.input_voltage(higher_side_resistor_resistance: BigDecimal("100000"), lower_side_resistor_resistance: BigDecimal("8200"))
+    # shunt resistance: 0.04[Ω]
+    input_current = voltage_current_input.input_current(resistance_for_current_measurement: BigDecimal("0.04"))
+    # higher_side_resistor_resistance: 100[kΩ], lower_side_resistor_resistance: 8.2[kΩ]
+    output_voltage = voltage_current_input.output_voltage(higher_side_resistor_resistance: BigDecimal("100000"), lower_side_resistor_resistance: BigDecimal("8200"))    
+
+    expect(input_voltage).to be_within(0.1).of(BigDecimal("5.7"))
+    expect(input_current).to be_within(0.1).of(BigDecimal("0.1"))
+    expect(output_voltage).to be_within(0.1).of(BigDecimal("3.0"))
+
+  end
+
+end