timex_datalink_client 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 187352acb16bdc8baa7fec37d4793942f49b6c3d60da9a778b4afd94505c9f1e
-  data.tar.gz: 55214e32e3536da008eb7739d0921af0012c1af6ff70d17491ef37a2fd6008a8
+  metadata.gz: 061a85e62bc26614e71a4fa43dc9c17cc6092a516a417d5545d7ecd029a34af6
+  data.tar.gz: 4e3fc39203b45c38599c6980c72c42e6e05efdc87e7c7d5c9f4cc099e995d39e
 SHA512:
-  metadata.gz: 9106e98e689a8646ab779cd1ca38bce9c220c8aa80ae0fe984237e6a92270b0ee10bbdf9b31bc40c4492dc7b17d25c796baf7f3a5720a4649d7deb09a37b540f
-  data.tar.gz: 70e7601d4ba51ecfc3cb6d3f51549e8272ec3baf55ee39174a6fbc5f48272569efcfad25b3eef447a05af767c855f79a4b84d15c286a39d30d2ad7506d273213
+  metadata.gz: 40b7dbbfd0af7b4600b5d94623584615b193b2011b976ed229ee7ba084892ba05d31002150dd9decfafcaecb301d2fa44d1c9a5a03ecace2a20441edda50b6ca
+  data.tar.gz: b902ecee9de6ebf920e86a08c57e9651730335492c1e05ccfe55d0169fbf7c714ac5ba02f8640983ea69bc5d34ae1269e8f1d97b9e36f4d3921e07cdea0f039c

data/lib/timex_datalink_client/helpers/char_encoders.rb

@@ -3,19 +3,24 @@
 class TimexDatalinkClient
   class Helpers
     module CharEncoders
-      CHARS = "0123456789abcdefghijklmnopqrstuvwxyz !\"#$%&'()*+,-./:\\;=@?ABCDEF"
+      CHARS = "0123456789abcdefghijklmnopqrstuvwxyz !\"#$%&'()*+,-./:\\;=@?_|<>[]"
+      EEPROM_CHARS = "0123456789abcdefghijklmnopqrstuvwxyz !\"#$%&'()*+,-./:\\;=@?_|<>["
+      PHONE_CHARS = "0123456789cfhpw "
+      INVALID_CHAR = " "
+
       EEPROM_TERMINATOR = 0x3f
 
-      PHONE_CHARS = "0123456789cfhpw "
+      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
 
-      def chars_for(string_chars, char_map: CHARS)
-        string_chars.each_char.map do |string_char|
-          char_map.index(string_char)
+        formatted_chars.each_char.map do |char|
+          char_map.index(char) || char_map.index(INVALID_CHAR)
         end
       end
 
       def eeprom_chars_for(string_chars)
-        chars = chars_for(string_chars).append(EEPROM_TERMINATOR)
+        chars = chars_for(string_chars, char_map: EEPROM_CHARS, length: 31).append(EEPROM_TERMINATOR)
 
         packed_int = chars.each_with_index.sum do |char, index|
           char << (6 * index)
@@ -25,7 +30,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/helpers/cpacket_paginator.rb

@@ -3,10 +3,8 @@
 class TimexDatalinkClient
   class Helpers
     module CpacketPaginator
-      ITEMS_PER_PACKET = 32
-
-      def paginate_cpackets(header:, cpackets:)
-        paginated_cpackets = cpackets.each_slice(ITEMS_PER_PACKET)
+      def paginate_cpackets(header:, length:, cpackets:)
+        paginated_cpackets = cpackets.each_slice(length)
 
         paginated_cpackets.map.with_index(1) do |paginated_cpacket, index|
           header + [index] + paginated_cpacket

data/lib/timex_datalink_client/protocol_1/alarm.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol1
+    class Alarm
+      include Helpers::CharEncoders
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_ALARM = [0x50]
+      CPACKET_ALARM_SILENT = [0x70, 0x00]
+
+      ALARM_SILENT_START_INDEX = 0x61
+
+      attr_accessor :number, :audible, :time, :message, :month, :day
+
+      # 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.
+      # @param month [Integer, nil] Month of alarm.
+      # @param day [Integer, nil] Day of alarm.
+      # @return [Alarm] Alarm instance.
+      def initialize(number:, audible:, time:, message:, month: nil, day: nil)
+        @number = number
+        @audible = audible
+        @time = time
+        @message = message
+        @month = month
+        @day = day
+      end
+
+      # Compile packets for an alarm.
+      #
+      # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
+      def packets
+        [alarm_data_packet].tap do |packets|
+          packets << alarm_silent_packet unless audible
+        end
+      end
+
+      private
+
+      def alarm_data_packet
+        [
+          CPACKET_ALARM,
+          number,
+          time.hour,
+          time.min,
+          month.to_i,
+          day.to_i,
+          message_characters,
+          audible_integer
+        ].flatten
+      end
+
+      def alarm_silent_packet
+        [
+          CPACKET_ALARM_SILENT,
+          alarm_silent_index,
+          0
+        ].flatten
+      end
+
+      def message_characters
+        chars_for(message, length: 8, pad: true)
+      end
+
+      def audible_integer
+        audible ? 1 : 0
+      end
+
+      def alarm_silent_index
+        ALARM_SILENT_START_INDEX + number
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_1/eeprom.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/cpacket_paginator"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol1
+    class Eeprom
+      include Helpers::CpacketPaginator
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_SECT = [0x60]
+      CPACKET_DATA = [0x61]
+      CPACKET_END = [0x62]
+
+      CPACKET_DATA_LENGTH = 27
+      START_INDEX = 14
+      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
+        [header] + payloads + [CPACKET_END]
+      end
+
+      private
+
+      def header
+        [
+          CPACKET_SECT,
+          payloads.length
+        ].flatten
+      end
+
+      def payload
+        [
+          items_indexes,
+          items_lengths,
+          earliest_appointment_year,
+          appointment_notification,
+          all_packets
+        ].flatten
+      end
+
+      def payloads
+        paginate_cpackets(header: CPACKET_DATA, length: CPACKET_DATA_LENGTH, cpackets: payload)
+      end
+
+      def all_items
+        [appointments, lists, phone_numbers, anniversaries]
+      end
+
+      def all_packets
+        all_items.flatten.map(&:packet).flatten
+      end
+
+      def items_indexes
+        index = START_INDEX
+
+        all_items.each_with_object([]) do |items, indexes|
+          indexes.concat(index.divmod(256))
+
+          index += 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_1/end.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/end"
+
+class TimexDatalinkClient
+  class Protocol1
+    class End < End
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_1/start.rb

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

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

data/lib/timex_datalink_client/protocol_1/time.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol1
+    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_1/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 Protocol1
+    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_3/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 Protocol3
+    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_3/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 Protocol3
+    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_3/end.rb

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

data/lib/timex_datalink_client/protocol_3/sound_options.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol3
+    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_3/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 Protocol3
+    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_3/start.rb

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