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

sensors: add readme with examples #237

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

niewim19
Copy link
Contributor

@niewim19 niewim19 commented Jun 9, 2022

JIRA: PP-36

Description

Added short readme of sensor manager. Readme based on sensor manager PR description as it was very informative.

Motivation and Context

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

How Has This Been Tested?

  • Already covered by automatic testing.
  • New test added: (add PR link here).
  • Tested by hand on: (list targets here).

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing linter checks and tests passed.
  • My changes generate no new compilation warnings for any of the targets.

Special treatment

  • This PR needs additional PRs to work (list the PRs, preferably in merge-order).
  • I will merge this PR by myself when appropriate.

@niewim19 niewim19 requested review from HBuczynski and damianloew June 9, 2022 11:57
Assumptions:
- the client communicates with manager via messages to **/dev/sensors**,
- there is an external library **libsensors** containing sensor structures and message events - external API for the client
- sensors server takes sensors description as arguments list: <sensor_name:bus:others>; arguments might be specific for the sensor driver,
Copy link
Contributor

Choose a reason for hiding this comment

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

A bus icon has been appeared here ;d
Please escape it.
Screenshot from 2022-06-09 14-03-50

@agkaminski
Copy link
Member

Maybe we should dedicate some place in phoenix-rtos-doc for devices documentation before matter gets out of hand? I've heard we want all documentation separated from the code

@niewim19
Copy link
Contributor Author

niewim19 commented Jun 9, 2022

Maybe we should dedicate some place in phoenix-rtos-doc for devices documentation before matter gets out of hand? I've heard we want all documentation separated from the code

Yea, thats right. Should be in phoenix-rtos-doc I will leave it here without merging and proceed after consultations on that matter soon.

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.

3 participants