ladder_drive 0.5.2 → 0.6.0

data/plugins/slack_plugin.rb

@@ -0,0 +1,155 @@
+#
+# Copyright (c) 2018 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.
+
+<<-DOC
+Here is a sample configuration.
+Puts your configuration to config/plugins/slack.yml
+
+device_comments:
+  - M0: エラー0
+  - M1: エラー1
+  - M2: エラー2
+  - M10: エラー10
+
+events:
+  - webhook_url: your_web_hook_url
+    trigger:
+      type: raise_and_fall
+      value_type: bool
+    format:
+      raise: __device_comment__ が発生しました。
+      fall: __device_comment__ が解除になりました。
+    devices: M0-M2,M10
+DOC
+
+require 'net/https'
+
+def plugin_slack_init plc
+  @plugin_slack_config = load_plugin_config 'slack'
+
+  @plugin_slack_values = {}
+  @plugin_slack_times = {}
+  @plugin_slack_worker_queue = Queue.new
+
+  # collect comments
+  @plugin_slack_comments = {}
+  @plugin_slack_config[:device_comments].each do |k, v|
+    d = plc.device_by_name(k)
+    @plugin_slack_comments[d.name] = v if d
+  end if @plugin_slack_config[:device_comments]
+
+  Thread.start {
+    plugin_slack_worker_loop
+  }
+end
+
+def plugin_slack_exec plc
+  return if @plugin_slack_config[:disable]
+
+  @plugin_slack_config[:events].each do |event|
+    next unless event[:devices]
+    next unless event[:webhook_url]
+    begin
+
+      # gether values
+      devices = event[:devices].split(",").map{|e| e.split("-")}.map do |devs|
+        devs = devs.map{|d| plc.device_by_name d.strip}
+        d1 = devs.first
+        d2 = devs.last
+        d = d1
+        [d2.number - d1.number + 1, 1].max.times.inject([]){|a, i| a << d1; d1 += 1; a}
+      end.flatten
+
+      interval_triggered = false
+      now = Time.now
+      devices.each do |device|
+        triggered = false
+        v = nil
+        case event[:trigger][:type]
+        when "interval"
+          t = @plugin_slack_times[event.object_id] || now
+          triggered = t <= now
+          if triggered
+            interval_triggered = true
+            t += event[:trigger][:interval] || 300
+            @plugin_slack_times[event.object_id] = t
+          end
+          v = device.send event[:value_type], event[:trigger][:text_length] || 8
+        else
+          v = device.send event[:value_type], event[:text_length] || 8
+          unless @plugin_slack_values[device.name] == v
+            @plugin_slack_values[device.name] = v
+            case event[:trigger][:type]
+            when "raise"
+              triggered = !!v
+            when "fall"
+              triggered = !v
+            else
+              triggered = true
+            end
+          end
+        end
+
+        next unless triggered || interval_triggered
+
+        @plugin_slack_worker_queue.push event:event,
+                                        device_name:device.name,
+                                        value:v,
+                                        time: now
+      end
+    rescue => e
+      p e
+    end
+  end if @plugin_slack_config[:events]
+end
+
+def plugin_slack_worker_loop
+  while arg = @plugin_slack_worker_queue.pop
+    begin
+      event = arg[:event]
+      uri = URI.parse(event[:webhook_url])
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      req = Net::HTTP::Post.new(uri.path)
+      req["Content-Type"] = "application/json"
+
+      format = event[:format] || "__comment__ occured at __time__"
+      format = arg[:value] ? format[:raise] : format[:fall] unless format.is_a? String
+
+      device_name = arg[:device_name]
+      comment = @plugin_slack_comments[device_name] || device_name
+      value = arg[:value].to_s
+      time = arg[:time].iso8601
+
+      payload = {text:format.gsub(/__device_comment__/, comment).gsub(/__value__/, value).gsub(/__time__/, time).gsub(/__device_name__/, device_name)
+                }
+      req.body = payload.to_json
+
+      http.request(req)
+    rescue => e
+      # TODO: Resend if it fails.
+      p e
+    end
+  end
+end

data/plugins/trello_plugin.rb

