Skip to content
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

Add lwm2m deviceshifu design #878

Merged
merged 11 commits into from
Oct 10, 2024
Merged

Add lwm2m deviceshifu design #878

merged 11 commits into from
Oct 10, 2024

Conversation

rhoninl
Copy link
Collaborator

@rhoninl rhoninl commented Apr 17, 2024

What this PR does / why we need it:
lwM2M deviceShifu design doc
Will this PR make the community happier?
yes
Which issue this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close that issue when PR gets merged): fixes #

How is this PR tested

  • unit test
  • e2e test
  • other (please specify)
    documentation no need test
    Special notes for your reviewer:

Release note:

- add lwM2M deviceShifu design doc

Copy link
Contributor

@tomqin93 tomqin93 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rhoninl added some comments, please include an architecture diagram too

docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
@rhoninl rhoninl requested a review from tomqin93 April 19, 2024 05:16
Copy link
Contributor

@tomqin93 tomqin93 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rhoninl added some comments

docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
@rhoninl rhoninl requested a review from tomqin93 October 8, 2024 02:58
Copy link

codecov bot commented Oct 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.63%. Comparing base (6c8e5ab) to head (82f818a).
Report is 59 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #878      +/-   ##
==========================================
+ Coverage   37.33%   37.63%   +0.30%     
==========================================
  Files          46       46              
  Lines        3544     2976     -568     
==========================================
- Hits         1323     1120     -203     
+ Misses       2105     1737     -368     
- Partials      116      119       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


The `deviceShifu-LwM2M` will represent each LwM2M object as an instruction that can be accessed through a RESTful API. The API will use the POST method for write operations and the GET method for read operations. The supported data formats for LwM2M v1.0 are TLV, JSON, Plain text, and Opaque.

deviceShifu-LwM2M's LwM2M server will handle Register, Update, De-register, Read, Write, Observe and Notify.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Register, Update, De-register, Read, Write, Observe and Notify. there are some typo and duplication in this text.

correct one FYI:
Register, Un-register, Read, Write, Observe and Notify.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image
In the official lwM2M documentation, it is named this way.

Copy link
Contributor

@tomqin93 tomqin93 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rhoninl added some comments, please take a look

docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
Copy link
Contributor

@tomqin93 tomqin93 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rhoninl added some comments, please take a look

docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
docs/design/deviceshifu/design-deviceShifu-lwm2m.md Outdated Show resolved Hide resolved
tomqin93
tomqin93 previously approved these changes Oct 10, 2024
Copy link
Contributor

@tomqin93 tomqin93 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kris21he
Copy link
Contributor

@rhoninl one more typo? please check, others LGTM

@tomqin93 tomqin93 merged commit 1d41155 into main Oct 10, 2024
4 checks passed
@tomqin93 tomqin93 deleted the add_lwm2m_deviceshifu_design branch October 10, 2024 05:58
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.

4 participants