summaryrefslogtreecommitdiff
path: root/README.md
blob: 998868bdaa99b57d0ebd1a61451a36353dbcd6b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
lctns-edit
==========
A quickly prototyped tool to edit name, latitude and longitude in LCTNS.FIT as
found on Garmin watches. Works for me, but no guarantees are given. If it
bricks your device you're responsible, not me.

How to use
----------
Example use (list all entries in LCTNS.FIT by default):

    % ./lctns-cli
       0: Garmin (N 38°51'19.976", W 94°47'56.468")
       1: Garmin Europe (N 50°58'58.367", W 1°27'50.040")
       2: Garmin Taiwan (N 25°3'42.418", E 121°38'24.959")

Example use (replace first entry with a decent café):

    % ./lctns-cli --input LCTNS.FIT --output EDITED.FIT --entry 0 \
        --name 'Tjili pop' --latitude "N 55°41.184'" --longitude "E 12°33.014'"
    Tjili pop (N 55°41'11.045", E 12°33'0.838")

New entries should appear after copying the generated output file to the
`GARMIN/NEWFILES/LCTNS.FIT` on your watch after having mounted it as a usb
storage device.

It is only possible to edit existing entries. It is not possible to add new
ones or remove from the file. It seems the firmware on the device will add all
new entries without overwriting any.

Install
-------
You'll need [`git`][] and [`cargo`][rustup]. Cloning with git from
<https://git.netizen.se/lctns-cli/> and running `cargo install --path .` should
place `lctns-cli` in `~/.cargo/bin/` by default.

The code is still too much of a prototype, and far from sufficiently tested,
for it to be suitable to distribute to non-developers.

I would consider publishing to <https://crates.io/>, but likely not until it
becomes [possible to use crates.io without relying on GitHub][msgh_required].

License and disclaimer
----------------------
MIT. Garmin makes great products, but this tool has nothing to do with them.
They own their trademarks et cetera and would unlikely recommend using anything
with their products not developed by them. You are using this at your own risk.

Feedback
--------
Constructive feedback is always welcome. The same goes for patches. Contact
details are easily found at: <https://www.netizen.se/>.

[git]: https://git-scm.com/
[rustup]: https://rustup.rs/
[msgh_required]: https://github.com/rust-lang/crates.io/issues/326