timex_datalink_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b30f06f6a23f4312ee7167089c7e0704ef5f799b4c3f7a2be36d57b445074f46
+  data.tar.gz: f2a82191c18efa5a7c51b422ff6b8c0ad30589890eac654a47507ece261ec445
+SHA512:
+  metadata.gz: 78ddeedea22f0d2476b934d84a0751e67c63c2528cdab1a077cf5a4ddde7310e716da02be053d7abfee90e17bd9110ea92d75f84df510b7acc79e81c814598c3
+  data.tar.gz: 9a4974b2abd86722dacc1d4badd802fcc3b7ac84fab8d27d2bc6f39c31269d0c188635cf4e89e55b189aa86c9290a5148e26925e9c9f15337503d539df01c838

data/lib/timex_datalink_client/alarm.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Alarm
+    include Helpers::CharEncoders
+    prepend Helpers::CrcPacketsWrapper
+
+    CPACKET_ALARM = [0x50]
+
+    MESSAGE_LENGTH = 8
+
+    attr_accessor :number, :audible, :time, :message
+
+    def initialize(number:, audible:, time:, message:)
+      @number = number
+      @audible = audible
+      @time = time
+      @message = message
+    end
+
+    def packets
+      [
+        [
+          CPACKET_ALARM,
+          number,
+          time.hour,
+          time.min,
+          0,
+          0,
+          message_characters,
+          audible
+        ].flatten
+      ]
+    end
+
+    private
+
+    def message_characters
+      message_padded = message.ljust(MESSAGE_LENGTH)
+
+      chars_for(message_padded)
+    end
+  end
+end

data/lib/timex_datalink_client/eeprom/anniversary.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/length_packet_wrapper"
+
+class TimexDatalinkClient
+  class Eeprom
+    class Anniversary
+      include Helpers::CharEncoders
+      prepend Helpers::LengthPacketWrapper
+
+      attr_accessor :time, :anniversary
+
+      def initialize(time:, anniversary:)
+        @time = time
+        @anniversary = anniversary
+      end
+
+      def packet
+        [
+          time.month,
+          time.day,
+          anniversary_characters
+        ].flatten
+      end
+
+      private
+
+      def anniversary_characters
+        eeprom_chars_for(anniversary)
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/eeprom/appointment.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/length_packet_wrapper"
+
+class TimexDatalinkClient
+  class Eeprom
+    class Appointment
+      include Helpers::CharEncoders
+      prepend Helpers::LengthPacketWrapper
+
+      attr_accessor :time, :message
+
+      def initialize(time:, message:)
+        @time = time
+        @message = message
+      end
+
+      def packet
+        [
+          time.month,
+          time.day,
+          time_15m,
+          message_characters
+        ].flatten
+      end
+
+      private
+
+      def time_15m
+        time.hour * 4 + time.min / 15
+      end
+
+      def message_characters
+        eeprom_chars_for(message)
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/eeprom/list.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/length_packet_wrapper"
+
+class TimexDatalinkClient
+  class Eeprom
+    class List
+      include Helpers::CharEncoders
+      prepend Helpers::LengthPacketWrapper
+
+      attr_accessor :list_entry, :priority
+
+      def initialize(list_entry:, priority:)
+        @list_entry = list_entry
+        @priority = priority
+      end
+
+      def packet
+        [
+          priority,
+          list_entry_characters
+        ].flatten
+      end
+
+      private
+
+      def list_entry_characters
+        eeprom_chars_for(list_entry)
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/eeprom/phone_number.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/char_encoders"
+require "timex_datalink_client/helpers/length_packet_wrapper"
+
+class TimexDatalinkClient
+  class Eeprom
+    class PhoneNumber
+      include Helpers::CharEncoders
+      prepend Helpers::LengthPacketWrapper
+
+      PHONE_DIGITS = 12
+
+      attr_accessor :name, :number, :type
+
+      def initialize(name:, number:, type: " ")
+        @name = name
+        @number = number
+        @type = type
+      end
+
+      def packet
+        [
+          number_with_type_characters,
+          name_characters,
+        ].flatten
+      end
+
+      private
+
+      def number_with_type_truncated
+        number_with_type = "#{number} #{type}"
+        padded_number_with_type = number_with_type.rjust(PHONE_DIGITS)
+
+        padded_number_with_type[0..PHONE_DIGITS - 1]
+      end
+
+      def number_with_type_characters
+        phone_chars_for(number_with_type_truncated)
+      end
+
+      def name_characters
+        eeprom_chars_for(name)
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/eeprom.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/cpacket_paginator"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Eeprom
+    include Helpers::CpacketPaginator
+    prepend Helpers::CrcPacketsWrapper
+
+    CPACKET_CLEAR = [0x93, 0x01]
+    CPACKET_SECT = [0x90, 0x01]
+    CPACKET_DATA = [0x91, 0x01]
+    CPACKET_END = [0x92, 0x01]
+
+    START_ADDRESS = 0x0236
+    APPOINTMENT_NO_NOTIFICATION = 0xff
+
+    attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification
+
+    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
+
+    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, 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

