remotedroid 0.3.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71e486b66042dfefbfff3717043ded61f7847043a4afc37f1bd7b215076e280b
-  data.tar.gz: e7dee07206e7351a472fd9fb5c767979f7350f65630c7e1161dd7a14d1349347
+  metadata.gz: 4599f668ded4ccead69bcab55ac94e081027b1054b4053ee2cb2f142303a7b01
+  data.tar.gz: cdbcb98bab0dd3df0d8252892ce5c44c7ed26332803a89292357b04f2f26a9e4
 SHA512:
-  metadata.gz: '08933909445d0ec11a57c9f3006ac9874db4a48d21602a56993505f6c5350acc566a4fb4171e9e2423bd41c2957f6ae5be8294c51f4551808d71f277b1aab2b1'
-  data.tar.gz: 1b48179921c54abd6ad3d112c277133352a3496be7f092709f15463e5ced3418307d93b1aec0edc18167b16677541bea563c2116e8d0068a0becd2a365edc5dd
+  metadata.gz: 636856536a64d87445c01d3e2b320ccf0fbfed713a6ba4384a19947b182f33bee281a6ae1e191237ed5f74e0995c6460f21108cb4a578b6ea406ecab0921b0c9
+  data.tar.gz: a650ca4d116ccba5251cd1e9f489587d8ebd5f33c7e8c106a8e59c0817187511d26d2d01aac92d88b27ee0efb07b9cad9eb4a6d7da0abace184f174550a3762e

data/lib/remotedroid.rb

@@ -13,6 +13,10 @@ require 'ruby-macrodroid'
 # 
 # # Triggers
 #
+# ## Device Events
+#
+# * screen on
+#
 # ## Sensors
 # 
 # * proximity (near)
@@ -22,6 +26,14 @@ require 'ruby-macrodroid'
 #
 # # Actions
 #
+# ## Camera/Photo
+#
+# * Take Picture
+#
+# ## Connectivity
+#
+# * Enable HotSpot
+#
 # ## Date/Time
 #
 # * Say Current Time
@@ -30,17 +42,72 @@ require 'ruby-macrodroid'
 #
 # * Speak text
 # * Torch toggle
+# * vibrate
 #
 # ## Location
 #
 # * Share Location
 #
+# ## Media
+#
+# * Play sound (Doda)
+#
 # ## Notification
 #
 # * Popup Message
 #
+# ## Screen
+#
+# * Keep Device Awake
+# * Screen On
+#
+
+# Variables which can be queried
+#
+# Description                         Variable
+# -------------------                 ----------------
+# Foreground app name                 :fg_app_name
+# Foreground app package              :fg_app_package
+# Current Brightness                  :current_brightness
+# Screen timeout (seconds)            :screen_timeout
+# Current battery %                   :battery
+# Battery temp °C                     :battery_temp
+# Power (On/Off)                      :power
+# Clipboard text                      :clipboard
+# Current IP address                  :ip
+# Wifi SSID                           :ssid
+# Wifi signal strength                :wifi_strength
+# System time                         :system_time
+# IMEI                                :imei
+# Cell Id                             :cell_id
+# Last known location (lat,lon)       :last_loc_latlong
+# Last known location (altitude)      :last_loc_alt
+# Last known location (link)          :last_loc_link
+# Last known location (time)          :last_loc_age_timestamp
+# Last known location (kmh)           :last_loc_speed_kmh
+# Last known location (mph)           :last_loc_speed_mph
+# Current Volume (Alarm)              :vol_alarm
+# Current Volume (Media / Music)      :vol_music
+# Current Volume (Ringer)             :vol_ring
+# Current Volume (Notification)       :vol_notif
+# Current Volume (System Sounds)      :vol_system
+# Current Volume (Voice Call)         :vol_call
+# Current Volume (Bluetooth Voice)    :vol_bt_voice
+# Device name                         :device_name
+# Device uptime                       :uptime_secs
+# Device manufacturer                 :device_manufacturer
+# Device model                        :device_model
+# Android version                     :android_version
+# Android version (SDK Level)         :android_version_sdk
+# Storage total (external)            :storage_external_total
+# Storage free (external)             :storage_external_free
+# Storage total (internal)            :storage_internal_total
+# Storage free (internal)             :storage_internal_free
 
 
+# The macros below are exported to JSON format as a file which is imported into
+# the Android device running MacroDroid.
+
 RD_MACROS =<<EOF
 m: Camera flash light
 t: webhook
