ladder_drive 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4f4231540625526b7fd6fbfc169a81e03b1263b9
-  data.tar.gz: 5564a1fcdacdfa69ac431d70f47043127d492a2b
+SHA256:
+  metadata.gz: 2bd6ed103f79bb7083b861a6464f83c668dcbb5c14808d3e702cc5a4206c9c6b
+  data.tar.gz: e7c1f12717307d569f203f8c054413cf97c69e66c832247846f675f0405b9d4f
 SHA512:
-  metadata.gz: ee8830bcdcea99c2dcb5f81474b5e13458a9cf075c0cbbf13762b9c4d03825a9983ba635aa5de00c4210069ca555f1897875727804ff7016d97cd8236923cd19
-  data.tar.gz: 5a7a21040c260cee1bf3769e1fef2507e447dfba2990586bc820dba6dbc30250c1e1f20a6c0c64e268337a794d52e24c7f62a0c28cb5931b499a2eaf934aa61b
+  metadata.gz: f6b4b164bbeba262f1c57334955ea09e423662b6e63a1b502f953211df9640645731a3970316e376f4545f046a75db2c3c5a0d3705d16725dd033ce3156e3483
+  data.tar.gz: a0525951ac3a7d82a1b767806a0b59e2c5a7f95b55621e7ab7fd456689659d3f537f5c90f2baa3cc5cd618c536c66510ccb97cc2bc29b751a5b74a0e2b314518

data/.gitignore

@@ -3,7 +3,6 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/Gemfile

@@ -5,7 +5,11 @@ gemspec
 
 gem "test-unit"
 
-gem "activesupport", ">=4.2.7"
+gem "activesupport", '~> 4.2', '>= 4.2.7'
 
-gem 'pi_piper'
+gem 'pi_piper', ">=  2.0.0"
+gem "ffi", "~> 1.9.24"
 
+gem 'serialport'
+gem 'google_drive'
+gem "ruby-trello"

data/Gemfile.lock

@@ -1,49 +1,125 @@
 PATH
   remote: .
   specs:
-    ladder_drive (0.5.2)
+    ladder_drive (0.6.0)
       activesupport (~> 4.2, >= 4.2.7)
-      pi_piper
+      ffi (~> 1.9.24, >= 1.9.24)
+      pi_piper (>= 2.0.0)
       thor (~> 0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.7.1)
+    activemodel (4.2.11)
+      activesupport (= 4.2.11)
+      builder (~> 3.1)
+    activesupport (4.2.11)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.3)
+    declarative (0.0.10)
+    declarative-option (0.1.0)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
     eventmachine (1.0.9)
