escalator 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13a9ccec9a5b8fc6febc862aaa8fd06437f9ec56
-  data.tar.gz: cefecca594c6a3b1180f2181abfa0b872c73195a
+  metadata.gz: dfe377639702aeca02103cea9454ca87ccdeb14d
+  data.tar.gz: d79050293143f59fedd8456ac4d5dc903776fc44
 SHA512:
-  metadata.gz: cf61af678cab0c758445dbf62cb0f73ec2e278928c8aca0463f792865b03d7e7c749de9c1d8ce0d520a2d6912afc45679408a94e7bfdf409f5305169b47b4ea5
-  data.tar.gz: 6157c0c6fbf9356cffa401991f00e737137267789756dabe55e155037f3f0f5d5130404674cf02186ae632ea46d1db4b715f900fdb379edb145ef446aaee1cab
+  metadata.gz: 734cbfe7bbc43d355cfc1cff00f1071aaca84be94d7813575f7bba9bbcefbfc0153b04bcf5415bf5b7354b3dc3f2e2f012d321213132aaf7cafc835e8eabe27f
+  data.tar.gz: 2011273b79c0aa5776ea148c3dba0ad21fb029e6ca28a6582cc83f6752803ee7c114fef653c32b813594a9556716c2af6c7b2f95d9cce469d2697e7dbe62c3b9

data/Gemfile

@@ -5,3 +5,5 @@ gemspec
 
 gem "test-unit"
 gem "activesupport"
+gem "webrick"
+gem "curses"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    escalator (0.1.2)
+    escalator (0.2.1)
       thor
 
 GEM

data/README.md

