timex_datalink_client 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10adb86fd981a90fa2e764e3dd63bbaf0b1ffa1c37b5210d510ea6aa29b76edb
-  data.tar.gz: 2d2b67b5b10a8a6bd7bbefd4423e9e7b661a4824649e241df0e4e3ca45e17290
+  metadata.gz: 6b3a3f3ffde31a9f937f60f6ebba23851aeacc62d49b5677f7769f7392a9a1ea
+  data.tar.gz: 5a9f3acd574998d9bf430225459bb7f98f2954b5e1f6fff038a240145c5ffef5
 SHA512:
-  metadata.gz: 3a2fca239d0220cc056a7577ec7b17d1e4e9cf9f2c706af832b38ec0d0eb5522ae4df970369fa7be882eea686fa0da0bb0f063d86f8ce3736ba24c9c0f1acca2
-  data.tar.gz: 4c8296686c59d03b8da2970cda23c8c525f2376a1d8bca2094c3b44955c37d59625d9cf8e9a8c9545a600421514e584a32e53d52fa537f40af0a035041f140b6
+  metadata.gz: 93da0a4e3153cbeb4feaae86574a25034e315d82182833f5b7822796d00cc6d4dbc8f57830bde9e906b6e21471a6829808f0e621b432937314cfefb2090d52f7
+  data.tar.gz: b4c516c8b2db51e393b60324ed0d723f00562f34823a6e43c62b07c276b6bfae7edaa9c4f8ab338af6b2fe395afed38729f4e072381d977baef6371c08370802

data/lib/timex_datalink_client/helpers/char_encoders.rb

@@ -4,6 +4,7 @@ class TimexDatalinkClient
   class Helpers
     module CharEncoders
       CHARS = "0123456789abcdefghijklmnopqrstuvwxyz !\"#$%&'()*+,-./:\\;=@?_|<>[]"
+      CHARS_PROTOCOL_6 = "0123456789 abcdefghijklmnopqrstuvwxyz!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
       EEPROM_CHARS = "0123456789abcdefghijklmnopqrstuvwxyz !\"#$%&'()*+,-./:\\;=@?_|<>["
       PHONE_CHARS = "0123456789cfhpw "
       INVALID_CHAR = " "
@@ -19,6 +20,10 @@ class TimexDatalinkClient
         end
       end
 
+      def protocol_6_chars_for(string_chars, length: nil, pad: false)
+        chars_for(string_chars, char_map: CHARS_PROTOCOL_6, length:, pad:)
+      end
+
       def eeprom_chars_for(string_chars, length: 31)
         chars = chars_for(string_chars, char_map: EEPROM_CHARS, length:).append(EEPROM_TERMINATOR)
 

data/lib/timex_datalink_client/protocol_1/time_name.rb

@@ -24,7 +24,7 @@ class TimexDatalinkClient
       # Create a TimeName instance.
       #
       # @param zone [Integer] Time zone number (1 or 2).
-      # @param name [String] Name of time zone (3 chars max)
+      # @param name [String] Name of time zone (3 chars max).
       # @return [TimeName] TimeName instance.
       def initialize(zone:, name:)
         @zone = zone
@@ -49,8 +49,12 @@ class TimexDatalinkClient
 
       private
 
+      def name_formatted
+        name || "tz#{zone}"
+      end
+
       def name_characters
-        chars_for(name, length: 3, pad: true)
+        chars_for(name_formatted, length: 3, pad: true)
       end
     end
   end

data/lib/timex_datalink_client/protocol_3/time.rb

@@ -33,7 +33,7 @@ class TimexDatalinkClient
         message: "%{value} is invalid!  Valid date formats are #{DATE_FORMAT_MAP.keys}."
       }
 
-      attr_accessor :zone, :is_24h, :date_format, :time
+      attr_accessor :zone, :is_24h, :date_format, :time, :name
 
       # Create a Time instance.
       #
