object_oriented_beaglebone_black 0.2.2 → 0.3.0

data/spec/examples/object_oriented_beaglebone_black_examples/voltage_current_calculation_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+require 'bigdecimal'
+
+describe ObjectOrientedBeagleboneBlackExamples::VoltageCurrentCalculation do
+
+  context "External analog digital converter (Arduino)" do
+
+    before(:each) do
+      @analog_steps = BigDecimal("1023")
+      reference_voltage = BigDecimal("5")
+      @voltage_current_calculation = ObjectOrientedBeagleboneBlackExamples::VoltageCurrentCalculation.new(@analog_steps, reference_voltage)
+    end
+
+    context "voltage" do
+    
+      it "should calculate voltage based on the raw analog data" do
+
+        raw_analog_reading = BigDecimal("1023")
+        expect(@voltage_current_calculation.voltage(raw_analog_reading)).to be_within(BigDecimal("0.1")).of(BigDecimal("5.0"))
+
+        raw_analog_reading = BigDecimal("511")
+        expect(@voltage_current_calculation.voltage(raw_analog_reading)).to be_within(BigDecimal("0.1")).of(BigDecimal("2.5"))
+
+      end
+
+      it "should calculate voltage based on the raw analog data with voltage divisor" do
+
+        raw_analog_reading = BigDecimal("1023")
+        expect(@voltage_current_calculation.voltage(raw_analog_reading, 
+                                                    higher_side_resistor_resistance: BigDecimal("1000"), 
+                                                    lower_side_resistor_resistance: BigDecimal("1000"))).to be_within(BigDecimal("0.1")).of(BigDecimal("10.0"))           
+
+        raw_analog_reading = BigDecimal("511")
+        expect(@voltage_current_calculation.voltage(raw_analog_reading, 
+                                                    higher_side_resistor_resistance: BigDecimal("1000"), 
+                                                    lower_side_resistor_resistance: BigDecimal("1000"))).to be_within(BigDecimal("0.1")).of(BigDecimal("5.0"))      
+
+        raw_analog_reading = BigDecimal("1023")
+        expect(@voltage_current_calculation.voltage(raw_analog_reading, 
+                                                    higher_side_resistor_resistance: BigDecimal("10"), 
+                                                    lower_side_resistor_resistance: BigDecimal("2.2"))).to be_within(BigDecimal("0.1")).of(BigDecimal("27.7"))            
+
+      end
+
+      context "voltage divider" do
+
+        it "should calculate resistor factor" do
+
+          higher_side_resistor_resistance = BigDecimal("1000")
+          lower_side_resistor_resistance = BigDecimal("1000")
+
+          expect(@voltage_current_calculation.resistor_factor(higher_side_resistor_resistance, 
+                                                              lower_side_resistor_resistance))
+                                                             .to eq(@analog_steps * BigDecimal("0.5"))
+
+          higher_side_resistor_resistance = BigDecimal("10")
+          lower_side_resistor_resistance = BigDecimal("2.2")
+
+          expect(@voltage_current_calculation.resistor_factor(higher_side_resistor_resistance, 
+                                                              lower_side_resistor_resistance))
+                                                             .to be_within(BigDecimal("1"))
+                                                             .of(@analog_steps * BigDecimal("0.18"))
+
+        end
+
+        it "should get analog steps as resistor factor if the resistances are nil" do
+
+          higher_side_resistor_resistance = nil
+          lower_side_resistor_resistance = nil
+
+          expect(@voltage_current_calculation.resistor_factor(higher_side_resistor_resistance, 
+                                                              lower_side_resistor_resistance))
+                                                             .to eq(@analog_steps * BigDecimal("1")) 
+
+        end
+
+      end
+
+    end
+
+    context "current" do
+
+      it "should calculate current based on the raw analog voltage accross shunt resistance" do
+
+        resistance_for_current_measurement = BigDecimal("0.005")
+        voltage_gain_for_current_measurement = BigDecimal("100")      
+
+        raw_analog_reading = BigDecimal("1023")
+        expect(@voltage_current_calculation.current(raw_analog_reading, 
+                                                    resistance_for_current_measurement: resistance_for_current_measurement, 
+                                                    voltage_gain_for_current_measurement: voltage_gain_for_current_measurement)).to be_within(BigDecimal("0.1")).of(BigDecimal("10.0"))
+
+        raw_analog_reading = BigDecimal("511")
+        expect(@voltage_current_calculation.current(raw_analog_reading, 
+                                                    resistance_for_current_measurement: resistance_for_current_measurement, 
+                                                    voltage_gain_for_current_measurement: voltage_gain_for_current_measurement)).to be_within(BigDecimal("0.1")).of(BigDecimal("5.0"))
+
+      end    
+
+    end
+
+  end
+
+  context "Internal analog digital converter" do
+
+    before(:each) do
+      @voltage_current_calculation = ObjectOrientedBeagleboneBlackExamples::VoltageCurrentCalculation.new
+    end
+
+    context "current" do
+
+      it "should calculate current based on the voltage measured by current sensor" do
+
+        voltage_current_ratio_for_current_measurement = BigDecimal("0.185") # 185 [mV/A] for ACS712
+
+        raw_analog_reading = BigDecimal("0.5")
+        expect(@voltage_current_calculation.current(raw_analog_reading, 
+                                                    voltage_current_ratio_for_current_measurement: voltage_current_ratio_for_current_measurement)).to be_within(BigDecimal("0.1")).of(BigDecimal("2.7"))
+
+      end
+
+    end
+
+  end
+
+end

