brewer 0.0.82 → 0.0.83

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ca0d81bd3b89653e651668a5c4ba4b54cb29822
-  data.tar.gz: bf27d0f266b6b90b5e82c7ef87d294ded57ff53e
+  metadata.gz: 609b03ad9438c34f412625c145e3ea542aa1ba24
+  data.tar.gz: c8c87ac2200e23851190b84c6a6d6cf243c46c53
 SHA512:
-  metadata.gz: 547df75710936d8e6e708ca3d18860cc8a7ab671e77e84d1d208688f9e710c74276a7c45c97be1697fd2c2e566943ac623969a702f8047fb5ea9b28ac4b03ee3
-  data.tar.gz: a74cc250cc8eabc97756cd37c538faaca937a726545ad828545c4e44cc1aa3a97d023a5162643888c8632122564723d8d1e5656c1d4e10e41aa999a3cd49fd5f
+  metadata.gz: 361547ccce8b1cb02ea49364554d5c03101d6c922bd1672dbc63a90fce2e2a48ba2b90a473b3520c74dd61f6228e36ef180810b47d6159f123064441e82c43ea
+  data.tar.gz: 3a60d9739afa32e0a89166b8c693e9fb539f177a69956e1ed7bcff9c519da66ac23037b0e323f113460238c5d2fb7eb92271841c9cc6603f68c68fb939b8a652

data/lib/brewer/adaptibrew.rb

@@ -0,0 +1,45 @@
+require_relative "../brewer"
+
+# This is the 'manager' for the adaptibrew repo. It handles cloning and such.
+class Adaptibrew
+
+  def initialize
+    refresh
+  end
+
+  # This will clone adaptibrew into ~/.brewer/adaptibrew/
+  def clone
+    raise "🛑  Cannot clone, no network connection" unless network?
+    if !Dir.exists?(adaptibrew_dir)
+      Git.clone('https://github.com/llamicron/adaptibrew.git', 'adaptibrew', :path => brewer_dir)
+    end
+    self
+  end
+
+  # Danger zone...
+  def clear
+    # :nocov: since this requires network to be off
+    if !network?
+      print "Warning: you have no network connection. If you clear, you will not be able to clone again, and you'll be stuck without the adaptibrew source. Are you sure? "
+      confirm ? nil : abort
+    end
+    # :nocov:
+    FileUtils.rm_rf(adaptibrew_dir)
+    self
+  end
+
+   # This is a good catch-all method
+   # If it's not there, it will clone.
+   # If it is, it will delete and re-clone
+  def refresh
+    raise "🛑  Cannot refresh, no network connection" unless network?
+    clear
+    clone
+    self
+  end
+
+  def present?
+    return Dir.exists?(adaptibrew_dir) ? true : false
+  end
+
+end

data/lib/brewer/brewer.rb

