ladder_converter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c46f0c84ae44923989d7908856041adfbed2fc8d
-  data.tar.gz: ee8d0b3d1e747e558ed7a892a7f1a34ba02ba1a3
+  metadata.gz: bdbf1d8ffd40e261a76df93ba59bfa11bc2d01c3
+  data.tar.gz: 374b5bb33728e8a1dc270ff7134ccdcce9d34ce5
 SHA512:
-  metadata.gz: ebeb0336ba77049f5bdc9c86a77072f702e1e7308611b884f078f374977af5a61260851a6d3d2bbb430c42ba8e0e3e7e2d59be56a9f74e856389290e21507712
-  data.tar.gz: daccf79825b546d80b48d99e4bd49637f0535d92a1edbb2a0ce302d27e8f081da6803142f001fbd8630e125b2495bc4ab74e4bcd293dcf04137ff12cd9930756
+  metadata.gz: d353c76986aa8e88cf507af7fd920b9d5a50d75076c58d1bda1e25d7c89a1284a6e882f50ee1bf127db20f2fec0f5fb3556a08e7e99c659b091e11c9a498fce4
+  data.tar.gz: fb4a6eea270bbb0f7f488e7c8ae6e521e187ba4c097bf18eae7c2cbd56466861cd938294ccb1302b1319fae08a8aaca637fb86e6850bb74796e769adda97d401

data/README.md

@@ -1,48 +1,63 @@
-# Ladder Converter
-
-The Ladder converter converts a PLC ladder program to another maker. Our first step is to convert MITSUBISHI PLCs to Keyence PLCs.  
-(MITSUBISHI FX series to Keyence KV Nano series)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'ladder_converter'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ladder_converter
-
-## Usage
-
-1. Export a mnemonic CSV file of MITSUBISHI PLC by GX Works  
-  (Now we trying FX series only.)
-2. Execute below ruby code. It generates a mnemonic file for Keyence PLC located you specified to dst_path.
-
-```
-    require 'ladder_converter'
-    include LadderConverter
-    src_path = "path_to_mitsubishi_csv_file ..."
-    dst_path = "path_to_store_keyence_mnm_file ..."
-    @converter = Mel2Kv.new src:src_path, dst:dst_path
-    @converter.save
-```
-
-3. Import the mnemonic file to KV STUDIO project.
-
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/ito-soft-design/ladder_converter.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+# Ladder Converter
+
+The Ladder converter converts a PLC ladder program to another maker. Our first step is to convert MITSUBISHI PLCs to Keyence PLCs.  
+(MITSUBISHI FX series to Keyence KV Nano series)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ladder_converter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ladder_converter
+
+## Usage
+
+### Commande
+
+1. Export a mnemonic CSV file of MITSUBISHI PLC by GX Works  
+  (Now we trying FX series only.)
+  
+2. Open a terminal. Execute ladder_converter command with source file (MITSUBISHI csv file) and target file (Keyence mnenonic file). It generates a Keyence mnemonic file.
+
+```
+    $ ladder_converter source_file target_file
+```
+
+3. Import the mnemonic file to KV STUDIO project.
+
+### Ruby script
+
+1. Export a mnemonic CSV file of MITSUBISHI PLC by GX Works  
+  (Now we trying FX series only.)
+
+2. Execute below ruby code. It generates a mnemonic file for Keyence PLC located you specified to dst_path.
+
+```
+    require 'ladder_converter'
+    include LadderConverter
+    src_path = "path_to_mitsubishi_csv_file ..."
+    dst_path = "path_to_store_keyence_mnm_file ..."
+    converter = Mel2Kv.new src:src_path, dst:dst_path
+    converter.save
+```
+
+3. Import the mnemonic file to KV STUDIO project.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ito-soft-design/ladder_converter.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/README_ja.md

