syncsign 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c71d9ba121262edad7f9e12094cede28b97909345521b48898bc792da31070d
-  data.tar.gz: 63a4e344b54a6ee357e636c5e62e56fc33565a17561a8b616a356304f5f0d10c
+  metadata.gz: e261ff9af0745d4e8e96f7ea246dd5318a9dae6abf59572ae41ad0090d0b91d3
+  data.tar.gz: d0964bfcc113b69e72d54c7a513d3ad1156dc2ce6488fc6d2bc29ba1f9814495
 SHA512:
-  metadata.gz: d500314480cda678242c4204b88cb0275c5a2d10642922cc79e49f05850bd32a064b646d25aed15401ad56f2b8f01112ced44a676e2ce2f3e00e7ba42a0eece9
-  data.tar.gz: 5e1acd15b5443e3a5097e1e3a89f520a610efdea3c37caea5f1d328e1f1d60c3dec152bcc9532318e8e21341233c50a4f2056f7ca52fb2a2d09981b2b63b6dcf
+  metadata.gz: c9cb756b7b3e6220a23912168fcb098652c038cecb2e3f085af83b917ea74db74429bc13241787c6b4137c894b2ec402336351d9d69a282b538c24adaf79ca30
+  data.tar.gz: c8bbd89fd3d3127b36977059accc5fbf340eb4ce13bdc83c5069949c68280babeb794ce16280a4d989494611cf968838b051e721254ad293b46ac4df9bdfa377

data/README.md

@@ -29,11 +29,24 @@ Create a SyncSign Service instance using your API key (found in the SyncSign por
     template = SyncSign::Template.new(items: items)
     node.render(template: template)
 
+## Direct Rendering
+The SyncSign hubs have a simplified API that can be used, bypassing the cloud service. This can result in significant time savings (15s vs 25s) as well as less time between sending the request and the first visible change on the display. This is especially useful for the 4.2" model with buttons, as the time a user spends waiting after pressing a button can be significantly reduced.
+
+To enable direct rendering, create a file named signhubs.cfg in either the same directory as your app, the current directory, or /etc/signhubs.cfg. This file should have the following format:
+hub-serial-nbr  hub-ip  hub-apikey
+
+As an example:
+MCFEF5583A9DCA  192.168.0.50  8ab8125b-5d23-1b9a-e55e-a8b3d8c04614
+
+Once this is created, you can test it using examples/hubs.rb which should now list your hub as direct rendering capable. To enable this in your app, pass "render\_direct: true" when instantiating a new SyncSign::Service object.
+
+
 ## Examples
 
 Check out the examples/ folder for:
  * account\_info.rb - Show information about the account associated with the provided API key.
  * nodes.rb - List all nodes on the system and information about them.
+ * hubs.rb - List all hubs on the system and whether we have enough info to support direct rendering.
  * render.rb - Render a sample screen to the given node.
 
 ## Full Documentation

data/lib/syncsign/hub.rb

@@ -6,13 +6,18 @@ module SyncSign
     attr_reader :sn
     # @return [String] the friendly name of the hub.
     attr_reader :name
-    
+    # @return [String] the IP address or hostname of the hub.
+    attr_reader :addr
+    # @return [String] the API key of the hub.
+    attr_reader :apikey
+
     ##
     # Initialize a new hub object (normally only called from Service#hubs)
-    def initialize(sn: null, name: null, service: null)
+    def initialize(service: nil, sn: nil, name: nil)
       @sn = sn
       @name = name
       @service = service
+      load_hub_info
     end
     
     ##
@@ -20,6 +25,38 @@ module SyncSign
     def nodes
       SyncSign::Node::parse_collection(service: @service, nodeinfo: @service.api_call(path: "/devices/#{@sn}/nodes"))
     end
+
+
+    def direct_rendering_capable?
+      return @addr && @apikey
+    end
+
+    private
+
+    ##
+    # Load info about a hub from the config file (IP address and API key)
+    def load_hub_info
+      cfg_locations = [
+        "./signhubs.cfg",
+        "#{File::dirname($0)}/signhubs.cfg",
+        "/etc/signhubs.cfg"
+      ]
+      cfgfile = cfg_locations.find { |file| File.exist?(file) }
+      return unless cfgfile
+
+      File.open(cfgfile) do |f|
+        f.each_line do |line|
+          next if line[0] == "#"
+
+          hubinfo = line.split(/\s+/)
+          if(@sn == hubinfo[0]) then
+            @addr = hubinfo[1]
+            @apikey = hubinfo[2]
+            return true
+          end
+        end
+      end
+    end
   end
 end
 

data/lib/syncsign/node-display.rb

@@ -6,7 +6,7 @@ module SyncSign
     # Render a template to this display.
     # @param template [Template] Template to render to this display.
     def render(template: nil)
-      @service.api_call(type: :post, path: "/nodes/#{@id}/renders", data: template.to_s)
+      @service.api_call(type: :post, path: "/nodes/#{@id}/renders", data: template.to_s, node: self, direct: @service.direct_rendering?)
     end
 
     ##

data/lib/syncsign/node.rb

@@ -16,7 +16,7 @@ module SyncSign
 
     ##
     # Initialize a new Node object (normally only called from Hub#nodes or Service#nodes).
-    def initialize(service: nil, id: nil, name: nil, online: nil, battery: nil, signal: nil, model: nil)
+    def initialize(service: nil, id: nil, name: nil, online: nil, battery: nil, signal: nil, model: nil, hubid: nil)
       @service = service
       @id = id
       @name = name
@@ -24,6 +24,7 @@ module SyncSign
       @battery = battery
       @signal = signal
       @model = model
+      @hubid = hubid
     end
 
     ##
@@ -32,6 +33,12 @@ module SyncSign
       @online
     end
 
+    ##
+    # Return the hub that this node is associated with
+    def hub
+      Hub.new(service: @service, sn: @hubid)
+    end
+
     ##
     # Parse a JSON description of a single node into a +Node+ object.
     # Normally only called from Hub#nodes or Service#nodes.
@@ -50,7 +57,8 @@ module SyncSign
         online: nodeinfo['onlined'],
         battery: nodeinfo['batteryLevel'],
         signal: nodeinfo['signalLevel'],
-        model: nodeinfo['model']
+        model: nodeinfo['model'],
+        hubid: nodeinfo['thingName']
       )
     end
     

