brewby 0.1.0

data/spec/heating_element_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Brewby::HeatingElement do
+  def millis_from_now i
+    (Time.now.to_i + i) * 1000
+  end
+
+  before do
+    adapter = Brewby::Outputs::Test.new
+    @element = Brewby::HeatingElement.new(adapter, pulse_range: 5000)
+    @element.pulse_width = 3000
+  end
+
+  describe 'relay pulsing' do
+    it 'turn on the relay when first pulsed' do
+      @element.should be_off
+      @element.pulse
+      @element.should be_on
+    end
+
+    it 'turns on the relay while within pulse width' do
+      @element.should be_off
+      @element.instance_variable_set(:@pulse_range_end, millis_from_now(4))
+      @element.pulse
+      @element.should be_on
+    end
+
+    it 'turns off the relay when time exceeds pulse width' do
+      @element.instance_variable_set(:@pulse_range_end, millis_from_now(5))
+      @element.pulse
+      @element.should be_on
+      @element.instance_variable_set(:@pulse_range_end, millis_from_now(1))
+      @element.pulse
+      @element.should be_off
+    end
+    
+    it 'turns on the relay when time hits the next pulse range' do
+      @element.should be_off
+      @element.instance_variable_set(:@pulse_range_end, millis_from_now(-1))
+      @element.pulse
+      @element.should be_on
+    end
+  end
+end

data/spec/inputs/ds18b20_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Brewby::Inputs::DS18B20 do
+  it 'accepts a hardware_id' do
+    sensor = Brewby::Inputs::DS18B20.new hardware_id: 'something'
+    sensor.hardware_id.should == 'something'
+  end
+
+  it 'picks the first hardware_id it finds when no hardware_id is specified' do
+    Dir.mktmpdir do |dir|
+      File.write "#{dir}/28-12345", "1"
+      sensor = Brewby::Inputs::DS18B20.new device_path: dir
+      sensor.hardware_id.should == '28-12345'
+    end
+  end
+
+  context 'reading sensor data' do
+    before do
+      Brewby::Inputs::DS18B20.any_instance.stub(:read_raw) { "f5 00 4b 46 7f ff 0b 10 d7 : crc=d7 YES\nf5 00 4b 46 7f ff 0b 10 d7 t=15312" }
+      @sensor = Brewby::Inputs::DS18B20.new device_path: @device_dir, hardware_id: '28-12345'
+    end
+
+    it 'reads the temperaturee and returns it in fahrenheit' do
+      input = @sensor.read
+      input.should == 59.562
+    end
+
+    it 'parses the raw data to celsius' do
+      tempC = @sensor.parse @sensor.read_raw
+      tempC.should == 15.312
+    end
+
+    it 'returns nil when an error occurs when parsing' do
+      Brewby::Inputs::DS18B20.any_instance.stub(:read_raw) { "f5 00 4b 46 7f ff 0b 10 d7 : crc=d7 NO\nf5 00 4b 46 7f ff 0b 10 d7" }
+      input = @sensor.read
+      input.should be_nil
+    end
+  end
+end

data/spec/inputs_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Brewby::Inputs do
+  it 'determines input class based on adapter' do
+    Brewby::Inputs.adapter_class(:test).should == Brewby::Inputs::Test
+    Brewby::Inputs.adapter_class(:raspberry_pi).should == Brewby::Inputs::DS18B20
+  end
+end

data/spec/outputs/gpio_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Brewby::Outputs::GPIO do
+  before do
+    @gpio_dir = Dir.mktmpdir
+    Dir.mkdir "#{@gpio_dir}/gpio1"
+    File.write "#{@gpio_dir}/export", ""
+    File.write "#{@gpio_dir}/gpio1/direction", ""
+  end
+
+  after do
+    FileUtils.remove_entry @gpio_dir
+  end
+
+  context 'GPIO initialization' do
+    it 'initializes the GPIO pin via export' do
+      Brewby::Outputs::GPIO.new pin: 1, gpio_path: @gpio_dir
+      data = File.read "#{@gpio_dir}/export"
+      data.should == '1'
+    end
+
+    it 'initializes the GPIO pin direction' do
+      Brewby::Outputs::GPIO.new pin: 1, gpio_path: @gpio_dir
+      data = File.read "#{@gpio_dir}/gpio1/direction"
+      data.should == 'out'
+    end
+
+    it 'does not initialize the GPIO pin if already initialized' do
+      File.write "#{@gpio_dir}/gpio1/value", ""
+      Brewby::Outputs::GPIO.new pin: 1, gpio_path: @gpio_dir
+      data = File.read "#{@gpio_dir}/export"
+      data.should == ''
+    end
+  end
+
+  context 'output' do
+    before do
+      @output = Brewby::Outputs::GPIO.new pin: 1, gpio_path: @gpio_dir
+      File.write "#{@gpio_dir}/gpio1/value", ""
+    end
+
+    def pin_value
+      File.read "#{@gpio_dir}/gpio1/value"
+    end
+
+    it 'sets the pin value to 1 when on' do
+      @output.on
+      pin_value.should == '1'
+    end
+
+    it 'sets the pin value to 0 when off' do
+      @output.off
+      pin_value.should == '0'
+    end
+
+    it 'returns false when off' do
+      @output.should_not be_on
+    end
+
+    it 'returns true when on' do
+      @output.on
+      @output.should be_on
+    end
+  end
+end

