machine_setup 0.0.1

data/examples/underleaver/underleaver.setup.param.en.yml

@@ -0,0 +1,218 @@
+en:
+
+  #Tabs aka categories
+  common:
+    name: "Common"
+
+  drives:
+    name: "Drives Underleaver"
+
+  #parameter
+  underleaver_config:
+    name:  "Underleaver virtual=1 / real=0"
+    comment:  "Unit�s Place:\n
+              x0: Controller with real drives and covers\n
+              x1: Controller simulates all selected drives and covers\n
+              \n
+              Ten�s Place:\n
+              0x: CanBus on\n
+              1x: CanBus off\n
+              \n
+              Hundred�s Place:\n
+              1xx: The controller simulates all drives."
+
+  distance_photo_sensor:
+    name:  "Distance of photo sensor"
+    comment:  "Configuration of photo sensor.\n
+              \n
+                X: Describes the distance [mm] from photo sensor to the paper exit."
+
+  distance_blade_to_sheet_drive:
+    name:  "Distance of blade"
+    comment:  "Configuration of Blade\n
+               \n
+              X: Describes the distance [mm] from blade to the paper feed drive."
+
+  distance_sheet_drive_to_sheet_exit:
+    name:  "Distance of sheet drive"
+    comment:  "Configuration of foil drive\n
+              \n
+              X: Describes the distance [mm] from the paper feed drive to paper exit."
+
+  time_for_cutting_unit:
+    name:  "Time of cutting unit"
+    comment:  "Configuration of cutting unit.\n
+              \n
+               X: Describes the time [ms] to lift up the cutting unit."
+
+  paper_jam_detection_active:
+    name:  "Paper jam monitoring"
+    comment:  "Configuration of paper jam sensor\n
+              \n
+              0: Deselect the paper jam monitoring.\n
+              1: Select the paper jam monitoring."
+
+  paper_jam_detection_signal_length:
+    name:  "Paper jam signal duration"
+    comment:  "Configuration of paper jam sensor\n
+              \n
+              X: Describes the signal duration [ms] that defines a paper jam.\n
+              0: The signal duration will be defined by an internal value.\n
+              \n
+              Value is given in milliseconds."
+
+  paper_jam_detection_check_time:
+    name:  "Paper jam check time after 'last' product"
+    comment:  "Configuration of paper jam sensor\n
+              \n
+              Paper jam checks for the current product are executed at the beginning of the next product.\n
+              But when there is no product following the current product this parameter allows you to define a timer.\n
+              Started after finishing the current product after the expiration of this time the paper jam checks are executed.\n
+              A value of 3000 means that 3 seconds after the last product a paper jam check is executed.\n
+              \n
+              The value is given in milliseconds."
+
+  ext_enabling_following_unit:
+    name:  "External behavior to downstream unit"
+    comment:  "Configuration of external behavior (downstream)\n
+              \n
+              Select/Deselect the enable signal from the downstream unit.\n
+              \n
+              0: The underleaver works standalone or has no downstream unit.\n
+              1: The underleaver has a downstream unit and react to enable signal."
+
+  ext_enabling_following_unit_method:
+    name:  "Configuration of enable signal"
+    comment:  "Configuration of external behavior (downstream)\n
+              \n
+              0: Impulse - Switch the enabling signal at any impulse (on->off oder off->on)\n
+              1: Negative continuously signal - enables by 0V\n
+              2: Positiv continuously signal - enables by 12V"
+
+  ext_enabling_following_unit_delay:
+    name:  "Configuration of enable delay"
+    comment:  "Configuration of external behavior (downstream)\n
+              \n
+              X: Describes the time [ms] to wait for reacting to the enabling signal. Not till then the underleaver continuous conveyance."
+
+  ext_enabling_previous_unit:
+    name:  "External behavior to upstream unit"
+    comment:  "Configuration of external behavior (upstream)\n
+              \n
+              0: Impulse - Switch the enabling signal at any impulse (on->off oder off->on)\n
+              1: Negative continuously signal - enables by 0V\n
+              2: Positiv continuously signal - enables by 12V"
+
+  paper_roll_drive_config:
+    name:  "Paper roll drive - Select/Deselect"
+    comment: &COMMON_DRIVE_CONFIG "Unit�s Place: 'Select/Deselect drive'\n
+              \n
+              XXX0: Drive doesn't exist.\n
+              XXX1: Drive exists as a servo.\n
+              XXX2: Drive exists as a frequency converter.\n
+              \n
+              Ten�s and Hundred�s Place: 'Typ of Drive'\n
+              \n
+              X00X = NORD_MOTOR_037\n
+              X01X = NORD_MOTOR_075\n
+              X02X = LENZE_063C32\n
+              X03X = LENZE_047C22\n
+              X04X = LENZE_063C22\n
+              X05X = INTERROLL_TM111_037_2_081\n
+              X06X = INTERROLL_TM082_012_2_056\n
+              X07X = LENZE_063C22_GEBER\n
+              X08X = LENZE_063C22_POSI\n
+              X17X = INTERROLL_111_2P_037_133V\n
+              X18X = INTERROLL_111_2P_037_133V_GEBER\n
+              X19X = INTERROLL_111_2P_037_133V_POSI\n
+              X20X = INTERROLL_111_2P_037_133V_GEBER_AUF_C400\n
+              X21X = HARMONIC_DRIVE_FHA_11C_D200_GEBER\n
+              \n
+              Thousend�s Place:\n
+              \n
+              0XXX = without PTC\n
+              1XXX = with PTC"
+
+  paper_roll_drive_distance_revolution:
+    name:  "Paper roll drive - Distance per revolution [mm]"
+    comment: &COMMON_DISTANCE_REVOLUTION "X= Distance X per revolution [in mm]"
+
+  paper_roll_drive_gear_in:
+    name:  "Paper roll drive - Gear IN"
+    comment: &COMMON_GEAR_IN "Number of teeth motor sided."
+
+  paper_roll_drive_gear_out:
+    name:  "Paper roll drive - Gear OUT"
+    comment: &COMMON_GEAR_OUT "Number of teeth - drive shaft sided."
+
+  blade_drive_config:
+    name:  "Blade drive - Select/Deselect"
+    comment: *COMMON_DRIVE_CONFIG
+
+  blade_drive_diameter:
+    name:  "Blade drive - Diameter [mm]"
+    comment:  "X= Diameter X of blade drive [in mm]"
+
+  blade_drive_gear_in:
+    name:  "Blade drive - Gear IN"
+    comment:  *COMMON_GEAR_IN
+
+  blade_drive_gear_out:
+    name:  "Blade drive - Gear OUT"
+    comment:  *COMMON_GEAR_OUT
+
+  paper_feed_drive_config:
+    name:  "Paper feed drive - Select/Deselect"
+    comment:  *COMMON_DRIVE_CONFIG
+
+  paper_feed_drive_distance_revolution:
+    name:  "Paper feed drive - Distance per revolution [mm]"
+    comment:  *COMMON_DISTANCE_REVOLUTION
+
+  paper_feed_drive_gear_in:
+    name:  "Paper feed drive - Gear IN"
+    comment:  *COMMON_GEAR_IN
+
+  paper_feed_drive_gear_out:
+    name:  "Paper feed drive - Gear OUT"
+    comment:  *COMMON_GEAR_OUT
+
+  transport_drive_config:
+    name:  "Transport drive - Select/Deselect"
+    comment:  *COMMON_DRIVE_CONFIG
+
+  transport_drive_distance_revolution:
+    name:  "Transport drive - Distance per revolution [mm]"
+    comment:  *COMMON_DISTANCE_REVOLUTION
+
+  transport_drive_gear_in:
+    name:  "Transport drive - Gear IN"
+    comment:  *COMMON_GEAR_IN
+
+  transport_drive_gear_out:
+    name:  "Transport drive - Gear OUT"
+    comment:  *COMMON_GEAR_OUT
+
+  transport_drive_belt_length:
+    name:  "Transport drive - Length of belt [mm]"
+    comment:  "Specify the length of the transport conveyor [in mm]"
+
+  infeed_drive_config:
+    name:  "Infeed drive - Select/Deselect"
+    comment:  *COMMON_DRIVE_CONFIG
+
+  infeed_drive_distance_revolution:
+    name:  "Infeed drive - Distance per revolution [mm]"
+    comment:  *COMMON_DISTANCE_REVOLUTION
+
+  infeed_drive_gear_in:
+    name:  "Infeed drive - Gear IN"
+    comment:  *COMMON_GEAR_IN
+
+  infeed_drive_gear_out:
+    name:  "Infeed drive - Gear OUT"
+    comment:  *COMMON_GEAR_OUT
+
+  infeed_drive_belt_length:
+    name:  "Infeed drive - Length of belt [mm]"
+    comment:  "Specify the length of the Infeed conveyor [in mm]"

