ladder_drive 0.3.0

data/lib/ladder_drive/asm.rb

@@ -0,0 +1,211 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2016 ITO SOFT DESIGN Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module LadderDrive
+
+  class Asm
+
+    attr_reader :codes
+    attr_reader :endian
+
+    LITTLE_ENDIAN   = 0
+    BIG_ENDIAN      = 1
+
+    def initialize source, endian = nil
+      @endian = endian || BIG_ENDIAN
+      @lines = []
+      address = 0
+      source.each_line do |line|
+        @lines << AsmLine.new(line, address, @endian)
+        address = @lines.last.next_address
+      end
+    end
+
+    def dump
+      @codes.map do |c|
+        c.to_s(16).rjust(2, "0")
+      end
+    end
+
+    def dump_line
+      @lines.map do |line|
+        "#{line.address.to_s(16).rjust(4, "0")} #{line.dump_line}"
+      end
+      .join("\n") << "\n"
+    end
+
+    def codes
+      @lines.map do |line|
+        line.codes
+      end.flatten
+    end
+
+    private
+
+      def parse line
+        @lines << AsmLine.new(line)
+      end
+
+
+  end
+
+  class AsmLine
+    attr_reader :line
+    attr_reader :codes
+    attr_reader :address
+    attr_reader :endian
+
+    def initialize line, address = 0, endian = nil
+      @endian = endian || Asm::LITTLE_ENDIAN
+      @line = line.upcase.chomp
+      @codes = []
+      @address = address
+      parse
+    end
+
+    def dump_line
+      "#{dump}\t#{line}"
+    end
+
+    def dump
+      @codes.map do |c|
+        c.to_s(16).rjust(2, "0")
+      end
+      .join(" ")
+      .ljust(12)
+    end
+
+    def next_address
+      address + codes.size
+    end
+
+    private
+
+      OPERAND_TYPE_NONE                   = 0
+      OPERAND_TYPE_TYPE_AND_NUMBER        = 1
+      OPERAND_TYPE_TYPE_AND_NUMBER_NUMBER = 2
+
+      def parse
+        /([^#]*)/ =~ line
+        a = $1.split(/\s+/)
+        mnemonic, operand1, operand2 = a
+        if mnemonic
+          @codes << encode_mnemonic(mnemonic)
+          case operand_type(mnemonic)
+          when OPERAND_TYPE_TYPE_AND_NUMBER
+            @codes += parse_type_and_number(operand1)
+          end
+        end
+      end
+
+      def operand_type mnemonic
+        case mnemonic
+        when /LD/, /AND/, /ANI/, /OR[^B]?$/, /OUT/, "SET", "RST", "PLS", "PLF", "FF", /SF(L|R)/
+          OPERAND_TYPE_TYPE_AND_NUMBER
+        else
+          OPERAND_TYPE_NONE
+        end
+      end
+
+      MNEMONIC_DEF = <<EOB
+| |00|10|20|30|40|50|60|70|80|90|A0|B0|C0|D0|E0|F0|
+|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
+|00|END|INV|MEP|ANB|MEF|ORB|FEND|NOP|
+|01|LD|LDI|LDP|LDPI|LDF|LDFI|MC|MCR|
+|02|AND|ANI|ANDP|ANPI|ANDF|ANFI|
+|03|OR|ORI|ORP|ORPI|ORF|ORFI|
+|04|OUT|OUTI|MPS|MRD|MPP| |
+|05|SET|RST|PLS| |PLF||
+|06|FF||| |||
+|07|
+|08|SFT|SFTP|SFL|SFLP|SFR|SFRP|
+|09|BSFL|BSFLP|DSFL|DSFLP|BSFR|BSFRP|DSFR|DSFRP|
+|0A|SFTL|SFTLP|WSFL|WSFLP|SFTR|SFTRP|WFSR|WSFRP|
+|0B|
+|0C|
+|0D|
+|0E|
+|0F|
+EOB
+      def mnemonic_dict
+        @@mnemonic_dict ||= begin
+          h = {}
+          MNEMONIC_DEF.dup.split(/\n/)[2..-1].each_with_index do |line, upper|
+            line.split(/\|/)[2..-1].each_with_index do |mnemonic, lower|
+              mnemonic.strip!
+              next if mnemonic.nil? || mnemonic.length == 0
+              code = (upper << 4) | lower
+              h[mnemonic] = code
+            end
+          end
+          h
+        end
+      end
+
+      def encode_mnemonic mnemonic
+        mnemonic_dict[mnemonic]
+      end
+
+      def parse_type_and_number operand
+        /([[:alpha:]]*)(\d+[0-9A-Fa-f]*)\.?(\d*)?/ =~ operand
+        suffix = $1
+        number = $2
+        bit = $3
+        len = 16
+        case suffix
+        when "X", "Y"
+          number = number.to_i(16)
+        else
+          number = number.to_i
+        end
+        type_code = %W(X Y M - C T L SC CC TC D NOP - CS TS H SD).index(suffix)
+        raise "undefind suffix: #{suffix}" if type_code.nil?
+
+        case (type_code & 0xc) >> 2
+        when 0, 1
+          type_code |= 0x80
+        else
+          type_code |= 0xa0
+        end
+
+        if number < 256
+          [type_code, number]
+        else
+          case endian
+          when Asm::LITTLE_ENDIAN
+            [type_code | 0x10, number & 0xff, (number & 0xff00) >> 8]
+          when Asm::BIG_ENDIAN
+            [type_code | 0x10, (number & 0xff00) >> 8, number & 0xff]
+          end
+        end
+      end
+
+  end
+
+
+end
+
+if $0 == __FILE__
+  asm = LadderDrive::Asm.new ARGF
+  puts asm.dump_line
+end

data/lib/ladder_drive/cli.rb

@@ -0,0 +1,55 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2016 ITO SOFT DESIGN Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'thor'
+require 'fileutils'
+
+include FileUtils
+
+module LadderDrive
+  class CLI < Thor
+
+    desc "create", "Create a new project"
+    def create(name)
+      if File.exist? name
+        puts "ERROR: #{name} already exists."
+        exit -1
+      end
+
+      # copy from template file
+      root_dir = File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
+      template_path = File.join(root_dir, "template", "ladder_drive")
+      cp_r template_path, name
+
+      # copy plc directory
+      temlate_plc_path = File.join(root_dir, "lib", "plc")
+      cp_r temlate_plc_path, name
+      # remove unnecessary file from plc directory
+      %w(plc.rb emulator).each do |fn|
+        rm_r File.join(name, "plc", fn)
+      end
+      puts "#{name} was successfully created."
+    end
+
+  end
+end

data/lib/ladder_drive/config.rb

@@ -0,0 +1,107 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2016 ITO SOFT DESIGN Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'active_support/core_ext/string/inflections'
+require 'yaml'
+require 'json'
+require 'protocol/protocol'
+
+include LadderDrive::Protocol::Mitsubishi
+include LadderDrive::Protocol::Keyence
+include LadderDrive::Protocol::Emulator
+
+module LadderDrive
+
+  class LadderDriveConfig
+
+    class << self
+
+      def default
+        @config ||= begin
+          load File.join("config", "plc.yml")
+        end
+      end
+
+      def load path
+        h = {}
+        if File.exist?(path)
+          h = YAML.load(File.read(path))
+          h = JSON.parse(h.to_json, symbolize_names: true)
+        end
+        new h || {}
+      end
+
+    end
+
+    def initialize options={}
+      default = {
+        input: "asm/main.asm",
+        output: "build/main.hex",
+      }
+      emulator_default = {
+        host: "localhost",
+        port: 5555,
+        protocol: "emu_protocol",
+      }
+
+      @config = default.merge options
+      @config[:plc] ||= {}
+      @config[:plc][:emulator] = @config[:plc][:emulator] ? emulator_default.merge(@config[:plc][:emulator]) : emulator_default
+
+      @config[:default] ||= {}
+
+      @targets = {}
+    end
+
+    def [] key
+      @config[key]
+    end
+
+    def target name=nil
+      name ||= (@config[:default][:target] || :emulator)
+      name = name.to_sym if name.is_a? String
+      target = @targets[name]
+      unless target
+        h = @config[:plc][name]
+        unless h.nil? || h.empty?
+          h = {name:name}.merge h
+          target = LadderDriveConfigTarget.new h
+          @targets[name] = target
+        end
+      end
+      target
+    end
+
+    def method_missing(name, *args)
+      name = name.to_s unless name.is_a? String
+      case name.to_s
+      when /(.*)=$/
+        @config[$1.to_sym] = args.first
+      else
+        @config[name.to_sym]
+      end
+    end
+
+  end
+
+end

data/lib/ladder_drive/config_target.rb

@@ -0,0 +1,93 @@
+#
+# Copyright (c) 2016 ITO SOFT DESIGN Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'active_support/core_ext/string/inflections'
+require 'yaml'
+require 'json'
+require 'protocol/protocol'
+
+include LadderDrive::Protocol::Mitsubishi
+include LadderDrive::Protocol::Keyence
+include LadderDrive::Protocol::Emulator
+
+module LadderDrive
+
+  class LadderDriveConfigTarget
+
+    class << self
+
+      def finalize
+        proc {
+          EmuPlcServer.terminate
+        }
+      end
+
+    end
+
+    def initialize options={}
+      @target_info = options
+      ObjectSpace.define_finalizer(self, self.class.finalize)
+    end
+
+    def protocol
+      @protocol ||= begin
+        p = eval("#{@target_info[:protocol].camelize}.new")
+        p.host = @target_info[:host] if @target_info[:host]
+        p.port = @target_info[:port] if @target_info[:port]
+        p.log_level = @target_info[:log_level] if @target_info[:log_level]
+        p
+      rescue
+        nil
+      end
+    end
+
+    def uploader
+      @uploader ||= begin
+        u = Uploader.new
+        u.protocol = self.protocol
+        u
+      end
+    end
+
+    def method_missing(name, *args)
+      name = name.to_s unless name.is_a? String
+      case name.to_s
+      when /(.*)=$/
+        @target_info[$1.to_sym] = args.first
+      else
+        @target_info[name.to_sym]
+      end
+    end
+
+    def run
+      case self.name
+      when :emulator
+        Plc::Emulator::EmuPlcServer.launch
+      else
+        # DO NOTHIN
+        # Actual device is running independently.
+      end
+    end
+
+  end
+
+end

data/lib/ladder_drive/console.rb

@@ -0,0 +1,113 @@
+#
+# Copyright (c) 2016 ITO SOFT DESIGN Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'singleton'
+
+module LadderDrive
+
+  attr_accessor :target
+
+  class Console
+    include Singleton
+
+    def run
+      l = true
+      trap(:INT) { puts "\n> " }
+
+      display_title
+
+      loop do
+        begin
+          print "> "
+          line = STDIN.gets
+          case line.chomp
+          when /^\s*exit\s*$/, /^\s*quit\s*$/, /^\s*q\s*$/
+            break
+          when /^r\s+(\w+)(\s+(\d+))?/
+            d = protocol.device_by_name EscDevice.new($1)
+            c = $2 ? $2.to_i : 1
+            values = protocol.get_from_devices d, c
+            values = values.map{|v| case v;  when true; 1; when false; 0; else; v; end}
+            puts values.join(" ")
+          when /^p\s+(\w+)(\s+(\d+))?/
+            d = protocol.device_by_name EscDevice.new($1)
+            t = $2 ? $2.to_f : 0.1
+            protocol.set_to_devices d, true
+            sleep t
+            protocol.set_to_devices d, false
+          when /^w\s+(\w+)/
+            d = protocol.device_by_name EscDevice.new($1)
+            v = $'.scan(/\d+/).map{|e| e.to_i}
+            protocol.set_to_devices d, v
+          when /^E\s+/
+            puts protocol.execute(line)
+          when /^help/, /^h/
+            display_help
+          end
+        rescue => e
+          puts "*** ERROR: #{e} ***"
+        end
+      end
+    end
+
+    private
+
+      def protocol
+        target.protocol
+      end
+
+      def display_title
+        puts <<EOB
+
+  LadderDrive is an abstract PLC.
+  This is a console to communicate with PLC.
+
+EOB
+      end
+
+      def display_help
+        puts <<EOB
+Commands:
+
+  r: Read values from device.
+     r device [count]
+       e.g.) it reads values from M0 to M7.
+             > r m0 8
+  w: Write values to device.
+     w device value1 value2 ...
+       e.g.) it write values from D0 to D7.
+             > w d0 1 2 3 4 5 6 7 8
+       e.g.) it write values from M0 to M7.
+             > w m0 0 0 0 1 1 0 1 1
+  p: Pulse out on device. Default duration is 0.1 sec
+     p device [duration]
+       e.g.) it write 1 to m0, then write 0 after 0.5 sec.
+             > w m0 0.5
+  q: Quit this. You can use quit and exit instead of q.
+  h: Show help. You can use help instead of h.
+
+EOB
+      end
+
+  end
+
+end