@@ -42,7 +42,7 @@ class TimexDatalinkClient
       # @param date_format ["%_m-%d-%y", "%_d-%m-%y", "%y-%m-%d", "%_m.%d.%y", "%_d.%m.%y", "%y.%m.%d"] Date format
       #   (represented by Time#strftime 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)
+      # @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
@@ -79,12 +79,12 @@ class TimexDatalinkClient
 
       private
 
-      def name
-        @name || time.zone.downcase
+      def name_formatted
+        name || time.zone || "tz#{zone}"
       end
 
       def name_characters
-        chars_for(name, length: 3, pad: true)
+        chars_for(name_formatted, length: 3, pad: true)
       end
 
       def year_mod_1900

data/lib/timex_datalink_client/protocol_4/time.rb

@@ -33,7 +33,7 @@ class TimexDatalinkClient
         message: "%{value} is invalid!  Valid date formats are #{DATE_FORMAT_MAP.keys}."
       }
 
-      attr_accessor :zone, :is_24h, :date_format, :time
+      attr_accessor :zone, :is_24h, :date_format, :time, :name
 
       # Create a Time instance.
       #
@@ -42,7 +42,7 @@ class TimexDatalinkClient
       # @param date_format ["%_m-%d-%y", "%_d-%m-%y", "%y-%m-%d", "%_m.%d.%y", "%_d.%m.%y", "%y.%m.%d"] Date format
       #   (represented by Time#strftime 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)
+      # @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
@@ -79,12 +79,12 @@ class TimexDatalinkClient
 
       private
 
-      def name
-        @name || time.zone.downcase
+      def name_formatted
+        name || time.zone || "tz#{zone}"
       end
 
       def name_characters
-        chars_for(name, length: 3, pad: true)
+        chars_for(name_formatted, length: 3, pad: true)
       end
 
       def year_mod_1900