data/lib/timex_datalink_client/end.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class End
+    prepend Helpers::CrcPacketsWrapper
+
+    CPACKET_SKIP = [0x21]
+
+    def packets
+      [CPACKET_SKIP]
+    end
+  end
+end

data/lib/timex_datalink_client/helpers/char_encoders.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+class TimexDatalinkClient
+  class Helpers
+    module CharEncoders
+      CHARS = "0123456789abcdefghijklmnopqrstuvwxyz !\"#$%&'()*+,-./:\\;=@?ABCDEF"
+      EEPROM_TERMINATOR = 0x3f
+
+      PHONE_CHARS = "0123456789cfhpw "
+
+      def chars_for(string_chars, char_map: CHARS)
+        string_chars.each_char.map do |string_char|
+          char_map.index(string_char)
+        end
+      end
+
+      def eeprom_chars_for(string_chars)
+        chars = chars_for(string_chars).append(EEPROM_TERMINATOR)
+
+        packed_int = chars.each_with_index.sum do |char, index|
+          char << (6 * index)
+        end
+
+        packed_int.digits(256)
+      end
+
+      def phone_chars_for(string_chars)
+        chars = chars_for(string_chars, char_map: PHONE_CHARS)
+
+        packed_int = chars.each_with_index.sum do |char, index|
+          char << (4 * index)
+        end
+
+        packed_int.digits(256)
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/helpers/cpacket_paginator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class TimexDatalinkClient
+  class Helpers
+    module CpacketPaginator
+      ITEMS_PER_PACKET = 32
+
+      def paginate_cpackets(header:, cpackets:)
+        paginated_cpackets = cpackets.each_slice(ITEMS_PER_PACKET)
+
+        paginated_cpackets.map.with_index(1) do |paginated_cpacket, index|
+          header + [index] + paginated_cpacket
+        end
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/helpers/crc_packets_wrapper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "crc"
+
+class TimexDatalinkClient
+  class Helpers
+    module CrcPacketsWrapper
+      def packets
+        super.map do |packet|
+          crc_header(packet) + packet + crc_footer(packet)
+        end
+      end
+
+      private
+
+      def crc_header(packet)
+        [packet.length + 3]
+      end
+
+      def crc_footer(packet)
+        crc_check = (crc_header(packet) + packet).pack("C*")
+        crc = CRC.crc16_arc(crc_check)
+
+        crc.divmod(256)
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/helpers/length_packet_wrapper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class TimexDatalinkClient
+  class Helpers
+    module LengthPacketWrapper
+      def packet
+        [super.length + 1] + super
+      end
+    end
+  end
+end

