timex_datalink_client 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1e1ba04b363121e40f0dd55b6ec5b6b97abed22e912f2b5155f11a0bef098c7
-  data.tar.gz: fbfaed8471f55ab6d5ebfa515f62f1d396239e4b9c043a3aad2f783be3007219
+  metadata.gz: 93fe636dc699046ea5c14683b355f8c65bb162fb18ee91b3ffe27f4a72633808
+  data.tar.gz: d9476317e2cce78a77247c277e77208969f6e8fa13059a2e0f7452f502f9b112
 SHA512:
-  metadata.gz: fca16b6fdacba5294c6eb4b5645f5e2a8b54f3f38b1477771d84357e6365bb7e39e0821d9827e912d35f0f0dd2a58a081f422f650f604fb28770e55093895e41
-  data.tar.gz: fa6e1bc0cb2f273e729510cb6eabc4399c90c034ae3b7888fde84160aaff0a57b4867ba661929a437558613401435aa62e1ab71790494d764536cff6949b41a1
+  metadata.gz: 313b6bc8ea78a28ee55534ff28648a6544a8aa7dcf1abd731461fc7b9c21ba3711d441de603d7f538666541d5fce4ca0d6206449a2b8cee6cf5d56a263f8691a
+  data.tar.gz: df31c376348f69fd05ba4c0de720e443074f68d63788601610021e0328598af3cfa8a3f85789336d20e80aac90be5ac32526bc6872d208afdd2c6965582f1617

data/lib/timex_datalink_client/helpers/four_byte_formatter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class TimexDatalinkClient
+  class Helpers
+    module FourByteFormatter
+      BYTE_NULL = 0x000
+      BYTE_TERMINATOR_ENDF = 0x3fe
+      BYTE_TERMINATOR_ENDR = 0x3ff
+
+      def four_byte_format_for(byte_arrays)
+        byte_arrays.each_with_index.flat_map do |bytes, bytes_index|
+          last_index = bytes_index == byte_arrays.count - 1
+          terminator = last_index ? BYTE_TERMINATOR_ENDR : BYTE_TERMINATOR_ENDF
+
+          bytes_with_terminator = bytes + [terminator]
+
+          bytes_with_terminator.each_slice(4).flat_map do |bytes_slice|
+            bytes_slice.fill(BYTE_NULL, bytes_slice.count, 4 - bytes_slice.count)
+
+            packet_lsbs_sum = bytes_slice.each_with_index.sum { |byte, index| byte / 256 << 6 - index * 2 }
+            packet_msbs = bytes_slice.map { |byte| byte % 256 }
+
+            [packet_lsbs_sum] + packet_msbs
+          end
+        end
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_4/alarm.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol4
+    class Alarm
+      include Helpers::CharEncoders
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_ALARM = [0x50]
+
+      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
+        chars_for(message, length: 8, pad: true)
+      end
+
+      def audible_integer
+        audible ? 1 : 0
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_4/eeprom/anniversary.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/length_packet_wrapper"
+
+class TimexDatalinkClient
+  class Protocol4
+    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
+end

data/lib/timex_datalink_client/protocol_4/eeprom/appointment.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/length_packet_wrapper"
+
+class TimexDatalinkClient
+  class Protocol4
+    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
+end

data/lib/timex_datalink_client/protocol_4/eeprom/list.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/length_packet_wrapper"
+
+class TimexDatalinkClient
+  class Protocol4
+    class Eeprom
+      class List
+        include Helpers::CharEncoders
+        prepend Helpers::LengthPacketWrapper
+
+        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,
+            list_entry_characters
+          ].flatten
+        end
+
+        private
+
+        def list_entry_characters
+          eeprom_chars_for(list_entry)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/length_packet_wrapper"
+
+class TimexDatalinkClient
+  class Protocol4
+    class Eeprom
+      class PhoneNumber
+        include Helpers::CharEncoders
+        prepend Helpers::LengthPacketWrapper
+
+        PHONE_DIGITS = 12
+
+        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_padded
+          number_with_type = "#{number} #{type}"
+          number_with_type.rjust(PHONE_DIGITS)
+        end
+
+        def number_with_type_characters
+          phone_chars_for(number_with_type_padded)
+        end
+
+        def name_characters
+          eeprom_chars_for(name)
+        end
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_4/eeprom.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/cpacket_paginator"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol4
+    class Eeprom
+      include Helpers::CpacketPaginator
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_CLEAR = [0x93, 0x01]
+      CPACKET_SECT = [0x90, 0x01]
+      CPACKET_DATA = [0x91, 0x01]
+      CPACKET_END = [0x92, 0x01]
+
+      CPACKET_DATA_LENGTH = 32
+      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, length: CPACKET_DATA_LENGTH, 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
+end

data/lib/timex_datalink_client/protocol_4/end.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol4
+    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_4/sound_options.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol4
+    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
+end

data/lib/timex_datalink_client/protocol_4/sound_theme.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/cpacket_paginator"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol4
+    class SoundTheme
+      include Helpers::CpacketPaginator
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_SECT = [0x90, 0x03]
+      CPACKET_DATA = [0x91, 0x03]
+      CPACKET_END = [0x92, 0x03]
+
+      CPACKET_DATA_LENGTH = 32
+      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, length: CPACKET_DATA_LENGTH, 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
+end

data/lib/timex_datalink_client/protocol_4/start.rb

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class TimexDatalinkClient
+  class Protocol4
+    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_4/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 Protocol4
+    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