ladder_drive 0.5.2 → 0.6.0

data/lib/plc/emulator/plc_plugins.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.
+
+dir = Dir.pwd
+$:.unshift dir unless $:.include? dir
+
+require 'active_support'
+require 'active_support/core_ext'
+
+module PlcPlugins
+
+  #def self.included(klass)
+  #  load_plugins
+  #end
+
+  private
+
+    def plugins
+      @plugins ||= []
+    end
+
+    def load_plugins
+      return unless plugins.empty?
+      seen = {}
+
+      Dir.glob("plugins/*_plugin.rb").each do |plugin_path|
+        name = File.basename plugin_path, "_plugin.rb"
+        next if seen[name]
+        seen[name] = true
+
+        require plugin_path.gsub(/\.rb$/, "")
+        plugins << name
+      end
+      init_plugins
+    end
+
+    def init_plugins
+      send_message_plugins "init", self
+    end
+
+    def exec_plugins
+      send_message_plugins "exec", self
+    end
+
+    def send_message_plugins method, arg
+      plugins.each do |plugin|
+        msg = "plugin_#{plugin}_#{method}"
+        unless arg
+          send msg if Object.respond_to?(msg, true)
+        else
+          send msg, arg if Object.respond_to?(msg, true)
+        end
+      end
+    end
+
+end
+
+module LadderDrive
+module Emulator
+
+class Plugin
+
+  attr_reader :plc
+  attr_reader :config
+
+  class << self
+
+    def devices_with_plc_from_str plc, dev_str
+      devices = dev_str.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
+    end
+
+    def device_names_with_plc_from_str plc, dev_str
+      devices_with_plc_from_str.map{|d| d.name}
+    end
+
+  end
+
+  def devices_with_plc_from_str plc, dev_str
+    self.class.devices_with_plc_from_str plc, dev_str
+  end
+
+  def device_names_with_plc_from_str plc, dev_str
+    self.class.device_names_with_plc_from_str plc, dev_str
+  end
+
+  def initialize plc
+    @config = load_config
+    @plc = plc
+  end
+
+  def name
+    @name ||= self.class.name.split(":").last.underscore.scan(/(.*)_plugin$/).first.first
+  end
+
+  def disabled?
+    config[:disable]
+  end
+
+  def run_cycle plc
+    return false unless self.plc == plc
+  end
+
+  private
+
+    def load_config
+      h = {}
+      path = File.join("config", "plugins", "#{name}.yml")
+      if File.exist?(path)
+        h = YAML.load(File.read(path))
+        h = JSON.parse(h.to_json, symbolize_names: true)
+      end
+      h
+    end
+
+end
+
+end
+end
+
+
+# @deprecated use LadderDrive::Emulator::Plugin class instead of this.
+def load_plugin_config name
+  h = {}
+  path = File.join("config", "plugins", "#{name}.yml")
+  if File.exist?(path)
+    h = YAML.load(File.read(path))
+    h = JSON.parse(h.to_json, symbolize_names: true)
+  end
+  h
+end

data/plugins/blank_plugin.rb

@@ -0,0 +1,11 @@
+# Execute it when this file was loaded.
+def plugin_blank_init plc
+  # puts your code here.
+  #puts "Blank#init"
+end
+
+# Execute it each cycle.
+def plugin_blank_exec plc
+  # puts your code here.
+  #puts "Blank#exec"
+end

data/plugins/google_drive_plugin.rb