data/spec/outputs_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Brewby::Outputs do
+  it 'determines output class based on adapter' do
+    Brewby::Outputs.adapter_class(:test).should == Brewby::Outputs::Test
+    Brewby::Outputs.adapter_class(:raspberry_pi).should == Brewby::Outputs::GPIO
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'brewby'
+require 'pry'
+
+load './spec/support/virtual_view.rb'

data/spec/step_loader_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Brewby::StepLoader do
+  before do
+    Brewby::Application.any_instance.stub(:render)
+    Brewby::Application.any_instance.stub(:configure_view)
+
+    @application = Brewby::Application.new adapter: :test, 
+      outputs: [{ pin: 1, name: :hlt }, { pin: 2, name: :mlt }, { pin: 3, name: :bk }], 
+      inputs: [{ name: :hlt}, { name: :mlt }, { name: :bk }]
+    @loader = Brewby::StepLoader.new @application
+  end
+
+  it 'reads a Brewby process file' do
+    @loader.load_file File.join(File.dirname(__FILE__), 'support', 'sample_recipe.rb')
+    @application.should have(4).steps
+  end
+end

data/spec/steps/dsl/step_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Brewby::Steps::DSL::Step do
+  before do
+    @outputs = [
+      { name: :hlt, pin: 3 },
+      { name: :mlt, pin: 2 },
+      { name: :bk, pin: 1 }
+    ]
+
+    @inputs = [
+      { name: :bk },
+      { name: :mlt },
+      { name: :hlt }
+    ]
+
+    Brewby::Application.any_instance.stub(:render)
+    Brewby::Application.any_instance.stub(:configure_view)
+    @application = Brewby::Application.new adapter: :test, outputs: @outputs, inputs: @inputs
+    @step = Brewby::Steps::DSL::Step.new 'Test Step', @application
+  end
+
+  it 'accepts a type' do
+    @step.type :temp_control
+    @step.step_class.should == Brewby::Steps::TempControl
+  end
+
+  it 'accepts options on the type' do
+    @step.type :temp_control, mode: :auto, target: 155.0, duration: 60
+    @step.options[:mode].should == :auto
+    @step.options[:target].should == 155.0
+    @step.options[:duration].should == 60
+  end
+
+  it 'accepts a mode' do
+    @step.mode :manual
+    @step.options[:mode].should == :manual
+  end
+
+  it 'accepts a target' do
+    @step.target 155.0
+    @step.options[:target].should == 155.0
+  end
+
+  context 'creation' do
+    before do
+      @step.type :temp_control, mode: :manual, power_level: 1.0
+      @step.input :mlt
+      @step.output :bk
+      @created_step = @step.create!
+    end
+
+    it 'should translate the input correctly' do
+      @created_step.input.name.should == :mlt
+    end
+
+    it 'should translate the output correctly' do
+      @created_step.output.name.should == :bk
+    end
+  end
+end

data/spec/steps/temp_control_spec.rb