@@ -66,6 +133,50 @@ v: text
 t: webhook
 a: speak text ([lv=text])
 
+m: vibrate
+t: webhook
+a: vibrate
+
+m: play doda
+t: webhook
+a: play: Doda
+
+m: Screen
+v: on: false
+t: WebHook
+a:
+  If on = True
+    Screen On
+  Else
+    Screen Off
+  End If
+
+m: Hotspot
+v: enable: false
+t: WebHook
+a:
+  If enable = True
+    Enable Hotspot
+  Else
+    Disable Hotspot
+  End If
+
+m: Take Picture
+t: webhook
+a:
+  Take Picture
+    Rear Facing
+a: wait 2 seconds
+a: webhook
+
+m: stay awake
+t: webhook
+a: stay awake
+
+m: stay awake off
+t: webhook
+a: stay awake off
+
 m: Share location
 t: 
   WebHook
@@ -80,6 +191,47 @@ a:
     coords: [lv=coords]
     type: query
 
+m: query
+t: WebHook
+v: qvar
+a:
+  Set Variable
+    var: [[lv=qvar]]
+a:    
+  HTTP GET
+    [lv=qvar]: [lv=var]
+
+m: query setting system
+t: WebHook
+v: qvar
+a:
+  Set Variable
+    var: [setting_system=[lv=qvar]]
+a:    
+  HTTP GET
+    [lv=qvar]: [lv=var]    
+    
+m: query setting global
+t: WebHook
+v: qvar
+a:
+  Set Variable
+    var: [setting_global=[lv=qvar]]
+a:    
+  HTTP GET
+    [lv=qvar]: [lv=var]    
+    
+m: query setting secure
+t: WebHook
+v: qvar
+a:
+  Set Variable
+    var: [setting_secure=[lv=qvar]]
+a:    
+  HTTP GET
+    [lv=qvar]: [lv=var]    
+    
+        
 m: shake device
 t: shake device
 a: webhook
@@ -90,9 +242,30 @@ a:
   webhook
     identifier: proximity
     option: 0
+    
+m: Power connected
+t: Power Connected: Any
+a: webhook
+
+m: screen on off
+t: screen on
+a: webhook
 
 EOF
 
+=begin
+m: Screen
+v: on: true
+t: WebHook
+a:
+  If on = true
+    Screen On
+  Else
+    Screen Off
+  End If
+
+=end
+
 module RemoteDroid
 
   class Model
@@ -338,6 +511,7 @@ module RemoteDroid
       end
       
       @store = {}
+      @query = Query.new(self)
 
     end
     
@@ -346,7 +520,12 @@ module RemoteDroid
     end
     
     def invoke(name, options={})      
-      @control.method(name.to_sym).call(options)
+      
+      if @control.respond_to? name.to_sym then
+        @control.method(name.to_sym).call(options)
+      else
+        @control.http_exec name.to_sym, options
+      end
     end
 
     # Object Property (op)
@@ -357,12 +536,35 @@ module RemoteDroid
       @model.op
     end
     
-    def query(id)
+    def query(id=nil)
+      
+      return @query unless id
       
       @store[id] = nil
+
+      sys = %i(accelerometer_rotation)      
+      
+      global = [:airplane_mode_on, :bluetooth_on, :cell_on, :device_name, \
+                :usb_mass_storage_enabled, :wifi_on]       
+      
+      secure = %i(bluetooth_name flashlight_enabled)
+
       
       # send http request via macrodroid.com API