data/lib/timex_datalink_client/protocol_6/alarm.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require "active_model"
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol6
+    class Alarm
+      include ActiveModel::Validations
+      include Helpers::CharEncoders
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_ALARM = 0x51
+
+      VALID_DAYS_IN_MONTH = {
+        1 => 1..31,
+        2 => 1..29,
+        3 => 1..31,
+        4 => 1..30,
+        5 => 1..31,
+        6 => 1..30,
+        7 => 1..31,
+        8 => 1..31,
+        9 => 1..30,
+        10 => 1..31,
+        11 => 1..30,
+        12 => 1..31
+      }.freeze
+
+      ALARM_STATUS_MAP = {
+        disarmed: 0,
+        armed: 1,
+        unused: 2
+      }.freeze
+
+      DEFAULT_TIME = Time.new(0, 1, 1, 6, 0)
+
+      attr_accessor :number, :status, :time, :message, :month, :day
+
+      validates :number, inclusion: {
+        in: 1..8,
+        message: "value %{value} is invalid!  Valid number values are 1..8."
+      }
+
+      validates :status, inclusion: {
+        in: ALARM_STATUS_MAP.keys,
+        message: "%{value} is invalid!  Valid date formats are #{ALARM_STATUS_MAP.keys}."
+      }
+
+      validates :month, inclusion: {
+        in: 1..12,
+        allow_nil: true,
+        message: "%{value} is invalid!  Valid months are 1..12 and nil."
+      }
+
+      validates :day, inclusion: {
+        if: ->(alarm) { alarm.month.nil? },
+        in: 1..31,
+        allow_nil: true,
+        message: "%{value} is invalid!  Valid days are 1..31 and nil."
+      }
+
+      validates :day, inclusion: {
+        if: ->(alarm) { alarm.day && alarm.month },
+        in: ->(alarm) { VALID_DAYS_IN_MONTH[alarm.month] },
+        message: ->(alarm, _attributes) do
+          "#{alarm.day} is invalid for month #{alarm.month}!  " \
+          "Valid days are #{VALID_DAYS_IN_MONTH[alarm.month]} and nil when month is #{alarm.month}."
+        end
+      }
+
+      # Create an Alarm instance.
+      #
+      # @param number [Integer] Alarm number (from 1 to 8).
+      # @param status [Symbol] Alarm status (:armed, :disarmed, or :unused).
+      # @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:, status:, time: DEFAULT_TIME, message: "", month: nil, day: nil)
+        @number = number
+        @status = status
+        @time = time
+        @message = message
+        @month = month
+        @day = day
+      end
+
+      # Compile packets for an alarm.
+      #
+      # @raise [ActiveModel::ValidationError] One or more model values are invalid.
+      # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
+      def packets
+        validate!
+
+        [
+          [
+            CPACKET_ALARM,
+            number,
+            time.hour,
+            time.min,
+            month.to_i,
+            day.to_i,
+            status_formatted,
+            message_characters,
+          ].flatten
+        ]
+      end
+
+      private
+
+      def message_characters
+        protocol_6_chars_for(message, length: 16, pad: true)
+      end
+
+      def status_formatted
+        ALARM_STATUS_MAP[status]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/length_packet_wrapper"
+
+class TimexDatalinkClient
+  class Protocol6
+    class Eeprom
+      class PhoneNumber
+        include Helpers::CharEncoders
+        prepend Helpers::LengthPacketWrapper
+
+        PHONE_DIGITS = 12
+        NAME_MAX_LENGTH = 31
+
+        NUMBER_NAME_DELIMITER = "-"
+        NUMBER_NAME_MAX_NUMBER_LENGTH = 30
+
+        TERMINATOR = 0x5c
+
+        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,
+            TERMINATOR
+          ].flatten
+        end
+
+        private
+
+        def number_with_type_characters
+          phone_chars_for(number_with_type_padded)
+        end
+
+        def name_characters
+          return protocol_6_chars_for(name_with_number) if number.length > PHONE_DIGITS
+
+          protocol_6_chars_for(name, length: NAME_MAX_LENGTH)
+        end
+
+        def number_with_type_padded
+          number_with_type = "#{number} #{type}"
+          number_with_type.rjust(PHONE_DIGITS)
+        end
+
+        def name_with_number
+          number_name = NUMBER_NAME_DELIMITER
+          number_name += number[PHONE_DIGITS..NUMBER_NAME_MAX_NUMBER_LENGTH - 1]
+
+          name_length = NUMBER_NAME_MAX_NUMBER_LENGTH - number_name.length
+          truncated_name = name[..name_length - 1]
+
+          "#{truncated_name}#{number_name}"
+        end
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_6/eeprom.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/cpacket_paginator"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+require "timex_datalink_client/helpers/lsb_msb_formatter"
+
+class TimexDatalinkClient
+  class Protocol6
+    class Eeprom
+      include Helpers::CpacketPaginator
+      include Helpers::LsbMsbFormatter
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_CLEAR = [0x93, 0x01]
+      CPACKET_SECT = [0x90, 0x01]
+      CPACKET_DATA = [0x91, 0x01]
+      CPACKET_END = [0x92, 0x01]
+
+      CPACKET_DATA_LENGTH = 32
+
+      attr_accessor :phone_numbers
+
+      # Create an Eeprom instance.
+      #
+      # @param phone_numbers [Array<PhoneNumber>] Phone numbers to be added to EEPROM data.
+      # @return [Eeprom] Eeprom instance.
+      def initialize(phone_numbers: [])
+        @phone_numbers = phone_numbers
+      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,
+          0x04,
+          phone_numbers_length,
+        ].flatten
+      end
+
+      def payloads
+        paginate_cpackets(header: CPACKET_DATA, length: CPACKET_DATA_LENGTH, cpackets: all_packets)
+      end
+
+      def all_packets
+        phone_numbers.map(&:packet).flatten
+      end
+
+      def payloads_length
+        lsb_msb_format_for(payloads.length)
+      end
+
+      def phone_numbers_length
+        length_lsb = lsb_msb_format_for(phone_numbers.length).first
+
+        [length_lsb, 0]
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_6/end.rb

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol6
+    class NightModeOptions
+      include ActiveModel::Validations
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_NIGHT_MODE = 0x72
+
+      validates :night_mode_deactivate_hours, inclusion: {
+        in: 3..12,
+        message: "%{value} is invalid!  Valid night mode deactivate hour values are 3..12."
+      }
+
+      validates :indiglo_timeout_seconds, inclusion: {
+        in: 3..10,
+        message: "%{value} is invalid!  Valid Indiglo timeout second values are 3..10."
+      }
+
+      attr_accessor :night_mode_deactivate_hours, :indiglo_timeout_seconds, :night_mode_on_notification
+
+      # Create a NightModeOptions instance.
+      #
+      # @param night_mode_deactivate_hours [Integer] Automatically deactivate night mode after specified hours.
+      # @param indiglo_timeout_seconds [Integer] Turn Indiglo light off after specified seconds after each button push.
+      # @param night_mode_on_notification [Boolean] Toggle activating night mode on any pager or alarm event.
+      # @return [NightModeOptions] NightModeOptions instance.
+      def initialize(night_mode_deactivate_hours: 8, indiglo_timeout_seconds: 4, night_mode_on_notification: false)
+        @night_mode_deactivate_hours = night_mode_deactivate_hours
+        @indiglo_timeout_seconds = indiglo_timeout_seconds
+        @night_mode_on_notification = night_mode_on_notification
+      end
+
+      # Compile packets for night mode options.
+      #
+      # @raise [ActiveModel::ValidationError] One or more model values are invalid.
+      # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
+      def packets
+        validate!
+
+        [
+          [
+            CPACKET_NIGHT_MODE,
+            night_mode_on_notification_formatted,
+            night_mode_deactivate_hours,
+            indiglo_timeout_seconds
+          ]
+        ]
+      end
+
+      def night_mode_on_notification_formatted
+        night_mode_on_notification ? 1 : 0
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_6/pager_options.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol6
+    class PagerOptions
+      include ActiveModel::Validations
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_PAGER = 0x73
+      ALERT_SOUND_SILENT = 6
+
+      validates :on_hour, inclusion: {
+        in: 0..23,
+        message: "%{value} is invalid!  Valid on hour values are 0..23."
+      }
+
+      validates :on_minute, inclusion: {
+        in: 0..59,
+        message: "%{value} is invalid!  Valid on minute values are 0..59."
+      }
+
+      validates :off_hour, inclusion: {
+        in: 0..23,
+        message: "%{value} is invalid!  Valid off hour values are 0..23."
+      }
+
+      validates :off_minute, inclusion: {
+        in: 0..59,
+        message: "%{value} is invalid!  Valid off minute values are 0..59."
+      }
+
+      validates :alert_sound, inclusion: {
+        in: 0..5,
+        allow_nil: true,
+        message: "%{value} is invalid!  Valid alert sound values are 0..5 and nil."
+      }
+
+      attr_accessor :auto_on_off, :on_hour, :on_minute, :off_hour, :off_minute, :alert_sound
+
+      # Create a PagerOptions instance.
+      #
+      # @param auto_on_off [Boolean] Toggle turning pager on and off every day.
+      # @param on_hour [Integer] Hour to turn pager on at.
+      # @param on_minute [Integer] Minute to turn pager on at.
+      # @param off_hour [Integer] Hour to turn pager off at.
+      # @param off_minute [Integer] Minute to turn pager off at.
+      # @param alert_sound [Integer, nil] Pager alert sound (0 to 5 or nil for silent).
+      # @return [PagerOptions] PagerOptions instance.
+      def initialize(auto_on_off: false, on_hour: 0, on_minute: 0, off_hour: 0, off_minute: 0, alert_sound: 0)
+        @auto_on_off = auto_on_off
+        @on_hour = on_hour
+        @on_minute = on_minute
+        @off_hour = off_hour
+        @off_minute = off_minute
+        @alert_sound = alert_sound
+      end
+
+      # Compile packets for pager options.
+      #
+      # @raise [ActiveModel::ValidationError] One or more model values are invalid.
+      # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
+      def packets
+        validate!
+
+        [
+          [
+            CPACKET_PAGER,
+            auto_on_off_formatted,
+            on_hour,
+            on_minute,
+            off_hour,
+            off_minute,
+            alert_sound_formatted
+          ]
+        ]
+      end
+
+      def auto_on_off_formatted
+        auto_on_off ? 1 : 0
+      end
+
+      def alert_sound_formatted
+        alert_sound || ALERT_SOUND_SILENT
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_6/sound_scroll_options.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol6
+    class SoundScrollOptions
+      include ActiveModel::Validations
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_SOUND_SCROLL = 0x71
+
+      validates :scroll_speed, inclusion: {
+        in: 0..2,
+        message: "%{value} is invalid!  Valid scroll speed values are 0..2."
+      }
+
+      attr_accessor :hourly_chime, :button_beep, :scroll_speed
+
+      # Create a SoundScrollOptions instance.
+      #
+      # @param hourly_chime [Boolean] Toggle hourly chime.
+      # @param button_beep [Boolean] Toggle button beep.
+      # @param scroll_speed [Integer] Message scroll speed (0 to 2).
+      # @return [SoundScrollOptions] SoundScrollOptions instance.
+      def initialize(hourly_chime: false, button_beep: false, scroll_speed: 1)
+        @hourly_chime = hourly_chime
+        @button_beep = button_beep
+        @scroll_speed = scroll_speed
+      end
+
+      # Compile packets for sound and scroll options.
+      #
+      # @raise [ActiveModel::ValidationError] One or more model values are invalid.
+      # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
+      def packets
+        validate!
+
+        [
+          [
+            CPACKET_SOUND_SCROLL,
+            hourly_chime_formatted,
+            button_beep_formatted,
+            scroll_speed
+          ]
+        ]
+      end
+
+      def hourly_chime_formatted
+        hourly_chime ? 1 : 0
+      end
+
+      def button_beep_formatted
+        button_beep ? 1 : 0
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_6/start.rb

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class TimexDatalinkClient
+  class Protocol6
+    class Sync
+      PING_BYTE = [0x78]
+      FAST_MODE_BYTE = [0x56]
+      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 + FAST_MODE_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_6/time.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+require "active_model"
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Protocol6
+    class Time
+      include ActiveModel::Validations
+      include Helpers::CharEncoders
+      prepend Helpers::CrcPacketsWrapper
+
+      CPACKET_TIME = [0x32].freeze
+      CPACKET_FLEX_TIME = [0x33].freeze
+
+      ZONE_OFFSET_MAP = {
+        -39600 => 0x15,
+        -36000 => 0x16,
+        -32400 => 0x17,
+        -28800 => 0x18,
+        -25200 => 0x19,
+        -21600 => 0x1a,
+        -18000 => 0x1b,
+        -14400 => 0x1c,
+        -12600 => 0x14,
+        -10800 => 0x1d,
+        -7200 => 0x1e,
+        -3600 => 0x1f,
+        0 => 0x00,
+        3600 => 0x01,
+        7200 => 0x02,
+        10800 => 0x03,
+        12600 => 0x0d,
+        14400 => 0x04,
+        16200 => 0x0e,
+        18000 => 0x05,
+        19800 => 0x0f,
+        20700 => 0x11,
+        21600 => 0x06,
+        23400 => 0x12,
+        25200 => 0x07,
+        28800 => 0x08,
+        32400 => 0x09,
+        34200 => 0x13,
+        36000 => 0x0a,
+        39600 => 0x0b,
+        43200 => 0x0c
+      }.freeze
+
+      FLEX_TIME_ZONE = 0x10
+      FLEX_DST_VALUE = 0x08
+
+      DATE_FORMAT_MAP = {
+        "%_m-%d-%y" => 0x00,
+        "%_d-%m-%y" => 0x01,
+        "%y-%m-%d" => 0x02,
+        "%_m.%d.%y" => 0x04,
+        "%_d.%m.%y" => 0x05,
+        "%y.%m.%d" => 0x06
+      }.freeze
+
+      validates :zone, inclusion: {
+        in: 1..2,
+        message: "%{value} is invalid!  Valid zones are 1..2."
+      }
+
+      validates :date_format, inclusion: {
+        in: DATE_FORMAT_MAP.keys,
+        message: "%{value} is invalid!  Valid date formats are #{DATE_FORMAT_MAP.keys}."
+      }
+
+      validates :flex_time_zone, unless: :flex_time, inclusion: {
+        in: [false],
+        message: "cannot be enabled unless FLEXtime is also enabled."
+      }
+
+      validates :flex_dst, unless: :flex_time, inclusion: {
+        in: [false],
+        message: "cannot be enabled unless FLEXtime is also enabled."
+      }
+
+      attr_accessor :zone, :is_24h, :date_format, :time, :name, :flex_time, :flex_time_zone, :flex_dst
+
+      # Create a Time instance.
+      #
+      # @param zone [Integer] Time zone number (1 or 2).
+      # @param is_24h [Boolean] Toggle 24 hour time.
+      # @param date_format ["%_m-%d-%y", "%_d-%m-%y", "%y-%m-%d", "%_m.%d.%y", "%_d.%m.%y", "%y.%m.%d"] Date format
+      #   (represented by Time#strftime 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).
+      # @param flex_time [Boolean] Toggle using FLEXtime to set time and date.
+      # @param flex_time_zone [Boolean] Toggle using FLEXtime to set time zone.
+      # @param flex_dst [Boolean] Toggle using FLEXtime to apply daylight savings time offset.
+      # @return [Time] Time instance.
+      def initialize(
+        zone:, is_24h:, date_format:, time:, name: nil, flex_time: false, flex_time_zone: false, flex_dst: false
+      )
+        @zone = zone
+        @is_24h = is_24h
+        @date_format = date_format
+        @time = time
+        @name = name
+        @flex_time = flex_time
+        @flex_time_zone = flex_time_zone
+        @flex_dst = flex_dst
+      end
+
+      # Compile packets for a time.
+      #
+      # @raise [ActiveModel::ValidationError] One or more model values are invalid.
+      # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
+      def packets
+        validate!
+
+        [
+          [
+            cpacket,
+            zone,
+            second,
+            hour,
+            minute,
+            month,
+            day,
+            year_mod_1900,
+            name_characters,
+            wday_from_monday,
+            formatted_time_zone,
+            is_24h_value,
+            date_format_value
+          ].flatten
+        ]
+      end
+
+      private
+
+      def cpacket
+        flex_time ? CPACKET_FLEX_TIME : CPACKET_TIME
+      end
+
+      def second
+        flex_time ? 0 : formatted_time.sec
+      end
+
+      def hour
+        flex_time ? 0 : formatted_time.hour
+      end
+
+      def minute
+        flex_time ? 0 : formatted_time.min
+      end
+
+      def month
+        flex_time ? 0 : formatted_time.month
+      end
+
+      def day
+        flex_time ? 0 : formatted_time.day
+      end
+
+      def formatted_name
+        name || time.zone || "tz#{zone}"
+      end
+
+      def name_characters
+        protocol_6_chars_for(formatted_name, length: 3, pad: true)
+      end
+
+      def year_mod_1900
+        flex_time ? 0 : formatted_time.year % 100
+      end
+
+      def wday_from_monday
+        flex_time ? 0 : (formatted_time.wday + 6) % 7
+      end
+
+      def formatted_time
+        time.dst? ? time + 3600 : time
+      end
+
+      def formatted_utc_offset
+        time.dst? ? time.utc_offset - 3600 : time.utc_offset
+      end
+
+      def formatted_time_zone
+        flex_time_zone ? FLEX_TIME_ZONE : ZONE_OFFSET_MAP[formatted_utc_offset]
+      end
+
+      def is_24h_value
+        is_24h ? 2 : 1
+      end
+
+      def date_format_value
+        format = DATE_FORMAT_MAP.fetch(date_format)
+        format += FLEX_DST_VALUE if flex_dst
+
+        format
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_9/time_name.rb

