escalator 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c264fb022bd1412ffaed30646286e0a482d4f14c
-  data.tar.gz: e4db446ef5fe43d1019276831145a95b42dc23a1
+  metadata.gz: 97963603ab6ca43c800f1457985665cde1595d64
+  data.tar.gz: 2655e9900ca290185648b1b5d5436a8eb2703c25
 SHA512:
-  metadata.gz: 71972f246ec5255677e2e8efdc03a3f8c29fcfeeb65054cddca735ba4f726bd69f3a746208458b8b2728ab0e9d66b8671096a85b29dc3aacc68fe8f86033e986
-  data.tar.gz: 9b80c9f45104c524e82464eba6daaf05e1ecd3504e458bc1a858691d7a67fbffdb729bc8e0779e04dcba164ec567de79a33ef18b79cfcae3680176d12c53373f
+  metadata.gz: a023765c76d3fa85ccb6c4c399e3cf57b040d0c94e5bceb0c75890d0fb60b0531ba4d1b95b3732a739b3c098a18d30e0867e8bd42e41a609073a357b8a6fa4ab
+  data.tar.gz: 4f772215bb2dca5a8b63e8a18f030fd3e6347ef55f355b8923baea04a049a442838788cabe2bac686b23b86e3c2cc25516237159ca9c20e9f547e5bc9ae3e949

data/Gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem "test-unit"
+gem "activesupport"

data/Gemfile.lock

@@ -1,22 +1,34 @@
 PATH
   remote: .
   specs:
-    escalator (0.1.1)
+    escalator (0.1.2)
       thor
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.2)
+    i18n (0.7.0)
+    minitest (5.9.1)
     power_assert (0.2.7)
     rake (10.5.0)
     test-unit (3.1.7)
       power_assert
     thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   bundler (~> 1.11)
   escalator!
   rake (~> 10.0)

data/README.md

@@ -2,9 +2,99 @@
 
 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.
