escalator 0.2.1 → 0.2.2

data/lib/plc/emulator/emu_plc.rb

@@ -0,0 +1,411 @@
+#
+# 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 'escalator/plc_device'
+
+include Escalator
+
+module Plc
+module Emulator
+
+  class EmuPlc
+
+    attr_accessor :program_data
+    attr_reader :program_pointer
+    attr_reader :device_dict
+    attr_reader :errors
+
+    SUFFIXES = %w(x y m c t l sc cc tc d cs ts h sd)
+
+    SUFFIXES.each do |k|
+      attr_reader :"#{k}_devices"
+    end
+
+    STOP_PLC_FLAG         = 2     # bit 1
+    CLEAR_PROGRAM_FLAG    = 4     # bit 2  require bit 1 on
+
+    CYCLE_RUN_FLAG        = 2
+
+    def initialize
+      SUFFIXES.each do |k|
+        eval "@#{k}_devices = []"
+      end
+      @lock = Mutex.new
+      reset
+    end
+
+    def device_by_name name
+      @lock.synchronize {
+        d = device_dict[name]
+        unless d
+          d = EmuDevice.new name
+          device_dict[name] = d
+        end
+        d
+      }
+    end
+
+    def device_by_type_and_number type, number
+      d = EmuDevice.new type, number
+      device_by_name d.name
+    end
+
+    def reset
+      @word = 0
+      @program_data = []
+      @device_dict ||= {}
+      @lock.synchronize {
+        @device_dict.values.each do |d|
+          d.reset
+        end
+      }
+    end
+
+    def run_cycle
+      status_to_plc = device_by_name "SD0"
+      status_form_plc = device_by_name "SD1"
+      sync_input
+      case status_to_plc.value & (STOP_PLC_FLAG | CLEAR_PROGRAM_FLAG)
+      when STOP_PLC_FLAG
+        status_form_plc.value = 0
+        sleep 0.1
+      when STOP_PLC_FLAG | CLEAR_PROGRAM_FLAG
+        reset
+        status_form_plc.value = CLEAR_PROGRAM_FLAG
+        sleep 0.1
+      when 0
+        status_form_plc.value = CYCLE_RUN_FLAG
+        @program_pointer = 0
+        @stacks = [[]]
+        while fetch_and_execution; end
+        sleep 0.0001
+      else
+        sleep 0.1
+      end
+      sync_output
+    end
+
+    def bool
+      unless @stacks.empty?
+        !!@stacks.last.last
+      else
+        nil
+      end
+    end
+
+    def run
+      Thread.new do
+        loop do
+          run_cycle
+        end
+      end
+    end
+
+    def execute_console_commands line
+      a = line.chomp.split(/\s+/)
+      case a.first
+      when /^ST/i
+        d = device_by_name a[1]
+        d.set_value true, :in
+        "OK\r"
+      when /^RS/i
+        d = device_by_name a[1]
+        d.set_value false, :in
+        "OK\r"
+      when /^RDS/i
+        d = device_by_name a[1]
+        c = a[2].to_i
+        r = []
+        if d.bit_device?
+          c.times do
+            r << (d.bool(:out) ? 1 : 0)
+            d = device_by_name (d+1).name
+          end
+        else
+          case d.suffix
+          when "PRG"
+            c.times do
+              r << program_data[d.number * 2, 2].pack("c*").unpack("n").first
+              d = device_by_name (d+1).name
+            end
+          else
+            c.times do
+              r << d.word(:out)
+              d = device_by_name (d+1).name
+            end
+          end
+        end
+        r.map{|e| e.to_s}.join(" ") + "\r"
+      when /^WRS/i
+        d = device_by_name a[1]
+        c = a[2].to_i
+        case d.suffix
+        when "PRG"
+          a[3, c].each do |v|
+            program_data[d.number * 2, 2] = [v.to_i].pack("n").unpack("c*")
+            d = device_by_name (d+1).name
+          end
+        else
+          if d.bit_device?
+            a[3, c].each do |v|
+              d.set_value v == "0" ? false : true, :in
+              d = device_by_name (d+1).name
+            end
+          else
+            a[3, c].each do |v|
+              d.word = v.to_i
+              d.set_value v.to_i, :in
+              d = device_by_name (d+1).name
+            end
+          end
+        end
+        "OK\r"
+      when /E/
+        eval(a[1..-1].join(" ")).inspect
+      else
+        raise "Unknown command #{a.first}"
+      end
+    end
+
+    private
+
+      def stack
+        @stacks.last
+      end
+
+      def sync_input
+        @lock.synchronize {
+          device_dict.values.each do |d|
+            d.sync_input
+          end
+        }
+      end
+
+      def sync_output
+        @lock.synchronize {
+          device_dict.values.each do |d|
+            d.sync_output
+          end
+        }
+      end
+
+      def bool= value
+        if stack.empty?
+          stack << value
+        else
+          stack[-1] = value
+        end
+      end
+
+      def and_join_stack
+        @stacks[-1] = [@stacks.last.inject(true){|r,b| r & b}]
+      end
+
+      def mnenonic_table
+        @mnemonic_table ||= begin
+          s = <<EOB
+|00|END|INV|MEP|ANB|MEF|ORB|FEND|NOP|
+|10|LD|LDI|LDP|LDPI|LDF|LDFI|MC|MCR|
+|20|AND|ANI|ANDP|ANPI|ANDF|ANFI|
+|30|OR|ORI|ORP|ORPI|ORF|ORFI|
+|40|OUT|OUTI|MPS|MRD|MPP| |
+|50|SET|RST|PLS| |PLF||
+|60|FF||||||
+|70|
+|80|SFT|SFTP|SFL|SFLP|SFR|SFRP|
+|90|BSFL|BSFLP|DSFL|DSFLP|BSFR|BSFRP|DSFR|DSFRP|
+|A0|SFTL|SFTLP|WSFL|WSFLP|SFTR|SFTRP|WFSR|WSFRP|
+EOB
+          table = {}
+          s.lines.each_with_index do |line, h|
+            line.chomp.split("|")[2..-1].each_with_index do |mnemonic, l|
+              unless mnemonic.length == 0
+                table[h << 4 | l] = mnemonic.downcase.to_sym
+              end
+            end
+          end
+          table
+        end
+      end
+
+      def fetch_and_execution
+        code = fetch_1_byte
+        return false unless code
+        mnemonic = mnenonic_table[code]
+        if mnemonic && respond_to?(mnemonic, true)
+          r = send mnemonic
+          r
+        else
+          nil
+        end
+      end
+
+      def fetch_1_byte
+        if @program_pointer < program_data.size
+          program_data[@program_pointer].tap do
+            @program_pointer += 1
+          end
+        else
+          nil
+        end
+      end
+
+      def fetch_device_or_value
+        c = fetch_1_byte
+        return false unless c
+
+        # check value type
+        case c & 0xe0
+        when 0x80
+          # bit device
+        when 0x00
+          # immediate number
+          return c
+        else
+          add_error "invalidate value type #{c.to_h(16)}"
+          return false
+        end
+
+        # device type
+        device_type = c & 0x0f
+
+        # number
+        number = 0
+        if (c & 0x10) == 0
+          number = fetch_1_byte
+        else
+          number = fetch_2_byte
+        end
+
+        # make device
+        d = device_by_type_and_number device_type, number
+        unless d
+          add_error "invalid device type #{c&0x3} and number #{number}"
+          return false
+        end
+        d
+      end
+
+      def fetch_bool_value inverse=false
+        d = fetch_device_or_value
+        return false unless d
+        unless d.is_a? EmuDevice
+          add_error "ld must be specify a device nor number #{d}"
+          return false
+        end
+        inverse ? !d.bool : d.bool
+      end
+
+      def add_error reason
+        @errors << {pc:@program_pointer, reason:reason}
+      end
+
+
+      # --- mnenonic ---
+      def ld inverse=false
+        b = fetch_bool_value inverse
+        return false if b.nil?
+        stack << b
+        true
+      end
+      def ldi; ld true; end
+
+      def inv
+        and_join_stack
+        self.bool = !self.bool
+        true
+      end
+
+      def and inverse=false
+        b = fetch_bool_value inverse
+        return false if b.nil?
+        self.bool &= b
+        true
+      end
+      def ani; send :and, true; end
+
+      def or inverse=false
+        b = fetch_bool_value inverse
+        return false if b.nil?
+        self.bool |= b
+        true
+      end
+      def ori; send :or, true; end
+
+      def anb
+        true
+      end
+
+      def orb
+        b = self.bool
+        stack.pop
+        self.bool |= b
+        true
+      end
+
+      def nop; true; end
+
+      def mps
+        and_join_stack
+        @stacks << [self.bool]
+        true
+      end
+
+      def mrd
+        @stacks.pop
+        @stacks << [self.bool]
+        true
+      end
+      def mpp; mrd; end
+
+      def out inverse=false
+        and_join_stack
+        d = fetch_device_or_value
+        unless d.is_a? EmuDevice
+          add_error "ld must be specify a device nor number #{d}"
+          return false
+        end
+        d.bool = inverse ? !self.bool : self.bool unless d.input?
+        stack.pop
+        true
+      end
+      def outi; out true; end
+
+      def set inverse=false
+        and_join_stack
+        d = fetch_device_or_value
+        unless d.is_a? EmuDevice
+          add_error "ld must be specify a device nor number #{d}"
+          return false
+        end
+        d.bool = !inverse if self.bool unless d.input?
+        stack.pop
+        true
+      end
+      def rst; set true; end
+
+
+
+  end
+
+end
+end

