bcs-interrogator 0.0.2 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0717bda2b32e02b0b2bf97ded0d4fa4a7675cef6
+  data.tar.gz: 5c67f1e6fe53a249928ddff9a45d8220dabccb73
+SHA512:
+  metadata.gz: 67efd5b42bf25e79812df4b5a4b6703ddec253551d2c419a79c1f20a821d1ef88e2cdc2362a3d96b6cd76cd8d07bb771809b12248884edc0ead9d6d09e2935a8
+  data.tar.gz: 232a4d768c0cac99f521b8f3718c7e31aff5e36855e2b7724d3f0a212277d3b658130babf43c0057d7e413d515c7ab60d9041e2fd58cff27fae5298d248a8fb6

data/README.md

@@ -1,11 +1,8 @@
 BCS-Interrogator
 ================
 
-[![Build Status](https://secure.travis-ci.org/NewRepublicBrewing/BCS-Interrogator.png)](http://travis-ci.org/NewRepublicBrewing/BCS-Interrogator)
 [![Dependency Status](https://gemnasium.com/NewRepublicBrewing/BCS-Interrogator.png)](https://gemnasium.com/NewRepublicBrewing/BCS-Interrogator)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/NewRepublicBrewing/BCS-Interrogator)
-[![Buggerall](https://buggerall.herokuapp.com/bug/BCS-Interrogator.png)](https://github.com/brundage/buggerall)
-
+[![Code Climate](https://codeclimate.com/github/NewRepublicBrewing/BCS-Interrogator/badges/gpa.svg)](https://codeclimate.com/github/NewRepublicBrewing/BCS-Interrogator)
 
 Gem to talk to an EEC Brewery Control System
 
@@ -14,5 +11,3 @@ Requirements
 ============
 
 Ruby 1.9
-[NRB HTTP Service gem](https://github.com/NewRepublicBrewing/http-service)
-

data/lib/brewery_control_system.rb

@@ -0,0 +1,106 @@
+module NRB
+  class BreweryControlSystem
+    require 'brewery_control_system/version'
+
+    autoload :API,              'brewery_control_system/api'
+    autoload :HTTPService,      'brewery_control_system/http_service'
+    autoload :Input,            'brewery_control_system/input'
+    autoload :Middleware,       'brewery_control_system/middleware'
+    autoload :TemperatureProbe, 'brewery_control_system/temperature_probe'
+
+    attr_reader :base_url
+
+    def api_version
+      @api_version ||= firmware_version
+    end
+
+
+    def device
+      api.device
+    end
+
+
+    def discrete_inputs
+      # 8
+    end
+
+
+    def firmware_version
+      device.version
+    end
+
+
+    def firmware_build
+      device.build
+    end
+
+
+    def http_service &block
+      http_service_class.default_service url: base_url, &block
+    end
+
+
+    def initialize(api_class: API, base_url: nil, http_service_class: HTTPService, api_version: nil)
+      self.api_class = api_class
+      @base_url = base_url; @base_url.freeze
+      self.http_service_class = http_service_class
+      self.api_version = api_version
+    end
+
+
+    def inputs
+      # 8
+      []
+    end
+    alias_method :discrete_inputs, :inputs
+
+
+    def name
+      device.name
+    end
+
+
+    def outputs
+      # 18
+    end
+
+
+    def processes
+      # 8
+      # 8 states
+      # 4 timers
+      # 4 web inputs
+      []
+    end
+
+
+    def setpoints
+      api.setpoints
+    end
+
+
+    def temp_probes
+      api.temperature_probes
+    end
+    alias_method :temperature_probes, :temp_probes
+
+
+    def type
+      device.type
+    end
+
+  private
+
+    attr_accessor :api_class, :http_service_class
+    attr_reader :base_url
+    attr_writer :api, :api_version
+
+    def api
+      return @api unless @api.nil?
+      api_args = { base_url: base_url, bcs: self }
+      api_args[:api_version] = api_version unless @api_version.nil?
+      @api = api_class.new api_args
+    end
+
+  end
+end

data/lib/brewery_control_system/api.rb

@@ -0,0 +1,94 @@
+class NRB::BreweryControlSystem
+  class API
+
+    autoload :Device,           'brewery_control_system/api/device'
+    autoload :ServerVersion,    'brewery_control_system/api/server_version'
+    autoload :VersionCheck,     'brewery_control_system/api/version_check'
+
+    # Device
+    #   name     string
+    #   type     string
+    #   version  string
+    #   build    string
+    # 3.x
+    #   /bcs_sys.cfg
+    # 4.x
+    #   /device
+    def device
+      @device_response ||= http_service do |b|
+                             b.response DeviceEndpoint
+                           end.get(DeviceEndpoint.endpoint).body
+      Device.new *@device_response
+    end
+
+
+    def http_service
+      service = bcs.http_service do |b|
+                  b.response VersionCheck, api_version
+                end
+      yield service if block_given?
+      service
+    end
+
+
+    # Temperature Probes
+    #   name          string
+    #   temp          integer
+    #   setpoint      integer
+    #   resistance    integer
+    #   enabled       boolean
+    #   coefficients  array
+    def temperature_probes
+      TemperatureProbesEndpoint.fetch api: self
+    end
+
+    # Digital Inputs
+    #   name     string
+    #   on       boolean
+    #   enabled  boolean
+    #   oneshot  boolean
+
+    # Outputs
+    #   name     string
+    #   on       boolean
+    #   enabled  boolean
+
+    # Processes
+    #  name            string
+    #  running         boolean
+    #  paused          boolean
+    #  run_on_startup  boolean
+    #  current_state   state
+    #                    name   string
+    #                    state  integer
+
+    def initialize(api_version: '3.7.0', base_url: nil, bcs: nil)
+      self.base_url = base_url
+      self.bcs = bcs
+      self.api_version = api_version
+
+      require_endpoints
+    end
+
+  private
+
+    attr_accessor :base_url, :bcs, :api_version
+
+    def require_endpoints
+      %w( endpoint
+          device_endpoint
+          setpoints
+          temps
+          temperature_probes_endpoint
+          ultemp
+        ).each do |f|
+        begin
+          require "brewery_control_system/api/#{api_version}/#{f}"
+        rescue LoadError => e
+          warn "API v#{api_version} may not function: #{e}"
+        end
+      end
+    end
+
+  end
+end

data/lib/brewery_control_system/api/3.7.0/bcs_sys.rb

@@ -0,0 +1,158 @@
+class NRB::BreweryControlSystem::API
+  class BCSSys < Endpoint
+    # http://wiki.embeddedcc.com/index.php/Bcs_sys.cfg
+    #   The configuration file contains of all non-process parameters, with
+    #   some exclusions. All entries in the sysname structure cannot be more
+    #   than 16 characters, commas are not allowed.
+
+    class << self
+      def endpoint; 'bcs_sys.cfg'; end
+    end
+
+    DESCRIPTIONS = [
+                    'Firmware version',
+                    'System Name 0',
+                    'System Name 1',
+                    'Output 0 Name',
+                    'Output 1 Name',
+                    'Output 2 Name',
+                    'Output 3 Name',
+                    'Output 4 Name',
+                    'Output 5 Name',
+                    'Output 6 Name',
+                    'Output 7 Name',
+                    'Output 8 Name',
+                    'Output 9 Name',
+                    'Output 10 Name',
+                    'Output 11 Name',
+                    'Output 12 Name',
+                    'Output 13 Name',
+                    'Output 14 Name',
+                    'Output 15 Name',
+                    'Output 16 Name',
+                    'Output 17 Name',
+                    'Discrete Output 1 Name',
+                    'Discrete Output 2 Name',
+                    'Discrete Output 3 Name',
+                    'Discrete Output 4 Name',
+                    'Discrete Output 5 Name',
+                    'Discrete Output 6 Name',
+                    'Discrete Output 7 Name',
+                    'Discrete Output 8 Name',
+                    'Temp Probe 0 Name',
+                    'Temp Probe 1 Name',
+                    'Temp Probe 2 Name',
+                    'Temp Probe 3 Name',
+                    'Temp Probe 4 Name',
+                    'Temp Probe 5 Name',
+                    'Temp Probe 6 Name',
+                    'Temp Probe 7 Name',
+                    'Reserved 0',
+                    'Reserved 1',
+                    'Register 0 Name',
+                    'Register 1 Name',
+                    'Register 2 Name',
+                    'Register 3 Name',
+                    'Register 4 Name',
+                    'Register 5 Name',
+                    'Register 6 Name',
+                    'Register 7 Name',
+                    'Register 8 Name',
+                    'Register 9 Name',
+                    'Register 10 Name',
+                    'Register 11 Name',
+                    'Register 12 Name',
+                    'Register 13 Name',
+                    'Register 14 Name',
+                    'Register 15 Name',
+                    'Process 0 State',
+                    'Process 1 State',
+                    'Process 2 State',
+                    'Process 3 State',
+                    'Output 0,6,12 Value',
+                    'Output 1,7,13 Value',
+                    'Output 2,8,14 Value',
+                    'Output 3,9,15 Value',
+                    'Output 4,10,16 Value',
+                    'Output 5,11,17 Value',
+                    'Discrete Input 0,4 Value',
+                    'Discrete Input 1,5 Value',
+                    'Discrete Input 2,6 Value',
+                    'Discrete Input 3,7 Value',
+                    'Process 0,4 Web Input 0 Value',
+                    'Process 0,4 Web Input 1 Value',
+                    'Process 0,4 Web Input 2 Value',
+                    'Process 0,4 Web Input 3 Value',
+                    'Process 1,5 Web Input 0 Value',
+                    'Process 1,5 Web Input 1 Value',
+                    'Process 1,5 Web Input 2 Value',
+                    'Process 1,5 Web Input 3 Value',
+                    'Process 2,6 Web Input 0 Value',
+                    'Process 2,6 Web Input 1 Value',
+                    'Process 2,6 Web Input 2 Value',
+                    'Process 2,6 Web Input 3 Value',
+                    'Process 3,7 Web Input 0 Value',
+                    'Process 3,7 Web Input 1 Value',
+                    'Process 3,7 Web Input 2 Value',
+                    'Process 3,7 Web Input 3 Value',
+                    'Process 0,4 Run',
+                    'Process 1,5 Run',
+                    'Process 2,6 Run',
+                    'Proces,7 Run',
+                    'Manual Mode Run',
+                    'BCS Version',  # 0=BCS-460, 2=BCS-462
+                    'Reserved 0',
+                    'Reserved 1',
+                    'Discrete Input 0,4 Enable',
+                    'Discrete Input 1,5 Enable',
+                    'Discrete Input 2,6 Enable',
+                    'Discrete Input 3,7 Enable',
+                    'Process 0,4 Web Input 0 Enable',
+                    'Process 0,4 Web Input 1 Enable',
+                    'Process 0,4 Web Input 2 Enable',
+                    'Process 0,4 Web Input 3 Enable',
+                    'Process 1,5 Web Input 0 Enable',
+                    'Process 1,5 Web Input 1 Enable',
+                    'Process 1,5 Web Input 2 Enable',
+                    'Process 1,5 Web Input 3 Enable',
+                    'Process 2,6 Web Input 0 Enable',
+                    'Process 2,6 Web Input 1 Enable',
+                    'Process 2,6 Web Input 2 Enable',
+                    'Process 2,6 Web Input 3 Enable',
+                    'Process 3,7 Web Input 0 Enable',
+                    'Process 3,7 Web Input 1 Enable',
+                    'Process 3,7 Web Input 2 Enable',
+                    'Process 3,7 Web Input 3 Enable',
+                    'Output 0,6,12 Enable',
+                    'Output 1,7,13 Enable',
+                    'Output 2,8,14 Enable',
+                    'Output 3,9,15 Enable',
+                    'Output 4,10,16 Enable',
+                    'Output 5,11,17 Enable',
+                    'Temp 0,4 Enable',
+                    'Temp 1,5 Enable',
+                    'Temp 2,6 Enable',
+                    'Temp 3,7 Enable',
+                   ].freeze
+
+    register_middleware middleware_options(self)
+
+  private
+
+    def body_array
+      super.map { |val| val.strip[/.+/m] }
+    end
+
+
+    def parse
+raise "Stop using this"
+      return if body_text.nil?
+body_array[0..55] + body_array[248..252].map { |i| i.to_f / 10.0 }
+#      body_array.each_with_index.inject({}) do |hash,(body,i)|
+#        hash[descriptions[i]] = body_array[i]
+#        hash
+#      end
+    end
+
+  end
+end

data/lib/brewery_control_system/api/3.7.0/device_endpoint.rb

@@ -0,0 +1,25 @@
+class NRB::BreweryControlSystem::API
+  class DeviceEndpoint < Endpoint
+    # http://wiki.embeddedcc.com/index.php/Bcs_sys.cfg
+
+    class << self
+      def endpoint; 'bcs_sys.cfg'; end
+    end
+
+    register_middleware middleware_options(self)
+
+  private
+
+    def body_array
+      super.map { |val| val.strip[/.+/m] }
+    end
+
+
+    def parse
+      return if body_text.nil?
+      (device, version) = body_array[0].split(/\s+/)
+      [ body_array[1], device, version, nil ]
+    end
+
+  end
+end

data/lib/brewery_control_system/api/3.7.0/endpoint.rb

@@ -0,0 +1,48 @@
+class NRB::BreweryControlSystem::API
+  class Endpoint < Faraday::Response::Middleware
+
+    extend NRB::BreweryControlSystem::Middleware::Registration
+
+    class << self
+
+      def descriptions;
+        self.const_defined?(:DESCRIPTIONS) ? self.const_get(:DESCRIPTIONS) : []
+      end
+
+
+      def middleware_name; self; end
+
+
+      def middleware_options(endpoint)
+        opts = Hash.new
+        opts[middleware_name] = endpoint
+        opts
+      end
+
+    end
+
+
+    def descriptions; self.class.descriptions; end
+
+
+    def on_complete(env)
+      self.body_text = env[:body]
+      env[:body] = parse
+    end
+
+  private
+
+    attr_accessor :body_text
+    attr_reader :body_array
+
+    def body_array
+      return unless body_text
+      @body_array ||= body_text.split(/,/)
+    end
+
+
+    def parse
+    end
+
+  end
+end