ladder_drive 0.6.4 → 0.6.8

data/lib/plc/emulator/emu_plc_server.rb

@@ -52,9 +52,11 @@ module Emulator
       Thread.new do
         server = TCPServer.open @port
         puts "launching emulator ... "
+        launched = false
         loop do
           Thread.start(server.accept) do |socket|
-            puts "done launching"
+            puts "done launching" unless launched
+            launched ||= true
             while line = socket.gets
               begin
                 r = @plc.execute_console_commands line

data/lib/plc/emulator/plc_plugins.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2018 ITO SOFT DESIGN Inc.
+# Copyright (c) 201 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
@@ -25,6 +25,8 @@ $:.unshift dir unless $:.include? dir
 
 require 'active_support'
 require 'active_support/core_ext'
+require 'erb'
+require 'plugin_trigger_state'
 
 module PlcPlugins
 
@@ -110,6 +112,8 @@ class Plugin
   def initialize plc
     @config = load_config
     @plc = plc
+    @device_states = {}
+    @trigger_states = {}
   end
 
   def name
@@ -124,31 +128,34 @@ class Plugin
     return false unless self.plc == plc
   end
 
+  def triggered? trigger_config
+    state = trigger_state_for trigger_config
+    state.reset
+    state.update
+    state.triggered?
+  end
+
+  def trigger_state_for trigger_config
+    @trigger_states[trigger_config.object_id] ||= PluginTriggerState.new(plc, trigger_config)
+  end
+
+
   private
 
     def load_config
       h = {}
       path = File.join("config", "plugins", "#{name}.yml")
       if File.exist?(path)
-        h = YAML.load(File.read(path))
+        erb = ERB.new File.read(path)
+        h = YAML.load(erb.result(binding))
         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
 end

data/lib/plc/emulator/plugin_trigger_state.rb

@@ -0,0 +1,152 @@
+#
+# 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'
+require 'erb'
+
+
+module LadderDrive
+module Emulator
+
+
+class PluginTriggerState
+  attr_reader :plc
+  attr_reader :config
+  attr_reader :device
+  attr_reader :value_type
+  attr_reader :value
+
+  def initialize plc, config
+    @plc = plc
+    @config = config
+    @value_type = config[:value_type]
+    @devices = {}
+    @next_trigger_times = {}
+  end
+
+  def key
+    object_id
+  end
+
+  def value
+    @value
+  end
+
+  def value= value
+    if @changed.nil?
+      @changed = @value != value
+      @raised = @changed && !!value
+      @fallen = @changed && !value
+      @value = value
+    end
+  end
+
+  def changed?
+    !!@changed
+  end
+
+  def raised?
+    !!@raised
+  end
+
+  def fallen?
+    !!@fallen
+  end
+
+  def triggered?
+    !!@triggered
+  end
+
+  def device
+    device_with_trigger(config[:triggers]&.first || config[:trigger])
+  end
+
+  def update
+    return unless @triggered.nil?
+
+    triggers = config[:triggers]
+    triggers ||= [config[:trigger]]
+
+    @triggered = false
+
+    triggers.each do |trigger|
+      case trigger[:type]
+      when "changed", "raise", "fall", "raise_and_fall"
+        device = device_with_trigger(trigger)
+        value = device.send(@value_type || :value)
+
+        # update flags
+        @changed = @value != value
+        case value
+        when true, false, nil
+          @raised = @changed && !!value
+          @fallen = @changed && !value
+        else
+          @fallen = @changed && value == 0
+          @raised = @changed && !@fallen
+        end
+        @value = value
+
+        # judgement triggered
+        case trigger[:type]
+        when "raise"
+          @triggered = true if @raised
+        when "fall"
+          @triggered = true if @fallen
+        else
+          @triggered = true if @changed
+        end
+
+      when "interval"
+        now = Time.now
+        t = @next_trigger_times[trigger.object_id] || now
+        while now >= t
+          @triggered ||= true
+          t += trigger[:interval]
+        end
+        @next_trigger_times[trigger.object_id] = t
+      else
+        @triggered = false
+      end
+    end
+    @triggered
+  end
+
+  def reset
+    @changed = nil
+    @raised = nil
+    @fallen = nil
+    @triggered = nil
+  end
+
+  def device_with_trigger trigger
+    @devices[trigger.object_id] ||= @plc.device_by_name(trigger[:device])
+  end
+
+end
+
+end
+end

data/plugins/ambient_plugin.rb

@@ -82,7 +82,6 @@ class AmbientPlugin < Plugin
     return if disabled?
 
     @values = {}
-    @times = {}
     @worker_queue = Queue.new
 
     setup
@@ -93,41 +92,10 @@ class AmbientPlugin < Plugin
     return unless config[:channels]
 
     config[:channels].each do |channel|
-      channel = channel
       next unless channel[:channel_id]
       next unless channel[:write_key]
       begin
-
-        interval_triggered = false
-        now = Time.now
-        triggered = false
-        v = nil
-        case channel[:trigger][:type]
-        when "interval"
-          t = @times[channel.object_id] || now
-          triggered = t <= now
-          if triggered
-            interval_triggered = true
-            t += channel[:trigger][:interval] || 300
-            @times[channel.object_id] = t
-          end
-        else
-          device = plc.device_by_name channel[:trigger][:device]
-          v = device.send channel[:trigger][:value_type]
-          unless @values[device.name] == v
-            @values[device.name] = v
-            case channel[:trigger][:type]
-            when "raise"
-              triggered = !!v
-            when "fall"
-              triggered = !v
-            else
-              triggered = true
-            end
-          end
-        end
-
-        next unless triggered || interval_triggered
+        next unless self.triggered?(channel)
 
         # gether values
         values = channel[:devices].inject({}) do |h, pair|

