Skip to content

Commit e7f4678

Browse files
rettichschnidirettichschnidi
committed
doc: Fix LwM2M spelling
The proper spelling is LwM2M. Changes generated using the following commands: $ sed -i 's| LWM2M | LwM2M |' $(rg -lw LWM2M)
1 parent c13e0f9 commit e7f4678

24 files changed

+101
-101
lines changed

‎README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,15 @@ The different settings can be configured with CMake cache variables (e.g. `cmake
5555

5656
Wakaama supports multiple modes. At least one mode needs to be defined with CMake cache variables.
5757

58-
- WAKAAMA_MODE_SERVER to enable LWM2M Server interfaces.
59-
- WAKAAMA_MODE_BOOTSTRAP_SERVER to enable LWM2M Bootstrap Server interfaces.
60-
- WAKAAMA_MODE_CLIENT to enable LWM2M Client interfaces.
58+
- WAKAAMA_MODE_SERVER to enable LwM2M Server interfaces.
59+
- WAKAAMA_MODE_BOOTSTRAP_SERVER to enable LwM2M Bootstrap Server interfaces.
60+
- WAKAAMA_MODE_CLIENT to enable LwM2M Client interfaces.
6161

6262
#### Client Settings
6363

6464
Wakaama supports additional client related options. These are only available if the client mode is enabled.
6565

66-
- WAKAAMA_CLIENT_INITIATED_BOOTSTRAP to enable LWM2M Bootstrap support in a LWM2M Client.
66+
- WAKAAMA_CLIENT_INITIATED_BOOTSTRAP to enable LwM2M Bootstrap support in a LWM2M Client.
6767
- WAKAAMA_CLIENT_LWM2M_V_1_0: Restrict the client code to use LwM2M version 1.0
6868

6969
Please note: LwM2M version 1.0 is only supported by clients, while servers are backward compatible.
@@ -72,10 +72,10 @@ Please note: LwM2M version 1.0 is only supported by clients, while servers are b
7272

7373
The following data formats are configurable for Wakaama:
7474

75-
- WAKAAMA_DATA_TLV to enable TLV payload support (implicit except for LWM2M 1.1 clients)
75+
- WAKAAMA_DATA_TLV to enable TLV payload support (implicit except for LwM2M 1.1 clients)
7676
- WAKAAMA_DATA_JSON to enable JSON payload support (implicit when defining LWM2M_SERVER_MODE)
77-
- WAKAAMA_DATA_SENML_JSON to enable SenML JSON payload support (implicit for LWM2M 1.1 or greater when defining LWM2M_SERVER_MODE or LWM2M_BOOTSTRAP_SERVER_MODE)
78-
- WAKAAMA_DATA_SENML_CBOR to enable SenML CBOR payload support (implicit for LWM2M 1.1 or greater when defining LWM2M_SERVER_MODE or LWM2M_BOOTSTRAP_SERVER_MODE)
77+
- WAKAAMA_DATA_SENML_JSON to enable SenML JSON payload support (implicit for LwM2M 1.1 or greater when defining LWM2M_SERVER_MODE or LWM2M_BOOTSTRAP_SERVER_MODE)
78+
- WAKAAMA_DATA_SENML_CBOR to enable SenML CBOR payload support (implicit for LwM2M 1.1 or greater when defining LWM2M_SERVER_MODE or LWM2M_BOOTSTRAP_SERVER_MODE)
7979
- WAKAAMA_DATA_SENML_CBOR_FLOAT16_SUPPORT to enable 16-bit floating point encoding support in CBOR.
8080
- WAKAAMA_DATA_OLD_CONTENT_FORMAT to support the deprecated content format values for TLV and JSON.
8181

@@ -189,7 +189,7 @@ interface. Type 'help' for a list of supported commands.
189189
Options are:
190190
```
191191
Usage: lwm2mserver [OPTION]
192-
Launch a LWM2M server on localhost.
192+
Launch a LwM2M server on localhost.
193193
194194
Options:
195195
-4 Use IPv4 connection. Default: IPv6 connection
@@ -205,12 +205,12 @@ Options:
205205

206206
Next to lwm2mclient there are also examples with DTLS enabled and with raw block1 transfer enabled.
207207

208-
The lwm2mclient features nine LWM2M objects:
208+
The lwm2mclient features nine LwM2M objects:
209209
- Security Object (id: 0)
210210
- Server Object (id: 1)
211211
- Access Control Object (id: 2) as a skeleton
212212
- Device Object (id: 3) containing hard-coded values from the Example LWM2M
213-
Client of Appendix E of the LWM2M Technical Specification.
213+
Client of Appendix E of the LwM2M Technical Specification.
214214
- Connectivity Monitoring Object (id: 4) as a skeleton
215215
- Firmware Update Object (id: 5) as a skeleton.
216216
- Location Object (id: 6) as a skeleton.
@@ -228,19 +228,19 @@ The lwm2mclient features nine LWM2M objects:
228228
exec | 2 | E | No | Yes | | |
229229
dec | 3 | R/W | No | Yes | Float | |
230230

231-
The lwm2mclient opens UDP port 56830 and tries to register to a LWM2M Server at
231+
The lwm2mclient opens UDP port 56830 and tries to register to a LwM2M Server at
232232
127.0.0.1:5683. It features a basic command line interface. Type 'help' for a
233233
list of supported commands.
234234

235235
Options are:
236236
```
237237
Usage: lwm2mclient [OPTION]
238-
Launch a LWM2M client.
238+
Launch a LwM2M client.
239239
Options:
240240
-n NAME Set the endpoint name of the Client. Default: testlwm2mclient
241241
-l PORT Set the local UDP port of the Client. Default: 56830
242-
-h HOST Set the hostname of the LWM2M Server to connect to. Default: localhost
243-
-p PORT Set the port of the LWM2M Server to connect to. Default: 5683
242+
-h HOST Set the hostname of the LwM2M Server to connect to. Default: localhost
243+
-p PORT Set the port of the LwM2M Server to connect to. Default: 5683
244244
-4 Use IPv4 connection. Default: IPv6 connection
245245
-t TIME Set the lifetime of the Client. Default: 300
246246
-b Bootstrap requested.
@@ -269,15 +269,15 @@ LWM2M objects:
269269
- Security Object (id: 0)
270270
- Server Object (id: 1)
271271
- Device Object (id: 3) containing hard-coded values from the Example LWM2M
272-
Client of Appendix E of the LWM2M Technical Specification.
272+
Client of Appendix E of the LwM2M Technical Specification.
273273
- Test Object (id: 31024) from the lwm2mclient as described above.
274274

275275
The lightclient does not feature any command-line interface.
276276

277277
Options are:
278278
```
279279
Usage: lwm2mclient [OPTION]
280-
Launch a LWM2M client.
280+
Launch a LwM2M client.
281281
Options:
282282
-n NAME Set the endpoint name of the Client. Default: testlightclient
283283
-l PORT Set the local UDP port of the Client. Default: 56830

‎core/bootstrap.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ static uint8_t prv_handleBootstrapDiscover(lwm2m_context_t * contextP,
192192

193193
length = 0;
194194
#if !defined(LWM2M_VERSION_1_0)
195-
// LWM2M 1.1.1 adds "</>;" at the beginning
195+
// LwM2M 1.1.1 adds "</>;" at the beginning
196196
length += 4;
197197
#endif
198198
length += QUERY_VERSION_LEN + LWM2M_VERSION_LEN;
@@ -302,7 +302,7 @@ static uint8_t prv_handleBootstrapDiscover(lwm2m_context_t * contextP,
302302
if (*bufferP == NULL) return COAP_500_INTERNAL_SERVER_ERROR;
303303

304304
#if !defined(LWM2M_VERSION_1_0)
305-
// LWM2M 1.1.1 adds "</>;" at the beginning
305+
// LwM2M 1.1.1 adds "</>;" at the beginning
306306
if (length - (*lengthP) < 4) goto error;
307307
(*bufferP)[(*lengthP)++] = REG_URI_START;
308308
(*bufferP)[(*lengthP)++] = REG_PATH_SEPARATOR;
@@ -614,7 +614,7 @@ uint8_t bootstrap_handleFinish(lwm2m_context_t * context,
614614
/*
615615
* Reset the bootstrap servers statuses
616616
*
617-
* TODO: handle LWM2M Servers the client is registered to ?
617+
* TODO: handle LwM2M Servers the client is registered to ?
618618
*
619619
*/
620620
void bootstrap_start(lwm2m_context_t * contextP)

‎core/objects.c

+2-2
Original file line numberDiff line numberDiff line change
@@ -1033,7 +1033,7 @@ int object_getServers(lwm2m_context_t * contextP, bool checkOnly)
10331033
lwm2m_object_t * objectP;
10341034
lwm2m_object_t * securityObjP = NULL;
10351035
lwm2m_object_t * serverObjP = NULL;
1036-
lwm2m_list_t *securityInstP; // instanceID of the server in the LWM2M Security Object
1036+
lwm2m_list_t *securityInstP; // instanceID of the server in the LwM2M Security Object
10371037

10381038
LOG_DBG("Entering");
10391039

@@ -1134,7 +1134,7 @@ int object_getServers(lwm2m_context_t * contextP, bool checkOnly)
11341134
}
11351135
else
11361136
{
1137-
lwm2m_list_t *serverInstP; // instanceID of the server in the LWM2M Server Object
1137+
lwm2m_list_t *serverInstP; // instanceID of the server in the LwM2M Server Object
11381138

11391139
lwm2m_data_free(size, dataP);
11401140
size = 1;

‎core/registration.c

+2-2
Original file line numberDiff line numberDiff line change
@@ -1294,7 +1294,7 @@ static int prv_getParameters(multi_option_t * query,
12941294
if (*versionP == VERSION_1_0 &&
12951295
(*bindingP & (BINDING_T|BINDING_N)) != 0)
12961296
{
1297-
/* These bindings aren't valid in LWM2M 1.0 */
1297+
/* These bindings aren't valid in LwM2M 1.0 */
12981298
goto error;
12991299
}
13001300

@@ -1579,7 +1579,7 @@ static int prv_getId(uint8_t * data,
15791579

15801580
if (limit2 > limit - 2) return 0;
15811581

1582-
// Note that the LWM2M 1.1.1 spec limits the major and
1582+
// Note that the LwM2M 1.1.1 spec limits the major and
15831583
// minor to 1 digit. This allow for values up to 255 in
15841584
// case it is expanded in the future or some client
15851585
// incorrectly exceeds 1 digit.

‎data/cbor.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ static_assert(sizeof(double) == sizeof(uint64_t), "sizeof(double) != sizeof(uint
3131
#endif
3232

3333
#ifdef LWM2M_VERSION_1_0
34-
#error CBOR not supported with LWM2M 1.0
34+
#error CBOR not supported with LwM2M 1.0
3535
#endif
3636

3737
#define CBOR_UNSIGNED_INTEGER 0

‎data/json.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -652,7 +652,7 @@ int json_parse(lwm2m_uri_t * uriP,
652652
else
653653
{
654654
/* Base name may have a trailing "/" on a multiple instance
655-
* resource. This isn't valid for a URI string in LWM2M 1.0.
655+
* resource. This isn't valid for a URI string in LwM2M 1.0.
656656
* Strip off any trailing "/" to avoid an error. */
657657
if (buffer[bnStart + bnLen - 1] == '/') bnLen -= 1;
658658
res = lwm2m_stringToUri((char *)buffer + bnStart, bnLen, &baseURI);

‎data/senml_cbor.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
#ifdef LWM2M_SUPPORT_SENML_CBOR
2323

2424
#ifdef LWM2M_VERSION_1_0
25-
#error SenML CBOR not supported with LWM2M 1.0
25+
#error SenML CBOR not supported with LwM2M 1.0
2626
#endif
2727

2828
#define PRV_CBOR_BUFFER_SIZE 1024

‎data/senml_json.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
#ifdef LWM2M_SUPPORT_SENML_JSON
2828

2929
#ifdef LWM2M_VERSION_1_0
30-
#error SenML JSON not supported with LWM2M 1.0
30+
#error SenML JSON not supported with LwM2M 1.0
3131
#endif
3232

3333
#define PRV_JSON_BUFFER_SIZE 1024

‎doc/wakaama_features.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ This table shows the LwM2M features that are supported by Wakaama.
109109
Overview of LwM2M feature as specified by the OMA:
110110

111111
+----------------------------+----------------------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
112-
| Feature Type | Feature | LWM2M versions in which feature introduced/improved |
112+
| Feature Type | Feature | LwM2M versions in which feature introduced/improved |
113113
+----------------------------+----------------------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
114114
| | | 1.0 | 1.1 | 1.2 | 1.2.1 |
115115
+============================+========================================+=====================================================+=============================================================================================================+================================================================================================+=================================================================================================+

‎examples/bootstrap_server/README

+7-7
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Options:
66
-4 Use IPv4 connection. Default: IPv6 connection
77
-S BYTES CoAP block size. Options: 16, 32, 64, 128, 256, 512, 1024. Default: 1024
88

9-
When it receives a Bootstrap Request from a LWM2M Client, it sends commands as
9+
When it receives a Bootstrap Request from a LwM2M Client, it sends commands as
1010
described in the Bootstrap Information file.
1111
This file is a custom .INI file:
1212

@@ -16,10 +16,10 @@ Spaces at the end of lines are ignored.
1616

1717
Supported sections are [Server] and [Endpoint].
1818

19-
[Server] describes a LWM2M Server account. Keys are:
20-
- id: the short ID of the LWM2M Server. Also used as the instance ID
19+
[Server] describes a LwM2M Server account. Keys are:
20+
- id: the short ID of the LwM2M Server. Also used as the instance ID
2121
to avoid collisions. (MANDATORY)
22-
- uri: the URI of the LWM2M Server (MANDATORY)
22+
- uri: the URI of the LwM2M Server (MANDATORY)
2323
- bootstrap: supported values are YES or NO. Determines if this
2424
server is a Bootstrap Server. (Optional, default is no)
2525
- lifetime: registration lifetime. (optional)
@@ -40,12 +40,12 @@ Operations are sent in the same order as they appear in this file.
4040

4141
Supported keys for this section are:
4242
- Name: Endpoint Name of the Client (Optional)
43-
- Delete: Value must be a valid LWM2M URI. / is allowed. Send a Delete
43+
- Delete: Value must be a valid LwM2M URI. / is allowed. Send a Delete
4444
operation on the URI.
4545
- Server: [Value] is a Server ID matching a Server section. Send one
46-
or two Write operations containing the LWM2M Server
46+
or two Write operations containing the LwM2M Server
4747
informations (one operation only for Bootstrap Servers as they
48-
do not have a matching LWM2M Server Object instance.)
48+
do not have a matching LwM2M Server Object instance.)
4949

5050
All keywords (section names, key names, "yes", "no", "NoSec", "PSK",
5151
"RPK", "Certificate") are case-insensitive.

‎examples/bootstrap_server/bootstrap_info.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ static int prv_add_server(bs_info_t * infoP,
484484
serverP->securityData = lwm2m_data_new(serverP->securitySize);
485485
if (serverP->securityData == NULL) goto error;
486486

487-
// LWM2M Server URI
487+
// LwM2M Server URI
488488
serverP->securityData[0].id = LWM2M_SECURITY_URI_ID;
489489
lwm2m_data_encode_string(dataP->uri, serverP->securityData);
490490

‎examples/bootstrap_server/bootstrap_server.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ void handle_sigint(int signum)
8282

8383
void print_usage(const char *filename, const char *port) {
8484
fprintf(stdout, "Usage: bootstap_server [OPTION]\r\n");
85-
fprintf(stderr, "Launch a LWM2M Bootstrap Server.\r\n\n");
85+
fprintf(stderr, "Launch a LwM2M Bootstrap Server.\r\n\n");
8686
fprintf(stdout, "Options:\r\n");
8787
fprintf(stdout, " -f FILE\tSpecify BootStrap Information file. Default: ./%s\r\n", filename);
8888
fprintf(stdout, " -l PORT\tSet the local UDP port of the Bootstrap Server. Default: %s\r\n", port);
@@ -526,7 +526,7 @@ static void prv_bootstrap_client(lwm2m_context_t *lwm2mH,
526526
*port = 0;
527527
port++;
528528

529-
fprintf(stderr, "Trying to connect to LWM2M CLient at %s:%s\r\n", host, port);
529+
fprintf(stderr, "Trying to connect to LwM2M CLient at %s:%s\r\n", host, port);
530530
newConnP = lwm2m_connection_create(dataP->connList, dataP->sock, host, port, dataP->addressFamily);
531531
if (newConnP == NULL) {
532532
fprintf(stderr, "Connection creation failed.\r\n");
@@ -535,7 +535,7 @@ static void prv_bootstrap_client(lwm2m_context_t *lwm2mH,
535535
dataP->connList = newConnP;
536536

537537
// simulate a client bootstrap request.
538-
// Only LWM2M 1.0 clients support this method of bootstrap. For them, TLV
538+
// Only LwM2M 1.0 clients support this method of bootstrap. For them, TLV
539539
// support is mandatory.
540540
if (COAP_204_CHANGED == prv_bootstrap_callback(lwm2mH, newConnP, COAP_NO_ERROR, NULL, name, LWM2M_CONTENT_TLV, NULL, 0, user_data))
541541
{

‎examples/bootstrap_server/bootstrap_server.ini

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
###########################################################################
22
#
3-
# Describes the Bootstrap operations to perform to various LWM2M Clients.
3+
# Describes the Bootstrap operations to perform to various LwM2M Clients.
44
#
55
# Commented lines starts either with a # or a ;
66
# Spaces before [ and key names are ignored. Spaces around = are ignored.
77
# Spaces at the end of lines are ignored.
88
#
99
# Supported sections are [Server] and [Endpoint].
1010
#
11-
# [Server] describes a LWM2M Server account. Keys are:
12-
# - id: the short ID of the LWM2M Server. Also used as the instance ID
11+
# [Server] describes a LwM2M Server account. Keys are:
12+
# - id: the short ID of the LwM2M Server. Also used as the instance ID
1313
# to avoid collisions. (MANDATORY)
14-
# - uri: the URI of the LWM2M Server (MANDATORY)
14+
# - uri: the URI of the LwM2M Server (MANDATORY)
1515
# - bootstrap: supported values are YES or NO. Determines if this
1616
# server is a Bootstrap Server. (Optional, default is no)
1717
# - lifetime: registration lifetime. (optional)
@@ -32,26 +32,26 @@
3232
#
3333
# Supported keys for this section are:
3434
# - Name: Endpoint Name of the Client (Optional)
35-
# - Delete: Value must be a valid LWM2M URI. / is allowed. Send a Delete
35+
# - Delete: Value must be a valid LwM2M URI. / is allowed. Send a Delete
3636
# operation on the URI.
3737
# - Server: [Value] is a Server ID matching a Server section. Send one
38-
# or two Write operations containing the LWM2M Server
38+
# or two Write operations containing the LwM2M Server
3939
# informations (one operation only for Bootstrap Servers as they
40-
# do not have a matching LWM2M Server Object instance.)
41-
# - Discover: Value must be a valid LWM2M URI. / is allowed. Send a
40+
# do not have a matching LwM2M Server Object instance.)
41+
# - Discover: Value must be a valid LwM2M URI. / is allowed. Send a
4242
# Bootstrap-Discover operation on the URI. (Optional)
43-
# - Read: Value must be a valid LWM2M URI. / is allowed. Send a Bootstrap-
43+
# - Read: Value must be a valid LwM2M URI. / is allowed. Send a Bootstrap-
4444
# Read operation on the URI. A discover must preceed a read to
45-
# determine the client version. Only LWM2M 1.1 or later clients will
46-
# be sent a read. (Optional, LWM2M 1.1 or later only)
45+
# determine the client version. Only LwM2M 1.1 or later clients will
46+
# be sent a read. (Optional, LwM2M 1.1 or later only)
4747
#
4848
# All keywords (section names, key names, "yes", "no", "NoSec", "PSK",
4949
# "RPK", "Certificate") are case-insensitive.
5050
#
5151

5252

5353

54-
# Information on a LWM2M server running on localhost
54+
# Information on a LwM2M server running on localhost
5555
# typically the wakaama test server
5656
[Server]
5757
id=1
@@ -69,7 +69,7 @@ bootstrap=no
6969
lifetime=300
7070
security=NoSec
7171

72-
# Information on a LWM2M server running on localhost
72+
# Information on a LwM2M server running on localhost
7373
# using Pre-Shared Key security
7474
[Server]
7575
id=3

0 commit comments

Comments
 (0)