-      @control.http_exec id
+      
+      if id.downcase.to_sym == :location then
+        @control.http_exec id
+      elsif sys.include? id
+        @control.http_exec :'query-setting-system', {qvar: id}        
+      elsif global.include? id
+        @control.http_exec :'query-setting-global', {qvar: id}
+      elsif secure.include? id
+        @control.http_exec :'query-setting-secure', {qvar: id}        
+      elsif id.downcase.to_sym == :'take-picture'
+        @control.http_exec id
+      else
+        @control.http_exec :query, {qvar: id}
+      end
       
       # wait for the local variable to be updated
       # timeout after 5 seoncds
@@ -370,9 +572,10 @@ module RemoteDroid
       
       begin
         sleep 1
-      end until @store[id] or Time.now > t + 5
+      end until @store[id] or Time.now > t + 10
+      
+      return {warning: 'HTTP response timeout'} if Time.now > t+5
       
-
       return @store[id]
 
       
@@ -412,11 +615,17 @@ module RemoteDroid
     
     alias trigger_fired trigger
     
-    def update(key, val)
-      @store[key.to_sym] = val      
+    def update(id, val)
+      
+      key  = if %i(location take-picture).include? id
+        id
+      else
+        val.keys.first.to_sym
+      end
+      
+      @store[key] = val      
     end
         
-
   end
 
   class Service
@@ -445,6 +654,13 @@ module RemoteDroid
     end
     
   end
+  
+  class ControlHelper
+    
+    def initialize(callback)
+      @callback
+    end
+  end
 
   class Control        
     
@@ -452,7 +668,7 @@ module RemoteDroid
       
       @deviceid, @remote_url, @debug = deviceid, remote_url, debug
       @torch = Torch.new(self)
-    end
+    end    
     
     def bluetooth()
       @bluetooth
@@ -461,6 +677,33 @@ module RemoteDroid
     def camera_flash_light(options={})
       http_exec 'camera-flash-light', options
     end
+    
+    def hotspot(state=nil)      
+      
+      if state then
+        http_exec 'hotspot', {enable: state == :enable} 
+      else        
+
+        def self.enable()
+          http_exec 'hotspot', {enable: true}
+        end                
+        
+        def self.on()
+          self.enable
+        end                
+        
+        def self.disable()
+          http_exec 'hotspot', {enable: false} 
+        end
+        
+        def self.off()
+          self.disable
+        end         
+        
+        self
+        
+      end
+    end    
         
     def http_exec(command, options={})
       
@@ -486,14 +729,58 @@ module RemoteDroid
     
     alias say_time say_current_time
     
+    def screen(state=nil)      
+      
+      if state then
+        http_exec 'screen', {on: state == :on} 
+      else        
+        
+        def self.on()
+          http_exec 'screen', {on: true}
+        end
+        
+        def self.off()
+          http_exec 'screen', {on: false} 
+        end
+        
+        self
+        
+      end
+    end
+    
     def share_location(options={})
       http_exec 'share-location'
     end
     
-    def speak_text(options={})
+    def speak_text(obj)
+      
+      options = case obj
+      when String
+        {text: obj}
+      when Hash
+        obj
+      end
+    
       http_exec 'speak-text', options
     end
     
+    alias say speak_text
+    
+    def stay_awake(options={})
+      http_exec 'stay-awake', options
+    end
+
+    def stay_awake_off(options={})
+      http_exec 'stay-awake-off', options
+    end
+    
+    def take_picture(options={})
+      http_exec 'take-picture', options
+    end
+    
+    alias take_photo take_picture
+
+    
     def toast(options={})
       http_exec :toast, options
     end
@@ -501,6 +788,10 @@ module RemoteDroid
     def torch(options={})
       http_exec :torch 
     end
+    
+    def vibrate(options={})
+      http_exec :vibrate
+    end    
 
 
     def write(s)
@@ -512,12 +803,58 @@ module RemoteDroid
     
     alias export write
     
-    def method_missing(method_name, *args)
+    def method_missing2(method_name, *args)
       http_exec(method_name, args.first)
     end    
     
   end
   
