Skip to content

Commit

Permalink
update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Felix Schaede committed Jan 5, 2022
1 parent 4508624 commit b94b2b8
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Cumulocity LWM2M Demo client
Example implementation of the [eclipse Leshan client demo](https://github.com/eclipse/leshan) in **Cumulocity IoT**. The leshan client demo sends temperature values and supports location tracking and device controls. In the following it will be showen how to easily connect and use the demo client with Cumulocity IoT.
Example implementation of the [eclipse Leshan client demo](https://github.com/eclipse/leshan) in **Cumulocity IoT**. The leshan client demo sends temperature values and supports location tracking and device controls. In the following it will be shown how to easily connect and use the demo client with Cumulocity IoT.

Cumulocity is an IoT platform that enables rapid connections of many, many different devices and applications. It allows you to monitor and respond to IoT data in real time and to spin up this capability in minutes. More information on Cumulocity IoT and how to start a free trial can be found [here](https://www.softwareag.cloud/site/product/cumulocity-iot.html#/).

Cumulocity IoT enables companies to to quickly and easily implement smart IoT solutions.
Cumulocity IoT enables companies to quickly and easily implement smart IoT solutions.

The [Cumulocity IoT documentation](https://cumulocity.com/guides/protocol-integration/lwm2m/) contains detailed instructions on how to connect LWM2M devices to the platfrom.
The [Cumulocity IoT documentation](https://cumulocity.com/guides/protocol-integration/lwm2m/) contains detailed instructions on how to connect LWM2M devices to the platform.
______________________


Expand All @@ -26,11 +26,11 @@ Before the demo client can be connected to the platform, the endpoint and the UR

### registration.csv

In the file registration.csv, the fields *ID*, *NAME*, *endpoint ID* and the field *lwm2m server uri* must be changed for each entry.
In the file registration.csv, the fields *ID*, *NAME*, *endpoint ID* and the field *lwm2m server URI* must be changed for each entry.

![Registration](img/registration.png)
![Registration](./img/registration.png)

The fields *ID*, *NAME*, *endpoint ID* indicate the LWM2M client's "endpoint ID" in order to allow the LwM2M bootstrap to provision the bootstrap information for the LWM2M client. The endpoint ID has be to be **unique** across all tenants and must have the same value as the ID.
The fields *ID*, *NAME*, *endpoint ID* indicate the LWM2M client's "endpoint ID" to allow the LwM2M bootstrap to provision the bootstrap information for the LWM2M client. The endpoint ID has be **unique** across all tenants and must have the same value as the ID.

### docker-compose.yaml

Expand All @@ -51,23 +51,23 @@ services:
## Upload device protocols to Cumulocity IoT

The leshan demo client uses the following LWM2M objects: 3 (device), 6 (location), 3303 (temperature sensor), 3441 (lwm2m test object).
Cumulocity allows any LWM2M objects to be easily intefaced with the platfornm. Cumulocity also supports out-of-the-box integration for the standard LWM2M protocols 3(device), 4(connectivity), 5(firmware) and 6(location).
Cumulocity allows any LWM2M objects to be easily interfaced with the platform. Cumulocity also supports out-of-the-box integration for the standard LWM2M protocols 3(device), 4(connectivity), 5(firmware) and 6(location).

Upload the xml resource files to Cumulocity in the **Device Management -> Device types -> Device protocols** tab.

![Device protocols](img/device_protocols.png)
![Device protocols](./img/device_protocols.png)

The leshan demo client sends a random temperatur measurement at 3303/5700. To add the functionality open the 3303 protocoll and turn on **Send measurement** for the Sensor Value. Make sure to enable on Auto obsere for at least one functionality per protocoll.
The leshan demo client sends a random temperature measurement at 3303/5700. To add the functionality, open the 3303 protocol and turn on **Send measurement** for the Sensor Value. Make sure to enable on Auto observe for at least one functionality per protocol.

![Send measurements](img/send_measurement.png)
![Send measurements](./img/send_measurement.png)

The LWM2M objects 3 (device) and 6 (location) dont need a mapping since the objects are supportet out-of-the-box.
The LWM2M objects 3 (device) and 6 (location) don't need a mapping since the objects are supported out-of-the-box.

## Device registration

To register a LWM2M device in Cumulocity IoT, upload a CSV file with registration data in the bulk registration dialog in **Device Management -> Devices -> Registration -> Register device -> Bulk device**.

![Bulk registration](img/bulk_registration.png)
![Bulk registration](./img/bulk_registration.png)

Start the demo clients with

Expand Down

0 comments on commit b94b2b8

Please sign in to comment.