data/lib/syncsign/service.rb

@@ -16,8 +16,11 @@ module SyncSign
     ##
     # Set up a new connection to the SyncSign cloud service.
     # @param apikey [String] the API key provided through the SyncSign portal.
-    def initialize(apikey: null)
+    # @param render_direct [Boolean] try to send renders directly to the hub,
+    # bypassing the cloud service.
+    def initialize(apikey: nil, render_direct: false)
       @apikey = apikey
+      @directrender = render_direct
       @baseurl = "https://api.sync-sign.com/v2/key/#{apikey}"
     end
 
@@ -57,16 +60,28 @@ module SyncSign
       Node::parse(service: self, nodeinfo: api_call(path: "/nodes/#{id}"))
     end
 
+    ##
+    # Query whether we are rendering direct to the hub or via the cloud.
+    def direct_rendering?
+      @directrender
+    end
+
     ##
     # Make a call to the SyncSign cloud service.
     # @param type [Symbol] The HTTP method to use, either :get or :put.
     # @param path [String] The path to make the API call to, minus the base path.
     # @param data [String] The POST data to send with the API call.
+    # @param direct [Boolean] Whether to try to send the call directly to the hub,
+    # bypassing the cloud service.
+    # @param node [Node] The SyncSign node that this request is associated with.
+    # Optional unless using direct rendering, in which case it is required.
     # @api private
-    def api_call(type: :get, path: "", data: "")
-      apiurl = URI.parse("#{@baseurl}#{path}")
+    def api_call(type: :get, path: "", data: "", direct: false, node: nil)
+      baseurl = @baseurl
+      baseurl = "http://#{node.hub.addr}/key/#{node.hub.apikey}" if direct and node.hub.direct_rendering_capable?
+      apiurl = URI.parse("#{baseurl}#{path}")
       http_obj = Net::HTTP.new(apiurl.host, apiurl.port)
-      http_obj.use_ssl = true
+      http_obj.use_ssl = baseurl.include?("https")
       response = nil
       http_obj.start() do |http|
         req = nil

data/lib/syncsign/version.rb

@@ -1,4 +1,4 @@
 module SyncSign
   # The version number of the SyncSign module.
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syncsign
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - sarahemm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-18 00:00:00.000000000 Z
+date: 2020-08-23 00:00:00.000000000 Z
 dependencies: []
 description: Interface library for SyncSign e-paper displays
 email: github@sen.cx