data/spec/examples/{voltage_measurement → object_oriented_beaglebone_black_examples/voltage_measurement}/voltage_input_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'voltage_measurement'
 require 'bigdecimal'
 
 describe "Voltage measurement with voltage divider of 11:1, e.g. 51[kΩ] and 5.1[kΩ]", analog_input: true do
@@ -28,10 +27,13 @@ describe "Voltage measurement with voltage divider of 11:1, e.g. 51[kΩ] and 5.1
   it "should calculate the measuring voltage" do
 
     pin_key = "P9_40"
+    higher_side_resistor_resistance = BigDecimal("51000") # [Ω] 
+    lower_side_resistor_resistance = BigDecimal("5100") # [Ω]
+
     expected_voltage = BigDecimal("20").to_f
     expected_raw_value = (BigDecimal(expected_voltage.to_s) / BigDecimal("11")).to_f
 
-    voltage_input = VoltageMeasurement::VoltageInput.new(pin_key)
+    voltage_input = ObjectOrientedBeagleboneBlackExamples::VoltageMeasurement::VoltageInput.new(pin_key, higher_side_resistor_resistance: higher_side_resistor_resistance, lower_side_resistor_resistance: lower_side_resistor_resistance)
 
     # 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/object_oriented_beaglebone_black/uart_connection_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'fileutils'
+require 'bigdecimal'
+
+describe "ObjectOrientedBeagleboneBlack::UartConnection" 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"
+    
+    uart_connection = ObjectOrientedBeagleboneBlack::UartConnection.new(uart_id)
+
+    # TODO: The following requires serial connection. Find a way to test it. 
+    # uart_connection.read(serial_baud_rate: 9600, serial_data_bits: 8, serial_stop_bits: 1, communication_command: 's')
+
+  end
+
+  it "should write the value through the specified UART connection" do
+
+    uart_id = "UART4"
+    
+    uart_connection = ObjectOrientedBeagleboneBlack::UartConnection.new(uart_id)
+
+    # TODO: The following requires serial connection. Find a way to test it. 
+    # uart_connection.write(serial_baud_rate: 9600, serial_data_bits: 8, serial_stop_bits: 1, communication_command: 'p127')    
+
+  end
+
+end

data/spec/object_oriented_beaglebone_black/uart_mappings_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe ObjectOrientedBeagleboneBlack::UartMappings do
+  
+  class TestUartMappingsClass
+    include ObjectOrientedBeagleboneBlack::UartMappings
+  end
+
+  before(:each) do
+    @test_uart_mappings = TestUartMappingsClass.new
+  end
+
+  it "should get Hash for UART4" do
+
+    expect(@test_uart_mappings.property_hash(id: "UART4")).to eq({"teletype_device_path" => "/dev/ttyO4", 
+                                                                  "devicetree" => "BB-UART4", 
+                                                                  "rx" => "P9_11", 
+                                                                  "tx" => "P9_13"})
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 ENV["OBJECT_ORIENTED_BEAGLEBONE_BLACK_ENV"] ||= 'test'
 
 require 'object_oriented_beaglebone_black'