data/lib/plc/emulator/emu_plc_server.rb

@@ -0,0 +1,71 @@
+#
+# 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 'socket'
+require 'escalator/plc_device'
+
+module Plc
+module Emulator
+
+  class EmuPlcServer
+
+    class << self
+
+      def launch
+        @server ||= begin
+          server = new
+          server.run
+          server
+        end
+      end
+
+    end
+
+    def initialize config = {}
+      @port = config[:port] || 5555
+      @plc = EmuPlc.new
+    end
+
+    def run
+      @plc.run
+      Thread.new do
+        server = TCPServer.open @port
+        puts "launching emulator ... "
+        loop do
+          socket = server.accept
+          puts "done launching"
+          while line = socket.gets
+            begin
+              r = @plc.execute_console_commands line
+              socket.puts r
+            rescue => e
+              socket.puts "E0 #{e}\r"
+            end
+          end
+        end
+      end
+    end
+
+  end
+
+end
+end

data/lib/plc/emulator/emulator.rb

@@ -0,0 +1,28 @@
+#
+# 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 'emu_device'
+require 'emu_plc'
+require 'emu_plc_server'

data/lib/plc/plc.rb

@@ -0,0 +1,27 @@
+#
+# 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
+
+# Use load instead require, because there are two emulator files.
+load File.join(dir, 'emulator/emulator.rb')