@@ -0,0 +1,141 @@
+require_relative "../brewer"
+
+class Brewer
+
+  attr_reader :base_path
+  attr_accessor :temps
+
+  def initialize
+    @base_path = Dir.home + '/.brewer'
+    Settings.new
+    @temps = {}
+  end
+
+  public
+
+  # Brewer methods ------------------------------------------------------
+  # general utilities for the brewer class
+
+  def wait(time=30)
+    sleep(time.to_f)
+    true
+  end
+
+  # Runs an adaptibrew script
+  # Output will be stored in @out
+  # you may see `echo` quite a bit. This will almost always be directly after calling a script
+  # It will be set to the output of the last script. I can't just return the output because i need to return self
+  def script(script, params=nil)
+    `python #{@base_path}/adaptibrew/#{script}.py #{params}`.chomp
+  end
+
+  # Adaptibrew methods ----------------------------------------------
+  # for working with the rig
+
+  def pump(state="status")
+    if state == "status"
+      return relay_status($settings['pumpRelay'])
+    end
+
+    if state == 1
+      return script("set_pump_on")
+    else
+      if pid['pid_running'].to_b
+        pid(0)
+      end
+      return script("set_pump_off")
+    end
+  end
+
+  # Turns PID on or off, or gets state if no arg is provided
+  def pid(state="status")
+    if state == "status"
+      return {
+        'pid_running' => script("is_pid_running"),
+        'sv_temp' => sv,
+        'pv_temp' => pv
+      }
+    end
+
+    if state == 1
+      script('set_pid_on')
+      pump(1)
+      return "Pump and PID are now on"
+    else
+      return script("set_pid_off")
+    end
+  end
+
+  def sv(temp=nil)
+    if temp
+      return script('set_sv', temp).to_f
+    end
+    script('get_sv').to_f
+  end
+
+  def pv
+    script('get_pv').to_f
+  end
+
+  def relay(relay, state)
+    # If you try to turn the relay to a state that it is already in, this skips the wait
+    if relay_status(relay).to_b == state.to_b
+      return true
+    end
+    script("set_relay", "#{relay} #{state}")
+    wait(10)
+    true
+  end
+
+  def all_relays_status
+    output = script("get_relay_status_test")
+    puts output.split('\n')
+    true
+  end
+
+  def relay_status(relay)
+    if script("get_relay_status", "#{relay}").include? "on"
+      return "on"
+    else
+      return "off"
+    end
+  end
+
+  # :nocov:
+  def watch
+    until pv >= sv do
+      wait(2)
+    end
+    self
+  end
+  # :nocov:
+
+  def rims_to(location)
+    if location == "mash"
+      # we ended up swapping this relay, so the name is backwards
+      relay($settings['rimsToMashRelay'], 0)
+    elsif location == "boil"
+      relay($settings['rimsToMashRelay'], 1)
+    end
+    self
+  end
+
+  def hlt_to(location)
+    if location == "mash"
+      relay($settings['spargeToMashRelay'], 0)
+    elsif location == "boil"
+      relay($settings['spargeToMashRelay'], 1)
+    end
+    self
+  end
+
+  def hlt(state)
+    if state.to_b
+      relay($settings['spargeRelay'], 1)
+    elsif !state.to_b
+      relay($settings['spargeRelay'], 0)
+    end
+    self
+  end
+
+end

data/lib/brewer/communicator.rb

@@ -0,0 +1,67 @@
+require_relative "../brewer"
+
+class Communicator
+
+  attr_accessor :slack, :brewer
+
+  def initialize
+    @settings = Settings.new
+    @brewer = Brewer.new
+    @slack = configure_slack
+  end
+
+  def configure_slack
+    unless @settings.settings['webhook_url']
+      print "Slack Webhook URL: "
+      webhook_url = gets.chomp
+      @settings.add({
+        'webhook_url' => webhook_url
+      })
+    end
+    return Slack::Notifier.new @settings.settings['webhook_url']
+  end
+
+  def ping(message="ping at #{Time.now}")
+    if message.is_a? Array
+      final = message.join("\n")
+      @slack.ping(final)
+    end
+    @slack.ping(message)
+  end
+
+  # TODO: test these methods
+  def slack_monitor(delay=10)
+    while true do
+      before_temp = @brewer.pv
+      @brewer.wait(to_seconds(delay))
+      diff = @brewer.pv - before_temp
+
+      ping([
+        "Current Temperature: #{@brewer.pid['pv_temp']} F",
+        "Set Value Temperature: #{@brewer.pid['sv_temp']} F",
+        "Current temperature has climed #{diff} F since #{delay} minute(s) ago",
+        "Sent at #{Time.now.strftime("%H:%M")}",
+        ""
+      ])
+    end
+    true
+  end
+
+  def monitor
+    while true do
+      status_table_rows = [
+        ["Current Temp", @brewer.pv],
+        ["Set Value Temp", @brewer.sv],
+        ["PID is: ", @brewer.pid['pid_running'].to_b ? "on" : "off"],
+        ["Pump is: ", @brewer.pump]
+      ]
+
+      status_table = Terminal::Table.new :headings ["Item", "Status"], :rows => status_table_rows
+
+      clear_screen
+      puts status_table
+      sleep(1)
+    end
+  end
+
+end

data/lib/brewer/helpers.rb

