star_ethernet 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afba0de930da0bd1b2ffff35864267d0c44c15bb9621d7b8b0590d3574077f78
-  data.tar.gz: 5aa6048f10b0fb2c70b2043e1a97b2f659571c1604d5d5b9989b14426141ca82
+  metadata.gz: e938547b2a7d713bbf3c3836d34dff3f74657c478ed1485c4c20e4bfd809d237
+  data.tar.gz: bfc8e7fcea483a1277a2f1fd19266864e48c95842f4e14107d8134731b1eddd8
 SHA512:
-  metadata.gz: 42abb8b909fdedb537c0e27a54822bf180456175da03d15b420a90b02b06f7bb01965fb9234657013be24295e61650c91f8d6d47babdcab889663990632bfa46
-  data.tar.gz: fb5ebd3c1296742ce7c87e074bb93a8d4e21b88e0618598ba39f82d3f39f802645d7c7fea8458b9dc554589b754b75aa58e686fe3239cba2cc9b60804a5d0bf6
+  metadata.gz: 826a49de39fc81da15c921acfb42714c05dd7e8e05daab6183a0ccc0515b1dcf99961a74a638f87095ea0b25ad78c65a3339559c592d66c92cc073269f7fb4db
+  data.tar.gz: 56fc58ba54b5ed7343236beaf96ee5dcd75c6765745ef0cde2926b1f9da0d8a8946b53bf5dc3ca2400e3bb7fcf0f6e29606c56edd9ec0ba48007349fe9811f1c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    star_ethernet (0.1.2)
+    star_ethernet (0.1.3)
 
 GEM
   remote: https://rubygems.org/

data/lib/star_ethernet/command.rb

@@ -1,5 +1,25 @@
 module StarEthernet
   module Command
+    def self.status_acquisition
+      ([0x32] + 50.times.map { 0x00 }).pack('C*')
+    end
+
+    def self.initialize_print_sequence
+      [
+        self.quit_raster_mode,
+        self.send_print_end_counter_initialize(0x04, 0x00,0x00),
+      ].join
+    end
+
+    def self.start_document
+      self.send_print_end_counter_initialize(0x03, 0x00, 0x00)
+    end
+
+    def self.end_document
+      self.send_print_end_counter_initialize(0x04, 0x00, 0x00)
+    end
+
+
     # Standard Command
     ## Font style and Character Set
     def self.select_font(n)

data/lib/star_ethernet/exceptions.rb

@@ -0,0 +1,13 @@
+module StarEthernet
+  class PrinterError < StandardError
+    def initialize(statuses_message)
+      super(statuses_message)
+    end
+  end
+
+  class EtbCountUpFailed < PrinterError; end
+
+  class PrintFailed < EtbCountUpFailed; end
+
+  class PrinterOffline < PrinterError; end
+end

data/lib/star_ethernet/printer.rb

@@ -1,43 +1,111 @@
 require 'socket'
 
 require 'star_ethernet/status'
+require 'star_ethernet/exceptions'
 
 module StarEthernet
   class Printer
     RAW_SOCKET_PRINT_PORT = 9100
     STATUS_ACQUISITION_PORT = 9101
+    ASB_STATUS_SIZE = 9
+    FETCH_TIME_INTERVAL = 0.1
+    RETRY_COUNTS = 300
 
-    attr_reader :status
+    attr_reader :status, :host
 
-    def initialize(host)
-      @host = host
-      @status = StarEthernet::Status.new
+    def initialize(host, nsb: false, asb: false, interval: FETCH_TIME_INTERVAL, retry_counts: RETRY_COUNTS)
+      @host, @nsb, @asb, @interval, @retry_counts = host, nsb, asb, interval, retry_counts
+      @status = StarEthernet::Status.new(self)
     end
 
     def print(data)
+      begin
+        socket = socket(RAW_SOCKET_PRINT_PORT)
+
+        if @nsb
+          nbs_status = socket.read(ASB_STATUS_SIZE)
+          @status.set_status(nbs_status, 'receive nbs status')
+        end
+
+        socket.print(StarEthernet::Command.initialize_print_sequence)
+
+        fetch_status('fetch etb status for checking counting up after initializing print sequence')
+
+        if current_status.offline?
+          raise StarEthernet::PrinterOffline.new(@status.full_messages)
+        end
+
+        socket.print(StarEthernet::Command.update_asb_etb_status)
+
+        @retry_counts.times do |index|
+          sleep @interval
+          fetch_status('fetch etb status for reserve etb count before printing')
+
+          break if etb_incremented?
+          if index == @retry_counts - 1
+            raise StarEthernet::EtbCountUpFailed.new(@status.full_messages)
+          end
+        end
+
+        socket.print(StarEthernet::Command.start_document)
+
+        socket.print(data)
+
+        socket.print(StarEthernet::Command.update_asb_etb_status)
+
+        socket.print(StarEthernet::Command.end_document)
+
+        @retry_counts.times do |index|
+          sleep @interval
+          fetch_status('fetch etb status for checking print success')
+          break if etb_incremented?
+          if index == @retry_counts - 1
+            raise StarEthernet::PrintFailed.new(@status.full_messages)
+          end
+        end
+      ensure
+        socket.close
+      end
+    end
+
+    def send_command(data)
       socket = socket(RAW_SOCKET_PRINT_PORT)
