object_oriented_beaglebone_black 0.0.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 668bcd57ff71c597b1f24a3084d4d11202291d64
-  data.tar.gz: 65e6e1629c619a3e90148612034a1daa28505c06
+  metadata.gz: dbe6449f8addf886e091badbb93261750b4dc6ba
+  data.tar.gz: 49cb896622d085d91b89cf18a22332da3fe06726
 SHA512:
-  metadata.gz: e35ec82cf7065cc5f2a359ad4aea441d71940ff89d3ea05d3cf840be491b36749f70eb53e1ebdf75c1c98e2b83c2772a205a678c48bdd23c5f164eee9330d0bd
-  data.tar.gz: 431e61ad98d696102b82258e6f61b5ec020ff77ed18ee83cc7ccab924a633aa3be1cb89f0c3d29e796d9af129eea1e9eb614ffe07cc0ee58881d582b52f1f47a
+  metadata.gz: dd858cf1e1c4af95a24f06c7ed2f2d86f281b849c551357ec4a468d3cdbc9bb4e415f3e972bfc59dcada5071fc4b7b16ee67c578ce92d8e175720b7facff5621
+  data.tar.gz: 7f89fe31bfc36a89a8aeac9729fee670954a94393054f1235967bb1bda8b7db55e89de515b21c3f35d08832126d3a6100bd95e581b7696fd4c528576156f0969

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.2.3

data/README.md

@@ -5,7 +5,7 @@ This is for using Beaglebone Black in Object-Oriented way through Ruby code.
 There are many Ruby projects in GitHub to do a similar thing. 
 But I have decided to develop my own from scratch this time instead of using an existing one like I always do.
 
-There are three reasons. 
+There are four reasons. 
 
 1. Build my own expertise on controlling Beaglebone Black directly. 
 
@@ -19,11 +19,11 @@ There are three reasons.
 
 3. Many existing ones don't have proper testings. 
 
-   I understand the difficulty of writing a test for a code to control hardware. But less test code makes the source code bulky and not modular. I want to make the code modular naturally by Test-Driven Development. (By Test-Driven Development, the code naturally becomes modular even when not consciously thinking about it by just thinking of making the code work.)
+   I understand the difficulty of writing a test for a code to control hardware. But less test code makes the source code bulky and not modular. I want to make the code modular naturally by Test-Driven Development. (By Test-Driven Development, the code naturally becomes modular even when not consciously thinking about it, by just thinking about making the code work.)
 
 4. Many existing ones for controlling hardware are focusing on Robotics (controlling motors). 
 
-   My objective is for developing a controller for DC-DC converter. Because of it, what makes existing ones good (for robotics) sometimes makes the code I need difficult to write for my objective. 
+   My objective is for developing a controller related to Power Electronics. Because of it, what makes existing ones good (for robotics) sometimes makes the code I need difficult to write for my objective. 
 
 The important point in this gem is that everything is Object-Oriented. 
 In other words, controlling hardware in Object-Oriented way, treating everything as an Object. 
@@ -104,6 +104,10 @@ Or install it yourself as:
 
    pwm.duty_cycle  # Read the duty cycle. 0.5 as set above. 
 
+   pwm.period = 1000 # Unit is [ns] (nano second)
+
+   pwm.period  # Read the period. 1000[ns] as set above. 
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/object_oriented_beaglebone_black/fork )

data/lib/object_oriented_beaglebone_black.rb

@@ -1,3 +1,4 @@
+require 'pry'
 require "object_oriented_beaglebone_black/version"
 require "erb"
 

data/lib/object_oriented_beaglebone_black/pwm.rb

@@ -8,8 +8,6 @@ module ObjectOrientedBeagleboneBlack
       INVERSE = 1
     end    
 
-    DUTY_VALUE_PER_ONE_HUNDREDTH = BigDecimal("5000")
-
     def initialize(pin_key)
       @pin_key = pin_key
       @slots_file_path = File.join(File.join(OBJECT_ORIENTED_BEAGLEBONE_BLACK_CONFIG["slots_directory"], "slots"))
@@ -20,14 +18,22 @@ 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. 
-      File.open(@slots_file_path, "a") { |file| file.write("am33xx_pwm") }
-      File.open(@slots_file_path, "a") { |file| file.write("bone_pwm_#{@pin_key}") }
+      # 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}")      
     end
 
     # duty_cycle (value between 0 and 1)
     def duty_cycle=(duty_cycle)
       self.polarity = ObjectOrientedBeagleboneBlack::Pwm::Polarity::DIRECT
-      internal_duty_value = (BigDecimal(duty_cycle.to_s) * BigDecimal("100") * DUTY_VALUE_PER_ONE_HUNDREDTH).to_i
+      internal_duty_value = (BigDecimal(duty_cycle.to_s) * BigDecimal(period.to_s)).to_i
       File.open(File.join(pwm_directory, "duty"), "w") { |file| file.write(internal_duty_value) }
     end
 
@@ -35,7 +41,7 @@ module ObjectOrientedBeagleboneBlack
       # Using this instead of simple "File.open(file_path).read" in order to close file after reading.
       internal_duty_value = nil
       File.open(File.join(pwm_directory, "duty"), "r") { |file| internal_duty_value = file.read.strip }