+require 'object_oriented_beaglebone_black_examples'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: object_oriented_beaglebone_black
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Tadatoshi Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2016-01-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,12 +88,18 @@ files:
 - config/i2c.json
 - config/pin_index.json
 - config/uarts.json
-- examples/current_measurement.rb
-- examples/current_measurement/current_input.rb
-- examples/current_measurement/current_input_with_point04_shunt.rb
-- examples/voltage_measurement.rb
-- examples/voltage_measurement/voltage_input.rb
-- examples/voltage_measurement/voltage_input_with_100k_and_20k_voltage_divider.rb
+- examples/arduino/arduino_sketches/DcDcConverterManagement/DcDcConverterManagement.ino
+- examples/arduino/arduino_sketches/VoltageMeasurement/VoltageMeasurement.ino
+- examples/object_oriented_beaglebone_black_examples.rb
+- examples/object_oriented_beaglebone_black_examples/current_measurement.rb
+- examples/object_oriented_beaglebone_black_examples/current_measurement/current_input.rb
+- examples/object_oriented_beaglebone_black_examples/dc_dc_converter_control_example_1.rb
+- examples/object_oriented_beaglebone_black_examples/uart_connection_to_arduino.rb
+- examples/object_oriented_beaglebone_black_examples/uart_connection_to_arduino/pwm_output.rb
+- examples/object_oriented_beaglebone_black_examples/uart_connection_to_arduino/voltage_current_input.rb
+- examples/object_oriented_beaglebone_black_examples/voltage_current_calculation.rb
+- examples/object_oriented_beaglebone_black_examples/voltage_measurement.rb
+- examples/object_oriented_beaglebone_black_examples/voltage_measurement/voltage_input.rb
 - lib/object_oriented_beaglebone_black.rb
 - lib/object_oriented_beaglebone_black/analog_input.rb
 - lib/object_oriented_beaglebone_black/gpio.rb
@@ -89,15 +109,22 @@ files:
 - lib/object_oriented_beaglebone_black/led.rb
 - lib/object_oriented_beaglebone_black/pin_mappings.rb
 - lib/object_oriented_beaglebone_black/pwm.rb
+- lib/object_oriented_beaglebone_black/uart_connection.rb
+- lib/object_oriented_beaglebone_black/uart_mappings.rb
 - lib/object_oriented_beaglebone_black/version.rb
 - object_orieted_beaglebone_black.gemspec
-- spec/examples/current_measurement/current_input_spec.rb
-- spec/examples/voltage_measurement/voltage_input_spec.rb
+- spec/examples/object_oriented_beaglebone_black_examples/current_measurement/current_input_spec.rb
+- spec/examples/object_oriented_beaglebone_black_examples/uart_connection_to_arduino/pwm_output_spec.rb
+- spec/examples/object_oriented_beaglebone_black_examples/uart_connection_to_arduino/voltage_current_input_spec.rb
+- spec/examples/object_oriented_beaglebone_black_examples/voltage_current_calculation_spec.rb
+- spec/examples/object_oriented_beaglebone_black_examples/voltage_measurement/voltage_input_spec.rb
 - spec/object_oriented_beaglebone_black/analog_input_spec.rb
 - spec/object_oriented_beaglebone_black/gpio_spec.rb
 - spec/object_oriented_beaglebone_black/led_spec.rb
 - spec/object_oriented_beaglebone_black/pin_mappings_spec.rb
 - spec/object_oriented_beaglebone_black/pwm_spec.rb
+- spec/object_oriented_beaglebone_black/uart_connection_spec.rb
+- spec/object_oriented_beaglebone_black/uart_mappings_spec.rb
 - spec/spec_helper.rb
 - spec/support/analog_input_file_behavoir_helper.rb
 - spec/support/gpio_file_behavior_helper.rb
@@ -128,13 +155,18 @@ signing_key:
 specification_version: 4
 summary: For using BeagleBone Black in Object-Oriented way through Ruby.
 test_files:
