pi_piper 2.0.beta.4 → 2.0.0

data/spec/pwm_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+include PiPiper
+
+describe 'Pwm' do
+  before(:example) do |example|
+    Platform.driver = StubDriver.new
+  end
+  
+  describe '#new' do
+    it 'should get the options right' do
+      default_pwm =  PiPiper::Pwm.new(pin: 18)
+      expect(default_pwm.options).to eq({ pin: 18, mode: :balanced, clock: 19200000.0, range: 1024 })
+      expect(default_pwm.value).to eq(0)
+
+      custom_pwm =  PiPiper::Pwm.new(pin: 18, mode: :markspace, clock: 1.megahertz, range: 10000, value: 1)
+      expect(custom_pwm.options).to eq({ pin: 18, mode: :markspace, clock: 1000000.0, range: 10000 })
+      expect(custom_pwm.value).to eq(1)
+    end
+
+    it 'should reject wrong options value' do
+      expect { PiPiper::Pwm.new pin: 0 }.to raise_error(ArgumentError, ':pin should be one of  [12, 13, 18, 19, 40, 41, 45, 52, 53] not 0')
+      expect { PiPiper::Pwm.new pin: 18 }.not_to raise_error
+      expect { PiPiper::Pwm.new pin: 18, mode: :balanced }.not_to raise_error
+      expect { PiPiper::Pwm.new pin: 18, mode: :markspace}.not_to raise_error
+      expect { PiPiper::Pwm.new pin: 18, mode: :another_mode }.to raise_error(ArgumentError, ':mode should be one of [:balanced, :markspace], not another_mode')
+    end
+
+    it 'should set the options' do
+      expect(Platform.driver).to receive(:gpio_select_function).with(18, 0b010)
+      expect(Platform.driver).to receive(:pwm_clock).with(9)
+      expect(Platform.driver).to receive(:pwm_range).with(0, 2)
+      expect(Platform.driver).to receive(:pwm_mode).with(0, 1, 1)
+
+      pwm =  PiPiper::Pwm.new pin: 18, range: 2, mode: :markspace, clock: 2.megahertz
+    end
+
+  end
+
+  let!(:pwm) { PiPiper::Pwm.new pin: 18 }
+  
+  describe 'start/stop & status' do
+    it '#on' do
+      expect(Platform.driver).to receive(:pwm_mode).twice.with(0, 0, 1)
+      pwm.on
+      pwm.start
+    end
+
+    it '#off' do
+      expect(Platform.driver).to receive(:pwm_mode).twice.with(0, 0, 0)
+      pwm.off
+      pwm.stop
+    end
+    
+    it '#on?' do
+      pwm.on
+      expect(pwm.on?).to be true
+      pwm.off
+      expect(pwm.on?).to be false
+    end
+
+    it '#off?' do
+      pwm.on
+      expect(pwm.off?).to be false
+      pwm.off
+      expect(pwm.off?).to be true
+    end
+  end
+
+  describe '#value=' do
+    it 'should set value between 0 and 1' do
+      expect(Platform.driver).to receive(:pwm_data).with(0, (0.4*1024).to_i)
+      pwm.value = 0.4
+      expect(pwm.value).to eq 0.4
+    end
+
+    it 'should set caped value outside 0 and 1' do
+      pwm.value = 2
+      expect(pwm.value).to eq 1
+      pwm.value = -2
+      expect(pwm.value).to eq 0
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+SimpleCov.start
+require 'pi_piper.rb'
+require 'rspec'
+require 'mocha/api'
+
+include PiPiper

data/spec/spi_spec.rb

@@ -0,0 +1,38 @@
+require_relative 'spec_helper'
+
+describe 'Spi' do
+
+  before(:example) do |example|
+    Platform.driver = StubDriver.new
+  end
+
+  describe 'when in block' do
+    it 'should call spi_begin' do
+      expect(Platform.driver).to receive(:spi_begin)
+      Spi.begin {}
+    end
+
+    it 'should call spi_chip_select to set and unset chip' do
+      expect(Platform.driver).to receive(:spi_chip_select).with(Spi::CHIP_SELECT_1)
+      expect(Platform.driver).to receive(:spi_chip_select).with(Spi::CHIP_SELECT_NONE)
+
+      Spi.begin(Spi::CHIP_SELECT_1) do
+        read
+      end
+    end
+  end
+
+  describe 'set mode' do
+    it 'should call spi_set_data_mode' do
+      expect(Platform.driver).to receive(:spi_set_data_mode).with(Spi::SPI_MODE3)
+      Spi.set_mode(1, 1)
+    end
+  end
+
+  describe '#spidev_out' do
+    it 'should attempt to write data to spi' do
+      expect(Platform.driver).to receive(:spidev_out).with([0, 1, 2, 3, 4, 5])
+      Spi.spidev_out([0, 1, 2, 3, 4, 5])
+    end
+  end
+end

