feat(linux): Add initial documentation for EV Charging User Guide #618
Conversation
Add initial documentation for building EV charging WIC image on AM62L using yocto. Signed-off-by: Yogesh Hegde <[email protected]>
yogeshhegde
requested review from
StaticRocket,
VeeruPrudhvi,
cshilwant,
gehariprasath,
jeevantelukula,
praneethbajjuri and
uditkumarti
as code owners
github-actions
bot
assigned
bryanbrattlof,
gehariprasath,
praneethbajjuri,
sskartheekadivi and
uditkumarti
|
New warnings found with rstcheck: |
cshilwant
left a comment
cshilwant
left a comment
There was a problem hiding this comment.
There are few valid warnings from vale which needs to be resolved - https://github.com/TexasInstruments/processor-sdk-doc/pull/618/files
| - Used for building Yocto based filesystem | ||
| - |__SDK_BUILD_MACHINE__| | ||
| * - :file:`processor-sdk-scarthgap-evse-11.02.08.03-config.txt` | ||
| - Used for building Yocto based filesystem with AM62L-EVSE-DEV-EVM support (for EV charging Use cases) |
There was a problem hiding this comment.
| - Used for building Yocto based filesystem with AM62L-EVSE-DEV-EVM support (for EV charging Use cases) | |
| - Used for building Yocto based filesystem with `AM62L-EVSE-DEV-EVM <https://www.ti.com/tool/AM62-EVSE-DEV-PLATFORM>`_ support (for EV charging Use cases) |
|
|
||
| ############################################ | ||
| AM62L EVSE - User Guide | ||
| ############################################ |
There was a problem hiding this comment.
Over-lines and underlines shouldn't extend the last character
#
A
#
| @@ -0,0 +1,117 @@ | |||
| .. _EV_charging_Demo_User_Guide-label: | |||
There was a problem hiding this comment.
This entire newly added rst file doesn't seem to follow the guidelines for section headers recommended by the project
https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#headings--sections
| The TIDA-010939 reference design addresses this complexity by providing a comprehensive front-end controller solution that serves as the central | ||
| communication module for EV charging operations. | ||
|
|
||
| This reference design combines the AM62L processor with the MSPM0G3507 microcontroller to create a versatile platform supporting both AC and |
There was a problem hiding this comment.
add external links to ti.com product pages
| This reference design combines the AM62L processor with the MSPM0G3507 microcontroller to create a versatile platform supporting both AC and | |
| This reference design combines the `AM62L processor <https://www.ti.com/product/AM62L>`_ with the `MSPM0G3507 <https://www.ti.com/product/MSPM0G3507 | |
| >`_ microcontroller to create a versatile platform supporting both AC and |
| The TIDA-010939 reference design is referred to as **AM62L-EVSE-DEV-EVM** throughout this documentation. | ||
|
|
||
| .. note:: | ||
| For complete hardware setup, testing procedures, and system architecture details, refer to the `AM62L-EVSE-DEV-EVM Software User Guide <https://www.ti.com/lit/pdf/SLUUDH5>`_. |
There was a problem hiding this comment.
Make sure that the directive and the content block have 1 new line between them
| SDK Overview | ||
| ============ | ||
|
|
||
| The latest AM62L Processor SDK provides software support for the AM62L-EVSE-DEV-EVM, enabling all communication interfaces |
There was a problem hiding this comment.
| The latest AM62L Processor SDK provides software support for the AM62L-EVSE-DEV-EVM, enabling all communication interfaces | |
| |__SDK_FULL_NAME__| provides software support for the AM62L-EVSE-DEV-EVM, enabling all communication interfaces |
| Quick Start with Pre-built Image | ||
| ================================ | ||
|
|
||
| For quick evaluation and testing, download the latest pre-built WIC image: `tisdk-evse-image-rt-am62lxx-evm-11.02.08.02.rootfs.wic.xz <https://dr-download-draft.ext.ti.com/software-development/software-development-kit-sdk/MD-YjEeNKJJjt/11.02.08.02-REDRAFT/tisdk-evse-image-rt-am62lxx-evm-11.02.08.02.rootfs.wic.xz>`_ |
| * The command below will build the :file:`tisdk-evse-image`, which is the | ||
| Processor SDK image with arago filesystem and AM62L-EVSE-DEV-EVM support (EV charging Use case support). | ||
|
|
||
| .. tabs:: |
There was a problem hiding this comment.
The tabs directive in Sphinx is most useful when you have multiple content blocks (paragraphs, code blocks, images, etc.) within each tab. In your case, since each tab contains only a single code block, using the tabs directive adds unnecessary complexity without much benefit. Simple code blocks with clear headings would work just as well.
| The TIDA-010939 reference design is referred to as **AM62L-EVSE-DEV-EVM** throughout this documentation. | ||
|
|
||
| .. note:: | ||
| For complete hardware setup, testing procedures, and system architecture details, refer to the `AM62L-EVSE-DEV-EVM Software User Guide <https://www.ti.com/lit/pdf/SLUUDH5>`_. |
There was a problem hiding this comment.
the link appears to be currently broken. Is that expected?
There was a problem hiding this comment.
Yes, it is expected since it is under review and yet to be published.
| ############################################ | ||
| AM62L EVSE - User Guide | ||
| ############################################ | ||
|
|
There was a problem hiding this comment.
I think a section calling out Hardware Prerequisites (similar to [0]) would be helpful as there are multiple HW's involved to get the Demo running
|
Also, general comment about https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#indentation-and-whitespace |
8 participants
Add initial documentation for building EV charging WIC image on AM62L using yocto.
Preview can be found here - https://yogeshhegde.github.io/processor-sdk-doc/processor-sdk-linux-AM62LX/esd/docs/master/linux/Demo_User_Guides/EV_charging_Demo_User_Guide.html