data/lib/ladder_drive/intel_hex.rb

@@ -0,0 +1,79 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2016 ITO SOFT DESIGN Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module LadderDrive
+
+  class IntelHex
+
+    attr_reader :offset, :codes
+
+    def self.load path
+      offset = 0
+      codes = []
+      File.read(path).lines.each do |l|
+        case l[7,2]
+        when "00"
+          address = l[3,4].to_i(16)
+          offset ||= address
+          l.chomp[9..-3].each_char.each_slice(2).each_with_index do |pair, i|
+            codes[address - offset + i] = pair.join("").to_i(16)
+          end
+        end
+      end
+      new codes, offset
+    end
+
+    def initialize codes, offset = 0
+      @offset = offset
+      @codes = codes
+    end
+
+    def write_to path
+      File.write(path, dump)
+    end
+
+    def dump
+      addr = offset
+      lines = []
+      @codes.each_slice(16) do |line_codes|
+        c = line_codes.size
+        s = ":#{c.to_s(16).rjust(2, '0')}"
+        s << "#{addr.to_s(16).rjust(4, '0')}"
+        s << "00"
+        line_codes.each do |code|
+          s << "#{code.to_s(16).rjust(2, '0')}"
+        end
+        check_sum = 256 - (s[1..-1].scan(/.{2}/).inject(0){|sum, code| sum += code.to_i(16)} & 0xff)
+        s << "#{check_sum.to_s(16).rjust(2, '0')}"
+        lines << s
+        addr += c
+      end
+
+      lines << ":00000001FF"
+      lines << ""
+      lines.join("\n")
+    end
+
+  end
+
+end

data/lib/ladder_drive/ladder_drive.rb

@@ -0,0 +1,36 @@
+#
+# Copyright (c) 2016 ITO SOFT DESIGN Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+dir = File.expand_path(File.dirname(__FILE__))
+$:.unshift dir unless $:.include? dir
+
+require "version"
+require "cli"
+require "asm"
+require "intel_hex"
+require "plc_define"
+require "uploader"
+require "config"
+require "config_target"
+require "plc_device"
+require "protocol/protocol"
+require "console"