infinitime/README.md

# InfiniTime

This is a go library for interfacing with InfiniTime firmware
over BLE on Linux.

[![Go Reference](https://pkg.go.dev/badge/go.arsenm.dev/infinitime.svg)](https://pkg.go.dev/go.arsenm.dev/infinitime)

---

### Importing

This library's import path is `go.arsenm.dev/infinitime`.

---

### Dependencies

This library requires `dbus`, `bluez`, and `pactl` to function. These allow the library to use bluetooth, control media, control volume, etc.

#### Arch

```shell
sudo pacman -S dbus bluez libpulse --needed
```

#### Debian/Ubuntu

```shell
sudo apt install dbus bluez pulseaudio-utils
```

#### Fedora

```shell
sudo dnf install dbus bluez pulseaudio-utils
```

---

### Features

This library currently supports the following features:

- Notifications
- Heart rate monitoring
- Setting time
- Battery level
- Music control
- OTA firmware upgrades
- Navigation

---

### Mentions

The DFU process used in this library was created with the help of [siglo](https://github.com/alexr4535/siglo)'s source code. Specifically, this file: [ble_dfu.py](https://github.com/alexr4535/siglo/blob/main/src/ble_dfu.py)
Initial Commit 2021-08-20 00:41:09 +00:00			`# InfiniTime`

			`This is a go library for interfacing with InfiniTime firmware`
			`over BLE on Linux.`

Add go reference badge 2021-08-20 00:59:38 +00:00			`[![Go Reference](https://pkg.go.dev/badge/go.arsenm.dev/infinitime.svg)](https://pkg.go.dev/go.arsenm.dev/infinitime)`

Initial Commit 2021-08-20 00:41:09 +00:00			`---`

Mention import path in README.md 2021-08-20 01:04:23 +00:00			`### Importing`

			This library's import path is `go.arsenm.dev/infinitime`.

			`---`

Initial Commit 2021-08-20 00:41:09 +00:00			`### Dependencies`

Fix README errors 2021-11-25 00:51:42 +00:00			This library requires `dbus`, `bluez`, and `pactl` to function. These allow the library to use bluetooth, control media, control volume, etc.
Initial Commit 2021-08-20 00:41:09 +00:00
			`#### Arch`

			```shell
Remove playerctl from dependencies and add pactl providers 2021-11-25 00:50:35 +00:00			`sudo pacman -S dbus bluez libpulse --needed`
Initial Commit 2021-08-20 00:41:09 +00:00			```

			`#### Debian/Ubuntu`

			```shell
Remove playerctl from dependencies and add pactl providers 2021-11-25 00:50:35 +00:00			`sudo apt install dbus bluez pulseaudio-utils`
Initial Commit 2021-08-20 00:41:09 +00:00			```

			`#### Fedora`

			```shell
Remove playerctl from dependencies and add pactl providers 2021-11-25 00:50:35 +00:00			`sudo dnf install dbus bluez pulseaudio-utils`
Initial Commit 2021-08-20 00:41:09 +00:00			```

			`---`

			`### Features`

			`This library currently supports the following features:`

			`- Notifications`
			`- Heart rate monitoring`
			`- Setting time`
			`- Battery level`
			`- Music control`
			`- OTA firmware upgrades`
Upated readme 2022-10-21 22:19:51 +00:00			`- Navigation`
Initial Commit 2021-08-20 00:41:09 +00:00
			`---`

			`### Mentions`

			`The DFU process used in this library was created with the help of [siglo](https://github.com/alexr4535/siglo)'s source code. Specifically, this file: [ble_dfu.py](https://github.com/alexr4535/siglo/blob/main/src/ble_dfu.py)`