@@ -0,0 +1,156 @@
+#
+# Copyright (c) 2018 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.
+
+<<-DOC
+Here is a sample configuration.
+Puts your configuration to config/plugins/trello.yml
+
+consummer_key: your_consumer_key
+consumer_secret: your_consumer_secret
+oauth_token: your_oauth_token
+
+events:
+  - trigger:
+      device: D0
+      type: changed
+      value_type: text
+      text_length: 8
+    board_name: 工程モニター
+    list_name: 工程1
+    title: __value__
+  - trigger:
+      device: D10
+      type: changed
+      value_type: text
+      text_length: 8
+    board_name: 工程モニター
+    list_name: 工程2
+    title: __value__
+DOC
+
+require 'net/https'
+require 'trello'
+
+# @see https://qiita.com/tbpgr/items/60fc13aca8afd153e37b
+
+=begin
+Dotenv.load
+
+b =  Trello::Board.all.find{|b| b.name == "工程モニター"}
+pp b.lists.map{|l| {id:l.id, name:l.name, cards:l.cards.map{|c| {id:c.id, name:c.name}}}}
+=end
+
+
+def plugin_trello_init plc
+  @plugin_trello_config = load_plugin_config 'trello'
+
+  @plugin_trello_values = {}
+  @plugin_trello_times = {}
+  @plugin_trello_worker_queue = Queue.new
+
+  @plugin_trello_configured = Trello.configure do |config|
+    config.consumer_key = @plugin_trello_config[:consumer_key]
+    config.consumer_secret = @plugin_trello_config[:consumer_secret]
+    config.oauth_token = @plugin_trello_config[:oauth_token]
+  end
+
+  Thread.start {
+    plugin_trello_worker_loop
+  }
+end
+
+def plugin_trello_exec plc
+  return if @plugin_trello_config[:disable]
+#  return unless @plugin_trello_configured
+
+  @plugin_trello_config[:events].each do |event|
+    begin
+
+      triggered = false
+      now = Time.now
+      device = nil
+
+      case event[:trigger][:type]
+      when "interval"
+        t = @plugin_trello_times[event.object_id] || now
+        triggered = t <= now
+        if triggered
+          interval_triggered = true
+          t += event[:trigger][:interval] || 300
+          @plugin_trello_times[event.object_id] = t
+        end
+      else
+        device = plc.device_by_name event[:trigger][:device]
+        v = device.send event[:trigger][:value_type], event[:trigger][:text_length] || 8
+        unless @plugin_trello_values[device.name] == v
+          @plugin_trello_values[device.name] = v
+          case event[:trigger][:type]
+          when "raise"
+            triggered = !!v
+          when "fall"
+            triggered = !v
+          else
+            triggered = true
+          end
+        end
+      end
+
+      next unless triggered
+
+      @plugin_trello_worker_queue.push event:event, device_name:device.name, value:v, time: now
+
+    rescue => e
+      p e
+    end
+  end if @plugin_trello_config[:events]
+end
+
+def plugin_trello_worker_loop
+  while arg = @plugin_trello_worker_queue.pop
+    begin
+      event = arg[:event]
+
+      board =  Trello::Board.all.find{|b| b.name == event[:board_name]}
+      next unless board
+
+      card_name = event[:card_name].dup || ""
+      card_name.gsub!(/__value__/, arg[:value] || "")
+      next if (card_name || "").empty?
+
+      list_name = event[:list_name]
+      next unless list_name
+      list = board.lists.find{|l| l.name == list_name}
+      next unless list
+
+      card = board.lists.map{|l| l.cards.map{|c| c}}.flatten.find{|c| c.name == card_name}
+      if card
+        card.move_to_list list
+      else
+        card = Trello::Card.create name:card_name, list_id:list.id
+      end
+
+    rescue => e
+      # TODO: Resend if it fails.
+      p e
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ladder_drive
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Katsuyoshi Ito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -44,20 +44,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.7
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.24
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.24
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.24
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.24
 - !ruby/object:Gem::Dependency
   name: pi_piper
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +131,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- doc/jp/raspberrypi.md
 - exe/ladder_drive
 - ladder_drive.gemspec
 - lib/ladder_drive.rb
@@ -122,6 +149,8 @@ files:
 - lib/ladder_drive/protocol/keyence/keyence.rb
 - lib/ladder_drive/protocol/keyence/kv_device.rb
 - lib/ladder_drive/protocol/keyence/kv_protocol.rb
+- lib/ladder_drive/protocol/mitsubishi/fx_device.rb
+- lib/ladder_drive/protocol/mitsubishi/fx_protocol.rb
 - lib/ladder_drive/protocol/mitsubishi/mc_protocol.rb
 - lib/ladder_drive/protocol/mitsubishi/mitsubishi.rb
 - lib/ladder_drive/protocol/mitsubishi/qdevice.rb
@@ -134,6 +163,7 @@ files:
 - lib/plc/emulator/emu_plc.rb
 - lib/plc/emulator/emu_plc_server.rb
 - lib/plc/emulator/emulator.rb
+- lib/plc/emulator/plc_plugins.rb
 - lib/plc/keyence/kv/kv-5000/DocumentWindowInfo.xml
 - lib/plc/keyence/kv/kv-5000/KvsMon.ini
 - lib/plc/keyence/kv/kv-5000/LadderDrive.mod
@@ -160,6 +190,12 @@ files:
 - lib/plc/raspberrypi/raspberrypi.rb
 - lib/plc/raspberrypi/raspberrypi_plc.rb
 - lib/plc/raspberrypi/raspberrypi_plc_server.rb
+- plugins/blank_plugin.rb
+- plugins/google_drive_plugin.rb
+- plugins/ifttt_plugin.rb
+- plugins/plc_mapper_plugin.rb
+- plugins/slack_plugin.rb
+- plugins/trello_plugin.rb
 - sample/ladder_drive/sample1.esc
 - sample/ladder_drive/sample2.esc
 - sample/ladder_drive/sample2.png
@@ -189,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: The ladder_drive is a simple abstract ladder for PLC (Programmable Logic