timex_datalink_client 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efa331ee9142b5392695a07a8f904f6c967584bb2b39abe1a5fd3577150f4eaf
-  data.tar.gz: ba994a959bb3156a218bfe1faef05c8a51223b911c6c926152d15182178ade1d
+  metadata.gz: 10adb86fd981a90fa2e764e3dd63bbaf0b1ffa1c37b5210d510ea6aa29b76edb
+  data.tar.gz: 2d2b67b5b10a8a6bd7bbefd4423e9e7b661a4824649e241df0e4e3ca45e17290
 SHA512:
-  metadata.gz: 69b09f2da57887e8ca4cc8c4f4186c21a9bb10b57d05e839d0122a0158ffde4fe7896268c74d525cdff2caf941dd1506b54d4db4ce4cd620d7bbbffb6d4cfa2a
-  data.tar.gz: 4cc7a686c22c7aa1b2a987286b2ecf023b3a36b423ba2d6a47665b743b8e989a3d29ab718466634893ac7d559f8b4e9e67d25d3797bdea8e8a1a399d67fa9f37
+  metadata.gz: 3a2fca239d0220cc056a7577ec7b17d1e4e9cf9f2c706af832b38ec0d0eb5522ae4df970369fa7be882eea686fa0da0bb0f063d86f8ce3736ba24c9c0f1acca2
+  data.tar.gz: 4c8296686c59d03b8da2970cda23c8c525f2376a1d8bca2094c3b44955c37d59625d9cf8e9a8c9545a600421514e584a32e53d52fa537f40af0a035041f140b6

data/lib/timex_datalink_client/helpers/char_encoders.rb

@@ -20,7 +20,7 @@ class TimexDatalinkClient
       end
 
       def eeprom_chars_for(string_chars, length: 31)
-        chars = chars_for(string_chars, char_map: EEPROM_CHARS, length: length).append(EEPROM_TERMINATOR)
+        chars = chars_for(string_chars, char_map: EEPROM_CHARS, length:).append(EEPROM_TERMINATOR)
 
         packed_int = chars.each_with_index.sum do |char, index|
           char << (6 * index)

data/lib/timex_datalink_client/helpers/lsb_msb_formatter.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class TimexDatalinkClient
+  class Helpers
+    module LsbMsbFormatter
+      def lsb_msb_format_for(value)
+        value.divmod(256).reverse
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/protocol_1/alarm.rb

@@ -1,11 +1,14 @@
 # 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 Protocol1
     class Alarm
+      include ActiveModel::Validations
       include Helpers::CharEncoders
       prepend Helpers::CrcPacketsWrapper
 
@@ -14,8 +17,50 @@ class TimexDatalinkClient
 
       ALARM_SILENT_START_INDEX = 0x61
 
+      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
+
       attr_accessor :number, :audible, :time, :message, :month, :day
 
+      validates :number, inclusion: {
+        in: 1..5,
+        message: "value %{value} is invalid!  Valid number values are 1..5."
+      }
+
+      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 5).
@@ -36,8 +81,11 @@ class TimexDatalinkClient
 
       # 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!
+
         [alarm_data_packet].tap do |packets|
           packets << alarm_silent_packet unless audible
         end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 require "timex_datalink_client/helpers/char_encoders"
 require "timex_datalink_client/helpers/length_packet_wrapper"
 
@@ -7,11 +9,18 @@ class TimexDatalinkClient
   class Protocol1
     class Eeprom
       class List
+        include ActiveModel::Validations
         include Helpers::CharEncoders
         prepend Helpers::LengthPacketWrapper
 
         attr_accessor :list_entry, :priority
 
+        validates :priority, inclusion: {
+          in: 1..5,
+          allow_nil: true,
+          message: "%{value} is invalid!  Valid priorities are 1..5 or nil."
+        }
+
         # Create a List instance.
         #
         # @param list_entry [String] List entry text.
@@ -24,10 +33,13 @@ class TimexDatalinkClient
 
         # Compile a packet for a list.
         #
+        # @raise [ActiveModel::ValidationError] One or more model values are invalid.
         # @return [Array<Integer>] Array of integers that represent bytes.
         def packet
+          validate!
+
           [
-            priority,
+            priority_value,
             list_entry_characters
           ].flatten
         end