data/spec/stub_driver_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+
+describe StubDriver do
+  let(:stub_driver) { StubDriver.new }
+
+  before do
+    @logger = double
+    @driver = StubDriver.new(logger: @logger)
+  end
+
+  describe '#pin_input' do
+    it 'should set pin as input' do
+      stub_driver.pin_input(10)
+      expect(stub_driver.pin_direction(10)).to eq(:in)
+    end
+
+    it 'should log that pin is set' do
+      expect(@logger).to receive(:debug).with('Pin #10 -> Input')
+      @driver.pin_input(10)
+    end
+  end
+
+  describe '#pin_output' do
+    it 'should set pin as output' do
+      stub_driver.pin_output(10)
+      expect(stub_driver.pin_direction(10)).to eq(:out)
+    end
+
+    it 'should log that pin is set' do
+      expect(@logger).to receive(:debug).with('Pin #10 -> Output')
+      @driver.pin_output(10)
+    end
+  end
+
+  describe '#pin_set' do
+    it 'should set pin value' do
+      stub_driver.pin_set(22, 42)
+      expect(stub_driver.pin_read(22)).to eq(42)
+    end
+
+    it 'should log the new pin value' do
+      expect(@logger).to receive(:debug).with('Pin #21 -> 22')
+      @driver.pin_set(21, 22)
+    end
+  end
+
+  describe '#pin_set_pud' do
+    it 'should set pin value' do
+      stub_driver.pin_set_pud(12, Pin::GPIO_PUD_UP)
+      expect(stub_driver.pin_read(12)).to eq(Pin::GPIO_HIGH)
+    end
+
+    it 'should not overwrite set value' do
+      stub_driver.pin_set(12, 0)
+      stub_driver.pin_set_pud(12, Pin::GPIO_PUD_DOWN)
+      expect(stub_driver.pin_read(12)).to eq(Pin::GPIO_LOW)
+    end
+
+    it 'should log the new pin value' do
+      expect(@logger).to receive(:debug).with('PinPUD #21 -> 22')
+      @driver.pin_set_pud(21, 22)
+    end
+  end
+
+  describe '#spidev_out' do
+    it 'should log the array sent to ada_spi_out' do
+      expect(@logger).to receive(:debug).with("SPIDEV -> \u0000\u0001\u0002")
+      @driver.spidev_out([0x00, 0x01, 0x02])
+    end
+  end
+
+  describe '#spi_begin' do
+    it 'should should clear spi data' do
+      expect(@logger).to receive(:debug)
+      @driver.spi_transfer_bytes([0x01, 0x02])
+      expect(@logger).to receive(:debug).with('SPI Begin')
+      @driver.spi_begin
+      expect(@driver.send(:spi_data)).to eq([])
+    end
+  end
+
+  describe '#spi_transfer_bytes' do
+    it 'should log and store sent data' do
+      expect(@logger).to receive(:debug).with('SPI CS0 <- [1, 2, 3]')
+      @driver.spi_transfer_bytes([0x01, 0x02, 0x03])
+      expect(@driver.send(:spi_data)).to eq([0x01, 0x02, 0x03])
+    end
+  end
+
+  describe '#spi_chip_select' do
+    it 'should return default 0 if nothing provided' do
+      expect(@logger).to receive(:debug).with('SPI Chip Select = 0')
+      expect(@driver.spi_chip_select).to eq(0)
+    end
+
+    it 'should set chip select value if passed in' do
+      expect(@logger).to receive(:debug).with('SPI Chip Select = 3').twice
+      @driver.spi_chip_select(3)
+      expect(@driver.spi_chip_select).to eq(3)
+    end
+  end
+
+  describe '#reset' do
+    it 'should not reset unless asked' do
+      StubDriver.new()
+      StubDriver.pin_set(1,3)
+      expect(StubDriver.pin_read(1)).to eq(3)
+      StubDriver.reset
+      expect(StubDriver.pin_read(1)).to be_nil
+    end
+  end
+
+  describe '#release_pins' do
+    before(:each) do
+      StubDriver.new
+      StubDriver.pin_input(4)
+      StubDriver.pin_output(6)
+    end
+
+    it 'should keep track of open pins and release them' do
+      expect(@driver).to receive(:release_pin).with(4)
+      expect(@driver).to receive(:release_pin).with(6)
+
+      StubDriver.release_pins
+    end
+
+    it 'should remove released pins' do
+      StubDriver.release_pins
+
+      expect(StubDriver.pin_direction(4)).to be_nil
+      expect(StubDriver.pin_direction(6)).to be_nil
+    end
+
+    it 'should keep track of released pins' do
+      StubDriver.release_pins
+      expect(@driver).not_to receive(:release_pin)
+      StubDriver.release_pins
+    end
+  end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: pi_piper
 version: !ruby/object:Gem::Version