+  class Query
+    
+    def initialize(callback)
+      @callback = callback
+    end
+    
+    def airplane_mode_enabled?()
+      q(:airplane_mode_on).to_i > 0 
+    end
+    
+    def battery()      
+      q(:battery).to_i
+    end
+    
+    def current_brightness()      
+      q(:current_brightness).to_i
+    end
+
+    alias brightness current_brightness
+    
+    def cell_id()      
+      q(:cell_id)
+    end
+    
+    alias cell_tower cell_id
+    
+    def ip()      
+      q(:ip)
+    end    
+    
+    def location()      
+      @callback.query(:location)[:coords]
+    end
+
+    def take_picture()      
+      @callback.query(:'take-picture')
+    end
+    
+    private
+    
+    def q(id)
+      @callback.query(id)[id]
+    end
+    
+  end
+  
   class Server
     
     def initialize(s, drb_host: '127.0.0.1', deviceid: nil)
@@ -540,6 +877,10 @@ module RemoteDroid
       @drb = OneDrb::Client.new host: host, port: '5777'    
     end
     
+    def control
+      @drb.control
+    end
+    
     def export(s)
       @drb.export(s)
     end
@@ -548,8 +889,9 @@ module RemoteDroid
       @drb.invoke(s, *args)
     end
     
-    def query(id)
+    def query(id=nil)
       
+      return @drb.query unless id
       t = Time.now
       h = @drb.query(id)
       h.merge({latency: (Time.now - t).round(3)})
@@ -563,6 +905,89 @@ module RemoteDroid
     def store()
       @drb.store
     end
+    
+    # -- helpful methods -----------------
+    
+    def battery()
+      query.battery
+    end
+    
+    def cell_tower()
+      query.cell_tower
+    end
+    
+    def hotspot(state=nil)      
+      control.hotspot state
+    end    
+    
+    def location()
+      query.location
+    end
+    
+    def photo()
+      take_picture
+    end
+    
+    def say(text)
+      control.speak_text text
+    end
+    
+    def say_time()
+      control.say_time
+    end
+    
+    alias saytime say_time
+    
+    def screen(state=nil)      
+      control.screen state
+    end
+    
+    def screen_on()
+      screen :on
+    end
+    
+    def screen_off()
+      screen :off
+    end
+    
+    def stay_awake()
+      control.stay_awake
+    end
+    
+    def stay_awake_off()
+      control.stay_awake_off
+    end
+    
+    def take_picture(ftp_src: nil, fileout: '.')
+      
+      #screen.on
+      r = query.take_picture
+            
+      if ftp_src then
+        
+        # the sleep statement will be replaced in the near future, 
+        # but it's fine to demonstrate it works
+        #sleep 8         
+        
+        credentials, dir = ftp_src.match(/(ftp:\/\/[^\/]+)\/([^$]+)/).captures
+        ftp = MyMediaFTP.new(credentials)
+        ftp.cd dir
+        filename = ftp.ls.sort_by {|x| x[:ctime]}.last[:name]
+        ftp.cp filename, fileout
+        
+      end
+      
+    end   
+    
+    alias take_photo take_picture
+    
+    def torch()
+      control.torch
+    end    
+    
+    def vibrate
+      control.vibrate
+    end
       
   end
   
@@ -620,8 +1045,11 @@ module RemoteDroid
       
       super(topic: topic) do |msg|
         
-        id, json = msg.split(/:\s+/,2)
-        @remote.update id.to_sym, JSON.parse(json, symbolize_names: true)
+        json, id = msg.split(/:\s+/,2).reverse
+        
+        h = JSON.parse(json, symbolize_names: true)
+        id ||= h.keys.first
+        @remote.update id.to_sym, h
         
       end
       

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remotedroid
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.4
 platform: ruby
 authors:
 - James Robertson
@@ -35,7 +35,7 @@ cert_chain:
   io3WPRDjULC924M5S8wbrus31v2AUjqFBPvmHr7caf/VHErWypV482xcDhWt1eif
   0G2k2ptozXcBS9odsqGUTb5N
   -----END CERTIFICATE-----
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2020-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: onedrb
@@ -106,7 +106,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 0.9.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -116,7 +116,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 0.9.7
 description: 
 email: james@jamesrobertson.eu
 executables: []