data/plugins/config/ambient.yaml.example

@@ -0,0 +1,34 @@
+# This is a sample setting for ambient plugin
+# Copy this file to ambient.yaml or rename.
+
+# If you want to disable this plugin, uncomment it.
+#disable: true
+
+# Configure ambient channels
+# Set the Ambient channel, which is to send data you want to.
+channels:
+
+  # set ambient configuration.
+  # We recommend setting write_key from an environment variable.
+  - channel_id: 12824
+    write_key: <%= ENV['AMBIENT_WRITE_KEY'] %>
+
+    # Set trigger conditions
+    # You can use type raise, fall, raise_and_fall, changed, and interval.
+    triggers:
+      - type: raise_and_fall
+        device: M100
+      - type: interval
+        interval: 60
+
+    # Set data to send, if triggered.
+    devices:
+      d1:
+        device: D10
+        value_type: value
+      d2:
+        device: D11
+        value_type: value
+      d3:
+        device: D12
+        value_type: value

data/plugins/config/google_drive.yaml.example

@@ -0,0 +1,39 @@
+# This is a sample setting for google drive plugin
+# Copy this file to google_drive.yaml or rename.
+
+# If you want to disable this plugin, uncomment it.
+#disable: true
+
+# Api configuration.
+client_id: <%= ENV['GOOGLE_CLIENT_ID'] %>
+client_secret: <%= ENV['GOOGLE_CLIENT_SECRET'] %>
+access_token: <%= ENV['GOOGLE_ACCESS_TOKEN'] %>
+refresh_token: <%= ENV['GOOGLE_REFRESH_TOKEN'] %>
+
+# Logging setting
+loggings:
+  - name: temperature
+
+    # Set trigger conditions
+    # You can use type raise, fall, raise_and_fall, changed, and interval.
+    trigger:
+      device: M0
+      type: raise_and_fall
+      value_type: bool
+
+    # Column header
+    columns: D0,D1,D2,D3,D4,D5,D6,D7,D8,D9,D20,M0
+
+    # Devices for logging
+    devices:
+      - device: D0-D9
+        type: value
+      - device: D20
+        type: value
+      - device: M0
+        type: bool
+
+    # Spreadsheet to access
+    spread_sheet:
+      spread_sheet_key: <%= ENV['GOOGLE_SPREADSHEET_KEY'] %>
+      sheet_no: 0

data/plugins/config/ifttt.yaml.example

@@ -0,0 +1,24 @@
+# This is a sample setting for ifttt plugin
+# Copy this file to ifttt.yaml or rename.
+
+# If you want to disable this plugin, uncomment it.
+#disable: true
+
+# Set webhook key of Webhooks service for IFTTT.
+# To see your webhook key, to open https://ifttt.com/maker_webhook
+# and click the Documentation link.
+# We recommend setting web_hook_key from an environment variable.
+web_hook_key: <%= ENV['IFTTT_WEBHOOK_KEY'] %>
+
+# Set trigger event of webhook.
+# Set event name to name attribute.
+# Pass values to the params to display information.
+events:
+  - name: rubyworldconference2019
+    trigger:
+      type: raise
+      device: M100
+    params:
+      value1: Abnormal temperature
+      value2: Something additional information.
+      value3: and more.

data/plugins/config/plc_mapper.yaml.example

@@ -0,0 +1,36 @@
+# This is a sample setting for Plc mapper plugin
+# Copy this file to plc_mapper.yaml or rename.
+
+# If you want to disable this plugin, uncomment it.
+#disable: true
+
+# This is a sample setting for Plc mapper plugin
+plcs:
+  - description: Machine A-123
+
+    # Set connection conditions between PLC
+    protocol: mc_protocol
+    host: 192.168.1.10
+    port: 5010
+    interval: 10
+
+    # Set address mapping.
+    mapping:
+
+      # Read from PLC to set Ladder drive.
+      # plc: PLC address area
+      # ld: Ladder drive area
+      read:
+        - plc: M1000-M1099
+          ld: M0
+        - plc: D1000-D1099
+          ld: D0
+      # Read from Ladder drive to set PLC.
+      # plc: PLC address area
+      # ld: Ladder drive area
+      write:
+        # LadderDrive address: PLC address
+        - plc: M100-M199
+          ld: M1100
+        - plc: D100-D199
+          ld: D1100

data/plugins/config/slack.yaml.example

@@ -0,0 +1,36 @@
+# This is a sample setting for Slack plugin
+# Copy this file to slack.yaml or rename.
+
+# If you want to disable this plugin, uncomment it.
+#disable: true
+
+# Define comment for a device
+device_comments:
+  M210: Full error
+  D10: Running
+
+# Event setting
+events:
+
+  # Set webhook url for IFTTT.
+  # We recommend setting web_hook_key from an environment variable.
+  - webhook_url: <%= ENV['SLACK_WEBHOOK_NOTIFICATION_URL'] %>
+
+    # Set trigger conditions
+    # You can use type raise, fall, raise_and_fall, changed, and interval.
+    trigger:
+      type: raise_and_fall
+
+    # String format to send Slack.
+    format:
+      raise: __device_comment__ has occurred at __time__ .
+      fall: __device_comment__ was reset at __time__ .
+    devices: M210
+
+  - webhook_url: <%= ENV['SLACK_WEBHOOK_URL'] %>
+    trigger:
+      type: raise_and_fall
+    format:
+      raise: Start __device_comment__ at __time__ .
+      fall: Stop __device_comment__ at __time__ .
+    devices: M100