-
Notifications
You must be signed in to change notification settings - Fork 1
/
Introduction.html
208 lines (187 loc) · 10.5 KB
/
Introduction.html
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>1. Introduction — Anjay 3.8.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=86f27845" />
<link rel="stylesheet" type="text/css" href="_static/theme_overrides.css?v=b9c2c5b9" />
<script src="_static/jquery.js?v=8dae8fb0"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=30f795a6"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="2. OMA LwM2M - Brief description" href="LwM2M.html" />
<link rel="prev" title="Welcome to Anjay LwM2M library documentation!" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: #ffd500" >
<a href="index.html">
<img src="_static/avsystem_header.png" class="logo" alt="Logo"/>
</a>
<div class="version">
3.8.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="LwM2M.html">2. OMA LwM2M - Brief description</a></li>
<li class="toctree-l1"><a class="reference internal" href="Compiling_client_applications.html">3. Compiling client applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="BasicClient.html">4. Basic client</a></li>
<li class="toctree-l1"><a class="reference internal" href="AdvancedTopics.html">5. Advanced topics</a></li>
<li class="toctree-l1"><a class="reference internal" href="FirmwareUpdateTutorial.html">6. Firmware Update Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tools.html">7. Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms.html">8. Porting guide for non-POSIX platforms</a></li>
<li class="toctree-l1"><a class="reference internal" href="Migrating.html">9. Migrating from older versions</a></li>
<li class="toctree-l1"><a class="reference internal" href="CommercialFeatures.html">10. Commercial features</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #ffd500" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Anjay</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active"><span class="section-number">1. </span>Introduction</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="introduction">
<h1><span class="section-number">1. </span>Introduction<a class="headerlink" href="#introduction" title="Link to this heading"></a></h1>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>With release of Anjay 3.0, the <a class="reference external" href="https://github.com/AVSystem/Anjay/blob/master/LICENSE">library’s license terms have changed</a>. Please make sure
that you have reviewed it before updating to the new major release. Previous
versions of Anjay remain with the old, Apache 2.0 license.</p>
</div>
<p><strong>Anjay</strong> is a library that implements the <em>OMA Lightweight Machine to Machine</em>
protocol, including the necessary subset of CoAP.</p>
<p>The project has been created and is actively maintained by
<a class="reference external" href="https://www.avsystem.com">AVSystem</a>.</p>
<section id="protocol-support-status">
<h2><span class="section-number">1.1. </span>Protocol support status<a class="headerlink" href="#protocol-support-status" title="Link to this heading"></a></h2>
<p>The basis for this implementation were the following documents:</p>
<ul class="simple">
<li><p><em>Lightweight Machine to Machine Technical Specification: Core</em>,
document number <code class="docutils literal notranslate"><span class="pre">OMA-TS-LightweightM2M_Core-V1_1_1-20190617-A</span></code></p></li>
<li><p><em>Lightweight Machine to Machine Technical Specification: Transport Bindings</em>,
document number <code class="docutils literal notranslate"><span class="pre">OMA-TS-LightweightM2M_Transport-V1_1_1-20190617-A</span></code>.</p></li>
</ul>
<p>In case of ambiguities, existing implementations were considered as a reference.</p>
<p>The following features are <strong>supported</strong>:</p>
<ul class="simple">
<li><p>Bootstrap - full support</p>
<ul>
<li><p>Enrollment over Secure Transport and smart card bootstrap are
<a class="reference internal" href="CommercialFeatures.html"><span class="doc">available commercially</span></a></p></li>
</ul>
</li>
<li><p>Client Registration - full support</p></li>
<li><p>Device Management and Service Enablement - full support</p></li>
<li><p>Information Reporting - full support</p></li>
<li><p>Data formats</p>
<ul>
<li><p>Plain Text</p></li>
<li><p>Opaque</p></li>
<li><p>CBOR</p></li>
<li><p>TLV</p></li>
<li><p>SenML JSON</p></li>
<li><p>SenML CBOR</p></li>
<li><p>LwM2M JSON (output only)</p></li>
</ul>
</li>
<li><p>Security</p>
<ul>
<li><p>DTLS with Certificates, if supported by backend TLS library</p></li>
<li><p>DTLS with PSK, if supported by backend TLS library</p></li>
<li><p>NoSec mode</p></li>
<li><p>Support for Hardware Security Modules (<a class="reference internal" href="CommercialFeatures.html"><span class="doc">available commercially</span></a>)</p></li>
</ul>
</li>
<li><p>Transport</p>
<ul>
<li><p>Support for UDP Binding</p></li>
<li><p>Support for TCP Binding</p></li>
<li><p>Support for SMS Binding (<a class="reference internal" href="CommercialFeatures.html"><span class="doc">available commercially</span></a>)</p></li>
<li><p>Support for NIDD Binding (<a class="reference internal" href="CommercialFeatures.html"><span class="doc">available commercially</span></a>)</p></li>
</ul>
</li>
</ul>
<p>The following features are <strong>not implemented</strong>:</p>
<ul class="simple">
<li><p>RPK DTLS mode</p></li>
<li><p>LwM2M JSON (input)</p></li>
</ul>
</section>
<section id="technical-information">
<h2><span class="section-number">1.2. </span>Technical information<a class="headerlink" href="#technical-information" title="Link to this heading"></a></h2>
<p>Anjay is written in standards-compliant C99. It partly relies on some POSIX
library extensions, although it can be easily ported to non-POSIX platforms.</p>
<p>Some optional features require C11’s <code class="docutils literal notranslate"><span class="pre">stdatomic.h</span></code> header to be available
(<code class="docutils literal notranslate"><span class="pre">ANJAY_WITH_EVENT_LOOP</span></code>, <code class="docutils literal notranslate"><span class="pre">AVS_COMMONS_COMPAT_THREADING_WITH_ATOMIC_SPINLOCK</span></code>).</p>
<p>Its only external dependency is the open source
<a class="reference external" href="https://github.com/AVSystem/avs_commons">AVSystem Commons Library</a>. That
library in turn may additionally depend either on
<a class="reference external" href="https://www.openssl.org/">OpenSSL</a> or <a class="reference external" href="https://tls.mbed.org/">Mbed TLS</a>
or <a class="reference external" href="https://projects.eclipse.org/projects/iot.tinydtls">TinyDTLS</a> for DTLS
support.</p>
<p>To build Anjay from source, <a class="reference external" href="https://www.cmake.org/">CMake</a> version 3.6.0 or
newer is necessary.</p>
</section>
<section id="deprecated-and-experimental-features">
<h2><span class="section-number">1.3. </span>Deprecated and experimental features<a class="headerlink" href="#deprecated-and-experimental-features" title="Link to this heading"></a></h2>
<p>Anjay’s Doxygen documentation contains, among others, <strong>@deprecated</strong> and
<strong>@experimental</strong> tags:</p>
<ul class="simple">
<li><p>features tagged with <strong>@deprecated</strong> are no longer supported and will be
deleted in the future versions,</p></li>
<li><p>features tagged with <strong>@experimental</strong> may contain changes (in the future
versions) that will break their backward compatibility.</p></li>
</ul>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to Anjay LwM2M library documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="LwM2M.html" class="btn btn-neutral float-right" title="2. OMA LwM2M - Brief description" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2017-2024, AVSystem.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>