remotedroid 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b788429e24f18de3a9237abe1fb9d8ba73ddb252edb59caa63b99fa9be986fad
-  data.tar.gz: 5257691864646241e82b92eeece3139c01ca743e1d4c13e49675f441fb5a734d
+  metadata.gz: dd7b7c4614e48123ecdc155abc68d996445d62d997df99dc65fe2969b9260c79
+  data.tar.gz: a4de25cf022d6bdaacc221f9b986a0244e1ea8b5faad38f151713825417b004c
 SHA512:
-  metadata.gz: dc5aee582390fe67b13e0e69876207292ab4b0892761bb55fea80826bbf5bf62515118decd47815d5ff00b28b2dd25f8179a74e3ddf2d4a02a6ee5c90c662711
-  data.tar.gz: 0c1fabdaa87e9907f4d79b1fb68285c1f6b7190393daffedfb362436628badfbf0f0c14a8da8d46869197d861f377ad02b7b0bae2681aa3a796d88f7346fd45b
+  metadata.gz: 0467d4f2441f460e6428ba1457637643fc707ec1f6c4aeb66e15f7d8cc75f2fec4284915d3b5f0bd3ea1b7fc9818305ed4a54b00fc07913ec5d01746b73d1ad4
+  data.tar.gz: 385c2c1d6b7a78954eadf6c01d03382cfe16986ac27c218fc1a8ac01e2350d814df6de0909bd0c084e1e36cc53398cd974bc9c49537dc24f51ea9d98621f5067

data/lib/remotedroid.rb

@@ -9,8 +9,97 @@ require 'sps-sub'
 require 'ruby-macrodroid'
 
 
+# Here's what's available so far:
+# 
+# # Triggers
+#
+# ## Sensors
+# 
+# * proximity (near)
+# * shake device
+#
+# ------------------------------------
+#
+# # Actions
+#
+# ## Date/Time
+#
+# * Say Current Time
+#
+# ## Device Actions
+#
+# * Speak text
+# * Torch toggle
+# * vibrate
+#
+# ## Location
+#
+# * Share Location
+#
+# ## Media
+#
+# * Play sound (Doda)
+#
+# ## Notification
+#
+# * Popup Message
+#
+# ## Screen
+#
+# * 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
+a: Torch toggle
+
 m: Torch
 t: webhook
 a: Torch toggle
@@ -22,11 +111,119 @@ a:
   Popup Message
     [lv=msg]
 
+m: Say current time
+t: webhook
+a: Say Current Time
+
+m: Speak text
+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: Share location
+t: 
+  WebHook
+    identifier: location
+a: Force Location Update    
+a:
+  Share Location
+    coords
+a:
+  HTTP GET
+    identifier: location
+    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
+
+m: Proximity near
+t: Proximity near
+a:
+  webhook
+    identifier: proximity
+    option: 0
+    
+m: Power connected
+t: Power Connected: Any
+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
@@ -257,7 +454,7 @@ module RemoteDroid
   class Controller
     
     attr_reader :model, :control
-    attr_accessor :title, :macros
+    attr_accessor :title, :macros, :store
 
     def initialize(mcs, model=MODEL, deviceid: nil, debug: false)
       
@@ -270,12 +467,24 @@ module RemoteDroid
       if model then
         @model = Model.new(model)
       end
+      
+      @store = {}
+      @query = Query.new(self)
 
     end
     
     def export(s)
       @macros = MacroDroid.new(s).macros
     end
+    
+    def invoke(name, 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)
     # Helpful for accessing properites in dot notation 
@@ -285,6 +494,49 @@ module RemoteDroid
       @model.op
     end
     
+    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
+      
+      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}        
+      else
+        @control.http_exec :query, {qvar: id}
+      end
+      
+      # wait for the local variable to be updated
+      # timeout after 5 seoncds
+      t = Time.now
+      
+      begin
+        sleep 1
+      end until @store[id] or Time.now > t + 5
+      
+      return {warning: 'HTTP response timeout'} if Time.now > t+5
+      
+      return @store[id]
+
+      
+    end    
+    
     def request(s)
       @model.request s
     end
@@ -318,6 +570,12 @@ module RemoteDroid
     end
     
     alias trigger_fired trigger
+    
+    def update(id, val)
+      key  = id == :location ? id : val.keys.first.to_sym
+      @store[key] = val      
+    end
+        
 
   end
 
@@ -347,6 +605,13 @@ module RemoteDroid
     end
     
   end
+  
+  class ControlHelper
+    
+    def initialize(callback)
+      @callback
+    end
+  end
 
   class Control        
     