@@ -24,7 +24,7 @@ class TimexDatalinkClient
       # Create a TimeName instance.
       #
       # @param zone [Integer] Time zone number (1 or 2).
-      # @param name [String] Name of time zone (3 chars max)
+      # @param name [String] Name of time zone (3 chars max).
       # @return [TimeName] TimeName instance.
       def initialize(zone:, name:)
         @zone = zone
@@ -49,8 +49,12 @@ class TimexDatalinkClient
 
       private
 
+      def name_formatted
+        name || "tz#{zone}"
+      end
+
       def name_characters
-        chars_for(name, length: 3, pad: true)
+        chars_for(name_formatted, length: 3, pad: true)
       end
     end
   end

data/lib/timex_datalink_client/version.rb

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

data/lib/timex_datalink_client.rb

@@ -43,6 +43,17 @@ require "timex_datalink_client/protocol_4/sync"
 require "timex_datalink_client/protocol_4/time"
 require "timex_datalink_client/protocol_4/wrist_app"
 
+require "timex_datalink_client/protocol_6/alarm"
+require "timex_datalink_client/protocol_6/eeprom"
+require "timex_datalink_client/protocol_6/eeprom/phone_number"
+require "timex_datalink_client/protocol_6/end"
+require "timex_datalink_client/protocol_6/night_mode_options"
+require "timex_datalink_client/protocol_6/pager_options"
+require "timex_datalink_client/protocol_6/sound_scroll_options"
+require "timex_datalink_client/protocol_6/start"
+require "timex_datalink_client/protocol_6/sync"
+require "timex_datalink_client/protocol_6/time"
+
 require "timex_datalink_client/protocol_7/eeprom"
 require "timex_datalink_client/protocol_7/eeprom/activity"
 require "timex_datalink_client/protocol_7/eeprom/calendar"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timex_datalink_client
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Maxwell Pray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-27 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -66,90 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: mdl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.41.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.41.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-github
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.20.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.20.0
-- !ruby/object:Gem::Dependency
-  name: tzinfo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.5
-- !ruby/object:Gem::Dependency
-  name: yard-junk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.9
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.9
 description:
 email: synthead@gmail.com
 executables: []
