timex_datalink_client 0.6.0 → 0.8.0

data/lib/timex_datalink_client/protocol_4/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 Protocol4
+    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 = 18
+
+      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/protocol_7/eeprom/activity.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/four_byte_formatter"
+
+class TimexDatalinkClient
+  class Protocol7
+    class Eeprom
+      class Activity
+        include Helpers::FourByteFormatter
+
+        METADATA_BYTES_BASE = 6
+        METADATA_BYTES_SIZE = 5
+
+        PACKETS_TERMINATOR = 0x04
+
+        # Compile data for all activities.
+        #
+        # @param activities [Array<Activity>] Activities to compile data for.
+        # @return [Array] Compiled data of all activities.
+        def self.packets(activities)
+          header(activities) + metadata_and_messages(activities) + [PACKETS_TERMINATOR]
+        end
+
+        private_class_method def self.header(activities)
+          [
+            random_speech(activities),
+            0,
+            0,
+            0,
+            activities.count,
+            0
+          ]
+        end
+
+        private_class_method def self.random_speech(activities)
+          activities.each_with_index.sum do |activity, activity_index|
+            activity.random_speech ? 1 << activity_index : 0
+          end
+        end
+
+        private_class_method def self.metadata_and_messages(activities)
+          metadata = activities.each_with_index.map do |activity, activity_index|
+            activity.metadata_packet(activities.count + activity_index)
+          end
+
+          messages = activities.map { |activity| activity.messages_packet }
+
+          (metadata + messages).flatten
+        end
+
+        attr_accessor :time, :messages, :random_speech
+
+        # Create an Activity instance.
+        #
+        # @param time [::Time] Time of activity.
+        # @param messages [Array<Array<Integer>>] Messages for activity.
+        # @param random_speech [Boolean] If activity should have random speech.
+        # @return [Activity] Activity instance.
+        def initialize(time:, messages:, random_speech:)
+          @time = time
+          @messages = messages
+          @random_speech = random_speech
+        end
+
+        # Compile a metadata packet for an activity.
+        #
+        # @param activity_index [Integer] Activity index.
+        # @return [Array<Integer>] Array of integers that represent bytes.
+        def metadata_packet(activity_index)
+          [
+            time.hour,
+            time.min,
+            messages.count,
+            metadata_bytes(activity_index),
+            0
+          ].flatten
+        end
+
+        # Compile a message packet for an activity.
+        #
+        # @return [Array<Integer>] Array of integers that represent bytes.
+        def messages_packet
+          four_byte_format_for(messages)
+        end
+
+        private
+
+        def metadata_bytes(activity_index)
+          METADATA_BYTES_BASE + METADATA_BYTES_SIZE * activity_index
+        end
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_7/eeprom/calendar/event.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class TimexDatalinkClient
+  class Protocol7
+    class Eeprom
+      class Calendar
+        class Event
+          FIVE_MINUTES_SECONDS = 300
+
+          attr_accessor :time, :phrase
+
+          # Create an Event instance.
+          #
+          # @param time [::Time] Time of event.
+          # @param phrase [Array<Integer>] Phrase for event.
+          # @return [Event] Event instance.
+          def initialize(time:, phrase:)
+            @time = time
+            @phrase = phrase
+          end
+
+          def time_formatted(device_time)
+            device_time_midnight = Time.new(device_time.year, device_time.month, device_time.day)
+            seconds = (time - device_time_midnight).to_i
+            five_minutes = seconds / FIVE_MINUTES_SECONDS
+
+            five_minutes.divmod(256).reverse
+          end
+        end
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_7/eeprom/calendar.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/four_byte_formatter"
+
+class TimexDatalinkClient
+  class Protocol7
+    class Eeprom
+      class Calendar
+        include Helpers::FourByteFormatter
+
+        DAY_START_TIME = Time.new(2000)
+        DAY_SECONDS = 86400
+
+        EVENTS_BYTES_BASE = 2
+        EVENTS_BYTES_EVENT = 4
+        EVENTS_BYTES_PHRASE_PACKET = 5
+
+        PACKETS_TERMINATOR = 0x01
+
+        attr_accessor :time, :events
+
+        # Create a Calendar instance.
+        #
+        # @param time [::Time] Time to set device to.
+        # @param events [Array<Event>] Event instances to add to the calendar.
+        # @return [Calendar] Calendar instance.
+        def initialize(time:, events: [])
+          @time = time
+          @events = events
+        end
+
+        # Compile data for calendar.
+        #
+        # @return [Array<Integer>] Compiled data for calendar.
+        def packet
+          [
+            events_count,
+            event_packets,
+            event_phrases,
+            time.hour,
+            time.min,
+            days_from_2000,
+            time_formatted,
+            PACKETS_TERMINATOR
+          ].flatten
+        end
+
+        private
+
+        def events_count
+          events.count.divmod(256).reverse
+        end
+
+        def event_packets
+          event_bytes = EVENTS_BYTES_BASE
+          event_bytes += EVENTS_BYTES_EVENT * events.count
+
+          [].tap do |event_packets|
+            events.each_with_index do |event, event_index|
+              event_bytes_formatted = event_bytes.divmod(256).reverse
+              event_time_formatted = event.time_formatted(time)
+
+              event_packets << [event_time_formatted, event_bytes_formatted]
+
+              event_bytes += EVENTS_BYTES_PHRASE_PACKET * (1 + event.phrase.length / 4)
+            end
+          end
+        end
+
+        def event_phrases
+          phrases = events.map(&:phrase)
+
+          four_byte_format_for(phrases)
+        end
+
+        def days_from_2000
+          since_start_time_seconds = time - DAY_START_TIME
+          since_start_time_days = since_start_time_seconds.to_i / DAY_SECONDS
+
+          since_start_time_days.divmod(256).reverse
+        end
+
+        def time_formatted
+          five_mintes = (time.hour * 60 + time.min) / 5
+
+          five_mintes.divmod(256).reverse
+        end
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_7/eeprom/games.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/four_byte_formatter"
+
+class TimexDatalinkClient
+  class Protocol7
+    class Eeprom
+      class Games
+        include Helpers::FourByteFormatter
+
+        COUNTDOWN_TIMER_SECONDS_DEFAULT = 60
+
+        COUNTDOWN_TIMER_SOUND_DEFAULT = 0x062
+        MUSIC_TIME_KEEPER_SOUND_DEFAULT = 0x062
+
+        PACKETS_TERMINATOR = 0x02
+
+        attr_accessor :memory_game_enabled, :fortune_teller_enabled, :countdown_timer_enabled, :countdown_timer_seconds,
+          :countdown_timer_sound, :mind_reader_enabled, :music_time_keeper_enabled, :music_time_keeper_sound,
+          :morse_code_practice_enabled, :treasure_hunter_enabled, :rhythm_rhyme_buster_enabled, :stop_watch_enabled,
+          :red_light_green_light_enabled
+
+        # Create a Games instance.
+        #
+        # @param memory_game_enabled [Boolean] Toggle memory game.
+        # @param fortune_teller_enabled [Boolean] Toggle fortune teller.
+        # @param countdown_timer_enabled [Boolean] Toggle countdown timer.
+        # @param countdown_timer_seconds [Integer] Duration for countdown timer in seconds.
+        # @param countdown_timer_sound [Integer] Sound for countdown timer.
+        # @param mind_reader_enabled [Boolean] Toggle mind reader.
+        # @param music_time_keeper_enabled [Boolean] Toggle music time keeper.
+        # @param music_time_keeper_sound [Integer] Sound for music time keeper.
+        # @param morse_code_practice_enabled [Boolean] Toggle Morse code practice.
+        # @param treasure_hunter_enabled [Boolean] Toggle treasure hunter.
+        # @param rhythm_rhyme_buster_enabled [Boolean] Toggle rhythm & rhyme buster.
+        # @param stop_watch_enabled [Boolean] Toggle stop watch.
+        # @param red_light_green_light_enabled [Boolean] Toggle red light, green light.
+        # @return [Games] Games instance.
+        def initialize(
+          memory_game_enabled: false,
+          fortune_teller_enabled: false,
+          countdown_timer_enabled: false,
+          countdown_timer_seconds: COUNTDOWN_TIMER_SECONDS_DEFAULT,
+          countdown_timer_sound: COUNTDOWN_TIMER_SOUND_DEFAULT,
+          mind_reader_enabled: false,
+          music_time_keeper_enabled: false,
+          music_time_keeper_sound: MUSIC_TIME_KEEPER_SOUND_DEFAULT,
+          morse_code_practice_enabled: false,
+          treasure_hunter_enabled: false,
+          rhythm_rhyme_buster_enabled: false,
+          stop_watch_enabled: false,
+          red_light_green_light_enabled: false
+        )
+          @memory_game_enabled = memory_game_enabled
+          @fortune_teller_enabled = fortune_teller_enabled
+          @countdown_timer_enabled = countdown_timer_enabled
+          @countdown_timer_seconds = countdown_timer_seconds
+          @countdown_timer_sound = countdown_timer_sound
+          @mind_reader_enabled = mind_reader_enabled
+          @music_time_keeper_enabled = music_time_keeper_enabled
+          @music_time_keeper_sound = music_time_keeper_sound
+          @morse_code_practice_enabled = morse_code_practice_enabled
+          @treasure_hunter_enabled = treasure_hunter_enabled
+          @rhythm_rhyme_buster_enabled = rhythm_rhyme_buster_enabled
+          @stop_watch_enabled = stop_watch_enabled
+          @red_light_green_light_enabled = red_light_green_light_enabled
+        end
+
+        # Compile data for games.
+        #
+        # @return [Array<Integer>] Compiled data for games.
+        def packet
+          [
+            enabled_games,
+            countdown_timer_time,
+            sounds,
+            PACKETS_TERMINATOR
+          ].flatten
+        end
+
+        private
+
+        def enabled_games
+          bitmask = games.each_with_index.sum do |game, game_index|
+            game ? 1 << game_index : 0
+          end
+
+          bitmask.divmod(256).reverse
+        end
+
+        def countdown_timer_time
+          (countdown_timer_seconds * 10).divmod(256).reverse
+        end
+
+        def sounds
+          sounds_extra_packet = four_byte_format_for(
+            [
+              [music_time_keeper_sound],
+              [countdown_timer_sound],
+              []
+            ]
+          )
+
+          sounds_extra_packet.first(10)
+        end
+
+        def games
+          [
+            memory_game_enabled,
+            fortune_teller_enabled,
+            countdown_timer_enabled,
+            mind_reader_enabled,
+            music_time_keeper_enabled,
+            morse_code_practice_enabled,
+            treasure_hunter_enabled,
+            rhythm_rhyme_buster_enabled,
+            stop_watch_enabled,
+            red_light_green_light_enabled
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/four_byte_formatter"
+
+class TimexDatalinkClient
+  class Protocol7
+    class Eeprom
+      class PhoneNumber
+        include Helpers::FourByteFormatter
+
+        PHONE_NUMBER_DIGITS_MAP = {
+          "0" => 0x001,
+          "1" => 0x002,
+          "2" => 0x003,
+          "3" => 0x004,
+          "4" => 0x005,
+          "5" => 0x006,
+          "6" => 0x007,
+          "7" => 0x008,
+          "8" => 0x009,
+          "9" => 0x00a
+        }.freeze
+
+        PACKETS_TERMINATOR = 0x03
+
+        # Compile data for all phone numbers.
+        #
+        # @param phone_numbers [Array<PhoneNumber>] Phone numbers to compile data for.
+        # @return [Array] Compiled data of all phone numbers.
+        def self.packets(phone_numbers)
+          header(phone_numbers) + names_and_numbers(phone_numbers) + [PACKETS_TERMINATOR]
+        end
+
+        private_class_method def self.header(phone_numbers)
+          [
+            phone_numbers.count,
+            0
+          ]
+        end
+
+        private_class_method def self.names_and_numbers(phone_numbers)
+          return [] if phone_numbers.empty?
+
+          names_and_numbers = phone_numbers.flat_map(&:name_and_number)
+
+          phone_numbers.first.four_byte_format_for(names_and_numbers)
+        end
+
+        attr_accessor :name, :number
+
+        # Create a PhoneNumber instance.
+        #
+        # @param name [Array<Integer>] Name associated to phone number.
+        # @param number [String] Phone number text.
+        # @return [PhoneNumber] PhoneNumber instance.
+        def initialize(name: [], number:)
+          @name = name
+          @number = number
+        end
+
+        # Compile an unformatted name and phone number.
+        #
+        # @return [Array<Integer>] Array of integers that represent bytes.
+        def name_and_number
+          [
+            name,
+            number_characters
+          ]
+        end
+
+        private
+
+        def number_characters
+          number.each_char.map { |digit| PHONE_NUMBER_DIGITS_MAP[digit] }
+        end
+      end
+    end
+  end
+end