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.

Sign up for GitHub

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

Jump to bottom

Add initial data model #1677

Merged
merged 16 commits into from
Feb 1, 2023
Merged

Add initial data model #1677

merged 16 commits into from
Feb 1, 2023

Conversation

cstoidner
Copy link
Contributor

Signed-off-by: Christoph Stoidner c.stoidner@gmx.de

Proposed changes

Initial documentation of the thin-edge data model

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

#1676

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

@cstoidner
Add initial data model
1d927db 
Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>
@cstoidner
Add MQTT communication diagram
2857a3a 
Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>
@cstoidner
Add retain flag hints
febddab 
Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>
@cstoidner
Add "type name" to sample's values
4988b17 
Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>
@cstoidner
Remove obsolete todo note
912c2af 
Values can be grouped by a sample.
reubenmiller
reubenmiller requested changes Jan 23, 2023
View reviewed changes
Copy link
Contributor

@reubenmiller reubenmiller left a comment

Choose a reason for hiding this comment

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

Please correct the spelling mistakes as well (GitHub shows the spelling mistakes and the suggestions accordingly)

docs/src/architecture/data-model.md Outdated Show resolved Hide resolved
docs/src/architecture/data-model.md Outdated Show resolved Hide resolved
docs/src/architecture/data-model.md Outdated Show resolved Hide resolved
docs/src/architecture/data-model.md Outdated Show resolved Hide resolved
docs/src/architecture/data-model.md Outdated Show resolved Hide resolved
docs/src/architecture/data-model.md Outdated Show resolved Hide resolved
docs/src/architecture/data-model.md Outdated Show resolved Hide resolved
docs/src/architecture/data-model.md Outdated Show resolved Hide resolved
docs/src/architecture/data-model.md Show resolved Hide resolved
docs/src/architecture/data-model.md Outdated Show resolved Hide resolved
cstoidner and others added 7 commits January 23, 2023 10:10
@cstoidner @reubenmiller
Improve wording
cd0f79a 
Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>

Co-authored-by: Reuben Miller <reuben.d.miller@gmail.com>
@cstoidner
Define timestamp as optional
10b6e22 
Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>
@cstoidner
Add link to mosquitto ACL doc
bfa02a8 
Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>
@cstoidner
Remove future TODOs
9bfeb0a 
Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>
@cstoidner
Add child-device MQTT topics
6a3b140 
Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>
@cstoidner
Remove data-type string and bool
a83bae7 
initial data-model shall reflect current implementation

Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>
@cstoidner
Fix spelling
0422166 
Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>
@cstoidner
Copy link
Contributor Author

Please correct the spelling mistakes as well (GitHub shows the spelling mistakes and the suggestions accordingly)

I corrected all spelling mistakes (showed by GitHub) and considered all your comments.

@cstoidner
Restructure telemetry data descriptions
2cf517a 
- have an introducing sentence before the bullet points
- remove JSON scheme, use only JSON example
- put element descriptions into tables

Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>
cstoidner and others added 3 commits January 30, 2023 14:54
@cstoidner
Fix typos
8802e8c 
Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>
@cstoidner @reubenmiller
Improve layout and wording
ec18ffb 
Co-authored-by: Reuben Miller <reuben.d.miller@gmail.com>
@cstoidner
Re-order sections 'Telemetry Data' and 'Use of MQTT'
0795970 
- put section 'Use of MQTT' before section 'Telemetry Data'
- merge telemetry specifics from section 'MQTT' into 'Telemetry Data'
- add custom fragment
- rename measurement's type_name to name

Signed-off-by: Christoph Stoidner <c.stoidner@gmx.de>
reubenmiller
reubenmiller approved these changes Jan 31, 2023
View reviewed changes
Copy link
Contributor

@reubenmiller reubenmiller left a comment

Choose a reason for hiding this comment

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

Approved

@reubenmiller reubenmiller merged commit 9910417 into thin-edge:main Feb 1, 2023
@cstoidner cstoidner mentioned this pull request Feb 26, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@reubenmiller reubenmiller reubenmiller approved these changes

@itsroshan itsroshan Awaiting requested review from itsroshan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@cstoidner @reubenmiller