@@ -0,0 +1,191 @@
+#
+# 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/google_drive.yml
+
+client_id: your_auth_2_0_client_id
+client_secret: your_client_secret
+refresh_token: your_refresh_token
+
+loggings:
+  - name: temperature
+    trigger:
+      device: M0
+      type: raise_and_fall
+      value_type: bool
+    columns: D0,D1,D2,D3,D4,D5,D6,D7,D8,D9,D20,M0
+    devices:
+      - device: D0-D9
+        type: value
+      - device: D20
+        type: value
+      - device: M0
+        type: bool
+    spread_sheet:
+      spread_sheet_key: 1LGiGzMUVj_NcdWRpzv9ivjtNKSWQa_0RXtK_4bch3bY
+      sheet_no: 0
+  - name: voltages
+    trigger:
+      type: interval
+      interval: 30.0
+    columns: D0,D1,D2,D3,D4,D5,D6,D7,D8,D9,D20,M0
+    devices:
+      - device: D0-D9
+        type: value
+      - device: D20
+        type: value
+      - device: M0
+        type: bool
+    spread_sheet:
+      spread_sheet_key: 1LGiGzMUVj_NcdWRpzv9ivjtNKSWQa_0RXtK_4bch3bY
+      sheet_name: Sheet2
+DOC
+
+require 'net/https'
+require 'google_drive'
+
+def plugin_google_drive_init plc
+  @plugin_google_drive_config = load_plugin_config 'google_drive'
+  return if @plugin_google_drive_config[:disable]
+
+  @plugin_google_drive_values = {}
+  @plugin_google_drive_times = {}
+  @plugin_google_drive_worker_queue = Queue.new
+
+  begin
+    # generate config file for google drive session
+    tmp_dir = File.expand_path "tmp"
+    session_path = File.join(tmp_dir, "google_drive_session.json")
+    unless File.exist? session_path
+      mkdir_p tmp_dir
+      conf =
+        [:client_id, :client_secret, :refresh_token].inject({}) do |h, key|
+          v = @plugin_google_drive_config[key]
+          h[key] = v if v
+          h
+        end
+      File.write session_path, JSON.generate(conf)
+    end
+
+    # create google drive session
+    @plugin_google_drive_session = GoogleDrive::Session.from_config(session_path)
+
+    # start worker thread
+    Thread.start {
+      plugin_google_drive_worker_loop
+    }
+  rescue => e
+    p e
+    @plugin_google_drive_session = nil
+  end
+end
+
+def plugin_google_drive_exec plc
+  return if @plugin_google_drive_config[:disable]
+  return unless @plugin_google_drive_session
+
+  @plugin_google_drive_config[:loggings].each do |logging|
+    begin
+      # check triggered or not
+      triggered = false
+      case logging[:trigger][:type]
+      when "interval"
+        now = Time.now
+        t = @plugin_google_drive_times[logging.object_id] || now
+        triggered = t <= now
+        if triggered
+          t += logging[:trigger][:interval] || 300
+          @plugin_google_drive_times[logging.object_id] = t
+        end
+      else
+        d = plc.device_by_name logging[:trigger][:device]
+        v = d.send logging[:trigger][:value_type], logging[:trigger][:text_length] || 8
+        unless @plugin_google_drive_values[logging.object_id] == v
+          @plugin_google_drive_values[logging.object_id] = v
+          case logging[:trigger][:type]
+          when "raise"
+            triggered = !!v
+          when "fall"
+            triggered = !v
+          else
+            triggered = true
+          end
+        end
+      end
+
+      next unless triggered
+
+      # gether values
+      values = logging[:devices].map do |config|
+        d1, d2 = config[:device].split("-").map{|d| plc.device_by_name d}
+        devices = [d1]
+        if d2
+          d = d1 + 1
+          devices += [d2.number - d1.number, 0].max.times.inject([]){|a, i| a << d; d += 1; a}
+        end
+        devices.map{|d| d.send config[:type], config[:length] || 8}
+      end.flatten
+      @plugin_google_drive_worker_queue.push logging:logging, values:values, time:Time.now
+    rescue => e
+      p e
+    end
+  end if @plugin_google_drive_config[:loggings]
+end
+
+def plugin_google_drive_worker_loop
+  while arg = @plugin_google_drive_worker_queue.pop
+    begin
+      logging = arg[:logging]
+      spread_sheet = @plugin_google_drive_session.spreadsheet_by_key(logging[:spread_sheet][:spread_sheet_key])
+
+      # get worksheet
+      worksheet = begin
+        if logging[:spread_sheet][:sheet_name]
+          spread_sheet.worksheet_by_title logging[:spread_sheet][:sheet_name]
+        else
+          spread_sheet.worksheets[logging[:spread_sheet][:sheet_no] || 0]
+        end
+      end
+
+      # write columns if needs
+      if worksheet.num_rows == 0
+        worksheet[1, 1] = "Time"
+        logging[:columns].split(",").each_with_index do |t, i|
+          worksheet[1, i + 2] = t
+        end
+      end
+
+      # write values
+      r = worksheet.num_rows + 1
+      worksheet[r, 1] = arg[:time]
+      arg[:values].each_with_index do |v, i|
+        worksheet[r, i + 2] = v
+      end if arg[:values]
+      worksheet.save
+    rescue => e
+      # TODO: Resend if it fails.
+      p e
+    end
+  end
+end

