-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #138 from synthead/add-protocol-4-documentation
Add protocol 4 documentation
- Loading branch information
Showing
1 changed file
with
312 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,312 @@ | ||
| # Using TimexDatalinkClient with Protocol 4 | ||
|
|
||
| This document describes how to use protocol 4 devices with this library by comparing code examples to the Timex Datalink | ||
| software version 2.1d. | ||
|
|
||
|  | ||
|
|
||
| ## Appointments | ||
|
|
||
|  | ||
|
|
||
| ```ruby | ||
| appointments = [ | ||
| TimexDatalinkClient::Protocol4::Eeprom::Appointment.new( | ||
| time: Time.new(2022, 10, 31, 19, 0), | ||
| message: "Scare the neighbors" | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Eeprom::Appointment.new( | ||
| time: Time.new(2022, 11, 24, 17, 0), | ||
| message: "Feed the neighbors" | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Eeprom::Appointment.new( | ||
| time: Time.new(2022, 12, 25, 14, 0), | ||
| message: "Spoil the neighbors" | ||
| ) | ||
| ] | ||
|
|
||
| TimexDatalinkClient::Protocol4::Eeprom.new( | ||
| appointments: appointments, | ||
| appointment_notification: 3 # In 5 minute intervals. 255 for no notification. | ||
| ) | ||
| ``` | ||
|
|
||
| ## Anniversaries | ||
|
|
||
|  | ||
|
|
||
| ```ruby | ||
| anniversaries = [ | ||
| TimexDatalinkClient::Protocol4::Eeprom::Anniversary.new( | ||
| time: Time.new(1985, 7, 3), | ||
| anniversary: "Release of Back to the Future" | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Eeprom::Anniversary.new( | ||
| time: Time.new(1968, 4, 6), | ||
| anniversary: "Release of 2001" | ||
| ) | ||
| ] | ||
|
|
||
| TimexDatalinkClient::Protocol4::Eeprom.new(anniversaries: anniversaries) | ||
| ``` | ||
|
|
||
| ## Phone Numbers | ||
|
|
||
|  | ||
|
|
||
| ```ruby | ||
| phone_numbers = [ | ||
| TimexDatalinkClient::Protocol4::Eeprom::PhoneNumber.new( | ||
| name: "Marty McFly", | ||
| number: "1112223333", | ||
| type: "H" | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Eeprom::PhoneNumber.new( | ||
| name: "Doc Brown", | ||
| number: "4445556666", | ||
| type: "C" | ||
| ) | ||
| ] | ||
|
|
||
| TimexDatalinkClient::Protocol4::Eeprom.new(phone_numbers: phone_numbers) | ||
| ``` | ||
|
|
||
| ## Make a List | ||
|
|
||
|  | ||
|
|
||
| ```ruby | ||
| lists = [ | ||
| TimexDatalinkClient::Protocol4::Eeprom::List.new( | ||
| list_entry: "Muffler bearings", | ||
| priority: 2 | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Eeprom::List.new( | ||
| list_entry: "Headlight fluid", | ||
| priority: 4 | ||
| ) | ||
| ] | ||
|
|
||
| TimexDatalinkClient::Protocol4::Eeprom.new(lists: lists) | ||
| ``` | ||
|
|
||
| ## Time Settings | ||
|
|
||
|  | ||
|
|
||
| ```ruby | ||
| TimexDatalinkClient::Protocol4::Time.new( | ||
| zone: 1, | ||
| name: "PDT", | ||
| time: Time.new(2022, 9, 5, 3, 39, 44), | ||
| is_24h: false, | ||
| date_format: 2 | ||
| ) | ||
|
|
||
| TimexDatalinkClient::Protocol4::Time.new( | ||
| zone: 2, | ||
| name: "GMT", | ||
| time: Time.new(2022, 9, 5, 11, 39, 44), | ||
| is_24h: true, | ||
| date_format: 2 | ||
| ) | ||
| ``` | ||
|
|
||
| ## Alarms | ||
|
|
||
|  | ||
|
|
||
| ```ruby | ||
| TimexDatalinkClient::Protocol4::Alarm.new( | ||
| number: 1, | ||
| audible: true, | ||
| time: Time.new(0, 1, 1, 9, 0), # Year, month, and day is ignored. | ||
| message: "Wake up" | ||
| ) | ||
|
|
||
| TimexDatalinkClient::Protocol4::Alarm.new( | ||
| number: 2, | ||
| audible: true, | ||
| time: Time.new(0, 1, 1, 9, 5), # Year, month, and day is ignored. | ||
| message: "For real" | ||
| ) | ||
|
|
||
| TimexDatalinkClient::Protocol4::Alarm.new( | ||
| number: 3, | ||
| audible: false, | ||
| time: Time.new(0, 1, 1, 9, 10), # Year, month, and day is ignored. | ||
| message: "Get up" | ||
| ) | ||
|
|
||
| TimexDatalinkClient::Protocol4::Alarm.new( | ||
| number: 4, | ||
| audible: true, | ||
| time: Time.new(0, 1, 1, 18, 0), # Year, month, and day is ignored. | ||
| message: "Or not" | ||
| ) | ||
|
|
||
| TimexDatalinkClient::Protocol4::Alarm.new( | ||
| number: 5, | ||
| audible: false, | ||
| time: Time.new(0, 1, 1, 14, 0), # Year, month, and day is ignored. | ||
| message: "Told you" | ||
| ) | ||
| ``` | ||
|
|
||
| ## WristApps | ||
|
|
||
|  | ||
|
|
||
| ```ruby | ||
| TimexDatalinkClient::Protocol4::WristApp.new(zap_file: "DATALINK/APP/TIMER13.ZAP") | ||
| ``` | ||
|
|
||
| ## Watch Sounds | ||
|
|
||
|  | ||
|
|
||
| ```ruby | ||
| TimexDatalinkClient::Protocol4::SoundTheme.new(spc_file: "DATALINK/SND/DEFAULT.SPC") | ||
|
|
||
| TimexDatalinkClient::Protocol4::SoundOptions.new( | ||
| hourly_chime: true, | ||
| button_beep: false | ||
| ) | ||
| ``` | ||
|
|
||
| ## Complete code example | ||
|
|
||
| Here is an example that syncs all models to a device that supports protocol 4: | ||
|
|
||
| ```ruby | ||
| require "timex_datalink_client" | ||
|
|
||
| appointments = [ | ||
| TimexDatalinkClient::Protocol4::Eeprom::Appointment.new( | ||
| time: Time.new(2022, 10, 31, 19, 0), | ||
| message: "Scare the neighbors" | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Eeprom::Appointment.new( | ||
| time: Time.new(2022, 11, 24, 17, 0), | ||
| message: "Feed the neighbors" | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Eeprom::Appointment.new( | ||
| time: Time.new(2022, 12, 25, 14, 0), | ||
| message: "Spoil the neighbors" | ||
| ) | ||
| ] | ||
|
|
||
| anniversaries = [ | ||
| TimexDatalinkClient::Protocol4::Eeprom::Anniversary.new( | ||
| time: Time.new(1985, 7, 3), | ||
| anniversary: "Release of Back to the Future" | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Eeprom::Anniversary.new( | ||
| time: Time.new(1968, 4, 6), | ||
| anniversary: "Release of 2001" | ||
| ) | ||
| ] | ||
|
|
||
| phone_numbers = [ | ||
| TimexDatalinkClient::Protocol4::Eeprom::PhoneNumber.new( | ||
| name: "Marty McFly", | ||
| number: "1112223333", | ||
| type: "H" | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Eeprom::PhoneNumber.new( | ||
| name: "Doc Brown", | ||
| number: "4445556666", | ||
| type: "C" | ||
| ) | ||
| ] | ||
|
|
||
| lists = [ | ||
| TimexDatalinkClient::Protocol4::Eeprom::List.new( | ||
| list_entry: "Muffler bearings", | ||
| priority: 2 | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Eeprom::List.new( | ||
| list_entry: "Headlight fluid", | ||
| priority: 4 | ||
| ) | ||
| ] | ||
|
|
||
| time1 = Time.now | ||
| time2 = time1.dup.utc | ||
|
|
||
| models = [ | ||
| TimexDatalinkClient::Protocol4::Sync.new, | ||
| TimexDatalinkClient::Protocol4::Start.new, | ||
|
|
||
| TimexDatalinkClient::Protocol4::Time.new( | ||
| zone: 1, | ||
| time: time1, | ||
| is_24h: false, | ||
| date_format: 2 | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Time.new( | ||
| zone: 2, | ||
| time: time2, | ||
| is_24h: true, | ||
| date_format: 2 | ||
| ), | ||
|
|
||
| TimexDatalinkClient::Protocol4::Alarm.new( | ||
| number: 1, | ||
| audible: true, | ||
| time: Time.new(0, 1, 1, 9, 0), # Year, month, and day is ignored. | ||
| message: "Wake up" | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Alarm.new( | ||
| number: 2, | ||
| audible: true, | ||
| time: Time.new(0, 1, 1, 9, 5), # Year, month, and day is ignored. | ||
| message: "For real" | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Alarm.new( | ||
| number: 3, | ||
| audible: false, | ||
| time: Time.new(0, 1, 1, 9, 10), # Year, month, and day is ignored. | ||
| message: "Get up" | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Alarm.new( | ||
| number: 4, | ||
| audible: true, | ||
| time: Time.new(0, 1, 1, 9, 15), # Year, month, and day is ignored. | ||
| message: "Or not" | ||
| ), | ||
| TimexDatalinkClient::Protocol4::Alarm.new( | ||
| number: 5, | ||
| audible: false, | ||
| time: Time.new(0, 1, 1, 11, 30), # Year, month, and day is ignored. | ||
| message: "Told you" | ||
| ), | ||
|
|
||
| TimexDatalinkClient::Protocol4::Eeprom.new( | ||
| appointments: appointments, | ||
| anniversaries: anniversaries, | ||
| lists: lists, | ||
| phone_numbers: phone_numbers, | ||
| appointment_notification: 3 # In 5 minute intervals. 255 for no notification. | ||
| ), | ||
|
|
||
| TimexDatalinkClient::Protocol4::SoundTheme.new(spc_file: "DATALINK/SND/DEFHIGH.SPC"), | ||
|
|
||
| TimexDatalinkClient::Protocol4::SoundOptions.new( | ||
| hourly_chime: true, | ||
| button_beep: true | ||
| ), | ||
|
|
||
| TimexDatalinkClient::Protocol4::WristApp.new(zap_file: "DATALINK/APP/TIMER13.ZAP"), | ||
|
|
||
| TimexDatalinkClient::Protocol4::End.new | ||
| ] | ||
|
|
||
| timex_datalink_client = TimexDatalinkClient.new( | ||
| serial_device: "/dev/ttyACM0", | ||
| models: models, | ||
| verbose: true | ||
| ) | ||
|
|
||
| timex_datalink_client.write | ||
| ``` |