@@ -354,16 +619,19 @@ module RemoteDroid
       
       @deviceid, @remote_url, @debug = deviceid, remote_url, debug
       @torch = Torch.new(self)
-    end
+    end    
     
     def bluetooth()
       @bluetooth
     end
     
+    def camera_flash_light(options={})
+      http_exec 'camera-flash-light', options
+    end
+        
     def http_exec(command, options={})
       
       url = "https://trigger.macrodroid.com/%s/%s" % [@deviceid, command]
-      File.write '/tmp/foo.txt', 'url : ' + url.inspect #if @debug
       
       if options and options.any? then
         h = options
@@ -375,13 +643,65 @@ module RemoteDroid
       
     end
     
+    def location(options={})
+      http_exec 'location'
+    end    
+    
+    def say_current_time(options={})
+      http_exec 'say-current-time'
+    end    
+    
+    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(obj)
+      
+      options = case obj
+      when String
+        {text: obj}
+      when Hash
+        obj
+      end
+    
+      http_exec 'speak-text', options
+    end
+    
+    alias say speak_text
+    
     def toast(options={})
-      http_exec 'toast', options
+      http_exec :toast, options
     end
     
-    def torch()
-      @torch
+    def torch(options={})
+      http_exec :torch 
     end
+    
+    def vibrate(options={})
+      http_exec :vibrate
+    end    
+
 
     def write(s)
             
@@ -392,12 +712,55 @@ 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
+
+    
+    private
+    
+    def q(id)
+      @callback.query(id)[id]
+    end
+    
+  end
+  
   class Server
     
     def initialize(s, drb_host: '127.0.0.1', deviceid: nil)
@@ -414,10 +777,91 @@ module RemoteDroid
 
   end
   
+  class Client
+    
+    def initialize(host='127.0.0.1')
+      @drb = OneDrb::Client.new host: host, port: '5777'    
+    end
+    
+    def control
+      @drb.control
+    end
+    
+    def export(s)
+      @drb.export(s)
+    end
+    
+    def invoke(s, *args)
+      @drb.invoke(s, *args)
+    end
+    
+    def query(id=nil)
+      
+      return @drb.query unless id
+      t = Time.now
+      h = @drb.query(id)
+      h.merge({latency: (Time.now - t).round(3)})
+      
+    end
+    
+    def update(key, val)
+      @drb.update key.to_sym, val
+    end
+    
+    def store()
+      @drb.store
+    end
+    
+    # -- helpful methods -----------------
+    
+    def battery()
+      query.battery
+    end
+    
+    def cell_tower()
+      query.cell_tower
+    end
+    
+    def location()
+      query.location
+    end
+    
+    def say(text)
+      control.say 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 torch()
+      control.torch
+    end    
+    
+    def vibrate
+      control.vibrate
+    end
+      
+  end
+  
   class TriggerSubscriber < SPSSub
     
     def initialize(host: 'sps.home', drb_host: '127.0.0.1')
-      @remote = OneDrb::Client.new host: drb_host, port: '5777'      
+      @remote = OneDrb::Client.new host: drb_host, port: '5777'    
       super(host: host)
     end
     
@@ -438,7 +882,7 @@ module RemoteDroid
   class ActionSubscriber < SPSSub
     
     def initialize(host: 'sps.home', drb_host: '127.0.0.1')
-      @remote = OneDrb::Client.new host: drb_host, port: '5777'      
+      @remote = OneDrb::Client.new host: drb_host, port: '5777'    
       super(host: host)
     end    
     
@@ -457,6 +901,25 @@ module RemoteDroid
     
   end
   
-  
+  class ResponseSubscriber < SPSSub
+    
+    def initialize(host: 'sps.home', drb_host: '127.0.0.1')
+      @remote = OneDrb::Client.new host: drb_host, port: '5777'    
+      super(host: host)
+    end    
+    
+    def subscribe(topic: 'macrodroid/response')
+      
+      super(topic: topic) do |msg|
+        
+        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
+      
+    end
+    
+  end  
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remotedroid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.1
 platform: ruby
 authors:
 - James Robertson
@@ -35,7 +35,7 @@ cert_chain:
   io3WPRDjULC924M5S8wbrus31v2AUjqFBPvmHr7caf/VHErWypV482xcDhWt1eif
   0G2k2ptozXcBS9odsqGUTb5N
   -----END CERTIFICATE-----
-date: 2020-10-02 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: onedrb
@@ -103,20 +103,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.12
+        version: 0.9.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.12
+        version: 0.9.5
 description: 
 email: james@jamesrobertson.eu
 executables: []