README_jp.md in escalator-0.1.2 vs README_jp.md in escalator-0.2.0

- old
+ new

@@ -3,8 +3,110 @@ エスカレーターはPLC(Programmable Logic Controller)向けの抽象的なラダーです。 どのPLCでも同じソース(できればバイナリー)で実行できる形態を目指しています。 まずはニーモニックレベルで実現し、その上に分かりやすい形のプログラミングツールを用意できればと考えています。 +# 使い方 + +使用するには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