data/template/escalator/asm/main.esc

@@ -1,7 +1,52 @@
-LD  X0
-OUT Y0
-LD  X1
-OR  M0
-ANI X2
-OUT M0
-END
+# |-|X0|-+-|/X1|-|/Y1|---(Y0)
+# |-|Y0|-+
+LD   X0
+OR   Y0
+ANI  X1
+ANI  Y1
+OUT  Y0
+
+# |X1|-+-|/X0|-|/Y0|---(Y1)
+# |Y1|-+
+LD   X1
+OR   Y1
+ANI  X0
+ANI  Y0
+OUT  Y1
+
+# |M0|-+-|M2|-+---(M4)
+# |M1|-+-|M3|-+
+LD   M0
+OR   M1
+LD   M2
+OR   M3
+ANB
+OUT  M4
+
+# |M5|-+-|M7|-+---(M10)
+# |M6|-+      |
+#             |
+# |M8|-+------+
+# |M9|-+
+LD   M5
+OR   M6
+AND  M7
+LD   M8
+OR   M9
+ORB
+OUT  M10
+
+# |M11|-+-/-+---(M13)
+# |M12|-+   +---(Y2)
+#           +---(/Y3)
+LD   M11
+OR   M12
+INV
+MPS
+OUT  M13
+MRD
+OUT  Y2
+MPP
+OUTI Y3
+
+END