-  version: 2.0.beta.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Jason Whitehorn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-14 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   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
@@ -30,70 +30,144 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 1.0.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 1.0.9
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Event driven Raspberry Pi GPIO library
 email: jason.whitehorn@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
-- lib/pi_piper.rb
-- lib/pi_piper/bcm2835.rb
-- lib/pi_piper/frequency.rb
-- lib/pi_piper/i2c.rb
-- lib/pi_piper/libbcm2835.img
-- lib/pi_piper/pin.rb
-- lib/pi_piper/platform.rb
-- lib/pi_piper/spi.rb
+- lib/pi_piper/libbcm2835.so
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
-- Manifest
+- LICENCE.md
 - README.md
 - Rakefile
+- examples/2_bit_counter/2_bit_counter.rb
+- examples/7-segment/7-segment.rb
+- examples/dsl_switch/dsl_switch.rb
+- examples/elro/README.md
+- examples/elro/docs/elro-dips.jpg
+- examples/elro/docs/elro-switch.jpg
+- examples/elro/docs/setup.jpg
+- examples/elro/docs/wireplan.jpg
+- examples/elro/docs/wrl10534.jpg
+- examples/elro/elro.rb
+- examples/elro/lib/elro_switch.rb
+- examples/elro/lib/elro_util.rb
+- examples/elro/spec/elro_spec.rb
+- examples/elro/spec/elro_util_spec.rb
+- examples/elro/spec/spec_helper.rb
+- examples/mcp3008/circuit.png
+- examples/mcp3008/mcp3008.rb
+- examples/mcp3008_spi/mcp3008_spi.rb
+- examples/morse_code/circuit.png
+- examples/morse_code/morse_code.rb
+- examples/simple_switch/circuit.png
+- examples/simple_switch/simple_switch.rb
 - lib/pi_piper.rb
 - lib/pi_piper/bcm2835.rb
 - lib/pi_piper/frequency.rb
 - lib/pi_piper/i2c.rb
-- lib/pi_piper/libbcm2835.img
+- lib/pi_piper/libbcm2835.so
 - lib/pi_piper/pin.rb
+- lib/pi_piper/pin_error.rb
+- lib/pi_piper/pin_values.rb
 - lib/pi_piper/platform.rb
+- lib/pi_piper/pwm.rb
 - lib/pi_piper/spi.rb
+- lib/pi_piper/stub_driver.rb
+- lib/pi_piper/version.rb
 - pi_piper.gemspec
+- spec/bcm2835_spec.rb
+- spec/i2c_spec.rb
+- spec/pin_spec.rb
+- spec/pwm_spec.rb
+- spec/spec_helper.rb
+- spec/spi_spec.rb
+- spec/stub_driver_spec.rb
 homepage: http://github.com/jwhitehorn/pi_piper
-licenses: []
+licenses:
+- BSD
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --line-numbers
-- --inline-source
-- --title
+- "--line-numbers"
+- "--inline-source"
+- "--title"
 - Pi_piper
-- --main
+- "--main"
 - README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '1.2'
+      version: 2.0.0
 requirements: []
-rubyforge_project: pi_piper
-rubygems_version: 2.0.0
+rubyforge_project: 
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Event driven Raspberry Pi GPIO library
 test_files: []
+has_rdoc: