doc: Add software architecture diagram and design considerations #43
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Closes #43 |
nejraselimovic
previously approved these changes
Oct 8, 2021
|
|
||
| The {{% gnse %}} software contains multiple applications, libraries and drivers. | ||
|
|
||
| The {{% gnse %}} software architecture observed below depicts three main layers |
There was a problem hiding this comment.
Suggested change
| The {{% gnse %}} software architecture observed below depicts three main layers | |
| The {{% gnse %}} software architecture observed below depicts three main layers: |
|
|
||
| Different applications use different libraries depending on the application desired functionality. | ||
|
|
||
| For example, an application that samples sensors and sends the data using LoRaWAN, will utilize the Sensors, GNSE APIs, bare-metal scheduler and LoRaWAN libraries. |
There was a problem hiding this comment.
Suggested change
| For example, an application that samples sensors and sends the data using LoRaWAN, will utilize the Sensors, GNSE APIs, bare-metal scheduler and LoRaWAN libraries. | |
| For example, an application that samples sensors and sends the data using LoRaWAN will utilize the Sensors, GNSE APIs, bare-metal scheduler and LoRaWAN libraries. |
Comment on lines
43
to
45
| The application layer contains sample boilerplate applications that can be used as a starting point. | ||
| The example applications are developed to be as energy efficient as possible and can be used for production testing and deployments. |
There was a problem hiding this comment.
Suggested change
| The application layer contains sample boilerplate applications that can be used as a starting point. | |
| The example applications are developed to be as energy efficient as possible and can be used for production testing and deployments. | |
| The application layer contains sample boilerplate applications that can be used as a starting point. | |
| The example applications are developed to be as energy efficient as possible and can be used for production testing and deployments. |
| The application layer contains sample boilerplate applications that can be used as a starting point. | ||
| The example applications are developed to be as energy efficient as possible and can be used for production testing and deployments. | ||
|
|
||
| Examples in the application layer should invoke the library layer functions/APIs and shouldn't directly invoke target layer functionalities unless that is the only way to achieve the desired functionality. |
There was a problem hiding this comment.
Suggested change
| Examples in the application layer should invoke the library layer functions/APIs and shouldn't directly invoke target layer functionalities unless that is the only way to achieve the desired functionality. | |
| Examples in the application layer should invoke the library layer functions/APIs and should not directly invoke target layer functionalities unless that is the only way to achieve the desired functionality. |
|
Thanks @nejraselimovic for the helpful feedback, can you please have another final review, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added SW architecture diagram, with explanations and design considerations.
Screenshots
Changes
Notes for Reviewers
...
Checklist
make server, posted screenshots, verified external links.new-in-versionshortcode, according to the guidelines in CONTRIBUTING.