@@ -0,0 +1,81 @@
+# Ladder Converter
+
+ラダーコンバーターはPLCのラダーを他メーカーのラダーに変換します。  
+最初のステップとして三菱電機製のPLCからキーエンス製のPLCのラダーに変換することを目指しています。  
+具体的にはFXシリーズからKV Nanoシリーズへの変換を試みています。
+
+## Installation
+
+Gemfileを使用している場合はGemfileに下の行を追加します。
+
+```ruby
+gem 'ladder_converter'
+```
+
+そしてbundleコマンドを実行します。
+
+    $ bundle
+
+または、gemコマンドでinstallします。
+
+    $ gem install ladder_converter
+
+## 使い方
+
+### コマンドとして使用する場合
+
+1. 三菱電機製のPLCプロジェクトをCSVファイルに書き出します。  
+  GX Works2で該当ラダーブログラムを表示し、編集メニューからCSVファイルへ書き込みを選択しCSVファイルを書き出せます。 (^1)
+  
+2. ターミナル (^2) を開きます、下の様にladder_converterに 1 で書き出したCSVファイルを指定し、次に書き出すKeyenceのニーモニックファイルの保存先を指定し実行すると変換されます。
+
+```
+    $ ladder_converter source_file target_file
+```
+
+3. KV STUDIO で 2 で生成したファイルを読み込みます。  
+  ファイルメニューからニーモニックリスト > 読出 を選択し2で保存したファイルを選択するとプロジェクトに取り込まれます。  
+  Mainという名称で取り込まれますが、同名のプログラムが既にある場合は取り込まれません。元のMainプログラムを別の名称に変更するか可能なら削除してから行ってください。
+
+### Rubyスクリプトで変換する場合
+
+1. 三菱電機製のPLCプロジェクトをCSVファイルに書き出します。  
+  GX Works2で該当ラダーブログラムを表示し、編集メニューからCSVファイルへ書き込みを選択しCSVファイルを書き出せます。(^1)  
+
+2. 下のコードを記述すると変換できます。  
+  src_pathには 1 で書き出したCSVファイルを指定します。dst_pathには書き出しすKeyenceのニーモニックファイルの保存先を指定します。
+  
+```
+    require 'ladder_converter'
+    include LadderConverter
+
+    src_path = "path_to_mitsubishi_csv_file ..."
+    dst_path = "path_to_store_keyence_mnm_file ..."
+    converter = Mel2Kv.new src:src_path, dst:dst_path
+    converter.save
+```
+
+3. KV STUDIO で 2 で生成したファイルを読み込みます。  
+  ファイルメニューからニーモニックリスト > 読出 を選択し2で保存したファイルを選択するとプロジェクトに取り込まれます。  
+  Mainという名称で取り込まれますが、同名のプログラムが既にある場合は取り込まれません。元のMainプログラムを別の名称に変更するか可能なら削除してから行ってください。
+
+## 進捗状況
+
+現在FX2プロジェクトからKV Nanoプロジェクトへの変換を試みています。  
+下のリンクにある、テストで用いたGX Works2プロジェクに含まれている基本的なラダーのみ変換可能です。  
+この中に含まれない命令が含まれている場合は変換できません。  
+
+https://github.com/ito-soft-design/ladder_converter/blob/master/test/files/src/FX2N.gxw
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ito-soft-design/ladder_converter.
+
+
+## ライセンス
+
+[MIT License](http://opensource.org/licenses/MIT)
+
+
+^1: ラベルを使わずラダーのみのプロジェクトの場合に書き出せます。  
+^2: Windowsの場合はコマンドプロンプトまたはWindows PowerShellを起動します。  

data/Rakefile

@@ -1,6 +1,9 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 require 'ladder_converter'
+require 'fileutils'
+
+include FileUtils
 
 ENV['TESTOPTS'] = "--max-diff-target-string-size=2000"
 Rake::TestTask.new(:test) do |t|
@@ -9,4 +12,18 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
+desc 'Generate exe file'
+task :genexe do
+  begin
+    mkdir_p 'tmp'
+    `ocra exe/ladder_converter --output tmp/ldconv.exe`
+  rescue
+    puts '*' * 40
+    puts "If an error occurred, try this command."
+    puts "'gem install ocra'"
+    puts '*' * 40
+    raise
+  end
+end
+
 task :default => :test

data/exe/ladder_converter

@@ -1,3 +1,42 @@
-#!/usr/bin/env ruby
-
-require "ladder_converter"
+#!/usr/bin/env ruby
+
+require "ladder_converter"
+require 'optparse'
+
+include LadderConverter
+
+@options = {ignore_unknown:true}
+
+opt = OptionParser.new do |opt|
+  opt.banner = 'Usage: ladder_converter source_file target_file'
+  opt.on('--[no-]ignore-unknown', "Skip a code if it's an unknown mnemonic or device. If set no- quit converting immediately.") {|v| @options[:ignore_unknown] = v }
+  opt.parse!(ARGV)
+end
+
+unless ARGV.size == 2
+  puts opt.help
+  exit -1
+end
+
+src_path = ARGV[0]
+dst_path = ARGV[1]
+
+unless File.exist? src_path
+  STDERR.puts "Source file #{File.basename(src_path)} is not found!"
+  exit -1
+end
+
+while File.exist? dst_path
+  print "Target file #{File.basename(dst_path)} is exist. Overwrite existing file (y/N) ? "
+  case STDIN.gets.chomp
+  when /^y$/i, /^yes$/i
+    break
+  when /^n$/i, /^no$/i
+    STDERR.puts "Abort converting!"
+    exit -1
+  end
+end
+
+
+converter = Mel2Kv.new @options.merge(src:src_path, dst:dst_path)
+converter.save

data/lib/ladder_converter/kv_code.rb

@@ -104,42 +104,46 @@ module LadderConverter
           if n
             n
           else
-            raise "Unknown mnemonic #{mnemonic}!"
+            raise UnknownCodeError, "Unknown mnemonic \"#{mnemonic}\"."
           end
         end
       end
 
       def own_device device
-        case device
-        when /^M8000$/i # 常時ON
-          "CR2002"
-        when /^M8001$/i # 常時OFF
-          "CR2003"
-        when /^([A-Z]+.+)(Z\d+)/
-          "#{$1}:#{conv_dev $2}"
-        when /^Z(\d+)$/
-          "Z#{($1.to_i + 1).to_s.rjust(2, '0')}"
-        when /^MR|^DM/i
-          device
-        when /(^M)(\d+)/i
-          n = $2.to_i
-          "MR#{n/16}#{(n%16).to_s.rjust(2, '0')}"
-        when /^X(\d+)/i
-          "R#{$1}"
-        when /^Y(\d+)/i
-          "R#{$1.to_i + 500}"
-        when /^D/i
-          device.gsub(/^D+/i, "DM")
-        when /^K\d+([A-Z]+.+)/i
-          return conv_dev $1
-        when /^K\d+$/i
-          device.gsub(/^K+/i, "#")
-        when /^H(.+)/
-          "$#{$1}"
-        when /^P(\d+)/
-          "##{$1}"
-        else
-          device
+        begin
+          case device
+          when /^M8000$/i # 常時ON
+            "CR2002"
+          when /^M8001$/i # 常時OFF
+            "CR2003"
+          when /^([A-Z]+.+)(Z\d+)/
+            "#{$1}:#{conv_dev $2}"
+          when /^Z(\d+)$/
+            "Z#{($1.to_i + 1).to_s.rjust(2, '0')}"
+          when /^MR|^DM/i
+            device
+          when /(^M)(\d+)/i
+            n = $2.to_i
+            "MR#{n/16}#{(n%16).to_s.rjust(2, '0')}"
+          when /^X(\d+)/i
+            "R#{$1}"
+          when /^Y(\d+)/i
+            "R#{$1.to_i + 500}"
+          when /^D/i
+            device.gsub(/^D+/i, "DM")
+          when /^K\d+([A-Z]+.+)/i
+            return conv_dev $1
+          when /^K\d+$/i
+            device.gsub(/^K+/i, "#")
+          when /^H(.+)/
+            "$#{$1}"
+          when /^P(\d+)/
+            "##{$1}"
+          else
+            device
+          end
+        rescue
+          raise UnknownCodeError, "Unknown device \"#{device}\"."
         end
       end
 

data/lib/ladder_converter/mel2kv.rb

@@ -8,9 +8,12 @@ class Mel2Kv
   attr_reader :converted
   attr_reader :src, :dst
 
+  attr_reader :ignore_unknown
+
   def initialize options={}
     @src = options[:src]
     @dst = options[:dst]
+    @ignore_unknown = options[:ignore_unknown]
     @codes = nil
   end
 
@@ -20,19 +23,24 @@ class Mel2Kv
 
     @codes = []
     has_end = false
-    CSV.open(@src, "rb:BOM|UTF-16:UTF-8", headers:true, skip_lines:Regexp.new(/^[^\t]+$|PC情報:/), col_sep:"\t").each_with_index do |row, l|
-      mnemonic = row["命令"]
-      device = row["I/O(デバイス)"]
-      case mnemonic
-      when ""
-        @codes.last.add_device device
-      when 'END', 'FEND'
-        unless has_end
+    CSV.open(@src, "rb:BOM|UTF-16:UTF-8", headers:true, skip_lines:Regexp.new(/^[^\t]+$|PC情報:/), col_sep:"\t").each_with_index do |row, i|
+      begin
+        mnemonic = row["命令"]
+        device = row["I/O(デバイス)"]
+        case mnemonic
+        when ""
+          @codes.last.add_device device
+        when 'END', 'FEND'
+          unless has_end
+            @codes << KvCode.new(mnemonic, [device])
+            has_end = true
+          end
+        else
           @codes << KvCode.new(mnemonic, [device])
-          has_end = true
         end
-      else
-        @codes << KvCode.new(mnemonic, [device])
+      rescue UnknownCodeError => e
+        STDERR.puts "[WARN] SKIPPED! : line #{i+(3+1)} : #{e}"
+        raise unless ignore_unknown
       end
     end
   end

data/lib/ladder_converter/plc_code.rb

@@ -31,4 +31,7 @@ module LadderConverter
 
   end
 
+  class UnknownCodeError < StandardError
+  end
+
 end

data/lib/ladder_converter/version.rb

@@ -1,3 +1,3 @@
-module LadderConverter
-  VERSION = "0.1.0"
-end
+module LadderConverter
+  VERSION = "0.1.1"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ladder_converter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Katsuyoshi Ito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,9 +78,9 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
+- README_ja.md
 - Rakefile
 - bin/console
 - bin/setup