data/lib/timex_datalink_client/notebook_adapter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rubyserial"
+
+class TimexDatalinkClient
+  class NotebookAdapter
+    BYTE_SLEEP = 0.025
+    PACKET_SLEEP = 0.25
+
+    attr_accessor :serial_device
+
+    def initialize(serial_device)
+      @serial_device = serial_device
+    end
+
+    def write(packets)
+      packets.each do |packet|
+        packet.each do |byte|
+          serial.write(byte.chr)
+
+          sleep(BYTE_SLEEP)
+        end
+
+        sleep(PACKET_SLEEP)
+      end
+    end
+
+    private
+
+    def serial
+      @serial ||= Serial.new(serial_device)
+    end
+  end
+end

data/lib/timex_datalink_client/sound_options.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class SoundOptions
+    prepend Helpers::CrcPacketsWrapper
+
+    CPACKET_BEEPS = [0x71]
+
+    attr_accessor :hourly_chimes, :button_beep
+
+    def initialize(hourly_chimes:, button_beep:)
+      @hourly_chimes = hourly_chimes
+      @button_beep = button_beep
+    end
+
+    def packets
+      [
+        CPACKET_BEEPS + [hourly_chimes, button_beep]
+      ]
+    end
+  end
+end

data/lib/timex_datalink_client/sound_theme.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/cpacket_paginator"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class SoundTheme
+    include Helpers::CpacketPaginator
+    prepend Helpers::CrcPacketsWrapper
+
+    CPACKET_SECT = [0x90, 0x03]
+    CPACKET_DATA = [0x91, 0x03]
+    CPACKET_END = [0x92, 0x03]
+
+    SOUND_DATA_HEADER = "\x25\x04\x19\x69"
+
+    attr_accessor :sound_data
+
+    def initialize(sound_data:)
+      @sound_data = sound_data
+    end
+
+    def packets
+      [load_sect] + payloads + [CPACKET_END]
+    end
+
+    private
+
+    def sound_bytes
+      sound_data.delete_prefix(SOUND_DATA_HEADER).bytes
+    end
+
+    def load_sect
+      CPACKET_SECT + [payloads.length, offset]
+    end
+
+    def payloads
+      paginate_cpackets(header: CPACKET_DATA, cpackets: sound_bytes)
+    end
+
+    def offset
+      0x100 - sound_bytes.length
+    end
+  end
+end

data/lib/timex_datalink_client/start.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class Start
+    prepend Helpers::CrcPacketsWrapper
+
+    CPACKET_START = [0x20, 0x00, 0x00, 0x03]
+
+    def packets
+      [CPACKET_START]
+    end
+  end
+end