@@ -37,6 +49,10 @@ class TimexDatalinkClient
         def list_entry_characters
           eeprom_chars_for(list_entry)
         end
+
+        def priority_value
+          priority.nil? ? 0 : priority
+        end
       end
     end
   end

data/lib/timex_datalink_client/protocol_1/eeprom.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 require "timex_datalink_client/helpers/cpacket_paginator"
 require "timex_datalink_client/helpers/crc_packets_wrapper"
 
 class TimexDatalinkClient
   class Protocol1
     class Eeprom
+      include ActiveModel::Validations
       include Helpers::CpacketPaginator
       prepend Helpers::CrcPacketsWrapper
 
@@ -16,8 +19,16 @@ class TimexDatalinkClient
       CPACKET_DATA_LENGTH = 27
       START_INDEX = 14
       APPOINTMENT_NO_NOTIFICATION = 0xff
+      APPOINTMENT_NOTIFICATION_VALID_MINUTES = (0..30).step(5)
+
+      attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification_minutes
 
-      attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification
+      validates :appointment_notification_minutes, inclusion: {
+        in: APPOINTMENT_NOTIFICATION_VALID_MINUTES,
+        allow_nil: true,
+        message: "value %{value} is invalid!  Valid appointment notification minutes values are" \
+          " #{APPOINTMENT_NOTIFICATION_VALID_MINUTES.to_a} or nil."
+      }
 
       # Create an Eeprom instance.
       #
@@ -25,21 +36,25 @@ class TimexDatalinkClient
       # @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)
+      # @param appointment_notification_minutes [Integer, nil] Appointment notification in minutes.
       # @return [Eeprom] Eeprom instance.
-      def initialize(appointments: [], anniversaries: [], phone_numbers: [], lists: [], appointment_notification: APPOINTMENT_NO_NOTIFICATION)
+      def initialize(
+        appointments: [], anniversaries: [], phone_numbers: [], lists: [], appointment_notification_minutes: nil
+      )
         @appointments = appointments
         @anniversaries = anniversaries
         @phone_numbers = phone_numbers
         @lists = lists
-        @appointment_notification = appointment_notification
+        @appointment_notification_minutes = appointment_notification_minutes
       end
 
       # Compile packets for EEPROM data.
       #
+      # @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!
+
         [header] + payloads + [CPACKET_END]
       end
 
@@ -57,7 +72,7 @@ class TimexDatalinkClient
           items_indexes,
           items_lengths,
           earliest_appointment_year,
-          appointment_notification,
+          appointment_notification_minutes_value,
           all_packets
         ].flatten
       end
@@ -95,6 +110,12 @@ class TimexDatalinkClient
 
         earliest_appointment.time.year % 100
       end
+
+      def appointment_notification_minutes_value
+        return APPOINTMENT_NO_NOTIFICATION unless appointment_notification_minutes
+
+        appointment_notification_minutes / 5
+      end
     end
   end
 end

data/lib/timex_datalink_client/protocol_1/time.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 require "timex_datalink_client/helpers/crc_packets_wrapper"
 
 class TimexDatalinkClient
   class Protocol1
     class Time
+      include ActiveModel::Validations
       prepend Helpers::CrcPacketsWrapper
 
       CPACKET_TIME = [0x30]
 
       attr_accessor :zone, :is_24h, :time
 
+      validates :zone, inclusion: {
+        in: 1..2,
+        message: "%{value} is invalid!  Valid zones are 1..2."
+      }
+
       # Create a Time instance.
       #
       # @param zone [Integer] Time zone number (1 or 2).
@@ -25,8 +33,11 @@ class TimexDatalinkClient
 
       # 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_TIME,

data/lib/timex_datalink_client/protocol_1/time_name.rb

@@ -1,11 +1,14 @@
 # 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 Protocol1
     class TimeName
+      include ActiveModel::Validations
       include Helpers::CharEncoders
       prepend Helpers::CrcPacketsWrapper
 
@@ -13,6 +16,11 @@ class TimexDatalinkClient
 
       attr_accessor :zone, :name
 
+      validates :zone, inclusion: {
+        in: 1..2,
+        message: "%{value} is invalid!  Valid zones are 1..2."
+      }
+
       # Create a TimeName instance.
       #
       # @param zone [Integer] Time zone number (1 or 2).
@@ -25,8 +33,11 @@ class TimexDatalinkClient
 
       # Compile packets for a time name.
       #
+      # @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_NAME,

data/lib/timex_datalink_client/protocol_3/alarm.rb

@@ -1,11 +1,14 @@
 # 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 Protocol3
     class Alarm
+      include ActiveModel::Validations
       include Helpers::CharEncoders
       prepend Helpers::CrcPacketsWrapper
 
@@ -13,6 +16,11 @@ class TimexDatalinkClient
 
       attr_accessor :number, :audible, :time, :message
 
+      validates :number, inclusion: {
+        in: 1..5,
+        message: "value %{value} is invalid!  Valid number values are 1..5."
+      }
+
       # Create an Alarm instance.
       #
       # @param number [Integer] Alarm number (from 1 to 5).
@@ -29,8 +37,11 @@ class TimexDatalinkClient
 
       # 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,

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 require "timex_datalink_client/helpers/char_encoders"
 require "timex_datalink_client/helpers/length_packet_wrapper"
 
@@ -7,15 +9,22 @@ class TimexDatalinkClient
   class Protocol3
     class Eeprom
       class List
+        include ActiveModel::Validations
         include Helpers::CharEncoders
         prepend Helpers::LengthPacketWrapper
 
         attr_accessor :list_entry, :priority
 
+        validates :priority, inclusion: {
+          in: 1..5,
+          allow_nil: true,
+          message: "%{value} is invalid!  Valid priorities are 1..5 or nil."
+        }
+
         # Create a List instance.
         #
         # @param list_entry [String] List entry text.
-        # @param priority [Integer] List priority.
+        # @param priority [Integer, nil] List priority.
         # @return [List] List instance.
         def initialize(list_entry:, priority:)
           @list_entry = list_entry
@@ -24,10 +33,13 @@ class TimexDatalinkClient
 
         # Compile a packet for a list.
         #
+        # @raise [ActiveModel::ValidationError] One or more model values are invalid.
         # @return [Array<Integer>] Array of integers that represent bytes.
         def packet
+          validate!
+
           [
-            priority,
+            priority_value,
             list_entry_characters
           ].flatten
         end
@@ -37,6 +49,10 @@ class TimexDatalinkClient
         def list_entry_characters
           eeprom_chars_for(list_entry)
         end
+
+        def priority_value
+          priority.nil? ? 0 : priority
+        end
       end
     end
   end

data/lib/timex_datalink_client/protocol_3/eeprom.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 require "timex_datalink_client/helpers/cpacket_paginator"
 require "timex_datalink_client/helpers/crc_packets_wrapper"
 
 class TimexDatalinkClient
   class Protocol3
     class Eeprom
+      include ActiveModel::Validations
       include Helpers::CpacketPaginator
       prepend Helpers::CrcPacketsWrapper
 
@@ -17,8 +20,16 @@ class TimexDatalinkClient
       CPACKET_DATA_LENGTH = 32
       START_ADDRESS = 0x0236
       APPOINTMENT_NO_NOTIFICATION = 0xff
+      APPOINTMENT_NOTIFICATION_VALID_MINUTES = (0..30).step(5)
+
+      attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification_minutes
 
-      attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification
+      validates :appointment_notification_minutes, inclusion: {
+        in: APPOINTMENT_NOTIFICATION_VALID_MINUTES,
+        allow_nil: true,
+        message: "value %{value} is invalid!  Valid appointment notification minutes values are" \
+          " #{APPOINTMENT_NOTIFICATION_VALID_MINUTES.to_a} or nil."
+      }
 
       # Create an Eeprom instance.
       #
@@ -26,21 +37,25 @@ class TimexDatalinkClient
       # @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)
+      # @param appointment_notification_minutes [Integer, nil] Appointment notification in minutes.
       # @return [Eeprom] Eeprom instance.
-      def initialize(appointments: [], anniversaries: [], phone_numbers: [], lists: [], appointment_notification: APPOINTMENT_NO_NOTIFICATION)
+      def initialize(
+        appointments: [], anniversaries: [], phone_numbers: [], lists: [], appointment_notification_minutes: nil
+      )
         @appointments = appointments
         @anniversaries = anniversaries
         @phone_numbers = phone_numbers
         @lists = lists
-        @appointment_notification = appointment_notification
+        @appointment_notification_minutes = appointment_notification_minutes
       end
 
       # Compile packets for EEPROM data.
       #
+      # @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_CLEAR, header] + payloads + [CPACKET_END]
       end
 
@@ -53,7 +68,7 @@ class TimexDatalinkClient
           items_addresses,
           items_lengths,
           earliest_appointment_year,
-          appointment_notification
+          appointment_notification_minutes_value
         ].flatten
       end
 
@@ -90,6 +105,12 @@ class TimexDatalinkClient
 
         earliest_appointment.time.year % 100
       end
+
+      def appointment_notification_minutes_value
+        return APPOINTMENT_NO_NOTIFICATION unless appointment_notification_minutes
+
+        appointment_notification_minutes / 5
+      end
     end
   end
 end

data/lib/timex_datalink_client/protocol_3/time.rb

@@ -1,11 +1,14 @@
 # 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 Protocol3
     class Time
+      include ActiveModel::Validations
       include Helpers::CharEncoders
       prepend Helpers::CrcPacketsWrapper
 
@@ -20,6 +23,16 @@ class TimexDatalinkClient
         "%y.%m.%d" => 6
       }.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}."
+      }
+
       attr_accessor :zone, :is_24h, :date_format, :time
 
       # Create a Time instance.
@@ -41,8 +54,11 @@ class TimexDatalinkClient
 
       # 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_TIME,

data/lib/timex_datalink_client/protocol_4/alarm.rb

@@ -1,11 +1,14 @@
 # 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 Protocol4
     class Alarm
+      include ActiveModel::Validations
       include Helpers::CharEncoders
       prepend Helpers::CrcPacketsWrapper
 
@@ -13,6 +16,11 @@ class TimexDatalinkClient
 
       attr_accessor :number, :audible, :time, :message
 
+      validates :number, inclusion: {
+        in: 1..5,
+        message: "value %{value} is invalid!  Valid number values are 1..5."
+      }
+
       # Create an Alarm instance.
       #
       # @param number [Integer] Alarm number (from 1 to 5).
@@ -29,8 +37,11 @@ class TimexDatalinkClient
 
       # 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,

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 require "timex_datalink_client/helpers/char_encoders"
 require "timex_datalink_client/helpers/length_packet_wrapper"
 
@@ -7,11 +9,18 @@ class TimexDatalinkClient
   class Protocol4
     class Eeprom
       class List
+        include ActiveModel::Validations
         include Helpers::CharEncoders
         prepend Helpers::LengthPacketWrapper
 
         attr_accessor :list_entry, :priority
 
+        validates :priority, inclusion: {
+          in: 1..5,
+          allow_nil: true,
+          message: "%{value} is invalid!  Valid priorities are 1..5 or nil."
+        }
+
         # Create a List instance.
         #
         # @param list_entry [String] List entry text.
@@ -24,10 +33,13 @@ class TimexDatalinkClient
 
         # Compile a packet for a list.
         #
+        # @raise [ActiveModel::ValidationError] One or more model values are invalid.
         # @return [Array<Integer>] Array of integers that represent bytes.
         def packet
+          validate!
+
           [
-            priority,
+            priority_value,
             list_entry_characters
           ].flatten
         end
@@ -37,6 +49,10 @@ class TimexDatalinkClient
         def list_entry_characters
           eeprom_chars_for(list_entry)
         end
+
+        def priority_value
+          priority.nil? ? 0 : priority
+        end
       end
     end
   end

data/lib/timex_datalink_client/protocol_4/eeprom.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 require "timex_datalink_client/helpers/cpacket_paginator"
 require "timex_datalink_client/helpers/crc_packets_wrapper"
 
 class TimexDatalinkClient
   class Protocol4
     class Eeprom
+      include ActiveModel::Validations
       include Helpers::CpacketPaginator
       prepend Helpers::CrcPacketsWrapper
 
@@ -17,8 +20,16 @@ class TimexDatalinkClient
       CPACKET_DATA_LENGTH = 32
       START_ADDRESS = 0x0236
       APPOINTMENT_NO_NOTIFICATION = 0xff
+      APPOINTMENT_NOTIFICATION_VALID_MINUTES = (0..30).step(5)
+
+      attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification_minutes
 
-      attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification
+      validates :appointment_notification_minutes, inclusion: {
+        in: APPOINTMENT_NOTIFICATION_VALID_MINUTES,
+        allow_nil: true,
+        message: "value %{value} is invalid!  Valid appointment notification minutes values are" \
+          " #{APPOINTMENT_NOTIFICATION_VALID_MINUTES.to_a} or nil."
+      }
 
       # Create an Eeprom instance.
       #
@@ -26,21 +37,25 @@ class TimexDatalinkClient
       # @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)
+      # @param appointment_notification_minutes [Integer, nil] Appointment notification in minutes.
       # @return [Eeprom] Eeprom instance.
-      def initialize(appointments: [], anniversaries: [], phone_numbers: [], lists: [], appointment_notification: APPOINTMENT_NO_NOTIFICATION)
+      def initialize(
+        appointments: [], anniversaries: [], phone_numbers: [], lists: [], appointment_notification_minutes: nil
+      )
         @appointments = appointments
         @anniversaries = anniversaries
         @phone_numbers = phone_numbers
         @lists = lists
-        @appointment_notification = appointment_notification
+        @appointment_notification_minutes = appointment_notification_minutes
       end
 
       # Compile packets for EEPROM data.
       #
+      # @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_CLEAR, header] + payloads + [CPACKET_END]
       end
 
@@ -53,7 +68,7 @@ class TimexDatalinkClient
           items_addresses,
           items_lengths,
           earliest_appointment_year,
-          appointment_notification
+          appointment_notification_minutes_value
         ].flatten
       end
 
@@ -90,6 +105,12 @@ class TimexDatalinkClient
 
         earliest_appointment.time.year % 100
       end
+
+      def appointment_notification_minutes_value
+        return APPOINTMENT_NO_NOTIFICATION unless appointment_notification_minutes
+
+        appointment_notification_minutes / 5
+      end
     end
   end
 end

data/lib/timex_datalink_client/protocol_4/time.rb

@@ -1,11 +1,14 @@
 # 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 Protocol4
     class Time
+      include ActiveModel::Validations
       include Helpers::CharEncoders
       prepend Helpers::CrcPacketsWrapper
 
@@ -20,6 +23,16 @@ class TimexDatalinkClient
         "%y.%m.%d" => 6
       }.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}."
+      }
+
       attr_accessor :zone, :is_24h, :date_format, :time
 
       # Create a Time instance.
@@ -41,8 +54,11 @@ class TimexDatalinkClient
 
       # 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_TIME,

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

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
+require "timex_datalink_client/helpers/lsb_msb_formatter"
+
 class TimexDatalinkClient
   class Protocol7
     class Eeprom
       class Calendar
         class Event
+          include Helpers::LsbMsbFormatter
+
           FIVE_MINUTES_SECONDS = 300
 
           attr_accessor :time, :phrase
@@ -24,7 +28,7 @@ class TimexDatalinkClient
             seconds = (time - device_time_midnight).to_i
             five_minutes = seconds / FIVE_MINUTES_SECONDS
 
-            five_minutes.divmod(256).reverse
+            lsb_msb_format_for(five_minutes)
           end
         end
       end

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

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require "timex_datalink_client/helpers/four_byte_formatter"
+require "timex_datalink_client/helpers/lsb_msb_formatter"
 
 class TimexDatalinkClient
   class Protocol7
     class Eeprom
       class Calendar
         include Helpers::FourByteFormatter
+        include Helpers::LsbMsbFormatter
 
         DAY_START_TIME = Time.new(2000)
         DAY_SECONDS = 86400
@@ -48,7 +50,7 @@ class TimexDatalinkClient
         private
 
         def events_count
-          events.count.divmod(256).reverse
+          lsb_msb_format_for(events.count)
         end
 
         def event_packets
@@ -57,7 +59,7 @@ class TimexDatalinkClient
 
           [].tap do |event_packets|
             events.each_with_index do |event, event_index|
-              event_bytes_formatted = event_bytes.divmod(256).reverse
+              event_bytes_formatted = lsb_msb_format_for(event_bytes)
               event_time_formatted = event.time_formatted(time)
 
               event_packets << [event_time_formatted, event_bytes_formatted]
@@ -77,13 +79,13 @@ class TimexDatalinkClient
           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
+          lsb_msb_format_for(since_start_time_days)
         end
 
         def time_formatted
           five_mintes = (time.hour * 60 + time.min) / 5
 
-          five_mintes.divmod(256).reverse
+          lsb_msb_format_for(five_mintes)
         end
       end
     end

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

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require "timex_datalink_client/helpers/four_byte_formatter"
+require "timex_datalink_client/helpers/lsb_msb_formatter"
 
 class TimexDatalinkClient
   class Protocol7
     class Eeprom
       class Games
         include Helpers::FourByteFormatter
+        include Helpers::LsbMsbFormatter
 
         COUNTDOWN_TIMER_SECONDS_DEFAULT = 60
 
@@ -85,11 +87,11 @@ class TimexDatalinkClient
             game ? 1 << game_index : 0
           end
 
-          bitmask.divmod(256).reverse
+          lsb_msb_format_for(bitmask)
         end
 
         def countdown_timer_time
-          (countdown_timer_seconds * 10).divmod(256).reverse
+          lsb_msb_format_for(countdown_timer_seconds * 10)
         end
 
         def sounds

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

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require "timex_datalink_client/helpers/four_byte_formatter"
+require "timex_datalink_client/helpers/lsb_msb_formatter"
 
 class TimexDatalinkClient
   class Protocol7
     class Eeprom
       class Speech
         include Helpers::FourByteFormatter
+        include Helpers::LsbMsbFormatter
 
         NICKNAME_LENGTH_WITHOUT_DEVICE = 10
         NICKNAME_LENGTH_WITH_DEVICE = 14
@@ -123,7 +125,7 @@ class TimexDatalinkClient
         def header
           all_values = [header_value_1, header_value_2, header_value_3] + header_values_4 + header_values_5
 
-          all_values.flat_map { |value| value.divmod(256).reverse }
+          all_values.flat_map { |value| lsb_msb_format_for(value) }
         end
 
         def header_value_1
@@ -153,7 +155,10 @@ class TimexDatalinkClient
           value_4_length = device_nickname.any? ? NICKNAME_LENGTH_WITH_DEVICE : NICKNAME_LENGTH_WITHOUT_DEVICE
 
           value_4_length.times.flat_map do |value_4_index|
-            device_value = HEADER_VALUE_4_DEVICE_INDEXES[value_4_index].sum { |device_index| packet_lengths[device_index] }
+            device_value = HEADER_VALUE_4_DEVICE_INDEXES[value_4_index].sum do |device_index|
+              packet_lengths[device_index]
+            end
+
             device_value *= HEADER_VALUE_4_DEVICE_MULTIPLIERS[value_4_index]
 
             user_value = HEADER_VALUE_4_USER_INDEXES[value_4_index].sum { |device_index| packet_lengths[device_index] }

data/lib/timex_datalink_client/protocol_7/eeprom.rb

@@ -9,9 +9,6 @@ class TimexDatalinkClient
       include Helpers::CpacketPaginator
       prepend Helpers::CrcPacketsWrapper
 
-      # FIXME use arrays for array models
-      # FIXME: check Array<Integer> yardoc around places
-
       CPACKET_SECT = [0x90, 0x05]
       CPACKET_DATA = [0x91, 0x05]
       CPACKET_END = [0x92, 0x05]

data/lib/timex_datalink_client/protocol_9/alarm.rb

@@ -1,18 +1,63 @@
 # 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 Protocol9
     class Alarm
+      include ActiveModel::Validations
       include Helpers::CharEncoders
       prepend Helpers::CrcPacketsWrapper
 
       CPACKET_ALARM = [0x50]
 
+      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
+
       attr_accessor :number, :audible, :time, :message, :month, :day
 
+      validates :number, inclusion: {
+        in: 1..10,
+        message: "value %{value} is invalid!  Valid number values are 1..10."
+      }
+
+      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 10).
@@ -33,8 +78,11 @@ class TimexDatalinkClient
 
       # 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,

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

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 require "timex_datalink_client/helpers/char_encoders"
 
 class TimexDatalinkClient
   class Protocol9
     class Eeprom
       class Chrono