@@ -1,17 +1,19 @@
+[[Japanese description is here.]](https://github.com/ito-soft-design/escalator/blob/master/README_jp.md)
+
 # Escalator
 
 The escalator is a simple abstract ladder for PLC (Programmable Logic Controller).
 
-We aim 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 abstraction ladder which is able to run 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.
+To prepare the Ruby environment, please find web sites.
 
 Install Escalator at the command prompt.
 
-```
+```sh
 $ gem install escalator
 ```
 
@@ -19,12 +21,12 @@ $ gem install escalator
 
 At the command prompt, create a new Escalator project.
 
-```
+```sh
 $ escalator create my_project
 $ cd my_project
 ```
 
-Created files are consisted like below the tree.
+Created files are consisted like the tree below.
 
 ```
 .
@@ -41,31 +43,41 @@ Created files are consisted like below the tree.
                 └── r08.gx3
 ```
 
+[![](http://img.youtube.com/vi/aFEtOIgKLvQ/0.jpg)](https://youtu.be/aFEtOIgKLvQ)
+
 # 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.)
+(Currently we support the Emulator and 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.
 
+[![](http://img.youtube.com/vi/fGdyIo9AmuE/0.jpg)](https://youtu.be/fGdyIo9AmuE)
+
+
 ## 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.
+Currently we support MITSUBISHI iQ-R R08CUP and the Emulator.
+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
+# plc.yml
+plc:                        # Beginning of PLC section.
+  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.
 ```
+
+[![](http://img.youtube.com/vi/m0JaOBFIHqw/0.jpg)](https://youtu.be/m0JaOBFIHqw)
+
+
 ## Escalator programming
 
 Escalator program file is located under the asm directory.
@@ -75,24 +87,81 @@ 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
+# main.esc
+LD  M0
+AND M1
+OUT M2
 END
 ```
 
+[![](http://img.youtube.com/vi/OjaSqrkWv8Q/0.jpg)](https://youtu.be/OjaSqrkWv8Q)
+
+
 # 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.
+At the command prompt, use ```rake``` command to upload escalator program to the plc.
+By default, the target plc is ```emulator```. Then launch the Emulator.
 
+```sh
+$ rake
 ```
-$ rake plc
+
+If you use with the ```target``` option, the target PLC is it.
+
+```sh
+$ rake target=iq-r
 ```
 
+You can describe the default target by the target section in plc.yml.
+
+```
+# plc.yml
+default:
+  target: iq-r
+```
+
+```rake``` is same as ```rake target=iq-r```.
+
+
+The Escalator program runs immediately after uploaded.
+
+```sh
+$ rake [target=iq-r]
+uploading build/main.hex ...
+launching emulator ...
+done launching
+done uploading
+
+  Escalator is an abstract PLC.
+  This is a console to communicate with PLC.
+
+>
+```
+
+After uploaded the program, it becomes in to console mode.
+You can read and write a device by entering commands.
+
+Use the r command if you want to read devices.
+Below example reads values of devices from M0 to M7.
+
+```sh
+> r m0 8
+```
+
+Below example writes values to devices from M0 to M7.
+
+```sh
+> w m0 0 0 0 1 1 0 1 1
+```
+
+
+[![](http://img.youtube.com/vi/qGbicGLB7Gs/0.jpg)](https://youtu.be/qGbicGLB7Gs)
+
+
+# Information related escalator
+
+- [My japanese diary [escalator]](http://diary.itosoft.com/?category=escalator)
+- [Wiki](https://github.com/ito-soft-design/escalator/wiki/)
 
 
 ## License

data/README_jp.md

@@ -1,36 +1,38 @@
-# 概要
+# エスカレーター
+
+## 概要
 
 エスカレーターはPLC(Programmable Logic Controller)向けの抽象的なラダーです。
 どのPLCでも同じソース(できればバイナリー)で実行できる形態を目指しています。
 
 まずはニーモニックレベルで実現し、その上に分かりやすい形のプログラミングツールを用意できればと考えています。
 
-# 使い方
+## 使い方
 
 使用するにはRubyが実行できる環境が必要です。
 Rubyの実行環境の構築はWebサイト等を検索して構築してください。
 
-## インストール
+### インストール
 
 gemでエスカレーターをインストールします。
 
-```
+```sh
 $ gem install escalator
 ```
 
-## プロジェクト作成
+### プロジェクト作成
 
 エスカレーターをインストールするとescalatorコマンドが使用できる様になります。
 escalatorコマンドでラダーを構成するプロジェクトファイルを作ります。
 
-```
+```sh
 $ escalator create my_project
 $ cd my_project
 ```
 
 ファイルの構成は下の様になっています。
 plc以下にエスカレーターを実行するPLCプロジェクトの雛形があります。
-現在は三菱電機のiQ-RシリーズR08CPUのみの対応となっています。
+現在はエミュレーターと三菱電機のiQ-RシリーズR08CPUのみの対応となっています。
 他メーカーや他の機種は今後追加する予定です。
 
 
@@ -49,30 +51,36 @@ plc以下にエスカレーターを実行するPLCプロジェクトの雛形
                 └── r08.gx3
 ```
 
-## 通信設定
+[![](http://img.youtube.com/vi/aFEtOIgKLvQ/0.jpg)](https://youtu.be/aFEtOIgKLvQ)
+
+### 通信設定
+
+#### PLCの通信設定
 
-### PLCの通信設定
+plc以下の使用したいPLCのプロジェクトファイルを開きます。
+IPアドレスなど必要な箇所変更し、PLCに転送します。
 
-plc以下のプロジェクトファイルを開いてIPアドレスなど変更します。
-変更後PLCに設定とプログラムを書き込みます。
+[![](http://img.youtube.com/vi/fGdyIo9AmuE/0.jpg)](https://youtu.be/fGdyIo9AmuE)
 
-### エスカレーターの設定
+#### エスカレーターの設定
 
 config/plc.ymlファイルで設定します。
 
-現在はiQ-Rのみの対応なので:host: 192.168.0.1の行でPLCに設定したIPアドレスを指定するのみで接続できます。
+現在はiQ-Rのみの対応なので:host: 192.168.0.10の行でPLCに設定したIPアドレスを指定するだけで接続できます。
 
 ```
-:plc:
-  :cpu: iq-r
-  :protocol: mc_protocol
-  :host: 192.168.0.1
-  :port: 5007
-  :program_area: d10000
-  :interaction_area: d9998
+# plc.yml
+plc:                        # Beginning of PLC section.
+  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.
 ```
 
-## エスカレータープログラム作成
+[![](http://img.youtube.com/vi/m0JaOBFIHqw/0.jpg)](https://youtu.be/m0JaOBFIHqw)
+
+### エスカレータープログラム作成
 
 エスカレーターのプログラムはasm以下にあります。
 現在はmain.escファイルから生成します。
@@ -83,30 +91,94 @@ PLC側の実装がまだ進んでいないので実行できるニーモニッ
 ニーモニックについては[Wiki](https://github.com/ito-soft-design/escalator/wiki/mnemonic)の方を参照してください。
 
 ```
-LD  X0
-OUT Y0
-LD  X1
-OR  M0
-ANI X2
-OUT M0
+# main.esc
+LD  M0
+AND M1
+OUT M2
 END
 ```
 
-## プログラムの転送
+[![](http://img.youtube.com/vi/OjaSqrkWv8Q/0.jpg)](https://youtu.be/OjaSqrkWv8Q)
+
+### プログラムの転送
+
+エスカレータープログラムをplcに転送するには```rake```コマンドを使用します。
+デフォルトではエミュレーターが対象になり、エミュレーターが起動します。
+
+```sh
+$ rake
+```
+
+targetを指定するとplc.ymlのplcセクション内の該当するターゲットが対象になります。
+
+```sh
+$ rake target=iq-r
+```
+
+plc.ymlファイルのdefaultセクションのtargetでデフォルトのターゲトを設定できます。
+
+```
+# plc.yml
+default:
+  target: iq-r
+```
+
+この場合に```rake```を行うと```rake target=iq-r```をしたのと同じになります。
+
 
-エスカレータープログラムをplcに転送するはrakeコマンドを使用します。
 転送後プログラムが実行されます。
 
+```sh
+$ rake [target=iq-r]
+uploading build/main.hex ...
+launching emulator ...
+done launching
+done uploading
+
+  Escalator is an abstract PLC.
+  This is a console to communicate with PLC.
+
+>
 ```
-$ rake plc
+
+アップロードが完了するとコンソールモードになります。
+コンソールモードではコマンドを打つ事でデバイスの読み書きができます。
+
+デバイスの値を読み取るにはrコマンドを使用します。
+下の例ではm0から8子分のデバイスを読み出します。
+
+```sh
+> r m0 8
+```
+
+デバイスに値を書き込むにはwコマンドを使用します。
+下の例ではM0からM7まで書き込んでいます。
+
+```sh
+> w m0 0 0 0 1 1 0 1 1
 ```
 
+ボタンを押した様にパルス状にデバイスをオンにするにはpwコマンドを使用します。
+
+```sh
+> p m0
+```
+
+オンになる時間をデバイスのあとに指定することもできます。単位は秒です。
+
+```sh
+> p m0 1.5
+```
+
+
+
+[![](http://img.youtube.com/vi/qGbicGLB7Gs/0.jpg)](https://youtu.be/qGbicGLB7Gs)
 
-# エスカレーターに関する情報
+## エスカレーターに関する情報
 
 - [一往確認日記 [escalator]](http://diary.itosoft.com/?category=escalator)
 - [Wiki](https://github.com/ito-soft-design/escalator/wiki/)
 
-# ライセンス
+## ライセンス
 
 MIT

data/escalator.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ["kito@itosoft.com"]
 
   spec.summary       = %q{The escalator is a simple abstract ladder for PLC (Programmable Logic Controller).}
-  spec.description   = %q{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.}
-  spec.homepage      = "https://github.com/ito-soft-design/escalator/wiki"
+  spec.description   = %q{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.}
+  spec.homepage      = "https://github.com/ito-soft-design/escalator"
   spec.license       = "MIT"
 
   spec.add_dependency "thor"

data/exe/escalator

@@ -1,3 +1,28 @@
 #!/usr/bin/env ruby
 
+# 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 "escalator"
+
+Escalator::CLI.start

data/lib/escalator/asm.rb

@@ -35,7 +35,7 @@ module Escalator
       @endian = endian || BIG_ENDIAN
       @lines = []
       address = 0
-      source.each_line do | line|
+      source.each_line do |line|
         @lines << AsmLine.new(line, address, @endian)
         address = @lines.last.next_address
       end
@@ -106,18 +106,21 @@ module Escalator
       OPERAND_TYPE_TYPE_AND_NUMBER_NUMBER = 2
 
       def parse
-        a = line.split(/\s+/)
+        /([^#]*)/ =~ line
+        a = $1.split(/\s+/)
         mnemonic, operand1, operand2 = a
-        @codes << encode_mnemonic(mnemonic) if mnemonic
-        case operand_type(mnemonic)
-        when OPERAND_TYPE_TYPE_AND_NUMBER
-          @codes += parse_type_and_number(operand1)
+        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/, /OR[^B]?$/, /OUT/, "SET", "RST", "PLS", "PLF", "FF", /SF(L|R)/
+        when /LD/, /AND/, /ANI/, /OR[^B]?$/, /OUT/, "SET", "RST", "PLS", "PLF", "FF", /SF(L|R)/
           OPERAND_TYPE_TYPE_AND_NUMBER
         else
           OPERAND_TYPE_NONE
@@ -131,7 +134,7 @@ module Escalator
 |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|MPD|MPP| |
+|04|OUT|OUTI|MPS|MRD|MPP| |
 |05|SET|RST|PLS| |PLF||
 |06|FF||| |||
 |07|

data/lib/escalator/cli.rb

@@ -31,10 +31,19 @@ module Escalator
 
     desc "create", "Create a new project"
     def create(name)
-      template_path = File.join(Escalator_root, "template", "escalator")
+      if File.exist? name
+        puts "ERROR: #{name} already exists."
+        exit -1
+      end
+      root_dir = File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
+      template_path = File.join(root_dir, "template", "escalator")
       cp_r template_path, name
-      temlate_plc_path = File.join(Escalator_root, "plc")
+      temlate_plc_path = File.join(root_dir, "lib", "plc")
       cp_r temlate_plc_path, name
+      %w(plc.rb emulator).each do |fn|
+        rm_r File.join(name, "plc", fn)
+      end
+      puts "#{name} was successfully created."
     end
 
   end

data/lib/escalator/config.rb

@@ -22,51 +22,74 @@
 # 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'
+require 'json'
+require 'protocol/protocol'
 
 include Escalator::Protocol::Mitsubishi
+include Escalator::Protocol::Keyence
+include Escalator::Protocol::Emulator
 
 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)
+    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"}
-      @config = options.merge default
+      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 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
+    def [] key
+      @config[key]
     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
+    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 = EscalatorConfigTarget.new h
+          @targets[name] = target
+        end
       end
+      target
     end
 
     def method_missing(name, *args)