@@ -201,6 +117,16 @@ files:
 - lib/timex_datalink_client/protocol_4/sync.rb
 - lib/timex_datalink_client/protocol_4/time.rb
 - lib/timex_datalink_client/protocol_4/wrist_app.rb
+- lib/timex_datalink_client/protocol_6/alarm.rb
+- lib/timex_datalink_client/protocol_6/eeprom.rb
+- lib/timex_datalink_client/protocol_6/eeprom/phone_number.rb
+- lib/timex_datalink_client/protocol_6/end.rb
+- lib/timex_datalink_client/protocol_6/night_mode_options.rb
+- lib/timex_datalink_client/protocol_6/pager_options.rb
+- lib/timex_datalink_client/protocol_6/sound_scroll_options.rb
+- lib/timex_datalink_client/protocol_6/start.rb
+- lib/timex_datalink_client/protocol_6/sync.rb
+- lib/timex_datalink_client/protocol_6/time.rb
 - lib/timex_datalink_client/protocol_7/eeprom.rb
 - lib/timex_datalink_client/protocol_7/eeprom/activity.rb
 - lib/timex_datalink_client/protocol_7/eeprom/calendar.rb
@@ -224,7 +150,7 @@ files:
 - 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.11.0
+homepage: https://github.com/synthead/timex_datalink_client/tree/v0.12.0
 licenses:
 - MIT
 metadata: {}
@@ -243,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Write data to Timex Datalink devices with an optical sensor