+We aim to design runnable abstraction ladder which is running on any PLC with same ladder source or binary and prepare full stack tools.
+
+# Getting started
+
+It's required the Ruby environment.
+To prepare Ruby environment, please find web sites.
+
+Install Escalator at the command prompt.
+
+```
+$ gem install escalator
+```
+
+# Create an Escalator project
+
+At the command prompt, create a new Escalator project.
+
+```
+$ escalator create my_project
+$ cd my_project
+```
+
+Created files are consisted like below the tree.
+
+```
+.
+├── Rakefile
+├── asm
+│   └── main.esc
+├── config
+│   └── plc.yml
+└── plc
+    └── mitsubishi
+        └── iq-r
+            └── r08
+                ├── LICENSE
+                └── r08.gx3
+```
+
+# Connection configuration
+
+## PLC configuration
+
+There is a plc project under the plc directory.
+Launch the one of the plc project which you want to use.
+(Currently we support MITSUBISHI iQ-R R08CUP only.)
+
+Configure ethernet connection by the tool which is provided by plc maker.
+Then upload settings and plc program to the plc.
+
+## Escalator configuration
+
+There is a configuration file at config/plc.yml.
+Though currently we support MITSUBISHI iQ-R R08CUP only, you only change host to an ip address of your plc.
+
+```
+:plc:
+  :cpu: iq-r
+  :protocol: mc_protocol
+  :host: 192.168.0.1
+  :port: 5007
+  :program_area: d10000
+  :interaction_area: d9998
+```
+## Escalator programming
+
+Escalator program file is located under the asm directory.
+By default, use asm/main.esc.
+Edit it and programming.
+
+Refer [Wiki](https://github.com/ito-soft-design/escalator/wiki/mnemonic) to check mnemonic.
+
+```
+LD  X0
+OUT Y0
+LD  X1
+OR  M0
+ANI X2
+OUT M0
+END
+```
+
+# Transfer the Escalator program
+
+At the command prompt, use rake command to upload escalator program to the plc.
+The Escalator program is running immediate after uploaded.
+
+```
+$ rake plc
+```
+
+
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/README_jp.md

@@ -5,6 +5,108 @@
 
 まずはニーモニックレベルで実現し、その上に分かりやすい形のプログラミングツールを用意できればと考えています。
 
+# 使い方
+
+使用するにはRubyが実行できる環境が必要です。
+Rubyの実行環境の構築はWebサイト等を検索して構築してください。
+
+## インストール
+
+gemでエスカレーターをインストールします。
+
+```
+$ gem install escalator
+```
+
+## プロジェクト作成
+
+エスカレーターをインストールするとescalatorコマンドが使用できる様になります。
+escalatorコマンドでラダーを構成するプロジェクトファイルを作ります。
+
+```
+$ escalator create my_project
+$ cd my_project
+```
+
+ファイルの構成は下の様になっています。
+plc以下にエスカレーターを実行するPLCプロジェクトの雛形があります。
+現在は三菱電機のiQ-RシリーズR08CPUのみの対応となっています。
+他メーカーや他の機種は今後追加する予定です。
+
+
+```
+.
+├── Rakefile
+├── asm
+│   └── main.esc
+├── config
+│   └── plc.yml
+└── plc
+    └── mitsubishi
+        └── iq-r
+            └── r08
+                ├── LICENSE
+                └── r08.gx3
+```
+
+## 通信設定
+
+### PLCの通信設定
+
+plc以下のプロジェクトファイルを開いてIPアドレスなど変更します。
+変更後PLCに設定とプログラムを書き込みます。
+
+### エスカレーターの設定
+
+config/plc.ymlファイルで設定します。
+
+現在はiQ-Rのみの対応なので:host: 192.168.0.1の行でPLCに設定したIPアドレスを指定するのみで接続できます。
+
+```
+:plc:
+  :cpu: iq-r
+  :protocol: mc_protocol
+  :host: 192.168.0.1
+  :port: 5007
+  :program_area: d10000
+  :interaction_area: d9998
+```
+
+## エスカレータープログラム作成
+
+エスカレーターのプログラムはasm以下にあります。
+現在はmain.escファイルから生成します。
+
+main.escを編集しプログラムを作成します。
+PLC側の実装がまだ進んでいないので実行できるニーモニックはLD、OUT、AND、ORとその反転程度です。
+
+ニーモニックについては[Wiki](https://github.com/ito-soft-design/escalator/wiki/mnemonic)の方を参照してください。
+
+```
+LD  X0
+OUT Y0
+LD  X1
+OR  M0
+ANI X2
+OUT M0
+END
+```
+
+## プログラムの転送
+
+エスカレータープログラムをplcに転送するはrakeコマンドを使用します。
+転送後プログラムが実行されます。
+
+```
+$ rake plc
+```
+
+
+# エスカレーターに関する情報
+
+- [一往確認日記 [escalator]](http://diary.itosoft.com/?category=escalator)
+- [Wiki](https://github.com/ito-soft-design/escalator/wiki/)
+
 # ライセンス
 
 MIT

data/lib/escalator/asm.rb

@@ -32,7 +32,7 @@ module Escalator
     BIG_ENDIAN      = 1
 
     def initialize source, endian = nil
-      @endian = endian || LITTLE_ENDIAN
+      @endian = endian || BIG_ENDIAN
       @lines = []
       address = 0
       source.each_line do | line|

data/lib/escalator/cli.rb

@@ -1,7 +1,7 @@
 # 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
@@ -9,10 +9,10 @@
 # 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
@@ -28,13 +28,14 @@ include FileUtils
 
 module Escalator
   class CLI < Thor
-    
+
     desc "create", "Create a new project"
     def create(name)
       template_path = File.join(Escalator_root, "template", "escalator")
       cp_r template_path, name
-
+      temlate_plc_path = File.join(Escalator_root, "plc")
+      cp_r temlate_plc_path, name
     end
-    
+
   end
 end

data/lib/escalator/config.rb

@@ -0,0 +1,84 @@
+# 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 "escalator/protocol/protocol"
+require 'escalator/uploader'
+require 'yaml'
+
+include Escalator::Protocol::Mitsubishi
+
+module Escalator
+
+
+  class EscalatorConfig
+
+    def self.default
+      @config ||= begin
+        config_path = File.join "config", "plc.yml"
+        h = YAML.load(File.read(config_path)) if File.exist?(config_path)
+        new h || {}
+      end
+    end
+
+    def initialize options={}
+      default = {input: "asm/main.asm", output: "build/main.hex"}
+      @config = options.merge default
+    end
+
+    def protocol
+      @protocol ||= begin
+        plc_info = @config[:plc]
+        p = eval("#{plc_info[:protocol].camelize}.new")
+        p.host = plc_info[:host] if plc_info[:host]
+        p.port = plc_info[:port] if plc_info[:port]
+        p.log_level = plc_info[:log_level] if plc_info[:log_level]
+        p
+      rescue
+        nil
+      end
+    end
+
+    def uploader
+      @uploader ||= begin
+        u = Uploader.new
+        u.protocol = self.protocol
+        u.program_area = u.protocol.device_by_name(@config[:plc][:program_area]) if @config[:plc] && @config[:plc][:program_area]
+        u.interaction_area = u.protocol.device_by_name(@config[:plc][:interaction_area]) if @config[:plc] && @config[:plc][:interaction_area]
+        u
+      end
+    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/escalator/intel_hex.rb

@@ -1,14 +1,57 @@
+# 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 Escalator
 
   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 = []
@@ -31,15 +74,6 @@ module Escalator
       lines.join("\n")
     end
 
-    def gxworks_memory_image
-      lines = []
-      @codes.each_slice(8) do |line_codes|
-        lines << line_codes.join("\t")
-      end
-
-      lines.join("\n")
-    end
-
   end
 
 end

data/lib/escalator/protocol/mitsubishi/mc_protocol.rb

@@ -0,0 +1,228 @@
+# 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 Escalator
+module Protocol
+module Mitsubishi
+
+  class McProtocol < Protocol
+
+    def initialize options={}
+      super
+      @host = options[:host] || "192.168.0.1"
+      @port = options[:port] || 5010
+    end
+
+    def open
+      @socket ||= TCPSocket.open(@host, @port)
+    end
+
+    def close
+      @socket.close if @socket
+      @socket = nil
+    end
+
+    def get_bit_from_device device
+      device = device_by_name device
+      get_bits_from_device(1, device).first
+    end
+
+    def get_bits_from_device count, device
+      device = device_by_name device
+      packet = make_packet(body_for_get_bits_from_deivce(count, device))
+      @logger.debug("> #{dump_packet packet}")
+      open
+      @socket.write(packet.pack("c*"))
+      @socket.flush
+      res = receive
+      bits = []
+      count.times do |i|
+        v = res[11 + i / 2]
+        if i % 2 == 0
+          bits << ((v >> 4) != 0)
+        else
+          bits << ((v & 0xf) != 0)
+        end
+      end
+      @logger.debug("get #{device.name} => #{bits}")
+      bits
+    end
+
+    def set_bits_to_device bits, device
+      device = device_by_name device
+      packet = make_packet(body_for_set_bits_to_device(bits, device))
+      @logger.debug("> #{dump_packet packet}")
+      open
+      @socket.write(packet.pack("c*"))
+      @socket.flush
+      res = receive
+      @logger.debug("set #{bits} to:#{device.name}")
+    end
+
+
+    def get_word_from_device device
+      device = device_by_name device
+      get_words_from_device(1, device).first
+    end
+
+    def get_words_from_device(count, device)
+      device = device_by_name device
+      packet = make_packet(body_for_get_words_from_deivce(count, device))
+      @logger.debug("> #{dump_packet packet}")
+      open
+      @socket.write(packet.pack("c*"))
+      @socket.flush
+      res = receive
+      words = []
+      res[11, 2 * count].each_slice(2) do |pair|
+        words << pair.pack("c*").unpack("v").first
+      end
+      @logger.debug("get from: #{device.name} => #{words}")
+      words
+    end
+
+    def set_words_to_device words, device
+      device = device_by_name device
+      packet = make_packet(body_for_set_words_to_device(words, device))
+      @logger.debug("> #{dump_packet packet}")
+      open
+      @socket.write(packet.pack("c*"))
+      @socket.flush
+      res = receive
+      @logger.debug("set #{words} to: #{device.name}")
+    end
+
+
+    def device_by_name name
+      case name
+      when String
+        QDevice.new name
+      else
+        # it may be already QDevice
+        name
+      end
+    end
+
+
+    def receive
+      res = []
+      len = 0
+      begin
+        Timeout.timeout(0.1) do
+          while  true
+            c = @socket.read(1)
+            next if c.nil? || c == ""
+
+            res << c.bytes.first
+            len = res[7] + res[8] << 8 if res.length >= 9
+            break if (len + 9 == res.length)
+          end
+        end
+      rescue Timeout::Error
+      end
+      @logger.debug("< #{dump_packet res}")
+      res
+    end
+
+  private
+
+    def make_packet body
+      header = [0x50, 0x00,  0x00,  0xff,  0xff, 0x03,  0x00,  0x00, 0x00,  0x10,  0x00]
+      header[7..8] = data_for_short(body.length + 2)
+      header + body
+    end
+
+    def body_for_get_bit_from_deivce device
+      body_for_get_bits_from_deivce 1, device
+    end
+
+    def body_for_get_bits_from_deivce count, device
+      body_for_get_words_from_deivce count, device, false
+    end
+
+    def body_for_get_words_from_deivce count, device, word = true
+      body = [0x01, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x90, 0x01, 0x00]
+      body[2] = 1 unless word
+      body[4..7] = data_for_device(device)
+      body[8..9] = data_for_short count
+      body
+    end
+
+
+    def body_for_set_bits_to_device bits, device
+      body = [0x01, 0x14, 0x01, 0x00, 0x00, 0x00, 0x00, 0x90, 0x01, 0x00]
+      d = device
+      bits = [bits] unless bits.is_a? Array
+      bits.each_slice(2) do |pair|
+        body << (pair.first ? 0x10 : 0x00)
+        body[-1] |= (pair.last ? 0x1 : 0x00) if pair.size == 2
+        d = d.next_device
+      end
+      body[4..7] = data_for_device(device)
+      body[8..9] = data_for_short bits.size
+      body
+    end
+    alias :body_for_set_bit_to_device :body_for_set_bits_to_device
+
+    def body_for_set_words_to_device words, device
+      body = [0x01, 0x14, 0x00, 0x00, 0x00, 0x00, 0x00, 0x90, 0x01, 0x00]
+      d = device
+      words = [words] unless words.is_a? Array
+      words.each do |v|
+        body += data_for_short v
+        d = d.next_device
+      end
+      body[4..7] = data_for_device(device)
+      body[8..9] = data_for_short words.size
+      body
+    end
+
+    def data_for_device device
+      a = data_for_int device.number
+      a[3] = device.suffix_code
+      a
+    end
+
+    def data_for_short value
+      [value].pack("v").unpack("c*")
+    end
+
+    def data_for_int value
+      [value].pack("V").unpack("c*")
+    end
+
+    def dump_packet packet
+      a = []
+      len = packet.length
+      bytes = packet.dup
+      len.times do |i|
+        a << ("0" + bytes[i].to_s(16))[-2, 2]
+      end
+      "[" + a.join(", ") + "]"
+    end
+
+  end
+
+end
+end
+end

data/lib/escalator/protocol/mitsubishi/mitsubishi.rb

@@ -0,0 +1,36 @@
+# 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.
+
+$:.unshift File.dirname(__FILE__)
+
+module Escalator
+module Protocol
+
+require 'socket'
+require 'logger'
+require 'timeout'
+require 'qdevice'
+require 'mc_protocol'
+
+end
+end

data/lib/escalator/protocol/mitsubishi/qdevice.rb

@@ -0,0 +1,114 @@
+# 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 Escalator
+module Protocol
+module Mitsubishi
+
+  class QDevice
+
+    attr_reader :suffix, :number
+
+    SUFFIXES = %w(SM SD X Y M L F V B D W TS TC TN SS SC SN CS CC CN SB SW S DX DY Z R ZR)
+    SUFFIX_CODES = [0x91, 0xa9, 0x9c, 0x9d, 0x90, 0x92, 0x93, 0x94, 0xa0, 0xa8, 0xb4, 0xc1, 0xc0, 0xc2, 0xc7, 0xc6, 0xc8, 0xc4, 0xc3, 0xc5, 0xa1, 0xb5, 0x98, 0xa2, 0xa3, 0xcc ,0xaf, 0xb0]
+
+    def initialize a, b = nil
+      case a
+      when Array
+        case a.size
+        when 4
+          @suffix = suffix_for_code(a[3])
+          @number = ((a[2] << 8 | a[1]) << 8) | a[0]
+        end
+      when String
+        if b
+          @suffix = a.upcase
+          @number = b
+        else
+          if a.length == 12
+            @suffix = [a[0,2].to_i(16), a[2,2].to_i(16)].pack "c*"
+            @suffix.strip!
+            @number = a[4,8].to_i(16)
+          elsif /(X|Y)(.+)/i =~ a
+            @suffix = $1.upcase
+            @number = $2.to_i(p_adic_number)
+          else
+            /(M|L|S|B|F|T|C|D|W|R)(.+)/i =~ a
+            @suffix = $1.upcase
+            @number = $2.to_i(p_adic_number)
+          end
+        end
+      end
+    end
+
+    def p_adic_number
+      case @suffix
+      when "X", "Y", "B", "W", "SB", "SW", "DX", "DY", "ZR"
+        16
+      else
+        10
+      end
+    end
+
+    def name
+      @suffix + @number.to_s(p_adic_number).upcase
+    end
+
+    def next_device
+      d = self.class.new @suffix, @number + 1
+      d
+    end
+
+    def bit_device?
+      case @suffix
+      when "SM", "X", "Y", "M", "L", "F", "V", "B",
+           "TS", "TC", "SS", "SC","CS", "CC", "SB", "S", "DX", "DY"
+        true
+      else
+        false
+      end
+    end
+
+    def suffix_for_code code
+      index = SUFFIX_CODES.index code
+      index ? SUFFIXES[index] : nil
+    end
+
+    def suffix_code
+      index = SUFFIXES.index suffix
+      index ? SUFFIX_CODES[index] : 0
+    end
+
+    def + value
+      QDevice.new self.suffix, self.number + value
+    end
+
+    def - value
+      QDevice.new self.suffix, [self.number - value, 0].max
+    end
+
+  end
+
+end
+end
+end

data/lib/escalator/protocol/protocol.rb

@@ -0,0 +1,78 @@
+# 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.
+
+$:.unshift File.dirname(__FILE__)
+
+module Escalator
+module Protocol
+
+  class Protocol
+
+    attr_accessor :host, :port, :log_level
+
+    def initialize options={}
+      @logger = Logger.new(STDOUT)
+      @logger.level = options[:log_level] || Logger::INFO
+    end
+
+    def log_level= level
+      @log_level = level.is_a?(String) ? level.to_sym : level
+      case @log_level
+      when :debug
+        @logger.level = Logger::DEBUG
+      when :error
+        @logger.level = Logger::ERROR
+      when :fatal
+        @logger.level = Logger::FATAL
+      when :info
+        @logger.level = Logger::INFO
+      when :unknown
+        @logger.level = Logger::UNKNOWN
+      when :warn
+        @logger.level = Logger::WARN
+      end
+    end
+
+    # abstract methods
+
+    def open; end
+    def close; end
+
+    def get_bit_from_device device; end
+    def get_bits_from_device count, device; end
+    def set_bits_to_device bits, device; end
+    def set_bit_to_device bit, device; set_bits_to_device bit, device; end
+
+    def get_word_from_device device; end
+    def get_words_from_device(count, device); end
+    def set_words_to_device words, device; end
+    def set_word_to_device word, device; set_words_to_device word, device; end
+
+    def device_by_name name; nil; end
+
+  end
+
+end
+end
+
+require 'mitsubishi/mitsubishi'

data/lib/escalator/tasks/build.rb

@@ -23,9 +23,11 @@
 
 Escalator_root = File.expand_path(File.join(File.dirname(__FILE__), "../../../"))
 
+require "escalator/config"
 require 'escalator/asm'
 require 'escalator/intel_hex'
 require 'rake/loaders/makefile'
+require 'fileutils'
 
 #directory "build"
 
@@ -61,6 +63,7 @@ rule %r{^build/.+\.hex} => ['%{^build,asm}X.esc'] do |t|
     $stderr = STDERR
   end
   stream = StringIO.new
+  puts "hex #{t.source}"
   asm = Escalator::Asm.new File.read(t.source)
   hex = Escalator::IntelHex.new asm.codes
   File.write(t.name, hex.dump)
@@ -77,51 +80,28 @@ rule %r{^build/.+\.gxwm} => ['%{^build,asm}X.esc'] do |t|
     $stderr = STDERR
   end
   stream = StringIO.new
+  puts "gxwm #{t.source}"
   asm = Escalator::Asm.new File.read(t.source)
   hex = Escalator::IntelHex.new asm.codes
   File.write(t.name, hex.gxworks_memory_image)
 end
 
-=begin
-desc "Assemble codes"
-task :asm do
-  # @refer: https://github.com/rsutphin/handbrake.rb/issues/1
-  begin
-    $stderr = File.open('hb.log', 'w')
-    $stdout = $stderr
-    mkdir_p "build"
-  ensure
-    $stdout = STDOUT
-    $stderr = STDERR
-  end
-  dir = "./asm"
-  stream = StringIO.new
-  sources = Dir.glob("asm/**/*.esc").each do |filename|
-    puts "asm #{filename}"
-    asm = Escalator::Asm.new File.read(filename)
-    dst = File.join("build", File.basename(filename, ".*") + ".lst")
-    File.write(dst, asm.dump_line)
-  end
+desc "Clean all generated files."
+task :clean do
+  FileUtils.rm_r "build"
 end
 
-desc "Make hex codes"
-task :hex do
-  begin
-    $stderr = File.open('hb.log', 'w')
-    $stdout = $stderr
-    mkdir_p "build"
-  ensure
-    $stdout = STDOUT
-    $stderr = STDERR
-  end
-  dir = "./asm"
-  stream = StringIO.new
-  sources = Dir.glob("asm/**/*.esc").each do |filename|
-    puts "hex #{filename}"
-    asm = Escalator::Asm.new File.read(filename)
-    dst = File.join("build", File.basename(filename, ".*") + ".hex")
-    hex = Escalator::IntelHex.new asm.codes
-    File.write(dst, hex.dump)
-  end
+@config = Escalator::EscalatorConfig.default
+
+task :upload => @config.output do
+  u = @config.uploader
+  u.source = @config.output
+  u.upload
+  puts "upload #{u.source}"
 end
-=end
+
+desc "Install program to PLCs."
+task :plc => :upload do
+end
+
+task :default => %w(build/main.lst build/main.hex build/main.gxwm)

data/lib/escalator/uploader.rb

@@ -0,0 +1,114 @@
+# 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 Escalator
+
+  class Uploader
+
+    attr_accessor :protocol
+    attr_accessor :program_area, :interaction_area
+    attr_accessor :source
+    attr_accessor :data
+
+    def initialize options={}
+      @protocol = options[:protocol] if options[:protocol]
+      @program_area = options[:program_area] if options[:program_area]
+      @interaction_area = options[:interaction_area] if options[:interaction_area]
+    end
+
+    STOP_PLC_FLAG         = 2     # bit 1
+    CLEAR_PROGRAM_FLAG    = 4     # bit 2  require bit 1 on
+
+    CYCLE_RUN_FLAG        = 2
+
+
+    def upload
+      # stop plc
+      stop_plc
+      clear_program
+      write_program
+      run_plc
+    end
+
+    def data
+      @data ||= begin
+        hex = IntelHex.load @source
+        hex.codes
+      end
+    end
+
+    def word_data
+      data.each_slice(2).map do |pair|
+        pair.pack("c*").unpack("n*")
+      end.flatten
+    end
+
+    private
+
+      def to_plc_status
+        @to_plc_status ||= interaction_area
+      end
+
+      def from_plc_status
+        @from_plc_status ||= interaction_area.next_device
+      end
+
+
+      def stop_plc
+        @protocol.set_word_to_device STOP_PLC_FLAG, to_plc_status
+        Timeout.timeout(5) do
+          v = @protocol.get_word_from_device from_plc_status
+          break if (v & STOP_PLC_FLAG) != 0
+          sleep 0.1
+        end
+      end
+
+      def clear_program
+        @protocol.set_word_to_device STOP_PLC_FLAG | CLEAR_PROGRAM_FLAG, to_plc_status
+        Timeout.timeout(5) do
+          v = @protocol.get_word_from_device from_plc_status
+          break if (v & CLEAR_PROGRAM_FLAG) != 0
+          sleep 0.1
+        end
+        @protocol.set_word_to_device STOP_PLC_FLAG, to_plc_status
+      end
+
+      def run_plc
+        @protocol.set_word_to_device 0, to_plc_status
+        Timeout.timeout(5) do
+          v = @protocol.get_word_from_device from_plc_status
+          break if (v & CYCLE_RUN_FLAG) != 0
+          sleep 0.1
+        end
+      end
+
+      def write_program
+        word_data.each_slice(2*1024) do |chunk|
+          @protocol.set_words_to_device chunk, @program_area
+        end
+      end
+
+  end
+
+
+end

data/lib/escalator/version.rb

@@ -22,5 +22,5 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module Escalator
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/escalator.rb

@@ -1,7 +1,7 @@
 # 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
@@ -9,10 +9,10 @@
 # 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
@@ -25,6 +25,7 @@ require "escalator/version"
 require "escalator/cli"
 require "escalator/asm"
 require "escalator/intel_hex"
+require "escalator/config"
 
 Escalator_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
 
@@ -32,4 +33,4 @@ module Escalator
 end
 
 
-Escalator::CLI.start
+Escalator::CLI.start

data/plc/mitsubishi/iq-r/r08/LICENSE

@@ -0,0 +1,21 @@
+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.

data/template/escalator/config/plc.yml

@@ -0,0 +1,7 @@
+:plc:
+  :cpu: iq-r
+  :protocol: mc_protocol
+  :ip: 192.168.0.1
+  :port: 5007
+  :program_area: d10000
+  :interaction_area: d9998

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: escalator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Katsuyoshi Ito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -76,14 +76,23 @@ files:
 - lib/escalator.rb
 - lib/escalator/asm.rb
 - lib/escalator/cli.rb
+- lib/escalator/config.rb
 - lib/escalator/intel_hex.rb
+- lib/escalator/protocol/mitsubishi/mc_protocol.rb
+- lib/escalator/protocol/mitsubishi/mitsubishi.rb
+- lib/escalator/protocol/mitsubishi/qdevice.rb
+- lib/escalator/protocol/protocol.rb
 - 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
 - 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
 licenses:
 - MIT