odroid_lcd 0.0.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6006d3b5b173420c1df81e8498d1a68b182c7eef
-  data.tar.gz: 1904a72869fe8cae59bcb2e94409b9f4e1e07170
+  metadata.gz: f626e738883e445715d2ab87b0fe9ea2c8f35b3d
+  data.tar.gz: 713a07322f33321d1f20d30731bb4e913cb0a3b3
 SHA512:
-  metadata.gz: 7aba291d2ff468fcc8330544c08f36e103dac6d948bbfd6e6202db21cee80fe1d561c67ce94b15e1f9405ee831f0902972802d8afde4b35a24cb2cb60d2dfc57
-  data.tar.gz: 650d24ba418a37ae228ef35198c4ee3cf1a1f3ab0f3196295567929212318a6ddf939a9dd6bd0e466b49fa3a5159b7a794dd901a5f32a88f0be97691e8340a90
+  metadata.gz: 1745a497c7ee5b639704bc2c733cfe03f721514fd345002e539d937a9a91a68bd65077cebac406fbfd382d729a8261978d23fbec573264b4a9d27e130daab335
+  data.tar.gz: 7afb8aaafab6fcb60b339e88b6dde1774702cd7162a2642134ad1ba334edfa6c8bb51b55af1e2731cef2553b515eedadfb264d84476277b575a07b9c2053ced7

data/bin/odroid-lcd

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'odroid_lcd'
+require_relative '../lib/odroid_lcd'
 
-cli = OdroidLCD::CLI.new
-cli.run(ARGV)
+cli = OdroidLCD::CLI.new(ARGV)
+cli.run()

data/lib/odroid_lcd.rb

@@ -1,7 +1,7 @@
 
-require 'odroid_lcd/hw'
-require "odroid_lcd/lcd"
-require "odroid_lcd/cli"
+require_relative "odroid_lcd/lcd"
+require_relative "odroid_lcd/cli"
+require_relative "odroid_lcd/hw_mock"
 
 module OdroidLCD
 end

data/lib/odroid_lcd/cli.rb

@@ -1,22 +1,93 @@
+
+require 'optparse'
+
 module OdroidLCD
   class CLI
 
-    def initialize
-      @lcd = OdroidLCD::LCD.new
+    def initialize(argv, mocks = {})
+      @options = parse_arguments(argv)
+      @argv = argv
+
+      # If we're testing via the command line, set the mock rather than LCD.
+      @lcd = if @options[:test]
+        @hw_mock = OdroidLCD::HWMock.new
+        mock_hw = mocks.merge({odroidlcd_hw: @hw_mock})
+        OdroidLCD::LCD.new(mocks: mock_hw)
+      else
+        OdroidLCD::LCD.new(mocks: mocks)
+      end
+
+      # set the default text alignment
+      @align = @options[:align] || "left"
+
+      freeze()
     end
 
-    def run(argv)
-      string = argv[0]
 
-      rows = argv[0].lines
-      if rows.length > 1
-        @lcd.set_string(row: 0, string: rows[0].chomp)
-        @lcd.set_string(row: 1, string: rows[1].chomp)
+    def run
+      lines = if @options.has_key?(:file)
+        read_file(@options[:file])
       else
-        @lcd.set_string(row: 0, string: rows[0].chomp)
+        @argv[0,2].map {|line| line.chomp }
       end
 
+      @lcd.set_lines(lines: lines, align: @align)
+
+      if @options[:test]
+        show_mocked_lcd()
+      end
+    end
+
+    def show_mocked_lcd
+      puts "[#{@hw_mock.get(row: 0).join}]"
+      puts "[#{@hw_mock.get(row: 1).join}]"
     end
 
+
+    def parse_arguments(argv)
+      options = {}
+      OptionParser.new do |opts|
+        opts.banner = "Usage: odroid-lcd [options] [first line] [second line]"
+
+        opts.on("-f", "--file=FILE", String, "Read content from a file") do |x|
+          if x == nil
+            puts opts
+            exit 2
+          end
+          options[:file] = x
+        end
+
+        opts.on("--test", "Dry run test (does not update the screen)") do |x|
+          options[:test] = x
+        end
+
+        opts.on("--align=ALIGN", String, "Align text: left, right, center") do |x|
+          if x == nil
+            puts opts
+            exit 2
+          end
+          options[:align] = x
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          exit
+        end
+
+      end.parse!
+      options
+    end
+
+    def read_file(filename)
+      file = if (filename == '-')
+        $stdin
+      else
+        File.open(filename, "r")
+      end
+
+      file.readlines.map {|line| line.chomp }
+    end
+
+
   end
 end

data/lib/odroid_lcd/hw_mock.rb