data/lib/setup_configuration.rb

@@ -0,0 +1,20 @@
+module SetupConfiguration
+end
+
+def SetupConfiguration(name, &block)
+  suite=SetupConfiguration::Suite.instance
+  suite.name=name
+  suite.instance_eval(&block)
+  suite.validate_params()
+rescue
+  raise
+end
+
+require 'pp'
+require 'singleton'
+require 'erb'
+require 'fileutils'
+require 'i18n'
+require File.expand_path(File.dirname(__FILE__) + '/setup_configuration/setup_config')
+require File.expand_path(File.dirname(__FILE__) + '/setup_configuration/suite_generator')
+require File.expand_path(File.dirname(__FILE__) + '/setup_configuration/translation')

data/lib/setup_configuration/setup_config.rb

@@ -0,0 +1,183 @@
+module SetupConfiguration
+
+  def self.description_ranges()
+    [(0..199), (200..599), (600..1299)]
+  end
+
+  def self.parameter_range()
+    Range.new(description_ranges().first().first(), description_ranges().last().last())
+  end
+
+end
+
+class SetupConfiguration::Suite
+  include Singleton
+
+  attr_accessor :categories
+  attr_accessor :settings
+  attr_accessor :name
+
+  def initialize
+    self.categories= Hash.new { |hash, key| hash[key] = [] }
+    self.settings= SetupConfiguration::Setting.new()
+  end
+
+  def category(category, &category_params)
+    if category_params then
+#      puts "executes category in Suite: #{category}"
+
+      #this code calls instance_eval and delivers the context object
+      parameter_factory = SetupConfiguration::ParameterFactory.new()
+      parameter_factory.instance_eval(&category_params)
+      categories[category] << parameter_factory.params()
+
+      # this .instance_eval call returns the last value of the last executed code (an array from method param in Parameters)
+      #categories[category] << SetupConfiguration::Parameters.new().instance_eval(&category_params)
+
+      # flatten is needed: Parameters#param returns an array which is inserted in an array...
+      categories[category].flatten!
+    else
+      puts "WARNING: Empty category '#{category}' will be ignored. "
+    end
+  end
+
+  def setting(&setting_params)
+    settings.instance_eval(&setting_params) if setting_params
+  end
+
+  # Gets all known parameters.
+  def parameters()
+    categories.values.flatten
+  end
+
+  #
+  # Finds a Parameter with the given key.
+  # If there is no such parameter the method returns nil.
+  #
+  def find_param(key)
+    find_param_by_key(key)
+  end
+
+  #
+  # Finds a Parameter with the given key.
+  # If there is no such parameter the method returns nil.
+  #
+  def find_param_by_key(key)
+    self.parameters().select(){|p| p.key.eql?(key)}.first
+  end
+
+  #
+  # Finds a Parameter with the given number.
+  # If there is no such parameter the method returns nil.
+  #
+  def find_param_by_number(number)
+    self.parameters().select(){|p| p.number.eql?(number)}.first
+  end
+
+  #
+  # Validates the uniqueness of parameter keys and numbers.
+  #
+  def validate_params()
+
+    keys=[]
+    numbers=[]
+    #valid parameter numbers start at 1
+    valid_param_numbers=Range.new(SetupConfiguration.parameter_range().first()+1, SetupConfiguration.parameter_range().last)
+
+    self.parameters().each() do |p|
+
+      throw RuntimeError.new("ERROR: parameter number '#{p.number}' not supported. Number must be in range #{valid_param_numbers}") unless valid_param_numbers.member?(p.number)
+
+      if keys.include? p.key
+        # todo error handling
+        throw RuntimeError.new("ERROR: parameter key '#{p.key}' defined more than once")
+      else
+        keys << p.key
+      end
+
+      if numbers.include? p.number
+        # todo error handling
+        throw RuntimeError.new("ERROR: parameter number '#{p.number}' defined more than once")
+      else
+        numbers << p.number
+      end
+    end
+  end
+
+end
+
+
+class SetupConfiguration::Setting
+
+  attr_reader :minimum
+  attr_reader :maximum
+  attr_reader :balance_minimum
+  attr_reader :balance_maximum
+
+  def initialize
+    @minimum=(0..0)
+    @maximum=(0..0)
+    @balance_minimum=(0..0)
+    @balance_maximum=(0..0)
+  end
+
+  def min(range)
+    @minimum=range
+  end
+
+  def max(range)
+    @maximum=range
+  end
+
+  def balance_min(range)
+    @balance_minimum=range
+  end
+
+  def balance_max(range)
+    @balance_maximum=range
+  end
+end
+
+class SetupConfiguration::ParameterFactory
+
+  attr_accessor :params
+
+  def initialize
+    self.params= []
+  end
+
+  def param(parameter, number, &parameter_def)
+#    puts "executed param in Parameters: #{parameter}"
+    # evaluate given block in Parameter context and return new parameter
+    p = SetupConfiguration::Parameter.new(parameter)
+    p.number=(number)
+    p.instance_eval(&parameter_def) if parameter_def
+    params << p
+  end
+
+end
+
+class SetupConfiguration::Parameter
+
+  attr_accessor :key
+  attr_accessor :number
+  attr_reader :dependency
+  attr_reader :machine_type
+
+  def initialize(name)
+    # depends upon no other parameter
+    @dependency=:none
+    # valid on all machines
+    @machine_type=0
+    @key= name
+  end
+
+  def depends_on(dependency)
+    @dependency=dependency
+  end
+
+  def for_machine_type(machine_type)
+    @machine_type=machine_type
+  end
+
+end