data/plugins/ifttt_plugin.rb

@@ -0,0 +1,134 @@
+#
+# 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/ifttt.yml
+
+web_hook_key: your_web_hook_key
+events:
+  - name: event1
+    trigger:
+      device: M0
+      type: raise_and_fall
+      value_type: bool
+    params:
+      value1: error
+      value2: unit1
+  - name: event2
+    trigger:
+      device: D0
+      value: word
+      type: changed
+    params:
+      value1: temperature
+      value2: 値2
+      value3: 値3
+  - name: event3
+    trigger:
+      device: D2
+      value: dword
+      type: interval
+      time: 10.0
+    params:
+      value1: @value
+      value2: 値2
+      value3: 値3
+DOC
+
+require 'net/https'
+
+def plugin_ifttt_init plc
+  @plugin_ifttt_config = load_plugin_config 'ifttt'
+  return if @plugin_ifttt_config[:disable]
+
+  @plugin_ifttt_values = {}
+  @plugin_ifttt_times = {}
+  @plugin_ifttt_worker_queue = Queue.new
+  Thread.start {
+    plugin_ifttt_worker_loop
+  }
+end
+
+def plugin_ifttt_exec plc
+  return if @plugin_ifttt_config[:disable]
+  return unless @plugin_ifttt_config[:web_hook_key]
+
+  @plugin_ifttt_config[:events].each do |event|
+    begin
+      triggered = false
+      case event[:trigger][:type]
+      when "interval"
+        now = Time.now
+        t = @plugin_ifttt_times[event.object_id] || now
+        triggered = t <= now
+        if triggered
+          t += event[:trigger][:interval] || 300
+          @plugin_ifttt_times[event.object_id] = t
+        end
+      else
+        d = plc.device_by_name event[:trigger][:device]
+        v = d.send event[:trigger][:value_type], event[:trigger][:text_length] || 8
+        unless @plugin_ifttt_values[event.object_id] == v
+          @plugin_ifttt_values[event.object_id] = v
+          case event[:trigger][:type]
+          when "raise"
+            triggered = !!v
+          when "fall"
+            triggered = !v
+          else
+            triggered = true
+          end
+        end
+      end
+
+      next unless triggered
+
+      @plugin_ifttt_worker_queue.push event:event[:name], payload:event[:params].dup || {}, value:v
+    rescue => e
+      p e
+    end
+  end if @plugin_ifttt_config[:events]
+end
+
+def plugin_ifttt_worker_loop
+  while arg = @plugin_ifttt_worker_queue.pop
+    begin
+      uri = URI.parse("https://maker.ifttt.com/trigger/#{arg[:event]}/with/key/#{@plugin_ifttt_config[:web_hook_key]}")
+      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)
+      payload = arg[:payload]
+      payload.keys.each do |key|
+        payload[key] = arg[:value] if payload[key] == "__value__"
+      end
+      req.set_form_data(payload)
+
+      http.request(req)
+    rescue => e
+      # TODO: Resend if it fails.
+      p e
+    end
+  end
+end

data/plugins/plc_mapper_plugin.rb