@@ -0,0 +1,42 @@
+require_relative "../brewer"
+
+module Helpers
+
+  # Formatted as: 03/07/2017 14:26
+  def time
+    Time.now.strftime("%m/%d/%Y %H:%M")
+  end
+
+  def network?
+    connection = Net::Ping::TCP.new('google.com', 80, 5)
+    connection.ping?
+  end
+
+  def confirm(input=gets.chomp)
+    if input.to_b
+      return true
+    end
+    false
+  end
+
+  def to_minutes(seconds)
+    seconds.to_f / 60
+  end
+
+  def to_seconds(minutes)
+    minutes.to_f * 60
+  end
+
+  def clear_screen
+    Gem.win_platform? ? (system "cls") : (system "clear")
+  end
+
+  def brewer_dir(path="")
+    return Dir.home + "/.brewer/#{path}"
+  end
+
+  def adaptibrew_dir(path="")
+    return brewer_dir + "adaptibrew/#{path}"
+  end
+
+end

data/lib/brewer/procedures.rb

@@ -0,0 +1,202 @@
+require_relative "../brewer"
+
+class Procedures
+
+  attr_accessor :com, :brewer, :recipe
+
+  def initialize
+    @brewer = Brewer.new
+    @com = Communicator.new
+    @recipe = Recipe.new(@brewer)
+  end
+
+  def master
+    @recipe.get_recipe_vars
+    boot
+    heat_strike_water
+    dough_in
+    mash
+    mashout
+    sparge
+    top_off
+    boil
+  end
+
+  def boot
+    puts Rainbow("booting...").yellow
+    @brewer.pid(0)
+    @brewer.pump(0)
+    @brewer.rims_to('mash')
+    @brewer.hlt_to('mash')
+    @brewer.all_relays_status
+    puts @brewer.pid
+
+    puts Rainbow("Boot finished!").green
+    @com.ping("🍺 boot finished 🍺")
+    true
+  end
+
+  # :nocov:
+  def heat_strike_water
+    puts "heat-strike-water procedure started"
+
+    # Confirm strike water is in the mash tun
+    print Rainbow("Is the strike water in the mash tun? ").yellow
+    # -> response
+    confirm ? nil : abort
+
+    # confirm return manifold is in the mash tun
+    print Rainbow("Is the return manifold in the mash tun? ").yellow
+    # -> response
+    confirm ? nil : abort
+
+    print Rainbow("Is the mash tun valve open? ").yellow
+    confirm ? nil : abort
+
+    # confirm RIMS relay is on
+    @brewer.rims_to('mash')
+    puts "RIMS-to-mash relay is now on"
+
+    # turn on pump
+    @brewer.pump(1)
+    puts "Pump is now on"
+
+    puts Rainbow("Is the pump running properly? ").yellow
+    # TODO: Test this
+    until confirm
+      puts "restarting pump"
+      @brewer.pump(0)
+      @brewer.wait(2)
+      @brewer.pump(1)
+    end
+
+    # confirm that strike water is circulating well
+    print Rainbow("Is the strike water circulating well? ").yellow
+    # -> response
+    confirm ? nil : abort
+
+
+    # calculate strike temp & set PID to strike temp
+    # this sets PID SV to calculated strike temp automagically
+    @brewer.sv(@recipe.strike_water_temp)
+    puts "SV has been set to calculated strike water temp"
+    # turn on RIMS heater
+    @brewer.pid(1)
+
+    # measure current strike water temp and save
+    @recipe.starting_strike_temp = @brewer.pv
+    puts "current strike water temp is #{@brewer.pv}. Saved."
+    puts "Heating to #{@brewer.sv}"
+
+    @com.ping("Strike water beginning to heat. This may take a few minutes.")
+
+    # when strike temp is reached, @com.ping slack
+    @brewer.watch
+    @com.ping("Strike water heated to #{@brewer.pv}. Maintaining temperature.")
+    puts Rainbow("Strike water heated. Maintaining temp.").green
+    true
+  end
+  # :nocov:
+
+  def dough_in
+    # turn pump off
+    @brewer.pump(0)
+    # turn PID off
+    @brewer.pid(0)
+    @brewer.wait(3)
+    @com.ping("Ready to dough in")
+    puts Rainbow("Ready to dough in").green
+
+    # pour in grain
+
+    print Rainbow("Confirm when you're done with dough-in (y): ").yellow
+    confirm ? nil : abort
+    true
+  end
+
+  def mash
+    @brewer.sv(@recipe.mash_temp)
+
+    puts Rainbow("mash stated. This will take a while.").green
+    @com.ping("Mash started. This will take a while.")
+
+    @brewer.rims_to('mash')
+
+    @brewer.pump(1)
+    @brewer.pid(1)
+
+    @brewer.watch
+    @com.ping("Mash temp (#{@brewer.pv} F) reached. Starting timer for #{@recipe.mash_time} minutes.")
+    @brewer.wait(@recipe.mash_time)
+    @com.ping("🍺 Mash complete 🍺. Check for starch conversion.")
+    puts Rainbow("Mash complete").green
+    puts "Check for starch conversion"
+  end
+
+  def mashout
+    @com.ping("Start heating sparge water")
+
+    @brewer.sv(@recipe.mashout_temp)
+
+    @brewer.pump(1)
+    @brewer.pid(1)
+
+    @com.ping("Heating to #{@brewer.sv}... this could take a few minutes.")
+    @brewer.watch
+    @com.ping("Mashout temperature (#{@brewer.pv}) reached. Mashout complete.")
+  end
+
+  def sparge
+    print Rainbow("Is the sparge water heated to the correct temperature? ").yellow
+    confirm ? nil : abort
+
+    @brewer.hlt_to('mash')
+    @brewer.hlt(1)
+
+    print "Waiting for 10 seconds. "
+    puts Rainbow("Regulate sparge balance.").yellow
+    puts "(ctrl-c to abort proccess)"
+    @brewer.wait(30)
+
+    @brewer.rims_to('boil')
+    @brewer.pump(1)
+
+    @com.ping("Please check the sparge balance and ignite boil tun burner")
+
+    puts Rainbow("Waiting until intervention to turn off pump (y): ").yellow
+    confirm ? nil : abort
+
+    @brewer.pid(0)
+    @brewer.pump(0)
+
+    @brewer.hlt(0)
+  end
+
+  def top_off
+    @brewer.hlt_to('boil')
+
+    @brewer.hlt(1)
+
+    print Rainbow("waiting for intervention to turn off hlt (y): ").yellow
+    confirm ? nil : abort
+
+    @brewer.hlt(0)
+
+    @com.ping('Topping off complete')
+    puts Rainbow("Topping off complete").green
+  end
+
+  def boil
+    @com.ping("starting boil procedure")
+    @brewer.wait(to_seconds(5))
+    @com.ping("Add boil hops")
+    @brewer.wait(to_seconds(40))
+    @com.ping("Add flovering hops")
+    @brewer.wait(to_seconds(13))
+    @com.ping("Add finishing hops")
+    @brewer.wait(30)
+    @com.ping("Done.")
+    puts Rainbow("Done.").green
+  end
+
+end