data/lib/setup_configuration/suite_generator.rb

@@ -0,0 +1,252 @@
+module SetupConfiguration::Generator
+  @output_path=""
+
+  def output_path
+    @output_path
+  end
+
+  def output_path=(out)
+    @output_path=out
+  end
+
+  class TemplateBinding
+
+    attr_accessor :suite
+    attr_accessor :output
+
+    def categories
+      suite.categories.keys()
+    end
+
+    # Support templating of member data.
+    def get_binding
+      binding
+    end
+
+  end
+
+  class ParameterTemplateBinding < TemplateBinding
+    attr_accessor :lang
+    attr_accessor :parameter_range
+
+    def initialize(lang, range, output)
+      @lang=lang
+      @parameter_range=range
+      @output=output
+    end
+
+    def lang_name
+      SetupConfiguration::Translation.language_name(lang)
+    end
+
+    def cat_name(key)
+      name, desc=SetupConfiguration::Translation::Translator.new().translate(key, @lang)
+      name
+    end
+
+    def name(number)
+      p_name= translate(number) { |name, desc| name }
+      p_name.empty? ? "placeholder for mps3.exe" : p_name
+    end
+
+    def description(number)
+      translate(number) do |name, desc|
+        escape(desc)
+      end
+    end
+
+    def translate(number, &extractor)
+      #todo use suite as singleton!
+      p=self.suite.find_param_by_number(number)
+      if p
+        key=p.key
+        translation = SetupConfiguration::Translation::Translator.new().translate(key, @lang)
+        if extractor
+          extractor.call( translation)
+        else
+          translation
+        end
+      else
+        ""
+      end
+    end
+
+    private
+
+    #
+    # Zeilenumbr�che werden mit '��' dargestellt
+    #
+    def escape(message)
+      message.gsub(/\n\s?/, '��')
+    end
+
+  end
+
+  class MPSTemplateBinding < TemplateBinding
+
+
+    def languages
+      SetupConfiguration::Translation.language_names.values
+    end
+
+    def settings
+      self.suite.settings
+    end
+
+    def param_infos(category_key)
+      parameters=suite.categories[category_key]
+      depends, machine_type, number=[], [], []
+      parameters.each() do |param|
+        machine_type << param.machine_type
+        number << param.number
+        depends << depends_on(param.dependency)
+      end
+      [prepare(depends), prepare(machine_type), prepare(number) ]
+    end
+
+    :private
+
+    def prepare(array)
+      array.join(',')
+    end
+
+    def depends_on(key)
+
+      if :none.eql?(key) then
+        -1
+      else
+        param=suite.find_param(key)
+        if param
+          param.number
+        else
+          puts "ERROR: parameter with key '#{key}' not found."
+          # depends on no other parameter
+          -1
+        end
+      end
+    end
+
+  end
+
+#           [:de, "deutsch", (0..199), "deutsch1.lng"],
+#          [:de, "deutsch", (200..599), "deutsch2.lng"],
+#          [:de, "deutsch", (600..1299), "deutsch3.lng"],
+#          [:en, "english", (0..199), "english1.lng"],
+#          [:en, "english", (200..599), "english2.lng"],
+#          [:en, "english", (600..1299), "english3.lng"],
+  def description_bindings()
+    SetupConfiguration::Translation.languages().collect() do |lang|
+      SetupConfiguration.description_ranges().collect() do |range|
+        # constructs the output file names
+        out= "#{SetupConfiguration::Translation.language_name(lang)}#{SetupConfiguration.description_ranges().index(range)+1}.lng"
+        ParameterTemplateBinding.new(lang, range, out)
+      end
+    end.flatten()
+  end
+
+  def description_template
+    %q{
+    [<%= lang_name.upcase %>]
+    <% parameter_range.each do |number| %>
+    HILFEPARAM<%= number %>=<%= description(number) %>
+    <% end %>
+  }.gsub(/^\s*/, '')
+  end
+
+  def parameter_bindings()
+    SetupConfiguration::Translation.languages().collect() do |lang|
+      # constructs the output file names
+      out= "#{SetupConfiguration::Translation.language_name(lang)}.lng"
+      ParameterTemplateBinding.new(lang, SetupConfiguration.parameter_range(), out)
+    end
+  end
+
+  def parameter_template(lang)
+    template=File.join(File.dirname(__FILE__), "templates", "#{lang.to_s}.lng.erb")
+    if File.file?(template)
+      File.read(template)
+    else
+      puts "WARNING: Template file #{template} expected but not found"
+    end
+  end
+
+  def mps_template()
+    template=File.join(File.dirname(__FILE__), "templates", "mps3.ini.erb")
+    if File.file?(template)
+      File.read(template)
+    else
+      puts "WARNING: Template file #{template} expected but not found"
+    end
+  end
+
+  def mps_binding()
+    mps=MPSTemplateBinding.new
+    mps.output="mps3.ini"
+    mps
+  end
+
+
+end
+
+
+class SetupConfiguration::SuiteGenerator
+  include SetupConfiguration::Generator
+
+  attr_accessor :suite
+  attr_accessor :do_not_run
+
+  def initialize
+    self.do_not_run = false
+    self.suite = SetupConfiguration::Suite.instance
+  end
+
+  def self.do_not_run
+    self.do_not_run=true
+  end
+
+  def generate
+    return "no output" if self.do_not_run
+
+    description_bindings().each() do |bind|
+      bind.suite=self.suite
+      rhtml = ERB.new(description_template, nil, "<>")
+
+      File.open(File.join(output_path, bind.output), "w") do |f|
+        f << rhtml.result(bind.get_binding)
+      end
+    end
+
+    # extras:
+    # -every PARAMETER key needs a value!
+    # -use Windows line terminators CRLF - \r\n
+    # - do not use [] - output is an INI-file
+    parameter_bindings().each() do |bind|
+      bind.suite=self.suite
+      template = parameter_template(bind.lang_name())
+      if template then
+        rhtml = ERB.new( template, nil, "<>")
+
+        File.open(File.join(output_path, bind.output), "w") do |f|
+          f << rhtml.result(bind.get_binding)
+        end
+      else
+        puts "WARNING: No template found. Generation of #{bind.output} aborted."
+      end
+    end
+
+    bind=mps_binding()
+    bind.suite=self.suite
+    mps_template=mps_template()
+    if mps_template then
+      rhtml = ERB.new( mps_template, nil, "<>")
+
+      File.open(File.join(output_path, bind.output), "w") do |f|
+        f << rhtml.result(bind.get_binding)
+      end
+    else
+      puts "WARNING: No template found. Generation of #{bind.output} aborted."
+    end
+
+  end
+end
+