ACK/docs/index.html at eb685c5c8f7794d5bc59a6bdfc3a1bb801047593 · InkApplications/ACK · GitHub

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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8" />
    <meta name="robots" content="index,follow" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <title>ACK: APRS Client for Kotlin</title>
    <link rel="stylesheet" href="https://assets.inkapplications.com/css/main-v1.2.css" type="text/css" media="all" />
    <style>
        :root { --color-accent: #FFA72B; }
    </style>
</head>
<body class="content-break anchored-footer">
    <header>
        <h1>ACK: Aprs Client for Kotlin</h1>
        <p>
            ACK is a series of multiplatform Kotlin utilities and data
            structures for parsing Ham Radio APRS packets.
        </p>
    </header>
    <section>
        <article>
            <h1>Parser</h1>
            <p>
                The ACK Parser provides data structures and a multiplatform
                parsing utility for handling AFSK AX.25 Frames as well as
                String frames from APRS-IS.
            </p>
            <h2>Maven Coordinates</h2>
            <ul>
                <li>
                    APRS-IS Client: <code>com.inkapplications.ack:client</code>
                </li>
                <li>
                    Parser: <code>com.inkapplications.ack:codec</code>
                </li>
                <li>
                    Data Structures: <code>com.inkapplications.ack:structures</code>
                </li>
            </ul>
            <h2>Sources</h2>
            <ul>
                <li>
                    <a href="https://github.com/InkApplications/ACK">GitHub</a>
                </li>
                <li>
                    <a href="https://github.com/InkApplications/ACK/blob/master/LICENSE">View License</a>
                </li>
            </ul>
        </article>
        <article>
            <h1>CLI</h1>
            <p>
                The ACK CLI Client provides a jvm application for receiving
                data from APRS-IS, as well as file-parsing and other APRS
                utilities such as passcode generation.
            </p>
            <ul>
                <li>
                    Sources on
                    <a href="https://github.com/InkApplications/ACK">GitHub</a>
                </li>
                <li>
                    <a href="https://github.com/InkApplications/ACK/blob/master/LICENSE">View License</a>
                </li>
            </ul>
        </article>
        <article>
            <h1>Android Application</h1>
            <p>
                The ACK Android Application provides APRS-IS and AFSK access
                to the APRS network as well detailed logs and maps.
            </p>
            <ul>
                <li>
                    <a href="https://play.google.com/store/apps/details?id=com.inkapplications.ack.android">
                        Play Store
                    </a>
                </li>
            </ul>
        </article>
    </section>
    <section>
        <h1>Q&A</h1>
        <article>
            <h2>What is an APRS-IS Passcode and where do I get one?</h2>
            <p>
                Internet Services for APRS (APRS-IS) requires a passcode in order
                to publish data to the service.
                This is only required if you intend to broadcast your location
                to the Internet APRS services, and is intended to control spam and
                limit the sevice to licensed radio operators.
            </p>
            <p>
                We <strong>do not assign these passcodes</strong> and they are
                generated from your license. There are different ways you can
                obtain these, it is up to you to obtain one properly for your
                license.
            </p>
            <p>
                For the advanced user, the command line tool for
                <a href="https://github.com/InkApplications/ACK">ACK</a>
                can also generate these for you.
            </p>
        </article>
        <article>
            <h2>Is the App Free?</h2>
            <p>
                The ACK parsing and encoding library is free and open source.
                The android application that integrates these this library
                is sold on the Google Play store to support the ongoing
                development of both the app and the open source library.
            </p>
        </article>
        <article>
            <h2>How can I Support Development</h2>
            <p>
                If you would like to support the developer directly, you
                can do so through
                <a href="https://github.com/sponsors/ReneeVandervelde">Github Sponsors</a>
            </p>
        </article>
        <article>
            <h2>Will the Android application work offline?</h2>
            <p>Yes.</p>
            <p>This application was designed specifically with offline in mind.</p>
            <p>Internet specific features, such as APRS-IS will obviously not be available offline.</p>
        </article>
        <article>
            <h2>Does the Android application require Play Services?</h2>
            <p>No.</p>
            <p>
                I have gone out of my way to make sure that this application does
                not require Google's Play services and will function on nearly any
                Android device.
            </p>
        </article>
        <article>
            <h2>Is there an iOS App?</h2>
            <p>No.</p>
            <p>
                This would require a lot of additional work to support less
                compatible devices in a closed and unfriendly ecosystem.
                An iOS compatible application is not being considered at
                this time.
            </p>
            <p>
                However, the core library supports Kotlin Multiplatform,
                much of which is compatible with Apple native targets.
            </p>
        </article>
    </section>
    <footer class="ink">
        <div class="signature">
            <a href="https://InkApplications.com">Ink Applications</a>
        </div>
    </footer>
</body>
</html>