timex_datalink_client 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fab69b897b4f8d5bcb249c9e238d7cc2a4889598598528b7c2137eab7f68b93f
-  data.tar.gz: 87d353f312b3ba49b75b6024b8bbecb8d858a64974876364fd5b510d9f74c21b
+  metadata.gz: 499c12fec3a8fae40770efc4173421e0a996b999a98a19a7e9ec64295628d757
+  data.tar.gz: 29b1bec826b2d5a2c25f7d7c9e47405760a2c08526e04f7f84084587dfec44c5
 SHA512:
-  metadata.gz: 3104f3d9a9b9099a90b9899abc28f575c955633aca3ff7ca20483f425106fbd94e2da647702ccac620657a03fc96875a519f107c9d72fffbd0230d068c378695
-  data.tar.gz: d3c9344aa520f93e797549112f54510c9ed358577dbaf797e0c87ce9d86427b4d2f59345a395dafed0b1224931bbeaa1a1b4ab301b8cb35a7afc762346b8d648
+  metadata.gz: 1278164bd72754ee49ad9d26b7cf3a953de3f164e6bb19a42a30a34528ed012b6d967f605aeb244b6554ca29541312edec4b4d2730c1fadfa38b9946d862e76e
+  data.tar.gz: ad536dfbf0e894b5474be3fc36c4c8b0387cdc47e7134c58c98e7c6978ac004a78b20c4f54059e63d8cc3accda0e7b2f60199920be8bdbe128d98afa62798727

data/lib/timex_datalink_client/alarm.rb

@@ -14,6 +14,13 @@ class TimexDatalinkClient
 
     attr_accessor :number, :audible, :time, :message
 
+    # Create an Alarm instance.
+    #
+    # @param number [Integer] Alarm number (from 1 to 5).
+    # @param audible [Boolean] Toggle alarm sounds.
+    # @param time [::Time] Time of alarm.
+    # @param message [String] Alarm message text.
+    # @return [Alarm] Alarm instance.
     def initialize(number:, audible:, time:, message:)
       @number = number
       @audible = audible
@@ -21,6 +28,9 @@ class TimexDatalinkClient
       @message = message
     end
 
