Skip to content

Latest commit

 

History

History
362 lines (299 loc) · 9.47 KB

timex_datalink_protocol_3.md

File metadata and controls

362 lines (299 loc) · 9.47 KB
Raw

Using TimexDatalinkClient with Protocol 3

This document describes how to use protocol 3 devices with this library by comparing code examples to the Timex Datalink software version 2.1d.

image

Appointments

image

appointments = [
  TimexDatalinkClient::Protocol3::Eeprom::Appointment.new(
    time: Time.new(2022, 10, 31, 19, 0),
    message: "Scare the neighbors"
  ),
  TimexDatalinkClient::Protocol3::Eeprom::Appointment.new(
    time: Time.new(2022, 11, 24, 17, 0),
    message: "Feed the neighbors"
  ),
  TimexDatalinkClient::Protocol3::Eeprom::Appointment.new(
    time: Time.new(2022, 12, 25, 14, 0),
    message: "Spoil the neighbors"
  )
]

TimexDatalinkClient::Protocol3::Eeprom.new(
  appointments: appointments,
  appointment_notification_minutes: 15
)

Here are the available Watch pre-notification beep values from the Timex Datalink software with their equivalent Appointment appointment_notification_minutes values:

Timex Datalink Watch pre-notification beep value Appointment appointment_notification_minutes value
No beep nil
At time of appointments 0
5 minutes before appointments 5
10 minutes before appointments 10
15 minutes before appointments 15
20 minutes before appointments 20
25 minutes before appointments 25
30 minutes before appointments 30

Anniversaries

image

anniversaries = [
  TimexDatalinkClient::Protocol3::Eeprom::Anniversary.new(
    time: Time.new(1985, 7, 3),
    anniversary: "Release of Back to the Future"
  ),
  TimexDatalinkClient::Protocol3::Eeprom::Anniversary.new(
    time: Time.new(1968, 4, 6),
    anniversary: "Release of 2001"
  )
]

TimexDatalinkClient::Protocol3::Eeprom.new(anniversaries: anniversaries)

Phone Numbers

image

phone_numbers = [
  TimexDatalinkClient::Protocol3::Eeprom::PhoneNumber.new(
    name: "Marty McFly",
    number: "1112223333",
    type: "H"
  ),
  TimexDatalinkClient::Protocol3::Eeprom::PhoneNumber.new(
    name: "Doc Brown",
    number: "4445556666",
    type: "C"
  )
]

TimexDatalinkClient::Protocol3::Eeprom.new(phone_numbers: phone_numbers)

Make a List

image

lists = [
  TimexDatalinkClient::Protocol3::Eeprom::List.new(
    list_entry: "Muffler bearings",
    priority: 2
  ),
  TimexDatalinkClient::Protocol3::Eeprom::List.new(
    list_entry: "Headlight fluid",
    priority: 4
  )
]

TimexDatalinkClient::Protocol3::Eeprom.new(lists: lists)

Here are the available Priority values from the Timex Datalink software with their equivalent List priority values:

Timex Datalink Priority value List priority value
1 - Highest 1
2 - High 2
3 - Medium 3
4 - Low 4
5 - Lowest 5
None nil

Time Settings

image

TimexDatalinkClient::Protocol3::Time.new(
  zone: 1,
  name: "PDT",
  time: Time.new(2022, 9, 5, 3, 39, 44),
  is_24h: false,
  date_format: "%_m-%d-%y"
)

TimexDatalinkClient::Protocol3::Time.new(
  zone: 2,
  name: "GMT",
  time: Time.new(2022, 9, 5, 11, 39, 44),
  is_24h: true,
  date_format: "%_m-%d-%y"
)

Here are the valid values for date_format, represented by Time#strftime format, followed by an example of 2023-09-06 in %Y-%m-%d format:

date_format value Formatted example
"%_m-%d-%y" 9-06-23
"%_d-%m-%y" 6-09-23
"%y-%m-%d" 23-09-06
"%_m.%d.%y" 9.06.23
"%_d.%m.%y" 6.09.23
"%y.%m.%d" 23.09.06

Alarms

image

TimexDatalinkClient::Protocol3::Alarm.new(
  number: 1,
  audible: true,
  time: Time.new(0, 1, 1, 9, 0),  # Year, month, and day is ignored.
  message: "Wake up"
)

TimexDatalinkClient::Protocol3::Alarm.new(
  number: 2,
  audible: true,
  time: Time.new(0, 1, 1, 9, 5),  # Year, month, and day is ignored.
  message: "For real"
)

TimexDatalinkClient::Protocol3::Alarm.new(
  number: 3,
  audible: false,
  time: Time.new(0, 1, 1, 9, 10),  # Year, month, and day is ignored.
  message: "Get up"
)

TimexDatalinkClient::Protocol3::Alarm.new(
  number: 4,
  audible: true,
  time: Time.new(0, 1, 1, 18, 0),  # Year, month, and day is ignored.
  message: "Or not"
)

TimexDatalinkClient::Protocol3::Alarm.new(
  number: 5,
  audible: false,
  time: Time.new(0, 1, 1, 14, 0),  # Year, month, and day is ignored.
  message: "Told you"
)