-- spec/examples/current_measurement/current_input_spec.rb
-- spec/examples/voltage_measurement/voltage_input_spec.rb
+- spec/examples/object_oriented_beaglebone_black_examples/current_measurement/current_input_spec.rb
+- spec/examples/object_oriented_beaglebone_black_examples/uart_connection_to_arduino/pwm_output_spec.rb
+- spec/examples/object_oriented_beaglebone_black_examples/uart_connection_to_arduino/voltage_current_input_spec.rb
+- spec/examples/object_oriented_beaglebone_black_examples/voltage_current_calculation_spec.rb
+- spec/examples/object_oriented_beaglebone_black_examples/voltage_measurement/voltage_input_spec.rb
 - spec/object_oriented_beaglebone_black/analog_input_spec.rb
 - spec/object_oriented_beaglebone_black/gpio_spec.rb
 - spec/object_oriented_beaglebone_black/led_spec.rb
 - spec/object_oriented_beaglebone_black/pin_mappings_spec.rb
 - spec/object_oriented_beaglebone_black/pwm_spec.rb
+- spec/object_oriented_beaglebone_black/uart_connection_spec.rb
+- spec/object_oriented_beaglebone_black/uart_mappings_spec.rb
 - spec/spec_helper.rb
 - spec/support/analog_input_file_behavoir_helper.rb
 - spec/support/gpio_file_behavior_helper.rb

data/examples/current_measurement/current_input.rb

@@ -1,16 +0,0 @@
-require 'bigdecimal'
-
-module CurrentMeasurement
-  class CurrentInput
-
-    def initialize(pin_key)
-      @analog_input = ObjectOrientedBeagleboneBlack::AnalogInput.new(pin_key)
-    end
-
-    def value
-      # Conversion for ACS712 Breakout. If a different current measurement device is used, extract this code to subclass and make this class parent class.
-      (@analog_input.raw_value / BigDecimal("0.185")).to_f
-    end
-
-  end
-end

data/examples/current_measurement/current_input_with_point04_shunt.rb

@@ -1,12 +0,0 @@
-require 'bigdecimal'
-
-module CurrentMeasurement
-  class CurrentInputWithPoint04Shunt < CurrentInput
-
-    def value
-      # Conversion for 0.04 Ohm shunt resistance Breakout. 
-      (@analog_input.raw_value / BigDecimal("0.04")).to_f
-    end
-
-  end
-end

data/examples/current_measurement.rb

@@ -1,8 +0,0 @@
-require 'object_oriented_beaglebone_black'
-
-require 'current_measurement/current_input'
-require 'current_measurement/current_input_with_point04_shunt'
-
-module CurrentMeasurement
-  # Your code goes here...
-end

data/examples/voltage_measurement/voltage_input.rb

@@ -1,16 +0,0 @@
-require 'bigdecimal'
-
-module VoltageMeasurement
-  class VoltageInput
-
-    def initialize(pin_key)
-      @analog_input = ObjectOrientedBeagleboneBlack::AnalogInput.new(pin_key)
-    end
-
-    def value
-      # For voltage divider 11:1, e.g. 51[kΩ] and 5.1[kΩ]. If another voltage divider is added, extract this code to subclass and make this class parent class. 
-      (@analog_input.raw_value * BigDecimal("11")).to_f
-    end
-
-  end
-end

data/examples/voltage_measurement/voltage_input_with_100k_and_20k_voltage_divider.rb

@@ -1,12 +0,0 @@
-require 'bigdecimal'
-
-module VoltageMeasurement
-  class VoltageInputWith100kAnd20kVoltageDivider < VoltageInput
-
-    def value
-      # For voltage divider 6:1, e.g. 100[kΩ] and 20[kΩ]. 
-      (@analog_input.raw_value * BigDecimal("6")).to_f
-    end
-
-  end
-end

data/examples/voltage_measurement.rb

@@ -1,8 +0,0 @@
-require 'object_oriented_beaglebone_black'
-
-require 'voltage_measurement/voltage_input'
-require 'voltage_measurement/voltage_input_with_100k_and_20k_voltage_divider'
-
-module VoltageMeasurement
-  # Your code goes here...
-end