ruby-macrodroid 0.9.10 → 0.9.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfb8dbf1cb2f5796722de69e98afcb6d7058ba6faf743740a989589fd3d72fc5
-  data.tar.gz: 4b6ff72308bae85939e3eadf7776a3b56d2b8084103633dbb7754f496fb7c037
+  metadata.gz: 3ee2f540a744e2a309b3e4306a3f75c9ac3f437ebb9907d6f98cc39ea9b873fb
+  data.tar.gz: 1f8f909bcd280c7fabe301d8cbb3c8535d56901bb7986224cc0d046cccb3b61b
 SHA512:
-  metadata.gz: 722fc170955c3ee925821859e87c3380b5769db34081c8318ee043218e2bb36ae43e104d6c701238ef887405c30c8d05ab3cba32a040e6430392bc60dd6dbce1
-  data.tar.gz: 2343b75872d051e055d3dd6955dcf03c7c236ef5f77e1b43b5618515b8f0170728878336fe8a2aed5eac51ddce9361c751f3d9170418ee289d2e5522b18ff472
+  metadata.gz: 045fb9a42206777def57c23a89ec1aaccb2dac969b44f2b0fc388885e14a7ce8c1a6f093451237dcbfe8e2287cc3395033506853da6dca94706e368704df66ae
+  data.tar.gz: fc65220be3fd9e7265b6bfcdf194735c831e02fcb3b6c8e158d6e24cde83cbbbcfbb1547cd4932a0a96ba79f552d9134690dc1e91fdd0405751a6d6c41e382f9

data/lib/ruby-macrodroid.rb

@@ -603,4 +603,7 @@ require 'ruby-macrodroid/base'
 require 'ruby-macrodroid/triggers'
 require 'ruby-macrodroid/actions'
 require 'ruby-macrodroid/constraints'
+require 'ruby-macrodroid/triggersnlp'
+require 'ruby-macrodroid/actionsnlp'
+require 'ruby-macrodroid/constraintsnlp'  
 require 'ruby-macrodroid/macro'

data/lib/ruby-macrodroid/actions.rb

@@ -32,6 +32,30 @@
 #  
 
 
+APPS = {
+  'AutoBoy' => 'com.happyconz.blackbox',
+  'Amazon Alexa' => 'com.amazon.dee.app',
+  'Brave' => 'com.brave.browser',
+  'Camera' => 'com.google.android.camera',
+  'Cast to TV' => 'cast.video.screenmirroring.casttotv',
+  'File Manager' => 'com.alphainventor.filemanager',
+  'Firefox' => 'org.mozilla.firefox',
+  'Google Chrome' => 'com.google.android.chrome',
+  'Chrome' => 'com.google.android.chrome',
+  'Google Home' => 'com.google.android.apps.chromecast.app',  
+  'Google Play Music' => 'com.google.android.music',
+  'MacroDroid' => 'com.arlosoft.macrodroid',
+  'QuickEdit Text Editor Pro' => 'com.rhmsoft.edit.pro',
+  'QR & Barcode Reader' => 'com.teacapps.barcodescanner',
+  'Settings' => 'com.google.android.settings',
+  'tinyCam PRO' => 'com.alexvas.dvr.pro',
+  'Tor Browser' => 'org.torproject.torbrowser',
+  'VLC' => 'org.videolan.vlc',
+  'WiFi FTP Server' => 'com.medhaapps.wififtpserver',
+  'YouTube' => 'com.google.android.youtube'
+}
+
+
 class Action < MacroObject
   using ColouredText
   using Params
@@ -888,8 +912,17 @@ end
 #
 class SayTimeAction < DateTimeAction
 
-  def initialize(h={})
-
+  def initialize(obj=nil)
+    
+    h = if obj.is_a? Hash then
+      obj
+    elsif obj.is_a? Array
+      
+      e, macro = obj      
+      {:'12_hour' => e.text('item/description').to_s[/^\d+/] == '12'}
+      
+    end 
+    
     options = {
       :'12_hour' => true
     }
@@ -910,7 +943,9 @@ class SayTimeAction < DateTimeAction
   end
   
   def to_s(colour: false, indent: 0)
-    'Say Current Time'
+    @s = 'Say Current Time'
+    @s += "\n%s hour clock" % (@h[:'12_hour'] ? '12' : '24')
+    super()
   end  
 
 end