data/lib/timex_datalink_client/sync.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class TimexDatalinkClient
+  class Sync
+    SYNC_1_BYTE = [0x55]
+    SYNC_2_BYTE = [0xaa]
+
+    SYNC_2_LENGTH = 40
+
+    attr_accessor :length
+
+    def initialize(length: 300)
+      @length = length
+    end
+
+    def packets
+      [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

data/lib/timex_datalink_client/time.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 Time
+    include Helpers::CharEncoders
+    prepend Helpers::CrcPacketsWrapper
+
+    CPACKET_TIME = [0x32]
+
+    attr_accessor :zone, :is_24h, :date_format, :time
+
+    def initialize(zone:, is_24h:, date_format:, time:)
+      @zone = zone
+      @is_24h = is_24h
+      @date_format = date_format
+      @time = time
+    end
+
+    def packets
+      [
+        [
+          CPACKET_TIME,
+          zone,
+          time.sec,
+          time.hour,
+          time.min,
+          time.month,
+          time.day,
+          year_mod_1900,
+          timezone_characters,
+          wday_from_monday,
+          is_24h_value,
+          date_format
+        ].flatten
+      ]
+    end
+
+    private
+
+    def timezone_characters
+      chars_for(time.zone.downcase)
+    end
+
+    def year_mod_1900
+      time.year % 100
+    end
+
+    def wday_from_monday
+      (time.wday + 6) % 7
+    end
+
+    def is_24h_value
+      is_24h ? 2 : 1
+    end
+  end
+end

data/lib/timex_datalink_client/version.rb

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

data/lib/timex_datalink_client/wrist_app.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/helpers/cpacket_paginator"
+require "timex_datalink_client/helpers/crc_packets_wrapper"
+
+class TimexDatalinkClient
+  class WristApp
+    include Helpers::CpacketPaginator
+    prepend Helpers::CrcPacketsWrapper
+
+    CPACKET_CLEAR = [0x93, 0x02]
+    CPACKET_SECT = [0x90, 0x02]
+    CPACKET_DATA = [0x91, 0x02]
+    CPACKET_END = [0x92, 0x02]
+
+    WRIST_APP_DELIMITER = /\xac.*\r\n/n
+    WRIST_APP_CODE_INDEX = 8
+
+    attr_accessor :wrist_app_data
+
+    def initialize(wrist_app_data:)
+      @wrist_app_data = wrist_app_data
+    end
+
+    def packets
+      [CPACKET_CLEAR, cpacket_sect] + payloads + [CPACKET_END]
+    end
+
+    private
+
+    def cpacket_sect
+      CPACKET_SECT + [payloads.length, 1]
+    end
+
+    def wrist_app_ascii
+      wrist_app_data.split(WRIST_APP_DELIMITER)[WRIST_APP_CODE_INDEX]
+    end
+
+    def wrist_app_bytes
+      [wrist_app_ascii].pack("H*").bytes
+    end
+
+    def payloads
+      paginate_cpackets(header: CPACKET_DATA, cpackets: wrist_app_bytes)
+    end
+  end
+end

data/lib/timex_datalink_client.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "timex_datalink_client/alarm"
+require "timex_datalink_client/eeprom"
+require "timex_datalink_client/eeprom/anniversary"
+require "timex_datalink_client/eeprom/appointment"
+require "timex_datalink_client/eeprom/list"
+require "timex_datalink_client/eeprom/phone_number"
+require "timex_datalink_client/end"
+require "timex_datalink_client/notebook_adapter"
+require "timex_datalink_client/sound_options"
+require "timex_datalink_client/sound_theme"
+require "timex_datalink_client/start"
+require "timex_datalink_client/sync"
+require "timex_datalink_client/time"
+require "timex_datalink_client/version"
+require "timex_datalink_client/wrist_app"
+
+class TimexDatalinkClient
+  attr_accessor :serial_device, :models
+
+  def initialize(serial_device:, models: [])
+    @serial_device = serial_device
+    @models = models
+  end
+
+  def write
+    notebook_adapter.write(packets)
+  end
+
+  def packets
+    models.map(&:packets).flatten(1)
+  end
+
+  private
+
+  def notebook_adapter
+    @notebook_adapter ||= NotebookAdapter.new(serial_device)
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: timex_datalink_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maxwell Pray
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: crc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: rubyserial
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.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: 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
+description: Write data to Timex Datalink watches with an optical sensor
+email: synthead@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/timex_datalink_client.rb
+- lib/timex_datalink_client/alarm.rb
+- lib/timex_datalink_client/eeprom.rb
+- lib/timex_datalink_client/eeprom/anniversary.rb
+- lib/timex_datalink_client/eeprom/appointment.rb
+- lib/timex_datalink_client/eeprom/list.rb
+- lib/timex_datalink_client/eeprom/phone_number.rb
+- lib/timex_datalink_client/end.rb
+- lib/timex_datalink_client/helpers/char_encoders.rb
+- lib/timex_datalink_client/helpers/cpacket_paginator.rb
+- lib/timex_datalink_client/helpers/crc_packets_wrapper.rb
+- lib/timex_datalink_client/helpers/length_packet_wrapper.rb
+- lib/timex_datalink_client/notebook_adapter.rb
+- lib/timex_datalink_client/sound_options.rb
+- lib/timex_datalink_client/sound_theme.rb
+- lib/timex_datalink_client/start.rb
+- lib/timex_datalink_client/sync.rb
+- lib/timex_datalink_client/time.rb
+- lib/timex_datalink_client/version.rb
+- lib/timex_datalink_client/wrist_app.rb
+homepage: https://github.com/synthead/timex_datalink_client
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Library for optical Timex Datalink watches
+test_files: []