+    # Compile packets for an alarm.
+    #
+    # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
     def packets
       [
         [
@@ -39,9 +49,7 @@ class TimexDatalinkClient
     private
 
     def message_characters
-      message_padded = message.ljust(MESSAGE_LENGTH)
-
-      chars_for(message_padded)
+      chars_for(message, length: 8, pad: true)
     end
 
     def audible_integer

data/lib/timex_datalink_client/eeprom/anniversary.rb

@@ -11,11 +11,19 @@ class TimexDatalinkClient
 
       attr_accessor :time, :anniversary
 
+      # Create an Anniversary instance.
+      #
+      # @param time [::Time] Time of anniversary.
+      # @param anniversary [String] Anniversary text.
+      # @return [Anniversary] Anniversary instance.
       def initialize(time:, anniversary:)
         @time = time
         @anniversary = anniversary
       end
 
+      # Compile a packet for an anniversary.
+      #
+      # @return [Array<Integer>] Array of integers that represent bytes.
       def packet
         [
           time.month,

data/lib/timex_datalink_client/eeprom/appointment.rb

@@ -11,11 +11,19 @@ class TimexDatalinkClient
 
       attr_accessor :time, :message
 
+      # Create an Appointment instance.
+      #
+      # @param time [::Time] Time of appointment.
+      # @param message [String] Appointment text.
+      # @return [Appointment] Appointment instance.
       def initialize(time:, message:)
         @time = time
         @message = message
       end
 
+      # Compile a packet for an appointment.
+      #
+      # @return [Array<Integer>] Array of integers that represent bytes.
       def packet
         [
           time.month,

data/lib/timex_datalink_client/eeprom/list.rb

@@ -11,11 +11,19 @@ class TimexDatalinkClient
 
       attr_accessor :list_entry, :priority
 
+      # Create a List instance.
+      #
+      # @param list_entry [String] List entry text.
+      # @param priority [Integer] List priority.
+      # @return [List] List instance.
       def initialize(list_entry:, priority:)
         @list_entry = list_entry
         @priority = priority
       end
 
+      # Compile a packet for a list.
+      #
+      # @return [Array<Integer>] Array of integers that represent bytes.
       def packet
         [
           priority,

data/lib/timex_datalink_client/eeprom/phone_number.rb

@@ -13,12 +13,21 @@ class TimexDatalinkClient
 
       attr_accessor :name, :number, :type
 
+      # Create a PhoneNumber instance.
+      #
+      # @param name [String] Name associated to phone number.
+      # @param number [String] Phone number text.
+      # @param type [String] Phone number type.
+      # @return [PhoneNumber] PhoneNumber instance.
       def initialize(name:, number:, type: " ")
         @name = name
         @number = number
         @type = type
       end
 
+      # Compile a packet for a phone number.
+      #
+      # @return [Array<Integer>] Array of integers that represent bytes.
       def packet
         [
           number_with_type_characters,

data/lib/timex_datalink_client/eeprom.rb

@@ -18,6 +18,15 @@ class TimexDatalinkClient
 
     attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification
 
+    # Create an Eeprom instance.
+    #
+    # @param appointments [Array<Appointment>] Appointments to be added to EEPROM data.
+    # @param anniversaries [Array<Anniversary>] Anniversaries to be added to EEPROM data.
+    # @param phone_numbers [Array<PhoneNumber>] Phone numbers to be added to EEPROM data.
+    # @param lists [Array<List>] Lists to be added to EEPROM data.
+    # @param appointment_notification [Integer] Appointment notification (intervals of 15 minutes, 255 for no
+    #   notification)
+    # @return [Eeprom] Eeprom instance.
     def initialize(appointments: [], anniversaries: [], phone_numbers: [], lists: [], appointment_notification: APPOINTMENT_NO_NOTIFICATION)
       @appointments = appointments
       @anniversaries = anniversaries
@@ -26,6 +35,9 @@ class TimexDatalinkClient
       @appointment_notification = appointment_notification
     end
 
+    # Compile packets for EEPROM data.
+    #
+    # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
     def packets
       [CPACKET_CLEAR, header] + payloads + [CPACKET_END]
     end

data/lib/timex_datalink_client/end.rb

@@ -8,6 +8,9 @@ class TimexDatalinkClient
 
     CPACKET_SKIP = [0x21]
 
+    # Compile packets for data end command.
+    #
+    # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
     def packets
       [CPACKET_SKIP]
     end

data/lib/timex_datalink_client/helpers/char_encoders.rb

@@ -3,19 +3,23 @@
 class TimexDatalinkClient
   class Helpers
     module CharEncoders
-      CHARS = "0123456789abcdefghijklmnopqrstuvwxyz !\"#$%&'()*+,-./:\\;=@?ABCDEF"
+      CHARS = "0123456789abcdefghijklmnopqrstuvwxyz !\"#$%&'()*+,-./:\\;=@?_|<>[]"
+
       EEPROM_TERMINATOR = 0x3f
 
       PHONE_CHARS = "0123456789cfhpw "
 
-      def chars_for(string_chars, char_map: CHARS)
-        string_chars.each_char.map do |string_char|
-          char_map.index(string_char)
+      def chars_for(string_chars, char_map: CHARS, length: nil, pad: false)
+        formatted_chars = string_chars.downcase[0..length.to_i - 1]
+        formatted_chars = formatted_chars.ljust(length) if pad
+
+        formatted_chars.each_char.map do |char|
+          char_map.index(char)
         end
       end
 
       def eeprom_chars_for(string_chars)
-        chars = chars_for(string_chars).append(EEPROM_TERMINATOR)
+        chars = chars_for(string_chars, length: 31).append(EEPROM_TERMINATOR)
 
         packed_int = chars.each_with_index.sum do |char, index|
           char << (6 * index)
@@ -25,7 +29,7 @@ class TimexDatalinkClient
       end
 
       def phone_chars_for(string_chars)
-        chars = chars_for(string_chars, char_map: PHONE_CHARS)
+        chars = chars_for(string_chars, char_map: PHONE_CHARS, length: 12)
 
         packed_int = chars.each_with_index.sum do |char, index|
           char << (4 * index)

data/lib/timex_datalink_client/notebook_adapter.rb

@@ -4,16 +4,29 @@ require "rubyserial"
 
 class TimexDatalinkClient
   class NotebookAdapter
-    BYTE_SLEEP = 0.025
-    PACKET_SLEEP = 0.25
-
-    attr_accessor :serial_device, :verbose
-
-    def initialize(serial_device:, verbose: false)
+    BYTE_SLEEP_DEFAULT = 0.025
+    PACKET_SLEEP_DEFAULT = 0.25
+
+    attr_accessor :serial_device, :byte_sleep, :packet_sleep, :verbose
+
+    # Create a NotebookAdapter instance.
+    #
+    # @param serial_device [String] Path to serial device.
+    # @param byte_sleep [Integer, nil] Time to sleep after sending byte.
+    # @param packet_sleep [Integer, nil] Time to sleep after sending packet of bytes.
+    # @param verbose [Boolean] Write verbose output to console.
+    # @return [NotebookAdapter] NotebookAdapter instance.
+    def initialize(serial_device:, byte_sleep: nil, packet_sleep: nil, verbose: false)
       @serial_device = serial_device
+      @byte_sleep = byte_sleep || BYTE_SLEEP_DEFAULT
+      @packet_sleep = packet_sleep || PACKET_SLEEP_DEFAULT
       @verbose = verbose
     end
 
+    # Write packets of bytes to serial device.
+    #
+    # @param packets [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
+    # @return [void]
     def write(packets)
       packets.each do |packet|
         packet.each do |byte|
@@ -21,10 +34,10 @@ class TimexDatalinkClient
 
           serial.write(byte.chr)
 
-          sleep(BYTE_SLEEP)
+          sleep(byte_sleep)
         end
 
-        sleep(PACKET_SLEEP)
+        sleep(packet_sleep)
 
         puts if verbose
       end

data/lib/timex_datalink_client/sound_options.rb

@@ -10,11 +10,19 @@ class TimexDatalinkClient
 
     attr_accessor :hourly_chime, :button_beep
 
+    # Create a SoundOptions instance.
+    #
+    # @param hourly_chime [Boolean] Toggle hourly chime sounds.
+    # @param button_beep [Boolean] Toggle button beep sounds.
+    # @return [SoundOptions] SoundOptions instance.
     def initialize(hourly_chime:, button_beep:)
       @hourly_chime = hourly_chime
       @button_beep = button_beep
     end
 
+    # Compile packets for sound options.
+    #
+    # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
     def packets
       [
         CPACKET_BEEPS + [hourly_chime_integer, button_beep_integer]

data/lib/timex_datalink_client/sound_theme.rb

@@ -14,32 +14,49 @@ class TimexDatalinkClient
 
     SOUND_DATA_HEADER = "\x25\x04\x19\x69"
 
-    attr_accessor :sound_data
-
-    def initialize(sound_data:)
-      @sound_data = sound_data
+    attr_accessor :spc_file
+
+    # Create a SoundTheme instance.
+    #
+    # @param sound_theme_data [String, nil] Sound theme data.
+    # @param spc_file [String, nil] Path to SPC file.
+    # @return [SoundTheme] SoundTheme instance.
+    def initialize(sound_theme_data: nil, spc_file: nil)
+      @sound_theme_data = sound_theme_data
+      @spc_file = spc_file
     end
 
+    # Compile packets for a sound theme.
+    #
+    # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
     def packets
       [load_sect] + payloads + [CPACKET_END]
     end
 
     private
 
-    def sound_bytes
-      sound_data.delete_prefix(SOUND_DATA_HEADER).bytes
-    end
-
     def load_sect
       CPACKET_SECT + [payloads.length, offset]
     end
 
     def payloads
-      paginate_cpackets(header: CPACKET_DATA, cpackets: sound_bytes)
+      paginate_cpackets(header: CPACKET_DATA, cpackets: sound_theme_data.bytes)
+    end
+
+    def sound_theme_data
+      @sound_theme_data || spc_file_data_without_header
+    end
+
+    def spc_file_data
+      File.open(spc_file, "rb").read
+    end
+
+    def spc_file_data_without_header
+      spc_file_data.delete_prefix(SOUND_DATA_HEADER)
     end
 
     def offset
-      0x100 - sound_bytes.length
+      0x100 - sound_theme_data.bytesize
     end
   end
 end

data/lib/timex_datalink_client/start.rb

@@ -8,6 +8,9 @@ class TimexDatalinkClient
 
     CPACKET_START = [0x20, 0x00, 0x00, 0x03]
 
+    # Compile packets for data start command.
+    #
+    # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
     def packets
       [CPACKET_START]
     end

data/lib/timex_datalink_client/sync.rb

@@ -9,10 +9,17 @@ class TimexDatalinkClient
 
     attr_accessor :length
 
+    # Create a Sync instance.
+    #
+    # @param length [Integer] Number of 0x55 sync bytes to use.
+    # @return [Sync] Sync instance.
     def initialize(length: 300)
       @length = length
     end
 
+    # Compile packets for syncronization data.
+    #
+    # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
     def packets
       [render_sync_1 + render_sync_2]
     end

data/lib/timex_datalink_client/time.rb

@@ -12,13 +12,25 @@ class TimexDatalinkClient
 
     attr_accessor :zone, :is_24h, :date_format, :time
 
-    def initialize(zone:, is_24h:, date_format:, time:)
+    # Create a Time instance.
+    #
+    # @param zone [Integer] Time zone number (1 or 2).
+    # @param is_24h [Boolean] Toggle 24 hour time.
+    # @param date_format [Integer] Date format.
+    # @param time [::Time] Time to set (including time zone).
+    # @param name [String, nil] Name of time zone (defaults to zone from time; 3 chars max)
+    # @return [Time] Time instance.
+    def initialize(zone:, is_24h:, date_format:, time:, name: nil)
       @zone = zone
       @is_24h = is_24h
       @date_format = date_format
       @time = time
+      @name = name
     end
 
+    # Compile packets for a time.
+    #
+    # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
     def packets
       [
         [
@@ -30,7 +42,7 @@ class TimexDatalinkClient
           time.month,
           time.day,
           year_mod_1900,
-          timezone_characters,
+          name_characters,
           wday_from_monday,
           is_24h_value,
           date_format
@@ -40,8 +52,12 @@ class TimexDatalinkClient
 
     private
 
-    def timezone_characters
-      chars_for(time.zone.downcase)
+    def name
+      @name || time.zone.downcase
+    end
+
+    def name_characters
+      chars_for(name, length: 3, pad: true)
     end
 
     def year_mod_1900

data/lib/timex_datalink_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TimexDatalinkClient
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/timex_datalink_client/wrist_app.rb

@@ -16,12 +16,21 @@ class TimexDatalinkClient
     WRIST_APP_DELIMITER = /\xac.*\r\n/n
     WRIST_APP_CODE_INDEX = 8
 
-    attr_accessor :wrist_app_data
+    attr_accessor :zap_file
 
-    def initialize(wrist_app_data:)
+    # Create a WristApp instance.
+    #
+    # @param wrist_app_data [String, nil] WristApp data.
+    # @param zap_file [String, nil] Path to ZAP file.
+    # @return [WristApp] WristApp instance.
+    def initialize(wrist_app_data: nil, zap_file: nil)
       @wrist_app_data = wrist_app_data
+      @zap_file = zap_file
     end
 
+    # Compile packets for an alarm.
+    #
+    # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
     def packets
       [CPACKET_CLEAR, cpacket_sect] + payloads + [CPACKET_END]
     end
@@ -32,16 +41,24 @@ class TimexDatalinkClient
       CPACKET_SECT + [payloads.length, 1]
     end
 
-    def wrist_app_ascii
-      wrist_app_data.split(WRIST_APP_DELIMITER)[WRIST_APP_CODE_INDEX]
+    def payloads
+      paginate_cpackets(header: CPACKET_DATA, cpackets: wrist_app_data.bytes)
     end
 
-    def wrist_app_bytes
-      [wrist_app_ascii].pack("H*").bytes
+    def wrist_app_data
+      @wrist_app_data || zap_file_data_binary
     end
 
-    def payloads
-      paginate_cpackets(header: CPACKET_DATA, cpackets: wrist_app_bytes)
+    def zap_file_data
+      File.open(zap_file, "rb").read
+    end
+
+    def zap_file_data_ascii
+      zap_file_data.split(WRIST_APP_DELIMITER)[WRIST_APP_CODE_INDEX]
+    end
+
+    def zap_file_data_binary
+      [zap_file_data_ascii].pack("H*")
     end
   end
 end

data/lib/timex_datalink_client.rb

@@ -17,18 +17,35 @@ require "timex_datalink_client/version"
 require "timex_datalink_client/wrist_app"
 
 class TimexDatalinkClient
-  attr_accessor :serial_device, :models, :verbose
+  attr_accessor :serial_device, :models, :byte_sleep, :packet_sleep, :verbose
 
-  def initialize(serial_device:, models: [], verbose: false)
+  # Create a TimexDatalinkClient instance.
+  #
+  # @param serial_device [String] Path to serial device.
+  # @param models [Array<Alarm, Eeprom, End, SoundOptions, SoundTheme, Start, Sync, Time, WristApp>] Models to compile
+  #   data for.
+  # @param byte_sleep [Integer, nil] Time to sleep after sending byte.
+  # @param packet_sleep [Integer, nil] Time to sleep after sending packet of bytes.
+  # @param verbose [Boolean] Write verbose output to console.
+  # @return [TimexDatalinkClient] TimexDatalinkClient instance.
+  def initialize(serial_device:, models: [], byte_sleep: nil, packet_sleep: nil, verbose: false)
     @serial_device = serial_device
     @models = models
+    @byte_sleep = byte_sleep
+    @packet_sleep = packet_sleep
     @verbose = verbose
   end
 
+  # Write data for all models to serial device.
+  #
+  # @return [void]
   def write
     notebook_adapter.write(packets)
   end
 
+  # Compile packets for all models.
+  #
+  # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
   def packets
     models.map(&:packets).flatten(1)
   end
@@ -38,6 +55,8 @@ class TimexDatalinkClient
   def notebook_adapter
     @notebook_adapter ||= NotebookAdapter.new(
       serial_device: serial_device,
+      byte_sleep: byte_sleep,
+      packet_sleep: packet_sleep,
       verbose: verbose
     )
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timex_datalink_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Maxwell Pray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-07 00:00:00.000000000 Z
+date: 2022-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crc
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: yard-junk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.9
 description: Write data to Timex Datalink watches with an optical sensor
 email: synthead@gmail.com
 executables: []