Skip to content

Add Observe Strategies and Object Version Handling Section to LwM2M Documentation #2030

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop/4.1
Choose a base branch
from

Conversation

nickAS21
Copy link
Contributor

PR description

This PR introduces important updates to the LwM2M documentation:

πŸ”„ New Features:

  • Added support for multiple Observe behavior strategies in LwM2M device profiles:
    • Single β€” one Observe request per resource.
    • Composite All β€” all resources observed via a single Composite Observe.
    • Composite by Object β€” resources grouped by object and observed via separate Composite requests.

These options give users flexibility in balancing traffic efficiency and granularity.

πŸ“˜ New Section:

  • Handling of Object Versions in the LwM2M Model Structure
    A new section explaining how ThingsBoard handles object versions during profile configuration and request execution. This includes:
    • How versions are matched between device and profile.
    • What happens when versions mismatch.
    • Examples of correct request paths using versioned object IDs.

πŸ›  Other Improvements:

  • Clarified that profile settings are applied during client Registration and on the next Update Registration, depending on the session state.
  • ⚠️ Added a note that all changes in profile settings are applied only if the model object version matches, as described in the new section.
  • Minor language and formatting enhancements for clarity.

These changes help ensure users correctly configure LwM2M profiles and avoid version-related integration issues.

Link checker

The links will be checked by the build agent automatically once you create or update your PR.

You can use the following command to check the broken links locally.

docker run --rm -it --network=host --name=linkchecker ghcr.io/linkchecker/linkchecker --check-extern --no-warnings http://0.0.0.0:4000/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant