Skip to content

Latest commit

 

History

History
331 lines (279 loc) · 8.21 KB

timex_datalink_protocol_1.md

File metadata and controls

331 lines (279 loc) · 8.21 KB
Raw

Using TimexDatalinkClient with Protocol 1

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

image

Please note that WristApps and Watch Sounds are not supported in protocol 1, even though buttons are visible for them in the Timex Datalink software when protocol 1 is configured. When these buttons are clicked, it will display a dialog box about how the feature is not supported.

Appointments

image

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

TimexDatalinkClient::Protocol1::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::Protocol1::Eeprom::Anniversary.new(
    time: Time.new(1985, 7, 3),
    anniversary: "Release of Back to the Future"
  ),
  TimexDatalinkClient::Protocol1::Eeprom::Anniversary.new(
    time: Time.new(1968, 4, 6),
    anniversary: "Release of 2001"
  )
]

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

Phone Numbers

image

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

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

Make a List

image

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

TimexDatalinkClient::Protocol1::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::Protocol1::Time.new(
  zone: 1,
  time: Time.new(2022, 9, 5, 3, 39, 44),
  is_24h: false
)

TimexDatalinkClient::Protocol1::TimeName.new(
  zone: 1,
  name: "PDT"
)

TimexDatalinkClient::Protocol1::Time.new(
  zone: 2,
  time: Time.new(2022, 9, 5, 11, 39, 44),
  is_24h: true
)

TimexDatalinkClient::Protocol1::TimeName.new(
  zone: 2,
  name: "GMT"
)

Alarms

image

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

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

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

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

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

Complete code example

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

require "timex_datalink_client"

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

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

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

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

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

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

  TimexDatalinkClient::Protocol1::Time.new(
    zone: 1,
    time: time1,
    is_24h: false
  ),
  TimexDatalinkClient::Protocol1::TimeName.new(
    zone: 1,
    name: time1.zone
  ),

  TimexDatalinkClient::Protocol1::Time.new(
    zone: 2,
    time: time2,
    is_24h: true
  ),
  TimexDatalinkClient::Protocol1::TimeName.new(
    zone: 2,
    name: time2.zone
  ),

  TimexDatalinkClient::Protocol1::Alarm.new(
    number: 1,
    audible: true,
    time: Time.new(0, 1, 1, 9, 0),  # Year, month, and day is ignored.
    message: "Wake up"
  ),
  TimexDatalinkClient::Protocol1::Alarm.new(
    number: 2,
    audible: true,
    time: Time.new(0, 1, 1, 9, 5),  # Year, month, and day is ignored.
    message: "For real"
  ),
  TimexDatalinkClient::Protocol1::Alarm.new(
    number: 3,
    audible: false,
    time: Time.new(0, 1, 1, 9, 10),  # Year, month, and day is ignored.
    message: "Get up"
  ),
  TimexDatalinkClient::Protocol1::Alarm.new(
    number: 4,
    audible: true,
    time: Time.new(0, 1, 1, 18, 0),  # Year, month, and day is ignored.
    month: 9,
    day: 18,
    message: "Yearly"
  ),
  TimexDatalinkClient::Protocol1::Alarm.new(
    number: 5,
    audible: false,
    time: Time.new(0, 1, 1, 14, 0),  # Year, month, and day is ignored.
    day: 26,
    message: "Monthly"
  ),

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

  TimexDatalinkClient::Protocol1::End.new
]

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

timex_datalink_client.write