object_oriented_beaglebone_black 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbe6449f8addf886e091badbb93261750b4dc6ba
-  data.tar.gz: 49cb896622d085d91b89cf18a22332da3fe06726
+  metadata.gz: 4b12eebdcfd145dcf383e623349d7f844241b2ad
+  data.tar.gz: 52b1e565447eda98535b8e03a7a8363d8d2a8d10
 SHA512:
-  metadata.gz: dd858cf1e1c4af95a24f06c7ed2f2d86f281b849c551357ec4a468d3cdbc9bb4e415f3e972bfc59dcada5071fc4b7b16ee67c578ce92d8e175720b7facff5621
-  data.tar.gz: 7f89fe31bfc36a89a8aeac9729fee670954a94393054f1235967bb1bda8b7db55e89de515b21c3f35d08832126d3a6100bd95e581b7696fd4c528576156f0969
+  metadata.gz: 673e08d66213879c0b2350598309a087161363dd0796e2ee08600d76dbbbcad768ce0bebb2e8a10910c0dab16486e047065de07195639ec3efa8b958cf99c4aa
+  data.tar.gz: 567ad8f836785de958d232f041440d3df89f40ababaae1b6c30032dcb4d0578e4da57efef0769baeca6096ffbd438b428eaff609035f6bd41f06b81c5204eddc

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+## object_oriented_beaglebone_black 0.0.2 (December 26, 2014) ##
+
+* GPIO
+
+* Analog input
+
+* PWM
+
+## object_oriented_beaglebone_black 0.1.0 ##
+
+There is no 0.1.0. I simply made a mistake to change the version to 0.2.0, after changing the version to 0.1.1 in one commit. 
+
+## object_oriented_beaglebone_black 0.2.0 (September 26, 2015) ##
+
+* PWM period can be set and read.
+
+## object_oriented_beaglebone_black 0.2.1 (September 27, 2015) ##
+
+* When the PWM period is set, the internal "duty" value is modified automatically to keep the same duty cycle. 
+
+  Internally in BeagleBone Black, "duty" value is relative to "period" value. 
+
+    e.g. For "period" = 1000, "duty" = 500 gives the duty cycle = 500 / 1000 = 0.5. 
+
+  In version 0.2.0, when "period" is modified, "duty" is not modified. Hence, the duty cycle changes. 
+
+    e.g. For the example above, 
+         When "period" is modified to be 10000, the duty cycle has changed to 500 / 10000 = 0.05. 
+
+  In version 0.2.1, when "period" is modified, "duty" is modified accordingly, in order to keep the same duty cycle. 
+
+    e.g. For the example above, 
+         When "period" is modified to be 10000, "duty" is modified to be 5000, which gives the duty cycle 5000 / 10000 = 0.5. 
+          
+  Note: This can be considered to be incompatible API change. However, at this point, it is not yet considered to be a stable public API. Hence, the MAJOR version is kept to be 0. (See, [Semantic Versioning](http://semver.org/))

data/README.md

@@ -1,6 +1,6 @@
 # ObjectOrientedBeagleboneBlack
 
-This is for using Beaglebone Black in Object-Oriented way through Ruby code. 
+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.
@@ -50,63 +50,72 @@ Or install it yourself as:
 
 ## Usage
 
-1. GPIO. 
+1. GPIO 
 
    Example:
 
-   require 'object_oriented_beaglebone_black'
+    ```ruby
+    require 'object_oriented_beaglebone_black'
 
-   led_gpio_pin_number = 60
-   button_gpio_pin_number = 15
+    led_gpio_pin_number = 60
+    button_gpio_pin_number = 15
 
-   led_gpio = ObjectOrientedBeagleboneBlack::Gpio.new(led_gpio_pin_number)
+    led_gpio = ObjectOrientedBeagleboneBlack::Gpio.new(led_gpio_pin_number)
 
-   led_gpio.export
+    led_gpio.export
 
-   led_gpio.direction = ObjectOrientedBeagleboneBlack::IO::Direction::OUT
+    led_gpio.direction = ObjectOrientedBeagleboneBlack::IO::Direction::OUT
 
-   led_gpio.value = ObjectOrientedBeagleboneBlack::IO::Value::HIGH
+    led_gpio.value = ObjectOrientedBeagleboneBlack::IO::Value::HIGH
 
-   led_gpio.value  # Read the value. HIGH (1) as set above. 
+    led_gpio.value  # Read the value. HIGH (1) as set above. 
 
-   led_gpio.value = ObjectOrientedBeagleboneBlack::IO::Value::LOW
+    led_gpio.value = ObjectOrientedBeagleboneBlack::IO::Value::LOW
 
-   led_gpio.value  # Read the value. LOW (0) as set above. 
+    led_gpio.value  # Read the value. LOW (0) as set above. 
 
-   led_gpio.unexport
+    led_gpio.unexport
+    ```
 
 2. Analog input
+
    Example:
 
-   require 'object_oriented_beaglebone_black'
+    ```ruby
+    require 'object_oriented_beaglebone_black'
 
-   pin_key = "P9_40"
+    pin_key = "P9_40"
 
-   analog_input = ObjectOrientedBeagleboneBlack::AnalogInput.new(pin_key)
+    analog_input = ObjectOrientedBeagleboneBlack::AnalogInput.new(pin_key)
 
-   analog_input.raw_value  # Read the raw voltage value in the range of 0 and 1.8[V].
+    analog_input.raw_value  # Read the raw voltage value in the range of 0 and 1.8[V].
 
-   analog_input.value  # Read the relative value between 0 and 1. 
+    analog_input.value  # Read the relative value between 0 and 1. 
+    ```
 
 3. PWM
 
    Example: 
+ 
+    ```ruby
+    require 'object_oriented_beaglebone_black'
 
-   require 'object_oriented_beaglebone_black'
-
-   pwm_pin_key = "P9_14"
+    pwm_pin_key = "P9_14"
 
-   pwm = ObjectOrientedBeagleboneBlack::Pwm.new(pwm_pin_key)
+    pwm = ObjectOrientedBeagleboneBlack::Pwm.new(pwm_pin_key)
 
-   pwm.duty_cycle = 0.5
+    pwm.period = 1000 # Unit is [ns] (nano second)
 
-   pwm.polarity  # Read the polarity. The default is direct (ObjectOrientedBeagleboneBlack::Pwm::Polarity::DIRECT)
+    pwm.period  # Read the period. 1000[ns] as set above.    
 
-   pwm.duty_cycle  # Read the duty cycle. 0.5 as set above. 
+    pwm.duty_cycle = 0.5
 
-   pwm.period = 1000 # Unit is [ns] (nano second)
+    pwm.polarity  # Read the polarity. 
+                  # The default is direct:  
+                  #   ObjectOrientedBeagleboneBlack::Pwm::Polarity::DIRECT
 
-   pwm.period  # Read the period. 1000[ns] as set above. 
+    pwm.duty_cycle  # Read the duty cycle. 0.5 as set above. 
+    ```
 
 ## Contributing
 

data/lib/object_oriented_beaglebone_black/pwm.rb

@@ -56,7 +56,14 @@ module ObjectOrientedBeagleboneBlack
     end
 
     def period=(period)
+      current_duty_cycle = self.duty_cycle
+
       File.open(File.join(pwm_directory, "period"), "w") { |file| file.write(period) }
+      
+      # Preserves the duty cycle:
+      # Note: Internally in BeagleBone Black, "duty" value is relative to "period" value. 
+      #       e.g. For "period" = 1000, "duty" = 500 gives the duty cycle = 500 / 1000 = 0.5.
+      self.duty_cycle = current_duty_cycle
     end
 
     # Unit: [ns] (nano second)

data/lib/object_oriented_beaglebone_black/version.rb

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

data/spec/object_oriented_beaglebone_black/pwm_spec.rb

@@ -68,9 +68,15 @@ describe ObjectOrientedBeagleboneBlack::Pwm, pwm: true do
 
       expect(Dir.exists?(File.join(@device_directory, "pwm_test_#{pwm_pin_key}.15"))).to be true
 
+      # Set the duty cycle before period is modified:
+      pwm.duty_cycle = 0.5
+      expect(pwm.duty_cycle).to eq(0.5)
+
       pwm.period = 10000 # [ns]: nano second
 
       expect(pwm.period).to eq(10000)
+      # The duty cycle should be preserved: 
+      expect(pwm.duty_cycle).to eq(0.5)
 
     end
 
@@ -90,10 +96,10 @@ describe ObjectOrientedBeagleboneBlack::Pwm, pwm: true do
 
       expect(pwm.period).to eq(1000)
 
-      pwm.duty_cycle = 0.5
+      pwm.duty_cycle = 0.25
 
       expect(pwm.polarity).to eq(ObjectOrientedBeagleboneBlack::Pwm::Polarity::DIRECT)
-      expect(pwm.duty_cycle).to eq(0.5)      
+      expect(pwm.duty_cycle).to eq(0.25)      
 
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: object_oriented_beaglebone_black
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tadatoshi Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-26 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,6 +63,7 @@ files:
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md