timex_datalink_client 0.5.0 → 0.6.0

data/lib/timex_datalink_client/protocol_9/eeprom/phone_number.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/length_packet_wrapper"
+
+class TimexDatalinkClient
+  class Protocol9
+    class Eeprom
+      class PhoneNumber
+        include Helpers::CharEncoders
+        prepend Helpers::LengthPacketWrapper
+
+        NAME_CHARS = 15
+        PHONE_DIGITS = 12
+        TYPE_DIGITS = 2
+
+        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,
+            name_characters
+          ].flatten
+        end
+
+        private
+
+        def number_with_type_characters
+          phone_chars_for(number_with_type_padded)
+        end
+
+        def name_characters
+          eeprom_chars_for(name_with_number_rollover, length: NAME_CHARS)
+        end
+
+        def number_with_type_padded
+          type_padded = type.rjust(TYPE_DIGITS)
+          number_with_type = "#{number}#{type_padded}"
+
+          number_with_type.rjust(PHONE_DIGITS)
+        end
+
+        def number_rollover
+          "-" + number[PHONE_DIGITS..]
+        end
+
+        def name_with_number_rollover
+          return name unless number.length > PHONE_DIGITS
+
+          truncate_length = NAME_CHARS - (name.length + number_rollover.length)
+
+          return "#{name}#{number_rollover}" unless truncate_length.negative?
+
+          "#{name[..truncate_length - 1]}#{number_rollover}"
+        end
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_9/eeprom.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/cpacket_paginator"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol9
+    class Eeprom
+      include Helpers::CpacketPaginator
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_MEM = [0x70]
+      CPACKET_JMPMEM = [0x23]
+      CPACKET_SECT = [0x60]
+      CPACKET_DATA = [0x61]
+      CPACKET_END = [0x62]
+
+      SETUP_PACKETS = [
+        CPACKET_MEM + [
+          0x02, 0x40, 0x05, 0xa9, 0x22, 0x5f, 0xe6, 0xb2, 0xe8, 0xbb, 0xe7, 0xb2, 0xe8, 0xbb, 0xe7, 0xbb, 0xe8, 0xb2,
+          0xe7, 0xb2, 0x5c, 0xa3, 0x09, 0x26, 0xed, 0x15, 0xa9, 0x01
+        ],
+        CPACKET_MEM + [0x02, 0x5a, 0xa9, 0x02, 0x14, 0xa9, 0xb6, 0xa9, 0xa4, 0x07, 0x47, 0xb7, 0xa9, 0xcc, 0x74, 0x6f],
+        CPACKET_JMPMEM + [0x02, 0x40]
+      ]
+
+      PAYLOAD_HEADER = [0x00, 0x0e, 0x00]
+
+      CPACKET_DATA_LENGTH = 27
+      START_INDEX = 14
+      APPOINTMENT_NO_NOTIFICATION = 0xff
+
+      def self.empty_chrono
+        Chrono.new(label: "chrono", laps: 2)
+      end
+
+      attr_accessor :chrono, :phone_numbers
+
+      # Create an Eeprom instance.
+      #
+      # @param chrono [Chrono] Chrono to be added to EEPROM data.
+      # @param phone_numbers [Array<PhoneNumber>] Phone numbers to be added to EEPROM data.
+      # @return [Eeprom] Eeprom instance.
+      def initialize(chrono: nil, phone_numbers: [])
+        @chrono = chrono || self.class.empty_chrono
+        @phone_numbers = phone_numbers
+      end
+
+      # Compile packets for EEPROM data.
+      #
+      # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
+      def packets
+        SETUP_PACKETS + [header] + payloads + [CPACKET_END]
+      end
+
+      private
+
+      def header
+        CPACKET_SECT + [payloads.length]
+      end
+
+      def payload
+        [
+          PAYLOAD_HEADER,
+          chrono.chrono_bytesize,
+          chrono.laps,
+          phone_numbers.length,
+          all_packets
+        ].flatten
+      end
+
+      def payloads
+        paginate_cpackets(header: CPACKET_DATA, length: CPACKET_DATA_LENGTH, cpackets: payload)
+      end
+
+      def all_items
+        [[chrono], phone_numbers]
+      end
+
+      def all_packets
+        all_items.flatten.map(&:packet).flatten
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_9/end.rb

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

data/lib/timex_datalink_client/protocol_9/sound_options.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol9
+    class SoundOptions
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_BEEPS = [0x32]
+
+      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_value + button_beep_value]
+        ]
+      end
+
+      def hourly_chime_value
+        hourly_chime ? 1 : 0
+      end
+
+      def button_beep_value
+        button_beep ? 2 : 0
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_9/start.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol9
+    class Start
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_START = [0x20, 0x00, 0x00, 0x09]
+
+      # 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
+end