-    ffi (1.9.18)
-    ffi (1.9.18-x64-mingw32)
-    i18n (0.7.0)
-    json (1.8.3)
-    minitest (5.9.1)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.25)
+    google-api-client (0.21.2)
+      addressable (~> 2.5, >= 2.5.1)
+      googleauth (>= 0.5, < 0.7.0)
+      httpclient (>= 2.8.1, < 3.0)
+      mime-types (~> 3.0)
+      representable (~> 3.0)
+      retriable (>= 2.0, < 4.0)
+    google_drive (3.0.0)
+      google-api-client (>= 0.11.0, < 0.22.0)
+      googleauth (>= 0.5.0, < 1.0.0)
+      nokogiri (>= 1.5.3, < 2.0.0)
+    googleauth (0.6.7)
+      faraday (~> 0.12)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.7)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    httpclient (2.8.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    jwt (2.1.0)
+    memoist (0.16.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    multipart-post (2.0.0)
+    netrc (0.11.0)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    oauth (0.5.4)
+    os (1.0.0)
     pi_piper (2.0.0)
       eventmachine (= 1.0.9)
       ffi
-    power_assert (0.2.7)
+    power_assert (1.1.3)
+    public_suffix (3.0.3)
     rake (10.5.0)
-    test-unit (3.1.7)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    retriable (3.1.2)
+    ruby-trello (2.1.0)
+      activemodel (>= 3.2.0)
+      addressable (~> 2.3)
+      json
+      oauth (>= 0.4.5)
+      rest-client (>= 1.8.0)
+    serialport (1.3.1)
+    signet (0.11.0)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    test-unit (3.2.8)
       power_assert
-    thor (0.20.0)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    uber (0.1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
 
 PLATFORMS
   ruby
-  x64-mingw32
 
 DEPENDENCIES
-  activesupport (>= 4.2.7)
+  activesupport
   bundler (~> 1.11)
+  ffi
+  google_drive
   ladder_drive!
   pi_piper
   rake (~> 10.0)
+  ruby-trello
+  serialport
   test-unit
 
 BUNDLED WITH
-   1.15.4
+   1.16.6

data/README.md

@@ -4,12 +4,12 @@
 
 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.
+We aim to design the abstraction ladder which can 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.
+To prepare the Ruby environment, please find websites.
 
 Install LadderDrive at the command prompt.
 
@@ -19,7 +19,7 @@ $ gem install ladder_drive
 
 [![https://gyazo.com/6f00d74612def41fb33d836275b74c24](https://i.gyazo.com/6f00d74612def41fb33d836275b74c24.gif)](https://gyazo.com/6f00d74612def41fb33d836275b74c24)
 
-# Create an LadderDrive project
+# Create a LadderDrive project
 
 At the command prompt, create a new LadderDrive project.
 
@@ -30,7 +30,7 @@ $ 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.
+Created files have consisted like the tree below.
 
 ```
 .
@@ -52,8 +52,8 @@ Created files are consisted like the tree below.
 ## 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.)
+Launch one of the plc projects 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.
@@ -64,8 +64,8 @@ Then upload settings and plc program to the plc.
 ## 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.
+Currently, we support MITSUBISHI iQ-R R08CUP and the Emulator.
+You only change host to an IP address of your plc.
 
 ```
 # plc.yml
@@ -82,9 +82,9 @@ plc:                        # Beginning of PLC section.
 
 ## LadderDrive programming
 
-LadderDrive program file is located under the asm directory.
+The Ladderdrive program file is located under the asm directory.
 By default, use asm/main.esc.
-Edit it and programming.
+Edit it and programming.  
 
 Refer [Wiki](https://github.com/ito-soft-design/ladder_drive/wiki/mnemonic) to check mnemonic.
 
@@ -126,7 +126,7 @@ default:
 ```rake``` is same as ```rake target=iq-r```.
 
 
-The LadderDrive program runs immediately after uploaded.
+The LadderDrive program runs immediately after upload.
 
 ```sh
 $ rake [target=iq-r]
@@ -141,7 +141,7 @@ done uploading
 >
 ```
 
-After uploaded the program, it becomes in to console mode.
+After uploading 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.
@@ -188,9 +188,10 @@ X or Y devices are assigned to GPIOs.
 ### Installation
 
 ```sh
+$ sudo apt-get update
 $ sudo apt-get install ruby-dev
 $ sudo apt-get install libssl-dev
-$ sudo gem install ladder_drive
+$ sudo gem install ladder_drive --no-ri --no-rdoc
 ```
 
 ### Execution
@@ -198,7 +199,7 @@ $ sudo gem install ladder_drive
 ```sh
 $ ladder_drive create project
 $ cd project
-$ rake target=raspberrypi
+$ sudo rake target=raspberrypi
 ```
 
 ### I/O settings
@@ -268,6 +269,38 @@ plc["D0", 10] = [0, 1, 2, ..., 9]
 plc["D0".."D9"]   => [0, 1, 2, ..., 9]
 ```
 
+## Plugin
+
+If you want to an enhancement function Ladder drive running on Unix based machine, use a plugin.
+
+Put xxx_plugin.rb into your project's plugins directory.
+xxx is the name of the plugin. i.e.) If your plugin name is 'bar' then xxx is 'bar' . -> bar_plugin.rb  
+
+### Callbacks
+
+Ladder drive calls ```plugin_xxx_init``` function for the initialization. If you need to initialize it, to do here.  
+
+It also calls ```plugin_xxx_exec``` for execution of your plugin.
+
+### plugins
+
+Ladder drive has several plugins by default.
+If you want to use a plugin, execute below command.
+
+```
+$ ladder_drive plugin plugin_name
+```
+
+|Plugin name|description|
+|:--|:--|
+|ifttt|Launch IFTTT's Webhooks trigger service.|
+|google_drive|Writing data to Google spreadsheet.|
+|plc_mapper|Share other PLCs data with Ladder drive device.|
+|slack|Cast the data to the Slack.|
+|trello|Move the card of Trello to specified list.|
+
+
+
 # Information related ladder_drive
 
 - [My japanese diary [ladder_drive]](http://diary.itosoft.com/?category=ladder_drive)

data/README_jp.md

@@ -183,6 +183,13 @@ OUT M1
 
 <!-- [![](http://img.youtube.com/vi/qGbicGLB7Gs/0.jpg)](https://youtu.be/qGbicGLB7Gs) -->
 
+
+```warning: constant ::Fixnum is deprecated``` の表示が出る場合は次の様にしてみてください。
+
+```sh
+$ RUBYOPT="-W0" rake
+```
+
 ## Raspberry Pi
 
 Raspberry Pi上で動作させることもできます。
@@ -193,9 +200,10 @@ XとYデバイスはGPIOに割り付けます。
 OSとしてRaspbianを使用した場合は次の手順でインストールできます。
 
 ```sh
+$ sudo apt-get update
 $ sudo apt-get install ruby-dev
 $ sudo apt-get install libssl-dev
-$ sudo gem install ladder_drive
+$ sudo gem install ladder_drive --no-ri --no-rdoc
 ```
 
 この時の環境は下の通りです。
@@ -211,7 +219,7 @@ Linux raspberrypi 4.9.41+ #1023 Tue Aug 8 15:47:12 BST 2017 armv6l GNU/Linux
 ```sh
 $ ladder_drive create project
 $ cd project
-$ rake target=raspberrypi
+$ sudo rake target=raspberrypi
 ```
 
 ### I/O設定
@@ -281,6 +289,47 @@ plc["D0", 10] = [0, 1, 2, ..., 9]
 plc["D0".."D9"]   => [0, 1, 2, ..., 9]
 ```
 
+## プラグイン
+
+UnixベースのマシンでLadder Driveを実行した場合にプラグインで機能を拡張できます。  
+例えば各種センサーを読み込みLadder Driveのデバイスにセットしたり、Webサービスと連動させたりという事ができます。  
+
+プラグインを作成する場合はプロジェクにpluginsディレクトリを作成し、xxx_plugin.rbというファイル名のRubyスクリプトを作成します。xxxはプラグインの名称を示しbarプラグインならbar_plugin.rbになります。
+
+### プラグインのコールバック
+
+起動時にプラグインの初期化をするために```plugin_xxx_init```が呼び出されます。(xxxはプラグインの名称が入り、sample_plugin.rbならxxxにsampleが入ります)  
+初期が必要な場合はここで行なってください。  
+
+Ladder Driveが1サイクル実行後に```plugin_xxx_exec```を呼び出します。(xxxについては上記の通りです)  
+ここでLadder Driveデバイスへの読み書きなどを行います。  
+
+### あらかじめ用意されているプラグイン
+
+Ladder Driveでは次のプラグインがあらかじめ用意されています。  
+Ladder DriveをIoT Gateway として機能させるプラグインになります。  
+
+|名称|内容|
+|:--|:--|
+|ifttt|IFTTTのWebhooksを起動します。|
+|google_drive|Google spreadsheetにデータを書き込みます。|
+|plc_mapper|複数のPLCのデータをLadder Driveのメモリーに展開します。|
+|slack|Slackにデータの変化を記録します。|
+|trello|trelloのカードを指定のリストに移動します。|
+
+これらの用意されているプラグインをインストールするには
+
+```
+$ ladder_drive plugin plugin_name
+```
+
+plugin_nameには上記プラグインの名称を入れます。  
+指定されたプラグインがpluginsディレクトリーに作成されます。  
+
+
+それぞれのプラグインの使い方はWikiの方に記載する予定です。
+
+
 ## LadderDriveに関する情報
 
 - [一往確認日記 [ladder_drive]](http://diary.itosoft.com/?category=ladder_drive)

data/Rakefile

@@ -1,5 +1,8 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
+require 'fileutils'
+
+include FileUtils
 
 task :default => [:test]
 
@@ -7,3 +10,31 @@ Rake::TestTask.new do |t|
   t.test_files = FileList['test/**/test*.rb']
   t.verbose = true
 end
+
+namespace :doc do
+
+  desc "Make epub documentation."
+  task :epub do
+    dst_dir = "tmp/doc"
+    FileList['doc/**/*.md'].each do |src|
+      dst = dst_dir + src.gsub(/^doc/, "").gsub(/md$/, "epub")
+      mkdir_p File.dirname(dst), verbose: false
+      cmd = "pandoc -f markdown -t epub3 #{src} -o #{dst}"
+      puts `#{cmd}`
+    end
+  end
+
+=begin FIXME:It does not work on my mac.
+  desc "Make pdf documentation."
+  task :pdf do
+    dst_dir = "tmp/doc"
+    FileList['doc/**/*.md'].each do |src|
+      dst = dst_dir + src.gsub(/^doc/, "").gsub(/md$/, "pdf")
+      mkdir_p File.dirname(dst), verbose: false
+      cmd = "pandoc #{src} -o #{dst}"
+      puts `#{cmd}`
+    end
+  end
+=end
+
+end

data/doc/jp/raspberrypi.md

@@ -0,0 +1,183 @@
+# Ladder Drive
+
+Ladder Driveは仮想的なPLCです。
+Raspberry Piで動作させるとGPIOをX、Yデバイスとして制御できます。
+
+# Raspberry Pi編
+
+Ladder DriveはRaspberry Pi上で実行させることができます。
+ここではその手順を説明します。
+詳しいインストールの仕方については、別途Raspberry Piの入門書などをご覧ください。
+
+## Raspberry Piセットアップ
+
+ここでは、Raspberry PiのOSとしてメジャーなRaspbianを使用します。
+NOOBSというインストーラでインストールしていきます。
+
+### SDカードの準備
+
+[https://www.raspberrypi.org/downloads/](https://www.raspberrypi.org/downloads/)　にアクセスし、NOOBSをクリックします。
+
+![https://gyazo.com/30be6038352d507d94b8a4e83c3f305e](https://i.gyazo.com/30be6038352d507d94b8a4e83c3f305e.png)
+
+NOOBSのDonwload.zipをクリックしダウンロードします。
+
+![https://gyazo.com/b814dc957234af570526410c2ce676d1](https://i.gyazo.com/b814dc957234af570526410c2ce676d1.png)
+
+ダウンロードが完了したらzipファイルを展開します。
+そのファイルを全てフオーマット済み(FAT形式)の micro SD カードにコピーします。
+
+![https://gyazo.com/fb8ed27d51ab48172cbc9a70962cf1dc](https://i.gyazo.com/fb8ed27d51ab48172cbc9a70962cf1dc.png)
+
+
+### Raspbianのインスール
+
+micro SDカードをRaspberry Piに装着し起動します。
+キーボード、マウスをUSBポートに挿入し、HDMIケーブルでモニターかテレビに接続します。
+電源を繋いで起動します。
+
+NOBSが起動します。
+Raspbianを選択し、画面下の言語選択で日本語を選び、左上のインスールボタンを押します。
+
+![https://gyazo.com/c623af14a4dda765ea4b319f1546496a](https://i.gyazo.com/c623af14a4dda765ea4b319f1546496a.png)
+
+
+確認ダイアログが表示されるので、はいを押すとインストールが開始されます。
+
+![https://gyazo.com/1d7f34ca92d72dd0466ba9ff935c07bd](https://i.gyazo.com/1d7f34ca92d72dd0466ba9ff935c07bd.png)
+
+インストール中の画面。
+
+![https://gyazo.com/e1dc5ed11f1dfe5c95d81dc96940f290](https://i.gyazo.com/e1dc5ed11f1dfe5c95d81dc96940f290.png)
+
+### 初期設定
+
+インストールが完了するとGUI画面が表示されます。
+左上のメニューから設定 > Raspberry Piの設定を選びます。
+
+![https://gyazo.com/f0b366a941ea722fba9fee008ab07f98](https://i.gyazo.com/f0b366a941ea722fba9fee008ab07f98.jpg)
+
+この画面で必要に応じて初期設定を済ませます。
+インストール時に日本語を選択しているので、ローカリゼーションはタイムゾーンの設定くらいですみます。
+
+![https://gyazo.com/0b59ea21a4eb97a4b1a340941839ddd0](https://i.gyazo.com/0b59ea21a4eb97a4b1a340941839ddd0.jpg)
+
+
+## ladder_driveのインストール
+
+Ladder Driveのインストールはターミナルで行なっていきます。
+図の様にターミナルを起動します。
+
+![https://gyazo.com/5ab07b8875a820afd6538f7465f7d198](https://i.gyazo.com/5ab07b8875a820afd6538f7465f7d198.jpg)
+
+
+ターミナルで、以下のコマンドを入力していくとladder_driveがインストールできます。
+
+```
+$ sudo apt-get update
+$ sudo apt-get install ruby-dev
+$ sudo apt-get install libssl-dev
+$ sudo gem install ladder_drive --no-ri --no-rdoc
+```
+
+## プロジェクト作成
+
+Ladder Driveのプロジェクトを作成します。
+
+```ladder_drive create project``` コマンドでプロジェクトを作成、```cd project``` でプロジェクトディレクトリに移動します。
+
+```
+$ ladder_drive create project
+$ cd project
+```
+
+Ladder Driveでは asm/main.asm ファイルに記述されたラダープログラムを実行します。
+asm/main.asmを編集し次の様にします。
+
+```
+LD X0
+OR M0
+OUT Y0
+END
+```
+
+この例ではX0とM0のORの結果をY0に出力します。
+
+Raspberry PiではX0、Y0はGPIOに割り当てられています。
+どのGPIOに割り当てるかは confg/plc.yml ファイルで定義でき、デフォルトではGPIO4がX0、GPIO18がY0に割り当てられています。
+
+```
+  raspberrypi:
+    cpu: Raspberry Pi
+    io: # assign gpio to x and y
+      inputs:
+        x0:
+          pin: 4
+          pull: :up
+        x1:
+          pin: 17
+          pull: :up
+        x2:
+          pin: 27
+          pull: :up
+      outputs:
+        y0:
+          pin: 18
+        y1:
+          pin: 23
+        y2:
+          pin: 42
+```
+GPIO4にスイッチを配線し、GPIO18にLEDを配線します。
+
+![https://gyazo.com/ecd45a1a1cbdd71e52d79604bed05ba9](https://i.gyazo.com/ecd45a1a1cbdd71e52d79604bed05ba9.png)
+
+
+## プロジェクト実行
+
+```sudo rake target=raspberrypi``` を実行するとプロジェクトが起動し、コンソール入力待ちになります。
+
+```
+$ sudo rake target=raspberrypi
+launching respberrypi plc ... 
+done launching
+uploading build/main.hex ...
+done uploading
+
+  LadderDrive is an abstract PLC.
+  This is a console to communicate with PLC.
+
+> 
+```
+
+wコマンドにてデバイスの書き込みができます。
+```w m0 1``` と入力するとM0がONになります。
+main.asmでプログラミングした内容では、M0がONになるとY0もONになり、LEDが点灯します。
+```w m0 0``` と入力すると消灯します。
+
+```
+> w m0 1
+> w m0 0
+```
+
+main.asmでプログラミングした内容ではX0がONになってもY0がONになります。
+X0はGPIO4のことですから、スイッチを押すとLEDが点灯します。
+離すと消灯します。
+
+
+## サービスとして Ladder Drive を起動
+
+電源投入でLadder Driveが起動する様にサービスとして立ち上げることができます。 Ladder Driveプロジェクのディレクトリで以下のコマンドを実行することでサービスを立ち上げることができます。
+
+```
+$ sudo rake service:install
+$ sudo rake service:enable
+$ sudo rake service:start
+```
+
+## デモ
+
+Ladder Driveの動画をYouTubeにアプロードしています。
+スイッチを押すとLEDが点灯する様子が見れます。
+
+https://youtu.be/UBhSaRNp_gM

data/ladder_drive.gemspec

@@ -16,7 +16,8 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'thor', '~> 0'
   spec.add_runtime_dependency 'activesupport', '~> 4.2', '>= 4.2.7'
-  spec.add_runtime_dependency 'pi_piper'
+  spec.add_runtime_dependency 'ffi', '~> 1.9.24', '>= 1.9.24'
+  spec.add_runtime_dependency 'pi_piper', '~> 2.0', '>= 2.0.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"