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

I2C Address Cleanup and Documentation #13831

Merged
merged 8 commits into from
Apr 17, 2020
Merged

I2C Address Cleanup and Documentation #13831

merged 8 commits into from
Apr 17, 2020

Conversation

akshaim
Copy link
Member

@akshaim akshaim commented Apr 7, 2020 •
edited by leandrolanzieri

Contribution description

Make changes to expose I2C Address configurable and remove #ifndef wherever unnecessary

  1. drivers/include/bmx055.h -> define #ifndef (Refer Section 11.2 inDatasheet )
  2. drivers/include/ds1307.h -> Remove ifndef for I2C as address remains constant ( Refer Page 12 of 14 in Datasheet )
  3. drivers/include/hts221.h -> Remove ifndef for I2C as address remains constant ( Refer Section 5.1.1 I2C Operation in Datasheet )
  4. drivers/include/isl29020.h -> Add ifndef for I2C Addressing ( Refer Section I2C interface in Page 3 of 11 in Datasheet )
  5. drivers/include/l3g4200d.h -> Add ifndef for I2C Addressing ( Refer Section 5.1.1 I2C Operation in Datasheet )
  6. drivers/include/lpsxxx.h -> Add ifndef for I2C Addressing ( Refer 5.2.1 I2C operation in Datasheet )
  7. drivers/include/mma8x5x.h : Remove ifndef for I2C as address remains constant ( Refer Table 11 in Datasheet) Refer drivers: Add compile configurations groups and add parameters #13784
  8. drivers/include/mpl3115a2.h : Remove ifndef for I2C as address remains constant ( Refer Row I2C Address in Table 6 in Datasheet )
  9. drivers/include/tcs37727.h : Remove ifndef for I2C as address remains constant ( Refer Figure 54 in Datasheet )

Expose Compile Parameters to Doxygen

  1. drivers/include/bmx055.h - > Add to sensors group
  2. drivers/include/isl29020.h -> Add to sensors group
  3. drivers/include/l3g4200d.h -> Add to sensors group
  4. drivers/include/lpsxxx.h -> Add to sensors group
  5. drivers/include/mma8x5x.h -> Add brief Refer drivers: Add compile configurations groups and add parameters #13784
  6. drivers/include/tcs37727.h -> Add brief

Testing procedure

Doxygen Build works fine.

Issues/PRs references

Depends on #13784
Part of #10566

@akshaim akshaim changed the title I2 c address cleanup I2C Address Cleanup and Documentation Apr 7, 2020
@leandrolanzieri leandrolanzieri self-assigned this Apr 7, 2020
@leandrolanzieri leandrolanzieri added Area: doc Area: Documentation Area: drivers Area: Device drivers Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation labels Apr 7, 2020
@leandrolanzieri leandrolanzieri self-requested a review April 7, 2020 18:37
@leandrolanzieri leandrolanzieri added the State: waiting for other PR State: The PR requires another PR to be merged first label Apr 12, 2020
leandrolanzieri
leandrolanzieri requested changes Apr 12, 2020
View reviewed changes
drivers/include/bmx055.h Show resolved Hide resolved
drivers/include/isl29020.h Show resolved Hide resolved
drivers/include/isl29020.h Show resolved Hide resolved
drivers/include/l3g4200d.h Show resolved Hide resolved
drivers/include/lpsxxx.h Outdated Show resolved Hide resolved
drivers/include/mma8x5x.h Outdated Show resolved Hide resolved
@akshaim akshaim mentioned this pull request Apr 14, 2020
Merged
@leandrolanzieri leandrolanzieri removed the State: waiting for other PR State: The PR requires another PR to be merged first label Apr 14, 2020
@leandrolanzieri leandrolanzieri added this to the Release 2020.07 milestone Apr 14, 2020
@leandrolanzieri leandrolanzieri added the Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer label Apr 14, 2020
@leandrolanzieri
Copy link
Contributor

@akshaim please squash now as mentioned

@leandrolanzieri leandrolanzieri added Reviewed: 1-fundamentals The fundamentals of the PR were reviewed according to the maintainer guidelines Reviewed: 5-documentation The documentation details of the PR were reviewed according to the maintainer guidelines labels Apr 17, 2020
@akshaim
Copy link
Member Author

akshaim commented Apr 17, 2020

@akshaim please squash now as mentioned

Done.

@leandrolanzieri
Copy link
Contributor

Please check that there are still some commits that should get merged together:

akshaim and others added 3 commits April 17, 2020 15:45
@akshaim @leandrolanzieri
drivers/include/lpsxxx.h : Expose Parameters
c6f55b6 
Add ifndef and Expose Compile Parameters to Doxyen

Co-Authored-By: Leandro Lanzieri <leandro.lanzieri@haw-hamburg.de>
@akshaim
drivers/include/mpl3115a2.h : Remove ifndef for I2C
de5db5c
@akshaim
drivers/include/tcs37727.h : Remove ifndef for I2C
b75fc0c 
Remove ifndef and better formatting for Doxygen
@akshaim
Copy link
Member Author

akshaim commented Apr 17, 2020

Please check that there are still some commits that should get merged together:

* [8e1c2c6](https://github.com/RIOT-OS/RIOT/commit/8e1c2c67acb4b5f538acfb386753b66d3cb49438) and [f53bd5b](https://github.com/RIOT-OS/RIOT/commit/f53bd5b2c5854f41f0ab3e015651e687b010e6a0)

* [bb8ba02](https://github.com/RIOT-OS/RIOT/commit/bb8ba02b76523285aacbf755b7e81921f42bcf7f) and [4d9a236](https://github.com/RIOT-OS/RIOT/commit/4d9a23686a2e030d5e9813c55aa2e40cb3b96045)

Thank you pointing that out. Maybe I should use fixxups more often :)

@leandrolanzieri leandrolanzieri added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Reviewed: 3-testing The PR was tested according to the maintainer guidelines labels Apr 17, 2020
leandrolanzieri
leandrolanzieri approved these changes Apr 17, 2020
View reviewed changes
Copy link
Contributor

@leandrolanzieri leandrolanzieri left a comment

Choose a reason for hiding this comment

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

Changes look good. ACK.
Thanks for the contribution!

@leandrolanzieri leandrolanzieri merged commit 369eda6 into RIOT-OS:master Apr 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leandrolanzieri leandrolanzieri leandrolanzieri approved these changes

Assignees

@leandrolanzieri leandrolanzieri

Labels
Area: doc Area: Documentation Area: drivers Area: Device drivers CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Reviewed: 1-fundamentals The fundamentals of the PR were reviewed according to the maintainer guidelines Reviewed: 3-testing The PR was tested according to the maintainer guidelines Reviewed: 5-documentation The documentation details of the PR were reviewed according to the maintainer guidelines Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation
Projects
None yet
Milestone
Release 2020.07
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@akshaim @leandrolanzieri