data/lib/timex_datalink_client/protocol_9/sync.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class TimexDatalinkClient
+  class Protocol9
+    class Sync
+      PING_BYTE = [0x78]
+      SYNC_1_BYTE = [0x55]
+      SYNC_2_BYTE = [0xaa]
+
+      SYNC_2_LENGTH = 40
+
+      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
+        [PING_BYTE + render_sync_1 + render_sync_2]
+      end
+
+      private
+
+      def render_sync_1
+        SYNC_1_BYTE * length
+      end
+
+      def render_sync_2
+        SYNC_2_BYTE * SYNC_2_LENGTH
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_9/time.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol9
+    class Time
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_TIME = [0x30]
+
+      attr_accessor :zone, :is_24h, :time
+
+      # Create a Time instance.
+      #
+      # @param zone [Integer] Time zone number (1 or 2).
+      # @param is_24h [Boolean] Toggle 24 hour time.
+      # @param time [::Time] Time to set.
+      # @return [Time] Time instance.
+      def initialize(zone:, is_24h:, time:)
+        @zone = zone
+        @is_24h = is_24h
+        @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.hour,
+            time.min,
+            time.month,
+            time.day,
+            year_mod_1900,
+            wday_from_monday,
+            time.sec,
+            is_24h_value
+          ].flatten
+        ]
+      end
+
+      private
+
+      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_9/time_name.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol9
+    class TimeName
+      include Helpers::CharEncoders
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_NAME = [0x31]
+
+      attr_accessor :zone, :name
+
+      # Create a TimeName instance.
+      #
+      # @param zone [Integer] Time zone number (1 or 2).
+      # @param name [String] Name of time zone (3 chars max)
+      # @return [TimeName] TimeName instance.
+      def initialize(zone:, name:)
+        @zone = zone
+        @name = name
+      end
+
+      # Compile packets for a time name.
+      #
+      # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
+      def packets
+        [
+          [
+            CPACKET_NAME,
+            zone,
+            name_characters
+          ].flatten
+        ]
+      end
+
+      private
+
+      def name_characters
+        chars_for(name, length: 3, pad: true)
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_9/timer.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol9
+    class Timer
+      include Helpers::CharEncoders
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_TIMER = [0x43]
+
+      attr_accessor :number, :label, :time, :action_at_end
+
+      # Create a Timer instance.
+      #
+      # @param number [Integer] Entry number for timer.
+      # @param label [String] Label for timer.
+      # @param time [Time] Time of timer.
+      # @param action_at_end [Integer] Action at end of timer.
+      # @return [Timer] Timer instance.
+      def initialize(number:, label:, time:, action_at_end:)
+        @number = number
+        @label = label
+        @time = time
+        @action_at_end = action_at_end
+      end
+
+      # Compile packets for a timer.
+      #
+      # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
+      def packets
+        [
+          [
+            CPACKET_TIMER,
+            number,
+            time.hour,
+            time.min,
+            time.sec,
+            action_at_end,
+            label_characters
+          ].flatten
+        ]
+      end
+
+      private
+
+      def label_characters
+        chars_for(label, length: 8, pad: true)
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/version.rb

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

data/lib/timex_datalink_client.rb

@@ -3,13 +3,12 @@
 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/protocol_1/alarm"
 require "timex_datalink_client/protocol_1/eeprom"
+require "timex_datalink_client/protocol_1/eeprom/anniversary"
+require "timex_datalink_client/protocol_1/eeprom/appointment"
+require "timex_datalink_client/protocol_1/eeprom/list"
+require "timex_datalink_client/protocol_1/eeprom/phone_number"
 require "timex_datalink_client/protocol_1/end"
 require "timex_datalink_client/protocol_1/start"
 require "timex_datalink_client/protocol_1/sync"
@@ -18,6 +17,10 @@ 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/eeprom/anniversary"
+require "timex_datalink_client/protocol_3/eeprom/appointment"
+require "timex_datalink_client/protocol_3/eeprom/list"
+require "timex_datalink_client/protocol_3/eeprom/phone_number"
 require "timex_datalink_client/protocol_3/end"
 require "timex_datalink_client/protocol_3/sound_options"
 require "timex_datalink_client/protocol_3/sound_theme"
@@ -26,15 +29,29 @@ require "timex_datalink_client/protocol_3/sync"
 require "timex_datalink_client/protocol_3/time"
 require "timex_datalink_client/protocol_3/wrist_app"
 
+require "timex_datalink_client/protocol_9/alarm"
+require "timex_datalink_client/protocol_9/eeprom"
+require "timex_datalink_client/protocol_9/eeprom/chrono"
+require "timex_datalink_client/protocol_9/eeprom/phone_number"
+require "timex_datalink_client/protocol_9/end"
+require "timex_datalink_client/protocol_9/sound_options"
+require "timex_datalink_client/protocol_9/start"
+require "timex_datalink_client/protocol_9/sync"
+require "timex_datalink_client/protocol_9/time"
+require "timex_datalink_client/protocol_9/time_name"
+require "timex_datalink_client/protocol_9/timer"
+
 class TimexDatalinkClient
   attr_accessor :serial_device, :models, :byte_sleep, :packet_sleep, :verbose
 
   # Create a TimexDatalinkClient instance.
   #
   # @param serial_device [String] Path to serial device.