WristApps

image

This example requires a ZAP file present to upload. See the Acquiring SPC and ZAP Files for Protocols 3 and 4 documentation for information on how to acquire ZAP files from the original Timex Datalink software.

TimexDatalinkClient::Protocol3::WristApp.new(zap_file: "TIMER13.ZAP")

Watch Sounds

image

This example requires a SPC file present to upload. See the Acquiring SPC and ZAP Files for Protocols 3 and 4 documentation for information on how to acquire SPC files from the original Timex Datalink software.

TimexDatalinkClient::Protocol3::SoundTheme.new(spc_file: "DEFAULT.SPC")

TimexDatalinkClient::Protocol3::SoundOptions.new(
  hourly_chime: true,
  button_beep: false
)

Complete code example

This example requires SPC and ZAP files present to upload. See the Acquiring SPC and ZAP Files for Protocols 3 and 4 documentation for information on how to acquire SPC and ZAP files from the original Timex Datalink software.

Here is an example that syncs all models to a device that supports protocol 3:

require "timex_datalink_client"

appointments = [
  TimexDatalinkClient::Protocol3::Eeprom::Appointment.new(
    time: Time.new(2022, 10, 31, 19, 0),
    message: "Scare the neighbors"
  ),
  TimexDatalinkClient::Protocol3::Eeprom::Appointment.new(
    time: Time.new(2022, 11, 24, 17, 0),
    message: "Feed the neighbors"
  ),
  TimexDatalinkClient::Protocol3::Eeprom::Appointment.new(
    time: Time.new(2022, 12, 25, 14, 0),
    message: "Spoil the neighbors"
  )
]

anniversaries = [
  TimexDatalinkClient::Protocol3::Eeprom::Anniversary.new(
    time: Time.new(1985, 7, 3),
    anniversary: "Release of Back to the Future"
  ),
  TimexDatalinkClient::Protocol3::Eeprom::Anniversary.new(
    time: Time.new(1968, 4, 6),
    anniversary: "Release of 2001"
  )
]

phone_numbers = [
  TimexDatalinkClient::Protocol3::Eeprom::PhoneNumber.new(
    name: "Marty McFly",
    number: "1112223333",
    type: "H"
  ),
  TimexDatalinkClient::Protocol3::Eeprom::PhoneNumber.new(
    name: "Doc Brown",
    number: "4445556666",
    type: "C"
  )
]

lists = [
  TimexDatalinkClient::Protocol3::Eeprom::List.new(
    list_entry: "Muffler bearings",
    priority: 2
  ),
  TimexDatalinkClient::Protocol3::Eeprom::List.new(
    list_entry: "Headlight fluid",
    priority: 4
  )
]

time1 = Time.now
time2 = time1.dup.utc

models = [
  TimexDatalinkClient::Protocol3::Sync.new,
  TimexDatalinkClient::Protocol3::Start.new,

  TimexDatalinkClient::Protocol3::Time.new(
    zone: 1,
    time: time1,
    is_24h: false,
    date_format: "%_m-%d-%y"
  ),
  TimexDatalinkClient::Protocol3::Time.new(
    zone: 2,
    time: time2,
    is_24h: true,
    date_format: "%_m-%d-%y"
  ),

  TimexDatalinkClient::Protocol3::Alarm.new(
    number: 1,
    audible: true,
    time: Time.new(0, 1, 1, 9, 0),  # Year, month, and day is ignored.
    message: "Wake up"
  ),
  TimexDatalinkClient::Protocol3::Alarm.new(
    number: 2,
    audible: true,
    time: Time.new(0, 1, 1, 9, 5),  # Year, month, and day is ignored.
    message: "For real"
  ),
  TimexDatalinkClient::Protocol3::Alarm.new(
    number: 3,
    audible: false,
    time: Time.new(0, 1, 1, 9, 10),  # Year, month, and day is ignored.
    message: "Get up"
  ),
  TimexDatalinkClient::Protocol3::Alarm.new(
    number: 4,
    audible: true,
    time: Time.new(0, 1, 1, 9, 15),  # Year, month, and day is ignored.
    message: "Or not"
  ),
  TimexDatalinkClient::Protocol3::Alarm.new(
    number: 5,
    audible: false,
    time: Time.new(0, 1, 1, 11, 30),  # Year, month, and day is ignored.
    message: "Told you"
  ),

  TimexDatalinkClient::Protocol3::Eeprom.new(
    appointments: appointments,
    anniversaries: anniversaries,
    lists: lists,
    phone_numbers: phone_numbers,
    appointment_notification_minutes: 15
  ),

  TimexDatalinkClient::Protocol3::SoundTheme.new(spc_file: "DEFHIGH.SPC"),

  TimexDatalinkClient::Protocol3::SoundOptions.new(
    hourly_chime: true,
    button_beep: true
  ),

  TimexDatalinkClient::Protocol3::WristApp.new(zap_file: "TIMER13.ZAP"),

  TimexDatalinkClient::Protocol3::End.new
]

timex_datalink_client = TimexDatalinkClient.new(
  serial_device: "/dev/ttyACM0",
  models: models,
  verbose: true
)

timex_datalink_client.write