ladder_drive 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c79beb0c083c72e759e676ecdffe1172dae07ba
+  data.tar.gz: 7352398566885573d294b5f4b84473a0bcd4ad14
+SHA512:
+  metadata.gz: 84cb917f7b171e3631bc246dd9b2135b6992ef7c89de41506fc0b4a6f7f71b07d80dfa4a2c62bd81f2087eda9ed89ae28f9b8e2e2903ba72c5620c69fe56d689
+  data.tar.gz: 00a67076c5529457af230c57036964d52bf509089c10daf33cd085ca6b18f10cd114d16f6b8fdd492b7daea13814b215e6fd21ad638d10f09c73b20702fb349d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+/work/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ladder_drive.gemspec
+gemspec
+
+gem "test-unit"
+
+gem "activesupport", ">=4.2.7"

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    ladder_drive (0.3.0)
+      activesupport (>= 4.2.7)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.9.1)
+    power_assert (0.2.7)
+    rake (10.5.0)
+    test-unit (3.1.7)
+      power_assert
+    thor (0.19.4)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  activesupport (>= 4.2.7)
+  bundler (~> 1.11)
+  ladder_drive!
+  rake (~> 10.0)
+  test-unit
+
+BUNDLED WITH
+   1.14.3

data/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/README.md

@@ -0,0 +1,191 @@
+[[Japanese description is here.]](https://github.com/ito-soft-design/ladder_drive/blob/master/README_jp.md)
+
+# LadderDrive
+
+The ladder_drive is a simple abstract ladder for PLC (Programmable Logic Controller).
+
+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 the Ruby environment, please find web sites.
+
+Install LadderDrive at the command prompt.
+
+```sh
+$ gem install ladder_drive
+```
+
+[![https://gyazo.com/6f00d74612def41fb33d836275b74c24](https://i.gyazo.com/6f00d74612def41fb33d836275b74c24.gif)](https://gyazo.com/6f00d74612def41fb33d836275b74c24)
+
+# Create an LadderDrive project
+
+At the command prompt, create a new LadderDrive project.
+
+```sh
+$ ladder_drive create my_project
+$ cd my_project
+```
+
+[![https://gyazo.com/c538f66129aa425e2b1da4f478a10f52](https://i.gyazo.com/c538f66129aa425e2b1da4f478a10f52.gif)](https://gyazo.com/c538f66129aa425e2b1da4f478a10f52)
+
+Created files are consisted like the tree below.
+
+```
+.
+├── 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 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)
+
+
+## LadderDrive configuration
+
+There is a configuration file at config/plc.yml.
+Currently we support MITSUBISHI iQ-R R08CUP and the Emulator.
+You only change host to an ip address of your plc.
+
+```
+# 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)
+
+
+## LadderDrive programming
+
+LadderDrive 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/ladder_drive/wiki/mnemonic) to check mnemonic.
+
+```
+# main.esc
+# |M0|-|M1|----(M2)
+LD  M0
+AND M1
+OUT M2
+END
+```
+
+[![](http://img.youtube.com/vi/OjaSqrkWv8Q/0.jpg)](https://youtu.be/OjaSqrkWv8Q)
+
+
+# Transfer the LadderDrive program
+
+At the command prompt, use ```rake``` command to upload ladder_drive program to the plc.
+By default, the target plc is ```emulator```. Then launch the Emulator.
+
+```sh
+$ rake
+```
+
+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 LadderDrive program runs immediately after uploaded.
+
+```sh
+$ rake [target=iq-r]
+uploading build/main.hex ...
+launching emulator ...
+done launching
+done uploading
+
+  LadderDrive 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
+```
+
+If you want to turn on and off the device like pushing a button, use p command.
+
+```sh
+> p m0
+```
+
+You can describe turn on time duration after a device. The unit is sec.
+
+```sh
+> p m0 1.5
+```
+
+```
+# |M0|---(M1)
+LD  M0
+OUT M1
+```
+
+[![https://gyazo.com/565d24a35887503281a46775f6ccd747](https://i.gyazo.com/565d24a35887503281a46775f6ccd747.gif)](https://gyazo.com/565d24a35887503281a46775f6ccd747)
+
+<!-- [![](http://img.youtube.com/vi/qGbicGLB7Gs/0.jpg)](https://youtu.be/qGbicGLB7Gs) -->
+
+
+# Information related ladder_drive
+
+- [My japanese diary [ladder_drive]](http://diary.itosoft.com/?category=ladder_drive)
+- [Wiki](https://github.com/ito-soft-design/ladder_drive/wiki/)
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/README_jp.md

@@ -0,0 +1,193 @@
+# エスカレーター
+
+## 概要
+
+エスカレーターはPLC(Programmable Logic Controller)向けの抽象的なラダーです。
+どのPLCでも同じソース(できればバイナリー)で実行できる形態を目指しています。
+
+まずはニーモニックレベルで実現し、その上に分かりやすい形のプログラミングツールを用意できればと考えています。
+
+## 使い方
+
+使用するにはRubyが実行できる環境が必要です。
+Rubyの実行環境の構築はWebサイト等を検索して構築してください。
+
+### インストール
+
+gemでエスカレーターをインストールします。
+
+```sh
+$ gem install ladder_drive
+```
+
+[![https://gyazo.com/6f00d74612def41fb33d836275b74c24](https://i.gyazo.com/6f00d74612def41fb33d836275b74c24.gif)](https://gyazo.com/6f00d74612def41fb33d836275b74c24)
+
+### プロジェクト作成
+
+エスカレーターをインストールするとladder_driveコマンドが使用できる様になります。
+ladder_driveコマンドでラダーを構成するプロジェクトファイルを作ります。
+
+```sh
+$ ladder_drive create my_project
+$ cd my_project
+```
+
+[![https://gyazo.com/c538f66129aa425e2b1da4f478a10f52](https://i.gyazo.com/c538f66129aa425e2b1da4f478a10f52.gif)](https://gyazo.com/c538f66129aa425e2b1da4f478a10f52)
+
+ファイルの構成は下の様になっています。
+plc以下にエスカレーターを実行するPLCプロジェクトの雛形があります。
+現在はエミュレーターと三菱電機のiQ-RシリーズR08CPUのみの対応となっています。
+他メーカーや他の機種は今後追加する予定です。
+
+
+```
+.
+├── Rakefile
+├── asm
+│   └── main.esc
+├── config
+│   └── plc.yml
+└── plc
+    └── mitsubishi
+        └── iq-r
+            └── r08
+                ├── LICENSE
+                └── r08.gx3
+```
+
+### 通信設定
+
+#### PLCの通信設定
+
+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.10の行でPLCに設定したIPアドレスを指定するだけで接続できます。
+
+```
+# 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ファイルから生成します。
+
+main.escを編集しプログラムを作成します。
+PLC側の実装がまだ進んでいないので実行できるニーモニックはLD、OUT、AND、ORとその反転程度です。
+
+ニーモニックについては[Wiki](https://github.com/ito-soft-design/ladder_drive/wiki/mnemonic)の方を参照してください。
+
+```
+# main.esc
+# |M0|-|M1|----(M2)
+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```をしたのと同じになります。
+
+
+転送後プログラムが実行されます。
+
+```sh
+$ rake [target=iq-r]
+uploading build/main.hex ...
+launching emulator ...
+done launching
+done uploading
+
+  LadderDrive is an abstract PLC.
+  This is a console to communicate with PLC.
+
+>
+```
+
+アップロードが完了するとコンソールモードになります。
+コンソールモードではコマンドを打つ事でデバイスの読み書きができます。
+
+デバイスの値を読み取るにはrコマンドを使用します。
+下の例ではm0から8子分のデバイスを読み出します。
+
+```sh
+> r m0 8
+```
+
+デバイスに値を書き込むにはwコマンドを使用します。
+下の例ではM0からM7まで書き込んでいます。
+
+```sh
+> w m0 0 0 0 1 1 0 1 1
+```
+
+ボタンを押した様にパルス状にデバイスをオンにするにはpコマンドを使用します。
+
+```sh
+> p m0
+```
+
+オンになる時間をデバイスのあとに指定することもできます。単位は秒です。
+
+```sh
+> p m0 1.5
+```
+
+```
+# |M0|---(M1)
+LD  M0
+OUT M1
+```
+
+[![https://gyazo.com/565d24a35887503281a46775f6ccd747](https://i.gyazo.com/565d24a35887503281a46775f6ccd747.gif)](https://gyazo.com/565d24a35887503281a46775f6ccd747)
+
+<!-- [![](http://img.youtube.com/vi/qGbicGLB7Gs/0.jpg)](https://youtu.be/qGbicGLB7Gs) -->
+
+## エスカレーターに関する情報
+
+- [一往確認日記 [ladder_drive]](http://diary.itosoft.com/?category=ladder_drive)
+- [Wiki](https://github.com/ito-soft-design/ladder_drive/wiki/)
+
+## ライセンス
+
+MIT

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/test*.rb']
+  t.verbose = true
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ladder_drive"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/ladder_drive

@@ -0,0 +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 "ladder_drive"
+
+LadderDrive::CLI.start

data/ladder_drive.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ladder_drive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ladder_drive"
+  spec.version       = LadderDrive::VERSION
+  spec.authors       = ["Katsuyoshi Ito"]
+  spec.email         = ["kito@itosoft.com"]
+
+  spec.summary       = %q{The ladder_drive is a simple abstract ladder for PLC (Programmable Logic Controller). Formerly known as 'escalator'.}
+  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/ladder_drive"
+  spec.license       = "MIT"
+
+  spec.add_dependency "thor"
+  spec.add_runtime_dependency "activesupport", ">=4.2.7"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.post_install_message = <<-MESSAGE
+   ! The 'ladder_drive' gem has been deprecated and has been replaced by 'ladder_drive'.
+   ! See: https://rubygems.org/gems/ladder_drive
+   ! And: https://github.com/ito-soft-design/ladder_drive
+  MESSAGE
+end