hazardchem
63976af404
All checks were successful
ci/woodpecker/pr/woodpecker Pipeline was successful
Added openrc script. |
||
---|---|---|
api | ||
cmd | ||
internal/utils | ||
mpris | ||
scripts | ||
translit | ||
.gitignore | ||
.goreleaser.yaml | ||
.woodpecker.yml | ||
calls.go | ||
config.go | ||
go.mod | ||
go.sum | ||
itd | ||
itd.service | ||
itd.toml | ||
itgui.desktop | ||
LICENSE | ||
main.go | ||
Makefile | ||
maps.go | ||
metrics.go | ||
music.go | ||
notifs.go | ||
README.md | ||
socket.go | ||
version.go | ||
weather.go |
ITD
InfiniTime Daemon
itd
is a daemon that uses my infinitime library to interact with the PineTime running InfiniTime.
Features
- Notification relay
- Notification transliteration
- Call Notifications (ModemManager)
- Music control
- Get info from watch (HRM, Battery level, Firmware version, Motion)
- Set current time
- Control socket
- Firmware upgrades
- Weather
- BLE Filesystem
- Navigation (PureMaps)
Installation
Since ITD 0.0.7, packages are built and uploaded whenever a new release is created.
Arch Linux
Use the itd-bin
or itd-git
AUR packages.
Debian/Ubuntu
- Go to the latest release and download the
.deb
package for your CPU architecture. You can find your architecture by runninguname -m
in the terminal. - Run
sudo apt install <package>
, replacing<package>
with the path to the downloaded file. Note: relative paths must begin with./
. - Example:
sudo apt install ~/Downloads/itd-0.0.7-linux-aarch64.deb
Fedora
- Go to the latest release and download the
.rpm
package for your CPU architecture. You can find your architecture by runninguname -m
in the terminal. - Run
sudo dnf install <package>
, replacing<package>
with the path to the downloaded file. - Example:
sudo dnf install ~/Downloads/itd-0.0.7-linux-aarch64.rpm
Alpine (and postmarketOS)
- Go to the latest release and download the
.apk
package for your CPU architecture. You can find your architecture by runninguname -m
in the terminal. - Run
sudo apk add --allow-untrusted <package>
, replacing<package>
with the path to the downloaded file. - Example:
sudo apk add --allow-untrusted ~/Downloads/itd-0.0.7-linux-aarch64.apk
Note: --allow-untrusted
is required because ITD isn't part of a repository, and therefore is not signed.
Socket
This daemon creates a UNIX socket at /tmp/itd/socket
. It allows you to directly control the daemon and, by extension, the connected watch.
The socket uses my lrpc library for requests. This library accepts requests in msgpack, with the following format:
{"Receiver": "ITD", "Method": "Notify", "Arg": {"title": "title1", "body": "body1"}, "ID": "some-id-here"}
It will return a msgpack response, the format of which can be found here. The response will have the same ID as was sent in the request in order to allow the client to keep track of which request the response belongs to.
Transliteration
Since the PineTime does not have enough space to store all unicode glyphs, it only stores the ASCII space and Cyrillic. Therefore, this daemon can transliterate unsupported characters into supported ones. Since some languages have different transliterations, the transliterators to be used must be specified in the config. Here are the available transliterators:
- eASCII
- Scandinavian
- German
- Hebrew
- Greek
- Russian
- Ukranian
- Arabic
- Farsi
- Polish
- Lithuanian
- Estonian
- Icelandic
- Czech
- French
- Armenian
- Korean
- Chinese
- Romanian
- Emoji
Place the desired map names in an array as notifs.translit.use
. They will be evaluated in order. You can also put custom transliterations in notifs.translit.custom
. These take priority over any other maps. The notifs.translit
config section should look like this:
[notifs.translit]
use = ["eASCII", "Russian", "Emoji"]
custom = [
"test", "replaced"
]
itctl
This daemon comes with a binary called itctl
which uses the socket to control the daemon from the command line. As such, it can be scripted using bash.
This is the itctl
usage screen:
NAME:
itctl - A new cli application
USAGE:
itctl [global options] command [command options] [arguments...]
COMMANDS:
help Display help screen for a command
resources, res Handle InfiniTime resource loading
filesystem, fs Perform filesystem operations on the PineTime
firmware, fw Manage InfiniTime firmware
get Get information from InfiniTime
notify Send notification to InfiniTime
set Set information on InfiniTime
update, upd Update information on InfiniTime
watch Watch a value for changes
GLOBAL OPTIONS:
--socket-path value, -s value Path to itd socket (default: "/tmp/itd/socket")
itgui
In cmd/itgui
, there is a gui frontend to the socket of itd
. It uses the Fyne library for Go.
Compilation
Before compiling, certain prerequisites must be installed. These are listed on the following page: https://developer.fyne.io/started/#prerequisites
It can be compiled by running:
go build ./cmd/itgui
Cross-compilation
Due to the use of OpenGL, cross-compilation of itgui
isn't as simple as that of itd
and itctl
. The following guide from the Fyne website should work for itgui
: https://developer.fyne.io/started/cross-compiling.
Screenshots
Installation
To install, install the go compiler and make. Usually, go is provided by a package either named go
or golang
, and make is usually provided by make
. The go compiler must be version 1.17 or newer for various new reflect
features.
To install, run
make && sudo make install
Starting
To start the daemon, run the following without root:
systemctl --user start itd
To autostart on login, run:
systemctl --user enable itd
Cross compiling
To cross compile, simply set the go environment variables. For example, for PinePhone, use:
make GOOS=linux GOARCH=arm64
This will compile itd
and itctl
for Linux aarch64 which is what runs on the PinePhone. This daemon only runs on Linux due to the library's dependencies (dbus
, and bluez
specifically).
Configuration
This daemon places a config file at /etc/itd.toml
. This is the global config. itd
will also look for a config at ~/.config/itd.toml
.
Most of the time, the daemon does not need to be restarted for config changes to take effect.
Attribution
Location data from OpenStreetMap Nominatim, © OpenStreetMap contributors
Weather data from the Norwegian Meteorological Institute