+        include ActiveModel::Validations
         include Helpers::CharEncoders
 
         CHRONO_LABEL_LENGTH = 8
@@ -13,6 +16,11 @@ class TimexDatalinkClient
 
         attr_accessor :label, :laps
 
+        validates :laps, inclusion: {
+          in: 2..50,
+          message: "value %{value} is invalid!  Valid laps values are 2..50."
+        }
+
         # Create a Chrono instance.
         #
         # @param label [String] Label for chrono.
@@ -25,8 +33,11 @@ class TimexDatalinkClient
 
         # Compile a packet for a chrono.
         #
+        # @raise [ActiveModel::ValidationError] One or more model values are invalid.
         # @return [Array<Integer>] Array of integers that represent bytes.
         def packet
+          validate!
+
           label_characters
         end
 

data/lib/timex_datalink_client/protocol_9/time.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 require "timex_datalink_client/helpers/crc_packets_wrapper"
 
 class TimexDatalinkClient
   class Protocol9
     class Time
+      include ActiveModel::Validations
       prepend Helpers::CrcPacketsWrapper
 
       CPACKET_TIME = [0x30]
 
       attr_accessor :zone, :is_24h, :time
 
+      validates :zone, inclusion: {
+        in: 1..2,
+        message: "%{value} is invalid!  Valid zones are 1..2."
+      }
+
       # Create a Time instance.
       #
       # @param zone [Integer] Time zone number (1 or 2).
@@ -25,8 +33,11 @@ class TimexDatalinkClient
 
       # 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_TIME,

data/lib/timex_datalink_client/protocol_9/time_name.rb

@@ -1,11 +1,14 @@
 # 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 Protocol9
     class TimeName
+      include ActiveModel::Validations
       include Helpers::CharEncoders
       prepend Helpers::CrcPacketsWrapper
 
@@ -13,6 +16,11 @@ class TimexDatalinkClient
 
       attr_accessor :zone, :name
 
+      validates :zone, inclusion: {
+        in: 1..2,
+        message: "%{value} is invalid!  Valid zones are 1..2."
+      }
+
       # Create a TimeName instance.
       #
       # @param zone [Integer] Time zone number (1 or 2).
@@ -25,8 +33,11 @@ class TimexDatalinkClient
 
       # Compile packets for a time name.
       #
+      # @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_NAME,

data/lib/timex_datalink_client/version.rb

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

data/lib/timex_datalink_client.rb

@@ -104,17 +104,17 @@ class TimexDatalinkClient
   #
   # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
   def packets
-    models.map(&:packets).flatten(1)
+    models.flat_map(&:packets)
   end
 
   private
 
   def notebook_adapter
     @notebook_adapter ||= NotebookAdapter.new(
-      serial_device: serial_device,
-      byte_sleep: byte_sleep,
-      packet_sleep: packet_sleep,
-      verbose: verbose
+      serial_device:,
+      byte_sleep:,
+      packet_sleep:,
+      verbose:
     )
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: timex_datalink_client
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Maxwell Pray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2022-12-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.4
 - !ruby/object:Gem::Dependency
   name: crc
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: mdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rubyserial
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: mdb
+  name: mdl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
-  type: :runtime
+        version: 0.12.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,34 @@ dependencies:
     - - "~>"
       - !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
@@ -106,6 +162,7 @@ files:
 - lib/timex_datalink_client/helpers/crc_packets_wrapper.rb
 - lib/timex_datalink_client/helpers/four_byte_formatter.rb
 - lib/timex_datalink_client/helpers/length_packet_wrapper.rb
+- lib/timex_datalink_client/helpers/lsb_msb_formatter.rb
 - lib/timex_datalink_client/notebook_adapter.rb
 - lib/timex_datalink_client/protocol_1/alarm.rb
 - lib/timex_datalink_client/protocol_1/eeprom.rb
@@ -167,7 +224,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.9.0
+homepage: https://github.com/synthead/timex_datalink_client/tree/v0.11.0
 licenses:
 - MIT
 metadata: {}