-      duty_cycle = (BigDecimal(internal_duty_value.to_s) / DUTY_VALUE_PER_ONE_HUNDREDTH / BigDecimal("100")).to_f
+      duty_cycle = (BigDecimal(internal_duty_value.to_s) / BigDecimal(period.to_s)).to_f
       duty_cycle
     end
 
@@ -49,6 +55,17 @@ module ObjectOrientedBeagleboneBlack
       internal_polarity_value
     end
 
+    def period=(period)
+      File.open(File.join(pwm_directory, "period"), "w") { |file| file.write(period) }
+    end
+
+    # Unit: [ns] (nano second)
+    def period
+      internal_period_value = nil
+      File.open(File.join(pwm_directory, "period"), "r") { |file| internal_period_value = file.read.strip.to_i }
+      internal_period_value
+    end
+
     private
       def pwm_directory
         Dir["#{File.join(OBJECT_ORIENTED_BEAGLEBONE_BLACK_CONFIG["device_directory"], "pwm_test_#{@pin_key}.")}*"].first

data/lib/object_oriented_beaglebone_black/version.rb

@@ -1,3 +1,3 @@
 module ObjectOrientedBeagleboneBlack
-  VERSION = "0.0.2"
+  VERSION = "0.2.0"
 end

data/spec/object_oriented_beaglebone_black/pwm_spec.rb

@@ -33,7 +33,7 @@ describe ObjectOrientedBeagleboneBlack::Pwm, pwm: true do
       pwm = ObjectOrientedBeagleboneBlack::Pwm.new(pwm_pin_key)
 
       # 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.
+      # in the "test" environment with a regular file, it is mimicked here.
       mimic_internal_pwm_directory_creation(pwm_pin_key) if ENV["OBJECT_ORIENTED_BEAGLEBONE_BLACK_ENV"] == 'test'
 
       expect(Dir.exists?(File.join(@device_directory, "pwm_test_#{pwm_pin_key}.15"))).to be true
@@ -54,4 +54,49 @@ describe ObjectOrientedBeagleboneBlack::Pwm, pwm: true do
 
   end
 
+  context 'period' do
+
+    it 'should set the period' do
+
+      pwm_pin_key = 'P9_14'
+
+      pwm = ObjectOrientedBeagleboneBlack::Pwm.new(pwm_pin_key)
+
+      # 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 mimicked here.
+      mimic_internal_pwm_directory_creation(pwm_pin_key) if ENV["OBJECT_ORIENTED_BEAGLEBONE_BLACK_ENV"] == 'test'
+
+      expect(Dir.exists?(File.join(@device_directory, "pwm_test_#{pwm_pin_key}.15"))).to be true
+
+      pwm.period = 10000 # [ns]: nano second
+
+      expect(pwm.period).to eq(10000)
+
+    end
+
+    it 'should set the duty cycle corresponding to the specified period' do
+
+      pwm_pin_key = 'P9_14'
+
+      pwm = ObjectOrientedBeagleboneBlack::Pwm.new(pwm_pin_key)
+
+      # 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 mimicked here.
+      mimic_internal_pwm_directory_creation(pwm_pin_key) if ENV["OBJECT_ORIENTED_BEAGLEBONE_BLACK_ENV"] == 'test'
+
+      expect(Dir.exists?(File.join(@device_directory, "pwm_test_#{pwm_pin_key}.15"))).to be true
+
+      pwm.period = 1000 # [ns]: nano second
+
+      expect(pwm.period).to eq(1000)
+
+      pwm.duty_cycle = 0.5
+
+      expect(pwm.polarity).to eq(ObjectOrientedBeagleboneBlack::Pwm::Polarity::DIRECT)
+      expect(pwm.duty_cycle).to eq(0.5)      
+
+    end
+
+  end
+
 end

data/spec/support/pwm_file_behavior_helper.rb

@@ -10,14 +10,21 @@ module PwmFileBehaviorHelper
 
     unless Dir.exists?(temp_specific_pwm_directory)
       FileUtils.mkdir_p(temp_specific_pwm_directory, mode: 0700)
+    end
 
+    # "period" must be set to the default value, because duty value is relative to it:
+    FileUtils.touch(File.join(temp_specific_pwm_directory, "period"))
+    File.chmod(0700, File.join(temp_specific_pwm_directory, "period"))
+    File.open(File.join(temp_specific_pwm_directory, "period"), 'w') {|file| file.write(500000) }
+
+    unless Dir.exists?(temp_specific_pwm_directory)  
       FileUtils.touch(File.join(temp_specific_pwm_directory, "duty"))
       File.chmod(0700, File.join(temp_specific_pwm_directory, "duty"))
       File.open(File.join(temp_specific_pwm_directory, "duty"), 'w') {|file| file.write(250000) }
       FileUtils.touch(File.join(temp_specific_pwm_directory, "polarity"))
       File.chmod(0700, File.join(temp_specific_pwm_directory, "polarity"))
       File.open(File.join(temp_specific_pwm_directory, "polarity"), 'w') {|file| file.write(ObjectOrientedBeagleboneBlack::Pwm::Polarity::INVERSE) }      
-    end    
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: object_oriented_beaglebone_black
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Tadatoshi Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-26 00:00:00.000000000 Z
+date: 2015-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: For using BeagleBone Black in Object-Oriented way through Ruby.