@@ -0,0 +1,187 @@
+require 'spec_helper'
+
+describe Brewby::Steps::TempControl do
+  let(:sensor) { Brewby::TempSensor.new 1 }
+  let(:adapter) { Brewby::Outputs::Test.new }
+  let(:element) { Brewby::HeatingElement.new adapter, pulse_width: 5000 }
+  let(:step) { Brewby::Steps::TempControl.new mode: :manual, input: sensor, output: element }
+
+  it 'configures an input sensor' do
+    step.input.should be_instance_of Brewby::TempSensor
+  end
+
+  it 'configures an output sensor' do
+    step.output.should be_instance_of Brewby::HeatingElement
+  end
+
+  context 'automatic temperature control' do
+    before do
+      @step = Brewby::Steps::TempControl.new mode: :auto, target: 155.0, 
+        duration: 15, output: element, input: sensor
+    end
+
+    it 'configures a PID controller' do
+      @step.pid.should be_instance_of Temper::PID
+    end
+
+    it 'sets a target temperature' do
+      @step.target.should == 155.0
+      @step.pid.setpoint.should == 155.0
+    end
+
+    it 'sets a temperature hold duration' do
+      @step.duration.should == 15
+    end
+
+    it 'defaults to a 1 minute temperature hold duration' do
+      step = Brewby::Steps::TempControl.new mode: :auto, target: 155.0
+      step.duration.should == 1
+    end
+
+    it 'returns true for automatic control' do
+      @step.automatic_control?.should be_true
+    end
+
+    it 'returns false for manual control' do
+      @step.manual_control?.should be_false
+    end
+
+    it 'calculates the output level based on PID levels' do
+      @step.calculate_power_level
+      @step.power_level.should == 1.0
+      @step.output.pulse_width.should == 5000
+    end
+
+    it 'does not explode with a faulty input' do
+      @step.stub(:read_input) { nil }
+      @step.calculate_power_level
+      @step.output.pulse_width.should == 0
+    end
+  end
+
+  context 'manual temperature control' do
+    before do
+      @step = Brewby::Steps::TempControl.new mode: :manual, power_level: 0.85, output: element, input: sensor
+    end
+
+    it 'does not create a PID controller' do
+      @step.pid.should be_nil
+    end
+
+    it 'returns true for manual mode' do
+      @step.should be_manual_control
+    end
+
+    it 'returns false for automatic control' do
+      @step.should_not be_automatic_control
+    end
+
+    it 'sets the power level' do
+      @step.power_level.should == 0.85
+      @step.output.pulse_width.should == 4250
+    end
+
+    it 'can have the power level set manually' do
+      @step.set_power_level 0.75
+      @step.power_level.should == 0.75
+      @step.output.pulse_width.should == 3750
+    end
+  end
+
+  context 'sensor input' do
+    before do
+      @step = Brewby::Steps::TempControl.new mode: :auto, target: 155.0,
+        duration: 15, input: sensor, output: element
+    end
+
+    it 'reads sensor input' do
+      @step.input.should_receive(:read) { 115.0 }
+      @step.read_input.should == 115.0
+      @step.last_reading.should == 115.0
+    end
+
+    it 'does not set last_reading if sensor input is faulty' do
+      @step.input.stub(:read) { nil }
+      @step.read_input.should be_nil
+      @step.last_reading.should == 0.0
+    end
+  end
+
+  describe 'step iteration' do
+    context 'with manual control' do
+      before do
+        @step = Brewby::Steps::TempControl.new mode: :manual, power_level: 0.85,
+          input: sensor, output: element
+      end
+
+      it 'pulses the element' do
+        @step.step_iteration
+        @step.output.should be_on
+      end
+
+      it 'takes a sensor reading' do
+        @step.input.stub(:read) { 115.0 }
+        @step.step_iteration
+        @step.last_reading.should == 115.0
+      end
+
+      it 'does not take a sensor reading if input does not exist' do
+        @step = Brewby::Steps::TempControl.new mode: :manual, power_level: 0.85, output: element
+        @step.step_iteration
+        @step.last_reading.should == 0.0
+      end
+    end
+
+    context 'with automatic control' do
+      before do
+        @step = Brewby::Steps::TempControl.new mode: :auto, target: 155.0,
+          duration: 15, input: sensor, output: element
+      end
+
+      it 'pulses the element' do
+        @step.output.should_receive(:pulse)
+        @step.step_iteration
+      end
+
+      it 'calculates the power level and adjusts the heating element' do
+        @step.pid.stub(:control) { 3000 }
+        @step.step_iteration
+        @step.output.pulse_width.should == 3000
+      end
+
+      it 'reads from the sensor and logs to last_reading' do
+        @step.input.stub(:read) { 125.0 }
+        @step.step_iteration
+        @step.last_reading.should == 125.0
+      end
+
+      context 'when temperature threshold is reached' do
+        before do
+          @step.input.stub(:read) { 156.0 }
+          @step.step_iteration
+        end
+
+        it 'sets the threshold as true' do
+          @step.threshold_reached.should be_true
+        end
+
+        it 'maintains threshold_reached even when temp drops below threshold' do
+          @step.input.stub(:read) { 145.0 }
+          @step.step_iteration
+          @step.threshold_reached.should be_true
+        end
+
+        it 'starts the clock on time remaining' do
+          (@step.time_remaining > 0).should be_true
+          (@step.time_remaining <= @step.duration_in_seconds).should be_true
+        end
+
+        it 'stops the step when temperature has hit target for duration' do
+          @step.instance_variable_set(:@step_finishes_at, Time.now.to_i - 10)
+          @step.step_iteration
+          @step.should be_ended
+        end
+      end
+    end
+  end
+end