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

docs/psoc6: Adding hardware documentation. #121

Merged
merged 8 commits into from
Mar 26, 2024

Conversation

NikhitaR-IFX
Copy link
Member

@NikhitaR-IFX NikhitaR-IFX commented Feb 15, 2024

By creating this pull request you agree to the terms in CONTRIBUTING.md.
https://github.com/Infineon/.github/blob/master/CONTRIBUTING.md
--- DO NOT DELETE ANYTHING ABOVE THIS LINE ---

CONTRIBUTING.md also tells you what to expect in the PR process.

Description

Extended documentation support with:

  1. Added pinout diagrams for both boards.
  2. Sections per board with resource links
  3. Board overview and distinguishing feature

Find the documentation link for review here

*Note: We still have to add the final versions of the pinout after:

  1. Right versioning is added
  2. BLE pinout is verified

Please use this PR to review the content and overall alignment of sections etc.

@ederjc
Copy link
Member

ederjc commented Feb 16, 2024

Can we put the board overview like this?

Board Name GPIOs Connectivity Special Features
CY8CPROTO-062-4343W 58 WiFi, BT microSD card slot, external flash memory, thermistor, user button
CY8CPROTO-063-BLE 32 BLE user button, compact form-factor

I would also not put the features in the table which we currently not support in our port.

I think the pinout diagrams are still too small. Maybe I can find a solution to make them more narrow.

@NikhitaR-IFX
Copy link
Member Author

Can we put the board overview like this?

Board Name GPIOs Connectivity Special Features
CY8CPROTO-062-4343W 58 WiFi, BT microSD card slot, external flash memory, thermistor, user button
CY8CPROTO-063-BLE 32 BLE user button, compact form-factor
I would also not put the features in the table which we currently not support in our port.

I think the pinout diagrams are still too small. Maybe I can find a solution to make them more narrow.

Thanks for the review. I can sure make these changes. I agree for connectivity column. I feel why GPIO's are special here? Then why not add serial communication interfaces?

@ederjc ederjc marked this pull request as draft February 16, 2024 10:19
@jaenrig-ifx jaenrig-ifx force-pushed the ports-psoc6-main branch 5 times, most recently from d07543a to c3a8a27 Compare February 23, 2024 00:02
@jaenrig-ifx jaenrig-ifx force-pushed the ports-psoc6-main branch 5 times, most recently from 587f1ec to 255ba96 Compare March 2, 2024 00:02
@jaenrig-ifx jaenrig-ifx force-pushed the ports-psoc6-main branch 2 times, most recently from 2990f8a to 8bb0fbd Compare March 11, 2024 08:15
@jaenrig-ifx jaenrig-ifx force-pushed the ports-psoc6-main branch 6 times, most recently from c54d263 to 8b4ab50 Compare March 21, 2024 00:02
@jaenrig-ifx jaenrig-ifx force-pushed the ports-psoc6-main branch 2 times, most recently from f9a9bca to db76bcb Compare March 23, 2024 00:02
Copy link

github-actions bot commented Mar 25, 2024

Code size report:


@@ -0,0 +1,91 @@
/*
* This file is part of the MicroPython project, http://micropython.org/
Copy link
Member

Choose a reason for hiding this comment

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

This file has to be removed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

Copy link
Member

@jaenrig-ifx jaenrig-ifx left a comment

Choose a reason for hiding this comment

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

Accidentally added file to extmod.

jaenrig-ifx and others added 6 commits March 26, 2024 11:23
Signed-off-by: enriquezgarc <enriquezgarcia.external@infineon.com>
Signed-off-by: NikhitaR-IFX <Nikhita.Rajasekhar@infineon.com>
Signed-off-by: NikhitaR-IFX <Nikhita.Rajasekhar@infineon.com>
Signed-off-by: NikhitaR-IFX <Nikhita.Rajasekhar@infineon.com>
Signed-off-by: NikhitaR-IFX <Nikhita.Rajasekhar@infineon.com>
Signed-off-by: NikhitaR-IFX <Nikhita.Rajasekhar@infineon.com>
Signed-off-by: NikhitaR-IFX <Nikhita.Rajasekhar@infineon.com>
Signed-off-by: NikhitaR-IFX <Nikhita.Rajasekhar@infineon.com>
@NikhitaR-IFX NikhitaR-IFX marked this pull request as ready for review March 26, 2024 11:06
Copy link
Member

@ederjc ederjc left a comment

Choose a reason for hiding this comment

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

👍

@NikhitaR-IFX NikhitaR-IFX merged commit 8ea4f53 into ports-psoc6-main Mar 26, 2024
21 checks passed
@jaenrig-ifx jaenrig-ifx deleted the docs-hw-section branch May 17, 2024 14:45
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