ladder_drive 0.6.3 → 0.6.7

data/plugins/ambient_plugin.rb

@@ -0,0 +1,155 @@
+#
+# Copyright (c) 2019 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/ambient.yml
+
+channels:
+  - channel_id: 12345
+    write_key: your_write_key
+    trigger:
+      device: M100
+      type: raise_and_fall
+      value_type: bool
+    devices:
+      d1:
+        device: D30
+        value_type: value
+      d2:
+        device: D17
+        value_type: value
+      d3:
+        device: D11
+        value_type: value
+      d4:
+        device: D22
+        value_type: value
+      d5:
+        device: D25
+        value_type: value
+  - channel_id: 12345
+    write_key: your_write_key
+      type: interval
+      interval: 60
+    devices:
+      d1:
+        device: D30
+        value_type: value
+      d2:
+        device: D17
+        value_type: value
+      d3:
+        device: D11
+        value_type: value
+      d4:
+        device: D22
+        value_type: value
+      d5:
+        device: D25
+        value_type: value
+DOC
+
+require 'ambient_iot'
+
+
+module LadderDrive
+module Emulator
+
+class AmbientPlugin < Plugin
+
+  def initialize plc
+    super #plc
+    return if disabled?
+
+    @values = {}
+    @worker_queue = Queue.new
+
+    setup
+  end
+
+  def run_cycle plc
+    return if disabled?
+    return unless config[:channels]
+
+    config[:channels].each do |channel|
+      next unless channel[:channel_id]
+      next unless channel[:write_key]
+      begin
+        next unless self.triggered?(channel)
+
+        # gether values
+        values = channel[:devices].inject({}) do |h, pair|
+          d = plc.device_by_name pair.last[:device]
+          v = d.send pair.last[:value_type], pair.last[:text_length] || 8
+          h[pair.first] = v
+          h
+        end
+
+        @worker_queue.push channel:channel, values:values
+      rescue => e
+        p e
+      end
+    end
+  end
+
+  private
+
+    def setup
+      Thread.start {
+        thread_proc
+      }
+    end
+
+    def thread_proc
+      @uploaded_at = nil
+
+      while arg = @worker_queue.pop
+        begin
+          now = Time.now
+          # ignore a request if it's requested in a 5 sec from previous request.
+          next unless @uploaded_at.nil? || (now - @uploaded_at >= 5)
+
+          channel = arg[:channel]
+          client = AmbientIot::Client.new channel[:channel_id], write_key:channel[:write_key]
+          client << arg[:values]
+          client.sync
+          @uploaded_at = now
+        rescue => e
+          p e
+        end
+      end
+    end
+
+end
+
+end
+end
+
+
+def plugin_ambient_init plc
+  @ambient_plugin = LadderDrive::Emulator::AmbientPlugin.new plc
+end
+
+def plugin_ambient_exec plc
+  @ambient_plugin.run_cycle plc
+end

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

data/plugins/config/trello.yaml.example

@@ -0,0 +1,41 @@
+# This is a sample setting for Trello plugin
+# Copy this file to trello.yaml or rename.
+
+# If you want to disable this plugin, uncomment it.
+#disable: true
+
+# Connection configuration.
+consumer_key: <%= ENV['TRELLO_CONSUMER_KEY'] %>
+consumer_secret: <%= ENV['TRELLO_CONSUMMER_SECRET'] %>
+oauth_token: <%= ENV['TRELLO_OAUTH_TOKEN'] %>
+
+events:
+
+  # Set trigger conditions
+  # You can use type raise, fall, raise_and_fall, changed, and interval.
+  - trigger:
+      device: M100
+      type: raise
+
+    # Board name
+    board_name: Floor 1
+    # List name.
+    # If you set it, move the card into this list.
+    list_name: RUNNING
+    # Card name.
+    card_name: Machine A
+
+    # color label
+    color:
+      # Add color label
+      add: green
+
+  - trigger:
+      device: M100
+      type: fall
+    board_name: Floor 1
+    list_name: STOPPING
+    card_name: Machine A
+    color:
+      # Remove color label
+      remove: green

data/plugins/ifttt_plugin.rb

@@ -76,36 +76,13 @@ class IftttPlugin < Plugin
     return if disabled?
     config[:events].each do |event|
       begin
-        triggered = false
-        case event[:trigger][:type]
-        when "interval"
-          now = Time.now
-          t = @times[event.object_id] || now
-          triggered = t <= now
-          if triggered
-            t += event[:trigger][:interval] || 300
-            @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 @values[event.object_id] == v
-            @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
+        next unless self.triggered?(event)
 
+        v = trigger_state_for(event).value
         @worker_queue.push event:event[:name], payload:event[:params].dup || {}, value:v
       rescue => e
+puts $!
+puts $@
         p e
       end
     end if config[:events]

data/plugins/plc_mapper_plugin.rb

@@ -63,18 +63,19 @@ class PlcMapperPlugin < Plugin
 
   def run_cycle plc
     return if disabled?
-    return false unless super
+    #return false unless super
     @lock.synchronize {
       # set values from plcs to ladder drive.
-      values_for_reading.each do |d, v|
+      self.values_for_reading.each do |d, v|
         plc.device_by_name(d).value = v
       end
-      values_for_reading.clear
+      self.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
+      self.values_for_writing.each do |d, v|
+        dev = plc.device_by_name(d)
+        self.values_for_writing[d] = dev.bit_device? ? dev.bool : dev.value
       end
     }
   end
@@ -110,7 +111,7 @@ class PlcMapperPlugin < Plugin
           d1 = devs.first
           d2 = devs.last
           a << k
-          a << [d1, [d2.number - d1.number + 1, 1].max]
+          a << [d1, [d2 - d1 + 1, 1].max]
         end
         Hash[*a]
       end
@@ -137,11 +138,14 @@ class PlcMapperPlugin < Plugin
             sync_with_plc protocol, read_mappings, write_mappings
             next_time += interval
           end
-          sleep next_time - Time.now
+          sleep [next_time - Time.now, 0].max
           alerted = false
-        rescue
-          puts "#{config[:description]} is not reachable." unless alerted
+        rescue => e
+          puts "#{config[:description]} is not reachable. #{e}" unless alerted
+puts $!
+puts $@
           alerted = true
+          protocol.close
         end
       end
     end
@@ -160,7 +164,7 @@ class PlcMapperPlugin < Plugin
         }
       end
 
-      # set values form ladder drive (values_for_writing) to plc
+      # set values from 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.
@@ -169,10 +173,12 @@ class PlcMapperPlugin < Plugin
         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
+          c.times do
+            # It may not get the value for the first time, set zero instead of it.
+            self.values_for_writing[src_d.name] ||= (src_d.bit_device? ? false : 0)
+            values << self.values_for_writing[src_d.name]
+            src_d = src_d.next_device
+          end
         }
         protocol[dst_d.name, c] = values
       end
@@ -189,5 +195,11 @@ def plugin_plc_mapper_init plc
 end
 
 def plugin_plc_mapper_exec plc
-  @plugin_plc_mapper.run_cycle plc
+  begin
+    @plugin_plc_mapper.run_cycle plc
+  rescue
+puts $!
+puts $@
+    plc.close
+  end
 end