@@ -0,0 +1,186 @@
+#
+# 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/plc_mapper.yml
+
+plcs:
+  - description: Machine A-123
+    protocol: mc_protocol
+    host: 192.168.0.1
+    port: 5010
+    interval: 60
+    mapping:
+      read:
+        - plc: M1000-M1099
+          ld: M0
+        - plc: D1000-D1099
+          ld: D0
+      write:
+        - plc: M100-M199
+          ld: M1100
+        - plc: D100-D199
+          ld: D1100
+DOC
+
+module LadderDrive
+module Emulator
+
+class PlcMapperPlugin < Plugin
+
+  attr_reader :lock
+  attr_reader :values_for_reading
+  attr_reader :values_for_writing
+
+  def initialize plc
+    super #plc
+    @lock = Mutex.new
+    @values_for_reading = {}
+    @values_for_writing = {}
+    setup
+  end
+
+  def run_cycle plc
+    return false unless super
+    @lock.synchronize {
+      # set values from plcs to ladder drive.
+      values_for_reading.each do |d, v|
+        plc.device_by_name(d).value = v
+      end
+      values_for_reading.clear
+
+      # set values from ladder drive to values_for_writing.
+      # then set it to plc at #sync_with_plc
+      values_for_writing.each do |d, v|
+        values_for_writing[d] = plc.device_by_name(d).value
+      end
+    }
+  end
+
+  private
+
+    def setup
+      config[:plcs].each do |plc_config|
+        Thread.start(plc_config) {|plc_config|
+          mapping_thread_proc plc_config
+        }
+      end
+    end
+
+    def protocol_with_config config
+      begin
+        eval("#{config[:protocol].camelize}.new").tap do |protocol|
+          protocol.host = config[:host] if config[:host]
+          protocol.port = config[:port] if config[:port]
+        end
+      rescue
+        nil
+      end
+    end
+
+    def mapping_devices protocol, mappings
+      mappings.map do |h|
+        a = []
+        h.each do |k, v|
+          devs = v.split("-").map{|d| protocol.device_by_name d.strip}
+          d1 = devs.first
+          d2 = devs.last
+          a << k
+          a << [d1, [d2.number - d1.number + 1, 1].max]
+        end
+        Hash[*a]
+      end
+    end
+
+    def mapping_thread_proc config
+      protocol = protocol_with_config config
+
+      read_mappings = mapping_devices protocol, config[:mapping][:read]
+      write_mappings = mapping_devices protocol, config[:mapping][:write]
+
+      interval = config[:interval]
+      next_time = begin
+        t = Time.now.to_f
+        t = t - t % interval
+        Time.at t
+      end
+
+      loop do
+        begin
+          now = Time.now
+          if next_time <= now
+            sync_with_plc protocol, read_mappings, write_mappings
+            next_time += interval
+          end
+          sleep next_time - Time.now
+        rescue => e
+          puts e, caller
+        end
+      end
+    end
+
+    def sync_with_plc protocol, read_mappings, write_mappings
+      # set values from plc to values_for_reading.
+      read_mappings.each do |mapping|
+        src_d, c = mapping[:plc]
+        values = protocol[src_d.name, c]
+        dst_d = plc.device_by_name mapping[:ld].first.name
+        lock.synchronize {
+          values.each do |v|
+            values_for_reading[dst_d.name] = v
+            dst_d = dst_d.next_device
+          end
+        }
+      end
+
+      # set values form ladder drive (values_for_writing) to plc
+      # values_for_writing was set at run_cycle
+      # but for the first time, it's not known what device it should take.
+      # after running below, devices for need is listed to values_for_writing.
+      write_mappings.each do |mapping|
+        dst_d, c = mapping[:plc]
+        src_d = plc.device_by_name mapping[:ld].first.name
+        values = []
+        lock.synchronize {
+          # It may not get the value for the first time, set zero instead of it.
+          values_for_writing[src_d.name] ||= 0
+          values << values_for_writing[src_d.name]
+          src_d = src_d.next_device
+        }
+        protocol[dst_d.name, c] = values
+      end
+    end
+
+end
+
+end
+end
+
+
+def plugin_plc_mapper_init plc
+  @plugin_plc_mapper = LadderDrive::Emulator::PlcMapperPlugin.new plc
+end
+
+def plugin_plc_mapper_exec plc
+  @plugin_plc_mapper.run_cycle plc
+end