@@ -1656,9 +1691,18 @@ class ClearLogAction < LoggingAction
 end
 
 
+class MacroDroidAction < Action
+  
+  def initialize(h={})
+    super(h)
+    @group = 'macrodroid'
+  end
+  
+end
+
 # MacroDroid Specific
 #
-class CancelActiveMacroAction < Action
+class CancelActiveMacroAction < MacroDroidAction
   
   def initialize(h={})
     
@@ -1682,7 +1726,7 @@ end
 
 # MacroDroid Specific
 #
-class ConfirmNextAction < Action
+class ConfirmNextAction < MacroDroidAction
   
   def initialize(h={})
     
@@ -1706,7 +1750,7 @@ class ConfirmNextAction < Action
   
 end
 
-class DisableMacroAction < Action
+class DisableMacroAction < MacroDroidAction
   
   def initialize(obj=nil)
     
@@ -1716,17 +1760,19 @@ class DisableMacroAction < Action
       
     elsif obj.is_a? Array
       
-      e, macro = obj
+      e, macro, h2 = obj
       
       # find the macro guid for the given name
       name = e.text('item/description').to_s
       found = macro.parent.macros.find {|macro| macro.title =~ /#{name}/ }
       
-      if found then     
+      h3 = if found then     
         {macro_name: found.title, GUID: found.guid}
       else
         {macro_name: name}
       end
+      
+      h3.merge h2
 
     end      
     
@@ -1751,7 +1797,7 @@ end
 
 # MacroDroid Specific
 #
-class ExportMacrosAction < Action
+class ExportMacrosAction < MacroDroidAction
   
   def initialize(h={})
     
@@ -1773,9 +1819,61 @@ class ExportMacrosAction < Action
 end
 
 
+
+class ForceMacroRunAction < MacroDroidAction
+      
+  def initialize(obj=nil)
+    
+    h = if obj.is_a? Hash then
+    
+      obj
+      
+    elsif obj.is_a? Array
+      
+      e, macro, h2 = obj
+      
+      # find the macro guid for the given name
+      name = e.text('item/description').to_s
+      found = macro.parent.macros.find {|macro| macro.title =~ /#{name}/ }
+      
+      h3 = if found then     
+        {macro_name: found.title, GUID: found.guid}
+      else
+        {macro_name: name}
+      end
+      
+      h3.merge h2
+
+    end      
+    
+    options = {
+      guid: nil, ignore_constraints: true, 
+      macro_name: "", use_off_status: false, 
+      user_prompt_title: "Run Macro"      
+    }
+    super(options.merge h)
+    
+  end  
+  
+  def invoke()
+    super(macro_name: @h[:macro_name])
+  end
+  
+  def to_s(colour: false, indent: 0)
+    
+    @s = 'Macro Run'# + @h.inspect
+    @s += "\n" + @h[:macro_name]
+    super()
+    
+  end
+  
+  alias to_summary to_s
+  
+end
+
 # MacroDroid Specific
 #
-class SetVariableAction < Action
+class SetVariableAction < MacroDroidAction
   using ColouredText
   
   def initialize(obj=nil)
@@ -1865,7 +1963,7 @@ end
 
 # MacroDroid Specific
 #
-class TextManipulationAction < Action
+class TextManipulationAction < MacroDroidAction
   
   def initialize(h={})
     
@@ -1908,7 +2006,7 @@ end
 
 
 
-class PauseAction < Action
+class PauseAction < MacroDroidAction
   
   def initialize(h={})
     
@@ -1948,6 +2046,62 @@ end
 
 # Category: Media
 #
+
+
+# note: to find a package id from an App name, try searching for the name on 
+#       the Google Play Store and the id will be returned in the URL once the 
+#       correct app has been clicked. e.g.
+#       https://play.google.com/store/apps/details?id=com.google.android.music
+#
+class ControlMediaAction < MediaAction
+
+  def initialize(obj=nil)
+
+    h = if obj.is_a? Hash then
+      obj
+    elsif obj.is_a? Array
+      
+      e, macro = obj      
+      s = e.text('item/description').to_s
+      app = s[/Simulate Media Button \(([^\)]+)/,1]
+      
+      if app then        
+        
+        {
+          application_name: app,  package_name: APPS[app], 
+          simulate_media_button: true
+        }
+        
+      else
+        {}
+      end
+    end 
+    
+    options = {
+      application_name: "Google Play Music", option: "Play/Pause", 
+      package_name: "com.google.android.music", 
+      send_media_player_commands: false, 
+      simulate_media_button: true,
+    }
+
+    super(options.merge h)
+
+  end
+
+  def to_s(colour: false, indent: 0)
+    
+    @s = 'Media ' + @h[:option] #+ @h.inspect
+    
+    if @h[:simulate_media_button] then
+      @s +=  "\nSimulate Media Button (%s)" % @h[:application_name]
+    end
+    
+    super()
+  end
+
+  alias to_summary to_s
+end
+
 class RecordMicrophoneAction < MediaAction
 
   def initialize(h={})

data/lib/ruby-macrodroid/actionsnlp.rb

@@ -0,0 +1,262 @@
+#!/usr/bin/env ruby
+
+# file: actionsnlp.rb
+
+
+class ActionsNlp
+  include AppRoutes
+
+  def initialize(macro=nil)
+
+    super()
+
+    params = {macro: macro}
+    actions(params)
+
+  end
+
+  def actions(params)
+    
+    # -- Conditions/Loops ---------------------------------------------
+    #
+    
+    get /else if (.*)/i do
+      [ElseIfConditionAction, {}]
+    end        
+    
+    #e.g a: if Airplane mode enabled
+    #
+    get /if (.*)/i do
+      [IfConditionAction, {}]
+    end    
+    
+    get /else/i do
+      [ElseAction, {}]
+    end    
+    
+    get /End If/i do
+      [EndIfAction, {}]
+    end          
+    
+    
+    # -- Connectivity ------------------------------------------------------
+    
+    get /^(Enable|Disable) HotSpot/i do |state|
+      enable, state = if state.downcase == 'enable' then
+        [true, 0]
+      else
+        [false, 1]
+      end
+      [SetHotspotAction, {turn_wifi_on: enable, state: state }]
+    end   
+    
+    # e.g. message popup: hello world!
+    get /^(?:message popup|popup message): (.*)/i do |msg|
+      [ToastAction, {msg: msg}]
+    end
+
+    # e.g. Popup Message 'hello world!'
+    get /^Popup[ _]Message ['"]([^'"]+)/i do |msg|
+      [ToastAction, {msg: msg}]
+    end
+    
+    # e.g. Popup Message\n  hello world!
+    get /^Popup Message\n\s+(.*)/im do |msg|
+      [ToastAction, {msg: msg}]
+    end    
+            
+    # e.g. Popup Message
+    get /^Popup Message$/i do
+      [ToastAction, {}]
+    end    
+    
+    # e.g. say current time
+    get /^say current[ _]time/i do
+      [SayTimeAction, {}]
+    end    
+    
+    get /^Torch :?(.*)/i do |onoffstate|
+      state = %w(on off toggle).index onoffstate.downcase
+      [CameraFlashLightAction, {state: state}]
+    end    
+    
+    get /^Take Picture/i do
+      [TakePictureAction, {}]
+    end
+    
+    get /^take_picture/i do
+      [TakePictureAction, {}]
+    end           
+    
+    # -- DEVICE ACTIONS ------------------------------------------------------
+    
+    get /^Speak text \(([^\)]+)\)/i do |text|
+      [SpeakTextAction, {text: text}]
+    end           
+    
+    get /^Speak text ['"]([^'"]+)/i do |text|
+      [SpeakTextAction, {text: text}]
+    end         
+    
+    get /^Speak text$/i do |text|
+      [SpeakTextAction, {}]
+    end     
+    
+    get /^Vibrate \(([^\)]+)/i do |pattern|
+      [VibrateAction, {pattern: pattern}]
+    end     
+    
+    get /^Vibrate$/i do |pattern|
+      [VibrateAction, {pattern: 'short buzz'}]
+    end       
+    
+    # e.g. Display Notification: Hi there: This is the body of the message
+    get /^Display Notification: ([^:]+): [^$]+$/i do |subject, text|
+      [NotificationAction, {subject: subject, text: text}]
+    end           
+    
+    
+    # e.g. Enable Wifi
+    get /^(Enable|Disable) Wifi$/i do |raw_state|
+      
+      state = raw_state.downcase.to_sym == :enable ? 0 : 1
+      [SetWifiAction, {state: state}]
+      
+    end    
+    
+    # e.g. Play: Altair
+    get /^Play: (.*)$/i do |name|
+
+      [PlaySoundAction, {file_path: name}]
+      
+    end     
+    
+    # e.g. Launch Settings
+    get /^Launch (.*)$/i do |application|
+
+      app = APPS[application] || 'com.android.' + application.downcase.split()\
+          .join('.')
+      h = {
+        application_name: application,
+        package_to_launch: app
+      }
+      [LaunchActivityAction, h]
+      
+    end
+    
+    # e.g. HTTP GET http://someurl.com/something
+    get /^HTTP GET ([^$]+)$/i do |url|
+
+      [OpenWebPageAction, url_to_open: url]
+      
+    end
+        
+    get /^HTTP GET$/i do
+
+      [OpenWebPageAction, {}]
+      
+    end    
+    
+    # e.g. webhook entered_kitchen
+    #
+    get /(?:webhook|HTTP GET) ([^$]+)$/i do |s|
+      key = s =~ /^http/ ? :url_to_open : :identifier      
+      [OpenWebPageAction, {key => s}]
+    end
+    
+    #
+    get /^WebHook \(Url\)/i do
+      [OpenWebPageAction, {}]
+    end
+    
+    # e.g. webhook entered_kitchen
+    #
+    get /^webhook$/i do
+      [OpenWebPageAction, {}, params[:macro]]
+    end
+    
+    # -- Location ---------------------------------------------------------
+    
+    get /^Force Location Update$/i do
+      [ForceLocationUpdateAction, params]
+    end    
+    
+    get /^Share Location$/i do
+      [ShareLocationAction, {}]
+    end    
+    
+    #a: Keep Device Awake Screen On Until Disabled
+    #
+    get /Keep Device Awake Screen On Until Disabled/i do
+      [KeepAwakeAction, {enabled: true, permanent: true, screen_option: 0}]
+    end
+    
+    
+    #a: Keep Device Awake Screen On 1h 1m 1s
+    #
+    get /Keep Device Awake Screen On ([^$]+)/i do |duration|
+      
+      a = duration.split.map(&:to_i)
+      secs = Subunit.new(units={minutes:60, hours:60, seconds: 60}, a).to_i
+      
+      h = {
+        permanent: true, screen_option: 0, seconds_to_stay_awake_for: secs
+      }
+      [KeepAwakeAction, h]
+    end
+    
+    get /(?:Keep Device|stay) Awake$/i do
+      [KeepAwakeAction, {}]
+    end    
+    
+    #a: Disable Keep Awake
+    #
+    get /Disable Keep Awake|stay awake off/i do
+      [KeepAwakeAction, {enabled: false, screen_option: 0}]
+    end    
+
+    
+    # -- MacroDroid Specific ------------------------------------------------
+    #
+    
+    get /^((?:En|Dis)able) Macro$/i do |rawstate|
+      state = %w(enable disable toggle).index(rawstate.downcase)
+      [DisableMacroAction, {state: state}]
+    end        
+
+    get /^Macro Run$/i do
+      [ForceMacroRunAction, {}]
+    end
+    
+    get /^Run Macro$/i do
+      [ForceMacroRunAction, {}]
+    end    
+    
+    get /^Set Variable$/i do
+      [SetVariableAction, {}]
+    end        
+
+    get /^wait (\d+) seconds$/i do |seconds|
+      [PauseAction, {delay_in_seconds: seconds.to_i}]
+    end        
+    
+    ## -- Media -----------------------------------------
+    #
+    # options: Play/Pause, Previous, Next, Play, Pause, Stop
+    #
+    get /^Media ([^$]+)$/i do |option|
+      [ControlMediaAction, {option: option}]
+    end            
+    
+    # -- Screen ------------------------------------------------
+    #
+    get /^Screen (On|Off)$/i do |state|
+      [ScreenOnAction, {screen_off: state.downcase == 'off'}]
+    end       
+
+  end
+
+  alias find_action run_route
+
+
+end