data/lib/brewer/recipe.rb

@@ -0,0 +1,56 @@
+require_relative "../brewer"
+
+class Recipe
+
+  attr_accessor :mash_temp, :mash_time, :mashout_temp, :water, :grain, :grain_temp, :desired_mash_temp, :strike_water_temp, :starting_strike_temp
+
+  def initialize(brewer)
+    @brewer = brewer
+  end
+
+  def get_recipe_vars(vars=false)
+    if vars
+      raise "Vars must be a hash" unless vars.is_a? Hash
+      vars.each do |recipe_key, value|
+        instance_variable_set("@" + recipe_key, value)
+      end
+    end
+
+    puts "Variables for heating strike water"
+    get_strike_temp
+
+    puts "Variables for mash ---"
+    print "Enter mash temperature: "
+    @mash_temp = gets.chomp.to_f
+    print "Enter mash time in minutes: "
+    @mash_time = to_seconds(gets.chomp.to_f)
+
+    puts "Variables for mashout ---"
+    print "Enter mashout temp: "
+    @mashout_temp = gets.chomp.to_f
+  end
+
+  def get_strike_temp
+    print "Input amount of water in quarts: "
+    @water = gets.chomp.to_f
+
+    print "Input amount of grain in lbs: "
+    @grain = gets.chomp.to_f
+
+    print "Input current grain temp (#{@brewer.pv.to_s} F): "
+    @grain_temp = gets.chomp.to_f
+    if @grain_temp == ""
+      @grain_temp = @brewer.pv
+    end
+
+    print "Input desired mash temp (150 F): "
+    @desired_mash_temp = gets.chomp
+    if @desired_mash_temp == ""
+      @desired_mash_temp = 150
+    end
+    @desired_mash_temp
+
+    @strike_water_temp = script('get_strike_temp', "#{@water} #{@grain} #{@grain_temp} #{@desired_mash_temp}").to_f
+  end
+
+end