data/template/escalator/config/plc.yml

@@ -1,7 +1,23 @@
-:plc:
-  :cpu: iq-r
-  :protocol: mc_protocol
-  :host: 192.168.0.1
-  :port: 5007
-  :program_area: d10000
-  :interaction_area: d9998
+# Run rake with target like this.
+#   > rake target=iq-r
+
+# plc section
+plc:
+  iq-r:                     # It's a target name
+    cpu: iq-r               # It's just a comment.
+    protocol: mc_protocol   # It's a protocol to communicate with PLC.
+    host: 192.168.0.10      # It's PLC's IP address or dns name.
+    port: 5007              # It's PLC's port no.
+
+  # You can describe targets multiply.
+  #
+  # plc2:
+  #   cpu: kv-5000
+  #   protocl: kv_protocol
+  #   ...
+
+# default section
+default:
+  # If you set target iq-r, `rake` is same as `rake target=iq-r`.
+  # default target is emulator.
+  # target: iq-r

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: escalator
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Katsuyoshi Ito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-29 00:00:00.000000000 Z
+date: 2016-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,9 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: The escalator is a simple abstract ladder for PLC (Programmable Logic
-  Controller). My aim is to design runnable abstraction ladder which is running on
-  any PLC with same ladder source or binary and prepare full stack tools.
+description: We aim to design abstraction ladder which is able to run on any PLC with
+  same ladder source or binary and prepare full stack tools.
 email:
 - kito@itosoft.com
 executables:
@@ -77,7 +76,17 @@ files:
 - lib/escalator/asm.rb
 - lib/escalator/cli.rb
 - lib/escalator/config.rb
+- lib/escalator/config_target.rb
+- lib/escalator/console.rb
+- lib/escalator/escalator.rb
 - lib/escalator/intel_hex.rb
+- lib/escalator/plc_define.rb
+- lib/escalator/plc_device.rb
+- lib/escalator/protocol/emulator/emu_protocol.rb
+- lib/escalator/protocol/emulator/emulator.rb
+- lib/escalator/protocol/keyence/keyence.rb
+- lib/escalator/protocol/keyence/kv_device.rb
+- lib/escalator/protocol/keyence/kv_protocol.rb
 - lib/escalator/protocol/mitsubishi/mc_protocol.rb
 - lib/escalator/protocol/mitsubishi/mitsubishi.rb
 - lib/escalator/protocol/mitsubishi/qdevice.rb
@@ -85,15 +94,20 @@ files:
 - lib/escalator/tasks/build.rb
 - lib/escalator/uploader.rb
 - lib/escalator/version.rb
-- plc/mitsubishi/iq-r/r08/LICENSE
-- plc/mitsubishi/iq-r/r08/r08.gx3
+- lib/plc/emulator/emu_device.rb
+- lib/plc/emulator/emu_plc.rb
+- lib/plc/emulator/emu_plc_server.rb
+- lib/plc/emulator/emulator.rb
+- lib/plc/mitsubishi/iq-r/r08/LICENSE
+- lib/plc/mitsubishi/iq-r/r08/r08.gx3
+- lib/plc/plc.rb
 - sample/escalator/sample1.esc
 - sample/escalator/sample2.esc
 - sample/escalator/sample2.png
 - template/escalator/Rakefile
 - template/escalator/asm/main.esc
 - template/escalator/config/plc.yml
-homepage: https://github.com/ito-soft-design/escalator/wiki
+homepage: https://github.com/ito-soft-design/escalator
 licenses:
 - MIT
 metadata: {}