-      nbs_status = socket.read(11)
-      @status.set_status(nbs_status)
+      if @nsb
+        nbs_status = socket.read(ASB_STATUS_SIZE)
+        @status.set_status(nbs_status)
+      end
       socket.print(data)
-      socket.close_write
       socket.close
     end
 
-    def current_status
+    def fetch_status(purpose = '')
+      socket = socket(STATUS_ACQUISITION_PORT)
+      socket.print(StarEthernet::Command.status_acquisition)
+      asb_status = socket.read(ASB_STATUS_SIZE)
+      @status.set_status(asb_status, purpose)
+      socket.close
       @status.current_status
     end
 
-    def fetch_status
-      socket = socket(STATUS_ACQUISITION_PORT)
-      cmd = [0x32] + 50.times.map { 0x00 }
-      socket.print(cmd.pack('C*'))
-      asb_status = socket.read(11)
-      @status.set_status(asb_status)
-      socket.close
+    def etb_incremented?
+      current_etb == previous_etb + 1
+    end
+
+    def current_etb
+      current_status.etb
+    end
+
+    def previous_etb
+      previous_status.etb
+    end
+
+    def current_status
       @status.current_status
     end
 
-    private
+    def previous_status
+      @status.previous_status
+    end
 
     def socket(port)
       TCPSocket.new(@host, port)

data/lib/star_ethernet/status.rb

@@ -2,17 +2,32 @@ require 'star_ethernet/status_item'
 
 module StarEthernet
   class StarEthernet::Status
-    def initialize
-      @statuses = []
+    attr_reader :status_items
+
+    def initialize(printer)
+      @printer = printer
+      @status_items = []
     end
 
     def current_status
-      @statuses.first
+      @status_items.last
+    end
+
+    def previous_status
+      @status_items[-2]
     end
 
-    def set_status(status_data)
+    def set_status(status_data, purpose = '')
       current_status = StatusItem.decode_status(status_data)
-      @statuses.push(current_status)
+      current_status.purpose = purpose
+      @status_items.push(current_status)
+    end
+
+    def full_messages
+      <<~"EOS"
+      #{@printer.host} printer's statuses are
+      #{@status_items.map{ |status_item| status_item.message }.join("\n")}
+      EOS
     end
   end
 end

data/lib/star_ethernet/status_item.rb

@@ -1,5 +1,34 @@
 module StarEthernet
-  module StatusItem
+  class StatusItem
+    attr_reader :statuses, :time
+    attr_writer :purpose
+    attr_accessor :etb
+
+    def initialize(statuses: [])
+      @statuses = statuses
+      @etb = nil
+      @time = Time.now
+      @purpose = nil
+    end
+
+    def offline?
+      @statuses.include?(PrinterStatus::Offline)
+    end
+
+    def append_status(status)
+      @statuses.push(status)
+    end
+
+    def message
+      msg = @statuses.empty? ?
+        "[#{@time.to_s}] Normal status" :
+        "[#{@time.to_s}] #{@statuses.map{ |status| status.to_s }.join(', ')}"
+      msg += " etb:#{@etb}"
+      msg += " (#{@purpose})" if @purpose
+      msg
+    end
+
+
     class HeaderStatus
       # todo
     end
@@ -38,10 +67,8 @@ module StarEthernet
       class StateWherePaperIsPulledOut; end
     end
 
-    class NormalStatus; end
-
     def self.decode_status(status_raw_data)
-      status_items = []
+      status_item = StatusItem.new
 
       status_data = status_raw_data.unpack('H*').first
 
@@ -49,37 +76,38 @@ module StarEthernet
       byte2 = status_data[2..3].hex # todo version status
 
       byte3 = status_data[4..5].hex