data/lib/brewer/settings.rb

@@ -0,0 +1,137 @@
+require_relative "../brewer"
+
+class Settings
+
+  attr_accessor :settings
+  attr_reader :cache_file, :source
+
+  def initialize(testing=false)
+
+    @source = adaptibrew_dir('settings.py')
+    @cache_file = brewer_dir('settings.yml')
+
+    @settings = Hash.new
+
+    if !testing
+      Adaptibrew.new.clone
+
+      unless cache?
+        parse_and_cache
+      else
+        load_cached_settings
+      end
+
+      load_global
+    end
+  end
+
+  # This will create the cache and populate
+  # it with settings from settings.py
+  def parse_and_cache
+    parse
+    cache
+  end
+
+  # Loads cached settings
+  # If no cached settings, it returns false
+  def load_cached_settings
+    if cache?
+      @settings = YAML.load(File.open(@cache_file))
+      return true
+    end
+    false
+  end
+
+  # Checks if there are settings in the cache
+  def cache?
+    if File.exists?(@cache_file) and File.readlines(@cache_file).grep(/DEBUG/).size > 0
+      return true
+    end
+    false
+  end
+
+  # Parse the settings from the source file into @settings
+  def parse
+    File.open(@source, 'r') do |file|
+      file.each_line do |line|
+        if line.include? "=" and line[0] != "#"
+          key, value = line.match(/(.+)=(.+)/).captures
+          @settings[key.strip.chomp] = value.strip.chomp
+        end
+      end
+      type_cast
+      return true
+    end
+    false
+  end
+
+  # Creates the cache if there isn't one already
+  def create_cache
+    unless File.exists?(@cache_file)
+      File.open(@cache_file, 'w')
+    end
+    true
+  end
+
+  # This will add a new element to the @settings hash
+  # AND re-cache the settings
+  def add(setting)
+    raise "Setting needs to be a hash" unless setting.is_a? Hash
+    setting.each do |key, value|
+      @settings[key] = value
+    end
+    cache
+  end
+
+  # Stores the currents @settings in settings.yml
+  def cache
+    create_cache
+    store = YAML::Store.new @cache_file
+    store.transaction {
+      @settings.each do |k, v|
+        store[k] = v
+      end
+    }
+    true
+  end
+
+  # This deletes the cache file
+  def clear_cache
+    if File.exists?(@cache_file)
+      FileUtils.rm_f @cache_file
+    end
+    true
+  end
+
+  # This is so that the settings are easier to use in my code
+  # and for backwards compatability purposes
+  def load_global
+    parse_and_cache
+    $settings = @settings
+  end
+
+  def change(values)
+    raise "Values to change must be a hash" unless values.is_a? Hash
+    values.each do |k, v|
+      @settings[k] = v
+    end
+    return true
+  end
+
+  # This method is r/badcode, i know
+  def type_cast
+    # Super janky
+    change({
+      'rimsaddressint' => @settings['rimsaddressint'].to_i,
+      'switchaddressint' => @settings['switchaddressint'].to_i,
+      'baudrate' => @settings['baudrate'].to_i,
+      'timeout' => @settings['timeout'].to_i,
+      'spargeToMashRelay' => @settings['spargeToMashRelay'].to_i,
+      'spargeRelay' => @settings['spargeRelay'].to_i,
+      'rimsToMashRelay' => @settings['rimsToMashRelay'].to_i,
+      'pumpRelay' => @settings['pumpRelay'].to_i,
+      'DEBUG' => @settings['DEBUG'].to_b,
+    })
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brewer
 version: !ruby/object:Gem::Version
-  version: 0.0.82
+  version: 0.0.83
 platform: ruby
 authors:
 - Luke Sweeney
@@ -249,6 +249,13 @@ files:
 - Rakefile
 - bin/brewer
 - lib/brewer.rb
+- lib/brewer/adaptibrew.rb
+- lib/brewer/brewer.rb
+- lib/brewer/communicator.rb
+- lib/brewer/helpers.rb
+- lib/brewer/procedures.rb
+- lib/brewer/recipe.rb
+- lib/brewer/settings.rb
 - spec/adaptibrew_spec.rb
 - spec/brewer_spec.rb
 - spec/hardware_spec.rb