-  # @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 models [Array<Protocol1::Sync, Protocol1::Start, Protocol1::Time, Protocol1::TimeName, Protocol1::Alarm,
+  #   Protocol1::Eeprom, Protocol1::End, Protocol3::Sync, Protocol3::Start, Protocol3::Time, Protocol3::Alarm,
+  #   Protocol3::Eeprom, Protocol3::SoundTheme, Protocol3::SoundOptions, Protocol3::WristApp, Protocol3::End,
+  #   Protocol9::Sync, Protocol9::Start, Protocol9::Time, Protocol9::TimeName, Protocol9::Timer, Protocol9::Alarm,
+  #   Protocol9::Eeprom, Protocol9::SoundOptions, Protocol9::End>] 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timex_datalink_client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Maxwell Pray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-12 00:00:00.000000000 Z
+date: 2022-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crc
@@ -87,11 +87,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/timex_datalink_client.rb
-- lib/timex_datalink_client/eeprom/anniversary.rb
-- lib/timex_datalink_client/eeprom/appointment.rb
-- lib/timex_datalink_client/eeprom/list.rb
-- lib/timex_datalink_client/eeprom/phone_number.rb
-- lib/timex_datalink_client/end.rb
 - lib/timex_datalink_client/helpers/char_encoders.rb
 - lib/timex_datalink_client/helpers/cpacket_paginator.rb
 - lib/timex_datalink_client/helpers/crc_packets_wrapper.rb
@@ -99,6 +94,10 @@ files:
 - lib/timex_datalink_client/notebook_adapter.rb
 - lib/timex_datalink_client/protocol_1/alarm.rb
 - lib/timex_datalink_client/protocol_1/eeprom.rb
+- lib/timex_datalink_client/protocol_1/eeprom/anniversary.rb
+- lib/timex_datalink_client/protocol_1/eeprom/appointment.rb
+- lib/timex_datalink_client/protocol_1/eeprom/list.rb
+- lib/timex_datalink_client/protocol_1/eeprom/phone_number.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
@@ -106,6 +105,10 @@ files:
 - 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/eeprom/anniversary.rb
+- lib/timex_datalink_client/protocol_3/eeprom/appointment.rb
+- lib/timex_datalink_client/protocol_3/eeprom/list.rb
+- lib/timex_datalink_client/protocol_3/eeprom/phone_number.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
@@ -113,9 +116,19 @@ files:
 - 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/protocol_9/alarm.rb
+- lib/timex_datalink_client/protocol_9/eeprom.rb
+- lib/timex_datalink_client/protocol_9/eeprom/chrono.rb
+- lib/timex_datalink_client/protocol_9/eeprom/phone_number.rb
+- lib/timex_datalink_client/protocol_9/end.rb
+- lib/timex_datalink_client/protocol_9/sound_options.rb
+- lib/timex_datalink_client/protocol_9/start.rb
+- lib/timex_datalink_client/protocol_9/sync.rb
+- lib/timex_datalink_client/protocol_9/time.rb
+- lib/timex_datalink_client/protocol_9/time_name.rb
+- lib/timex_datalink_client/protocol_9/timer.rb
 - lib/timex_datalink_client/version.rb
-homepage: https://github.com/synthead/timex_datalink_client/tree/v0.5.0
+homepage: https://github.com/synthead/timex_datalink_client/tree/v0.6.0
 licenses:
 - MIT
 metadata: {}

data/lib/timex_datalink_client/eeprom/anniversary.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require "timex_datalink_client/helpers/char_encoders"
-require "timex_datalink_client/helpers/length_packet_wrapper"
-
-class TimexDatalinkClient
-  class Eeprom
-    class Anniversary
-      include Helpers::CharEncoders
-      prepend Helpers::LengthPacketWrapper
-
-      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,
-          time.day,
-          anniversary_characters
-        ].flatten
-      end
-
-      private
-
-      def anniversary_characters
-        eeprom_chars_for(anniversary)
-      end
-    end
-  end
-end

data/lib/timex_datalink_client/eeprom/appointment.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require "timex_datalink_client/helpers/char_encoders"
-require "timex_datalink_client/helpers/length_packet_wrapper"
-
-class TimexDatalinkClient
-  class Eeprom
-    class Appointment
-      include Helpers::CharEncoders
-      prepend Helpers::LengthPacketWrapper
-
-      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,
-          time.day,
-          time_15m,
-          message_characters
-        ].flatten
-      end
-
-      private
-
-      def time_15m
-        time.hour * 4 + time.min / 15
-      end
-
-      def message_characters
-        eeprom_chars_for(message)
-      end
-    end
-  end
-end