-      status_items.push(PrinterStatus::OfflineBySwitchInput)   if byte3 & 0b01000000 > 0
-      status_items.push(PrinterStatus::CoverOpen)              if byte3 & 0b00100000 > 0
-      status_items.push(PrinterStatus::Offline)                if byte3 & 0b00001000 > 0
-      status_items.push(PrinterStatus::ConversionSwitchClosed) if byte3 & 0b00000100 > 0
-      status_items.push(PrinterStatus::EtbCommandExecuted)     if byte3 & 0b00000010 > 0
+      status_item.append_status(PrinterStatus::OfflineBySwitchInput)   if byte3 & 0b01000000 > 0
+      status_item.append_status(PrinterStatus::CoverOpen)              if byte3 & 0b00100000 > 0
+      status_item.append_status(PrinterStatus::Offline)                if byte3 & 0b00001000 > 0
+      status_item.append_status(PrinterStatus::ConversionSwitchClosed) if byte3 & 0b00000100 > 0
+      status_item.append_status(PrinterStatus::EtbCommandExecuted)     if byte3 & 0b00000010 > 0
 
       byte4 = status_data[6..7].hex
-      status_items.push(ErrorStatus::StoppedByHighHeadTemperature) if byte4 & 0b01000000 > 0
-      status_items.push(ErrorStatus::NonRecoverableError)          if byte4 & 0b00100000 > 0
-      status_items.push(ErrorStatus::AutoCutterError)              if byte4 & 0b00001000 > 0
-      status_items.push(ErrorStatus::MechanicalError)              if byte4 & 0b00000100 > 0
+      status_item.append_status(ErrorStatus::StoppedByHighHeadTemperature) if byte4 & 0b01000000 > 0
+      status_item.append_status(ErrorStatus::NonRecoverableError)          if byte4 & 0b00100000 > 0
+      status_item.append_status(ErrorStatus::AutoCutterError)              if byte4 & 0b00001000 > 0
+      status_item.append_status(ErrorStatus::MechanicalError)              if byte4 & 0b00000100 > 0
 
       byte5 = status_data[8..9].hex
-      status_items.push(ErrorStatus::ReceiveBufferOverflow) if byte5 & 0b01000000 > 0
-      status_items.push(ErrorStatus::CommandError)          if byte5 & 0b00100000 > 0
-      status_items.push(ErrorStatus::BmError)               if byte5 & 0b00001000 > 0
-      status_items.push(ErrorStatus::PresenterPageJamError) if byte5 & 0b00000100 > 0
-      status_items.push(ErrorStatus::HeadUpError)           if byte5 & 0b00000010 > 0
+      status_item.append_status(ErrorStatus::ReceiveBufferOverflow) if byte5 & 0b01000000 > 0
+      status_item.append_status(ErrorStatus::CommandError)          if byte5 & 0b00100000 > 0
+      status_item.append_status(ErrorStatus::BmError)               if byte5 & 0b00001000 > 0
+      status_item.append_status(ErrorStatus::PresenterPageJamError) if byte5 & 0b00000100 > 0
+      status_item.append_status(ErrorStatus::HeadUpError)           if byte5 & 0b00000010 > 0
 
       byte6 = status_data[10..11].hex
-      status_items.push(SensorStatus::PaperEnd)            if byte6 & 0b00001000 > 0
-      status_items.push(SensorStatus::PaperNearInsideEnd)  if byte6 & 0b00000100 > 0
-      status_items.push(SensorStatus::PaperNearOutsideEnd) if byte6 & 0b00000010 > 0
+      status_item.append_status(SensorStatus::PaperEnd)            if byte6 & 0b00001000 > 0
+      status_item.append_status(SensorStatus::PaperNearInsideEnd)  if byte6 & 0b00000100 > 0
+      status_item.append_status(SensorStatus::PaperNearOutsideEnd) if byte6 & 0b00000010 > 0
 
       byte7 = status_data[12..13].hex # todo
-      byte8 = status_data[14..15].hex # todo
-      byte9 = status_data[16..17].hex # todo
 
-      status_items.push(NormalStatus) if status_items.empty?
+      byte8 = status_data[14..15].hex
+      status_item.etb = ((byte8 >> 1) & 0b00000111) + ((byte8 >> 2) & 0b00011000)
+
+      byte9 = status_data[16..17].hex # todo
 
-      status_items
+      status_item
     end
   end
 end

data/lib/star_ethernet/version.rb

@@ -1,3 +1,3 @@
 module StarEthernet
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/star_ethernet.rb

@@ -3,6 +3,7 @@ require 'star_ethernet/printer'
 require 'star_ethernet/status'
 require 'star_ethernet/status_item'
 require 'star_ethernet/version'
+require 'star_ethernet/exceptions'
 
 module StarEthernet
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: star_ethernet
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Shinsuke IMAI
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-19 00:00:00.000000000 Z
+date: 2019-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ files:
 - bin/setup
 - lib/star_ethernet.rb
 - lib/star_ethernet/command.rb
+- lib/star_ethernet/exceptions.rb
 - lib/star_ethernet/printer.rb
 - lib/star_ethernet/status.rb
 - lib/star_ethernet/status_item.rb