Sha256: 6d59af8120ed781466bfb6993972cc72579c818c12cc87ba97717f542faa42fd

Contents?: true

Size: 1.87 KB

Versions: 1

Compression:

Stored size: 1.87 KB

Contents

# TimexDatalinkCaldav

TimexDatalinkCaldav is a simple Ruby gem designed to sync events from a CalDAV server to a Timex Datalink watch. It can also be used as a standalone command-line interface (CLI) tool.

## Installation

To install the TimexDatalinkCaldav gem, simply run:

```sh
gem install timex_datalink_caldav
```

Or add this line to your application's Gemfile:

```ruby
source "https://rubygems.pkg.github.com/wjhrdy" do
  gem "timex_datalink_caldav"
end
```

And then execute:

```sh
bundle install
```

## Usage

### As a Gem

Here's an example of how to use the tool in your Ruby code:

```ruby
require 'timex_datalink_caldav'

client = TimexDatalinkCaldav::Client.new(your_username, your_password, your_server_uri, your_device)
client.sync_to_watch
```

### As a CLI Tool

After installing the gem, you can use it as a CLI tool:

```sh
timex_datalink_caldav -u https://caldavendpoint.com -n your_username -p your_password -d your_device
```

Please replace `caldavendpoint.com` `your_username`, `your_password`, and `your_device` with your actual CalDAV server, username, password, and serial device respectively.

The device is a serial device that flashes an led when it receives data. On Linux, this is usually `/dev/ttyUSB0`. On macOS, this is usually `/dev/cu.usbserial-0001`. On Windows, this is usually `COM1`.

If you want to use this I highly recommend pairing it with the Raspberry Pi Pico and [this project](https://github.com/famiclone6502/DIY_Datalink_Adapter). It is the cheapest and easiest way to get a serial device that works with the Timex Datalink watch.

## Note

Ensure you have the necessary dependencies installed on your system and you have the correct permissions to access the specified device.

The tool currently filters down to events that have attendees and converts event times to Eastern Standard Time (EST). Events are sorted by time before syncing to the watch.

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
timex_datalink_caldav-0.3.0 README.md