@@ -0,0 +1,46 @@
+module OdroidLCD
+  class HWMock
+
+    attr_reader :max_column
+    attr_reader :max_row
+
+    def initialize
+      @max_column = 16
+      @max_row = 2
+
+      @display = [
+        [],
+        []
+      ]
+
+    end
+
+    def clear
+      @display = [
+        [],
+        []
+      ]
+    end
+
+    #
+    # See: https://en.wikipedia.org/wiki/Hitachi_HD44780_LCD_controller
+    def set_character(row, column, character)
+      chr = case character
+            when "\u005c" then "\u00a5"
+            when "\u007e" then "\u2192"
+            when "\u007f" then "\u2190"
+            else character
+            end
+
+      @display[row][column] = chr
+    end
+
+    # Extra methods for use as a mock
+    #
+
+    def get(row: 0)
+      @display[row]
+    end
+
+  end
+end

data/lib/odroid_lcd/lcd.rb

@@ -1,31 +1,103 @@
 
 module OdroidLCD
+
+  class LCDError < StandardError; end
+
   class LCD
+    # The main interface to the LCD screen.
 
     attr_reader :max_column
     attr_reader :max_row
 
     def initialize(mocks: {})
-      @hw = mocks[:odroidlcd_hw] || OdroidLCD::HW.new
+      @hw = if mocks[:odroidlcd_hw]
+              mocks[:odroidlcd_hw]
+            else
+              require 'odroid_lcd/hw'
+              OdroidLCD::HW.new
+            end
+
       @max_column = @hw.max_column
       @max_row = @hw.max_row
       freeze()
     end
 
+    # Clear the display
     def clear
       @hw.clear
     end
 
+    # set_character
+    #
+    # Sets a single character at a particular position on the display.
+    #
+    # Note that the display uses a Japanese display driver, so
+    # the following quirks / features are present:
+    #
+    # "\" is displayed as the yen character
+    # "~" is displayed as a right arrow
+    # delete (or rubout) is displayed as a left arrow
+    #
+    # Row 0 is the top row, row 1 is the bottom row.
+    #
     def set_character(row:, column:, character:)
-      @hw.set_character(row, column, character)
+      begin
+        # It's a Japanese display, seemingly using Windows-31J
+        #
+        # Note that \ displays as a yen sign, ~ displays as a right arrow, DEL displays as a left arrow
+        chr = character.encode("Windows-31J")
+        @hw.set_character(row, column, chr)
+      rescue Encoding::UndefinedConversionError => e
+        raise OdroidLCD::LCDError, "Could not display character: #{character}, the display uses Japanese Windows-31J"
+      end
     end
 
-    def set_string(row: 0, string:)
+    # set_string
+    #
+    # Sets a string on the display.
+    #
+    # +::row::+
+    #   Which row of the display to update.
+    #   Row 0 is the top row, row 1 is the bottom row.
+    #
+    # +::string::+
+    #   The string to send to the display.
+    #
+    # +::align::+
+    #   Optional, either "left", "right", or "center"
+    #   Defaults to: "left"
+    #
+    def set_string(row: 0, string:, align: "left")
       column = 0
-      string[0, @max_column].ljust(@max_column - 1).chars do |chr|
+      str = case align
+            when "left"   then string[0, @max_column].ljust(@max_column)
+            when "right"  then string[0, @max_column].rjust(@max_column)
+            when "center" then string[0, @max_column].center(@max_column)
+            else string[0, @max_column].ljust(@max_column)
+            end
+
+      str.chars do |chr|
         set_character(row: row, column: column, character: chr)
         column += 1
       end
     end
+
+    # +::lines::+
+    #   ["line one", "line two"]
+    #   ["line one", "line two", "line three"]
+    #
+    # +::align::+
+    #   Optional, either "left", "right", or "center"
+    #   Defaults to: "left"
+    #
+    def set_lines(lines:, align: "left")
+      if lines.length >= @max_row
+        set_string(row: 0, string: lines[0].to_s, align: align)
+        set_string(row: 1, string: lines[1].to_s, align: align)
+      else
+        set_string(row: 0, string: lines[0].to_s, align: align)
+      end
+    end
+
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: odroid_lcd
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Phil Helliwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
-dependencies: []
+date: 2017-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 description: 'Allows writing strings to the LCD screen accessory, see: https://wiki.odroid.com/accessory/display/16x2_lcd_io_shield/c/start'
 email: phil.helliwell@gmail.com
 executables:
@@ -24,6 +38,7 @@ files:
 - lib/odroid_lcd.rb
 - lib/odroid_lcd/cli.rb
 - lib/odroid_lcd/hw.rb
+- lib/odroid_lcd/hw_mock.rb
 - lib/odroid_lcd/lcd.rb
 homepage: http://github.com/kill9zombie/odroid_lcd
 licenses: