timex_datalink_client 0.3.1 → 0.5.0

data/lib/timex_datalink_client/protocol_3/sync.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/sync"
+
+class TimexDatalinkClient
+  class Protocol3
+    class Sync < Sync
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_3/time.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol3
+    class Time
+      include Helpers::CharEncoders
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_TIME = [0x32]
+
+      attr_accessor :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
+        [
+          [
+            CPACKET_TIME,
+            zone,
+            time.sec,
+            time.hour,
+            time.min,
+            time.month,
+            time.day,
+            year_mod_1900,
+            name_characters,
+            wday_from_monday,
+            is_24h_value,
+            date_format
+          ].flatten
+        ]
+      end
+
+      private
+
+      def name
+        @name || time.zone.downcase
+      end
+
+      def name_characters
+        chars_for(name, length: 3, pad: true)
+      end
+
+      def year_mod_1900
+        time.year % 100
+      end
+
+      def wday_from_monday
+        (time.wday + 6) % 7
+      end
+
+      def is_24h_value
+        is_24h ? 2 : 1
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_3/wrist_app.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/cpacket_paginator"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol3
+    class WristApp
+      include Helpers::CpacketPaginator
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_CLEAR = [0x93, 0x02]
+      CPACKET_SECT = [0x90, 0x02]
+      CPACKET_DATA = [0x91, 0x02]
+      CPACKET_END = [0x92, 0x02]
+
+      CPACKET_DATA_LENGTH = 32
+      WRIST_APP_DELIMITER = /\xac.*\r\n/n
+      WRIST_APP_CODE_INDEX = 8
+
+      attr_accessor :zap_file
+
+      # 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
+
+      private
+
+      def cpacket_sect
+        CPACKET_SECT + [payloads.length, 1]
+      end
+
+      def payloads
+        paginate_cpackets(header: CPACKET_DATA, length: CPACKET_DATA_LENGTH, cpackets: wrist_app_data.bytes)
+      end
+
+      def wrist_app_data
+        @wrist_app_data || zap_file_data_binary
+      end
+
+      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
+end

data/lib/timex_datalink_client/version.rb

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

data/lib/timex_datalink_client.rb

@@ -1,20 +1,30 @@
 # frozen_string_literal: true
 
-require "timex_datalink_client/alarm"
-require "timex_datalink_client/eeprom"
+require "timex_datalink_client/version"
+require "timex_datalink_client/notebook_adapter"
+
 require "timex_datalink_client/eeprom/anniversary"
 require "timex_datalink_client/eeprom/appointment"
 require "timex_datalink_client/eeprom/list"
 require "timex_datalink_client/eeprom/phone_number"
-require "timex_datalink_client/end"
-require "timex_datalink_client/notebook_adapter"
-require "timex_datalink_client/sound_options"
-require "timex_datalink_client/sound_theme"
-require "timex_datalink_client/start"
-require "timex_datalink_client/sync"
-require "timex_datalink_client/time"
-require "timex_datalink_client/version"
-require "timex_datalink_client/wrist_app"
+
+require "timex_datalink_client/protocol_1/alarm"
+require "timex_datalink_client/protocol_1/eeprom"
+require "timex_datalink_client/protocol_1/end"
+require "timex_datalink_client/protocol_1/start"
+require "timex_datalink_client/protocol_1/sync"
+require "timex_datalink_client/protocol_1/time"
+require "timex_datalink_client/protocol_1/time_name"
+
+require "timex_datalink_client/protocol_3/alarm"
+require "timex_datalink_client/protocol_3/eeprom"
+require "timex_datalink_client/protocol_3/end"
+require "timex_datalink_client/protocol_3/sound_options"
+require "timex_datalink_client/protocol_3/sound_theme"
+require "timex_datalink_client/protocol_3/start"
+require "timex_datalink_client/protocol_3/sync"
+require "timex_datalink_client/protocol_3/time"
+require "timex_datalink_client/protocol_3/wrist_app"
 
 class TimexDatalinkClient
   attr_accessor :serial_device, :models, :byte_sleep, :packet_sleep, :verbose
@@ -22,7 +32,8 @@ class TimexDatalinkClient
   # 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
+  # @param models [Array<Protocol3::Alarm, Protocol3::Eeprom, Protocol3::End, Protocol3::SoundOptions,
+  #   Protocol3::SoundTheme, Protocol3::Start, Protocol3::Sync, Protocol3::Time, Protocol3::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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timex_datalink_client
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Maxwell Pray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crc
@@ -80,15 +80,13 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.9
-description: Write data to Timex Datalink watches with an optical sensor
+description:
 email: synthead@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/timex_datalink_client.rb
-- lib/timex_datalink_client/alarm.rb
-- lib/timex_datalink_client/eeprom.rb
 - lib/timex_datalink_client/eeprom/anniversary.rb
 - lib/timex_datalink_client/eeprom/appointment.rb
 - lib/timex_datalink_client/eeprom/list.rb
@@ -99,14 +97,25 @@ files:
 - lib/timex_datalink_client/helpers/crc_packets_wrapper.rb
 - lib/timex_datalink_client/helpers/length_packet_wrapper.rb
 - lib/timex_datalink_client/notebook_adapter.rb
-- lib/timex_datalink_client/sound_options.rb
-- lib/timex_datalink_client/sound_theme.rb
-- lib/timex_datalink_client/start.rb
+- lib/timex_datalink_client/protocol_1/alarm.rb
+- lib/timex_datalink_client/protocol_1/eeprom.rb
+- lib/timex_datalink_client/protocol_1/end.rb
+- lib/timex_datalink_client/protocol_1/start.rb
+- lib/timex_datalink_client/protocol_1/sync.rb
+- lib/timex_datalink_client/protocol_1/time.rb
+- lib/timex_datalink_client/protocol_1/time_name.rb
+- lib/timex_datalink_client/protocol_3/alarm.rb
+- lib/timex_datalink_client/protocol_3/eeprom.rb
+- lib/timex_datalink_client/protocol_3/end.rb
+- lib/timex_datalink_client/protocol_3/sound_options.rb
+- lib/timex_datalink_client/protocol_3/sound_theme.rb
+- lib/timex_datalink_client/protocol_3/start.rb
+- lib/timex_datalink_client/protocol_3/sync.rb
+- lib/timex_datalink_client/protocol_3/time.rb
+- lib/timex_datalink_client/protocol_3/wrist_app.rb
 - lib/timex_datalink_client/sync.rb
-- lib/timex_datalink_client/time.rb
 - lib/timex_datalink_client/version.rb
-- lib/timex_datalink_client/wrist_app.rb
-homepage: https://github.com/synthead/timex_datalink_client
+homepage: https://github.com/synthead/timex_datalink_client/tree/v0.5.0
 licenses:
 - MIT
 metadata: {}
@@ -128,5 +137,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Library for optical Timex Datalink watches
+summary: Write data to Timex Datalink devices with an optical sensor
 test_files: []

data/lib/timex_datalink_client/alarm.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require "timex_datalink_client/helpers/char_encoders"
-require "timex_datalink_client/helpers/crc_packets_wrapper"
-
-class TimexDatalinkClient
-  class Alarm
-    include Helpers::CharEncoders
-    prepend Helpers::CrcPacketsWrapper
-
-    CPACKET_ALARM = [0x50]
-
-    MESSAGE_LENGTH = 8
-
-    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
-      @time = time
-      @message = message
-    end
-
-    # Compile packets for an alarm.
-    #
-    # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
-    def packets
-      [
-        [
-          CPACKET_ALARM,
-          number,
-          time.hour,
-          time.min,
-          0,
-          0,
-          message_characters,
-          audible_integer
-        ].flatten
-      ]
-    end
-
-    private
-
-    def message_characters
-      message_padded = message.ljust(MESSAGE_LENGTH)
-
-      chars_for(message_padded)
-    end
-
-    def audible_integer
-      audible ? 1 : 0
-    end
-  end
-end

data/lib/timex_datalink_client/eeprom.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-require "timex_datalink_client/helpers/cpacket_paginator"
-require "timex_datalink_client/helpers/crc_packets_wrapper"
-
-class TimexDatalinkClient
-  class Eeprom
-    include Helpers::CpacketPaginator
-    prepend Helpers::CrcPacketsWrapper
-
-    CPACKET_CLEAR = [0x93, 0x01]
-    CPACKET_SECT = [0x90, 0x01]
-    CPACKET_DATA = [0x91, 0x01]
-    CPACKET_END = [0x92, 0x01]
-
-    START_ADDRESS = 0x0236
-    APPOINTMENT_NO_NOTIFICATION = 0xff
-
-    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
-      @phone_numbers = phone_numbers
-      @lists = lists
-      @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
-
-    private
-
-    def header
-      [
-        CPACKET_SECT,
-        payloads.length,
-        items_addresses,
-        items_lengths,
-        earliest_appointment_year,
-        appointment_notification
-      ].flatten
-    end
-
-    def payloads
-      paginate_cpackets(header: CPACKET_DATA, cpackets: all_packets)
-    end
-
-    def all_items
-      [appointments, lists, phone_numbers, anniversaries]
-    end
-
-    def all_packets
-      all_items.flatten.map(&:packet).flatten
-    end
-
-    def items_addresses
-      address = START_ADDRESS
-
-      all_items.each_with_object([]) do |items, addresses|
-        addresses.concat(address.divmod(256))
-
-        address += items.sum { |item| item.packet.length }
-      end
-    end
-
-    def items_lengths
-      all_items.map(&:length)
-    end
-
-    def earliest_appointment_year
-      earliest_appointment = appointments.min_by(&:time)
-
-      return 0 unless earliest_appointment
-
-      earliest_appointment.time.year % 100
-    end
-  end
-end

