syncsign 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ec8ce97ef1f4882420617de3310d74e2d4a3783a4f1922847c706c3eb04b13c
-  data.tar.gz: 0a867fa0debe259b37d347aff38800f9ae589a4e2afde253d69fbe2f2cab4bbe
+  metadata.gz: 0c71d9ba121262edad7f9e12094cede28b97909345521b48898bc792da31070d
+  data.tar.gz: 63a4e344b54a6ee357e636c5e62e56fc33565a17561a8b616a356304f5f0d10c
 SHA512:
-  metadata.gz: fc9cc2483763d6a35cee7d3c9370b2abe6774b5870321ec219ed02c26b61a0d60378c8a38149507bcef9e4cecbb6b88f9a4888e888732d7d47516d6597ab4d3b
-  data.tar.gz: 9bba6acf10f9b33d4a9d11065e12ae6c3d4270bc95e991e03651aace8dd0c52655fe07ea628f110572a0b58b6fce7ca51601dcf48d43cd30308b574b5b165de9
+  metadata.gz: d500314480cda678242c4204b88cb0275c5a2d10642922cc79e49f05850bd32a064b646d25aed15401ad56f2b8f01112ced44a676e2ce2f3e00e7ba42a0eece9
+  data.tar.gz: 5e1acd15b5443e3a5097e1e3a89f520a610efdea3c37caea5f1d328e1f1d60c3dec152bcc9532318e8e21341233c50a4f2056f7ca52fb2a2d09981b2b63b6dcf

data/README.md

@@ -36,3 +36,5 @@ Check out the examples/ folder for:
  * nodes.rb - List all nodes on the system and information about them.
  * render.rb - Render a sample screen to the given node.
 
+## Full Documentation
+YARD docs included, also available on [RubyDoc.info](https://www.rubydoc.info/github/sarahemm/ruby-syncsign/master)

data/lib/syncsign/template.rb

@@ -14,9 +14,12 @@ module SyncSign
     # @param items [Array] List of Widgets to add to the template.
     # @param pollrate [Integer] How often (in ms) the node should poll the hub
     #   for new information.
-    def initialize(bgcolour: :white, items: [], pollrate: 10000)
+    # @param enable_buttons [Boolean] Whether to enable the button labels at
+    #   the bottom of the screen.
+    def initialize(bgcolour: :white, items: [], pollrate: 10000, enable_buttons: false)
       @bgcolour = bgcolour
       @pollrate = pollrate
+      @enable_buttons = enable_buttons
       
       @items = []
       items.each do |item|
@@ -35,7 +38,10 @@ module SyncSign
     ##
     # Output this template as JSON in the format that the SyncSign service understands.
     def to_s
-      background = {bgColor: @bgcolour.to_s.upcase}
+      background = {
+        bgColor: @bgcolour.to_s.upcase,
+        enableButtonZone: @enable_buttons
+      }
       items = @items.collect { |item| item.to_a }
       options = {'pollRate': @pollrate}
       {

data/lib/syncsign/version.rb

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

data/lib/syncsign/widgets.rb

@@ -199,9 +199,10 @@ module SyncSign
       # @param font [Symbol] The font to use when drawing the text.
       # @param size [Integer] The point size to use when drawing the text.
       # @param align [Symbol] Whether to align the text left, center, or right.
+      # @param linespacing [Integer] How much space to leave between each line.
       # @param text [String] The text to draw in the box.
       # @param id [String] An ID value to attach to the text box.
-      def initialize(x: nil, y: nil, width: nil, height: nil, colour: :black, bgcolour: :white, font: nil, size: nil, id: nil, align: :left, text: nil)
+      def initialize(x: nil, y: nil, width: nil, height: nil, colour: :black, bgcolour: :white, font: nil, size: nil, id: nil, align: :left, linespacing: 2, text: nil)
         check_font(font: font, size: size)
         raise(AlignmentException, "Textbox: either y or height must be a multiple of 8") if y % 8 != 0 and height % 8 != 0
         raise(AlignmentException, "Textbox: width must be a multiple of 8") if width % 8 != 0
@@ -209,6 +210,7 @@ module SyncSign
         @size = size
         @id = id
         @align = align
+        @linespacing = linespacing
         @text = text
         super(x: x, y: y, width: width, height: height, colour: colour, bgcolour: bgcolour)
       end
@@ -216,18 +218,26 @@ module SyncSign
       ##
       # Convert the widget into an array for sending to the SyncSign service.
       def to_a
+        font_string = "#{@font}_#{@size.to_s}"
+        # this one font has to be specified in a different way
+        font_string += "_B" if @font.to_s.upcase == "YANONE_KAFFEESATZ"
         {
           'type': 'TEXT',
           'data': {
             'block': {x: @x, y: @y, w: @width, h: @height},
             'textColor': @colour.to_s.upcase,
             'textAlign': @align.to_s.upcase,
-            'font': "#{@font}_#{@size.to_s}",
+            'font': font_string,
+            'lineSpace': @linespacing,
             'text': @text
           }
         }
       end
 
+      # Check a font/size combination to make sure it's valid.
+      # Will raise ArgumentError if the font, size, or combination isn't supported..
+      # @param font [Symbol] A symbol to check, representing a font.
+      # @param size [Integer] A font size to check.
       def check_font(font: nil, size: nil)
         available_sizes = {
           :ddin => [16, 24, 32, 48, 64, 128],
@@ -306,6 +316,48 @@ module SyncSign
       end
     end
 
+    ##
+    # A widget that draws button labels for the 4.2" display.
+    class ButtonLabels
+      # @return [Array] Up to 4 strings of 17 characters each, to label the buttons with.
+      attr_accessor :labels
+      # @return [Array] Up to 4 boolean values showing whether each button should be reverse colours.
+      attr_accessor :reversed
+      
+      ##
+      # Initialize a new Button Labels widget.
+      # @param labels [Array] Up to 4 strings of 17 characters each, to label the buttons with.
+      # @param reversed [Array] Up to 4 boolean values showing whether each button should be reverse colours (white on black). Default is black on white.
+      def initialize(labels: [], reversed: [])
+        # TODO: validate <= 17 characters in each label
+        @labels = labels
+        @reversed = reversed
+      end
+
+      ##
+      # Convert the widget into an array for sending to the SyncSign service.
+      def to_a
+        label_arr = []
+        (0..3).each do |idx|
+          label_arr[idx] = {
+            :title => @labels[idx] || "",
+            :style => @reversed[idx] || 'DISABLED'
+          }
+        end
+
+        {
+          'type': 'BOTTOM_CUSTOM_BUTTONS',
+          'data': {
+            'list': label_arr
+          }
+        }
+      end
+    end
+
+    ##
+    # Check a set of colours to make sure they're all valid.
+    # Will raise ArgumentError if any elements are not valid colours.
+    # @param colours [Array] An array of symbols to check.
     def self.check_colours(colours)
       colours.each do |colour|
         next if [:white, :black, :red].include? colour
@@ -313,6 +365,9 @@ module SyncSign
       end
     end
     
+    # Check a set of patterns to make sure they're all valid.
+    # Will raise ArgumentError if any elements are not valid patterns.
+    # @param patterns [Array] An array of symbols to check.
     def self.check_patterns(patterns)
       patterns.each do |pattern|
         next if [:solid, :interleave, :dash_tiny, :dash_medium, :dash_wide, :none].include? pattern

metadata

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