data/lib/timex_datalink_client/sound_options.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require "timex_datalink_client/helpers/crc_packets_wrapper"
-
-class TimexDatalinkClient
-  class SoundOptions
-    prepend Helpers::CrcPacketsWrapper
-
-    CPACKET_BEEPS = [0x71]
-
-    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]
-      ]
-    end
-
-    def hourly_chime_integer
-      hourly_chime ? 1 : 0
-    end
-
-    def button_beep_integer
-      button_beep ? 1 : 0
-    end
-  end
-end

data/lib/timex_datalink_client/sound_theme.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require "timex_datalink_client/helpers/cpacket_paginator"
-require "timex_datalink_client/helpers/crc_packets_wrapper"
-
-class TimexDatalinkClient
-  class SoundTheme
-    include Helpers::CpacketPaginator
-    prepend Helpers::CrcPacketsWrapper
-
-    CPACKET_SECT = [0x90, 0x03]
-    CPACKET_DATA = [0x91, 0x03]
-    CPACKET_END = [0x92, 0x03]
-
-    SOUND_DATA_HEADER = "\x25\x04\x19\x69"
-
-    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 load_sect
-      CPACKET_SECT + [payloads.length, offset]
-    end
-
-    def payloads
-      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_theme_data.bytesize
-    end
-  end
-end

data/lib/timex_datalink_client/start.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "timex_datalink_client/helpers/crc_packets_wrapper"
-
-class TimexDatalinkClient
-  class Start
-    prepend Helpers::CrcPacketsWrapper
-
-    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
-  end
-end

data/lib/timex_datalink_client/time.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-require "timex_datalink_client/helpers/char_encoders"
-require "timex_datalink_client/helpers/crc_packets_wrapper"
-
-class TimexDatalinkClient
-  class Time
-    include Helpers::CharEncoders
-    prepend Helpers::CrcPacketsWrapper
-
-    CPACKET_TIME = [0x32]
-
-    attr_accessor :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).
-    # @return [Time] Time instance.
-    def initialize(zone:, is_24h:, date_format:, time:)
-      @zone = zone
-      @is_24h = is_24h
-      @date_format = date_format
-      @time = time
-    end
-
-    # Compile packets for a time.
-    #
-    # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
-    def packets
-      [
-        [
-          CPACKET_TIME,
-          zone,
-          time.sec,
-          time.hour,
-          time.min,
-          time.month,
-          time.day,
-          year_mod_1900,
-          timezone_characters,
-          wday_from_monday,
-          is_24h_value,
-          date_format
-        ].flatten
-      ]
-    end
-
-    private
-
-    def timezone_characters
-      chars_for(time.zone.downcase)
-    end
-
-    def year_mod_1900
-      time.year % 100
-    end
-
-    def wday_from_monday
-      (time.wday + 6) % 7
-    end
-
-    def is_24h_value
-      is_24h ? 2 : 1
-    end
-  end
-end

data/lib/timex_datalink_client/wrist_app.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require "timex_datalink_client/helpers/cpacket_paginator"
-require "timex_datalink_client/helpers/crc_packets_wrapper"
-
-class TimexDatalinkClient
-  class WristApp
-    include Helpers::CpacketPaginator
-    prepend Helpers::CrcPacketsWrapper
-
-    CPACKET_CLEAR = [0x93, 0x02]
-    CPACKET_SECT = [0x90, 0x02]
-    CPACKET_DATA = [0x91, 0x02]
-    CPACKET_END = [0x92, 0x02]
-
-    WRIST_APP_DELIMITER = /\xac.*\r\n/n
-    WRIST_APP_CODE_INDEX = 8
-
-    attr_accessor :zap_file
-
-    # 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
-
-    private
-
-    def cpacket_sect
-      CPACKET_SECT + [payloads.length, 1]
-    end
-
-    def payloads
-      paginate_cpackets(header: CPACKET_DATA, cpackets: wrist_app_data.bytes)
-    end
-
-    def wrist_app_data
-      @wrist_app_data || zap_file_data_binary
-    end
-
-    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