Repository navigation
docs: populate installation, boards, contributing, env-setup, run-tests - #31
Conversation
2a414fb to
a9fd00c
Compare
a9fd00c to
a62f552
Compare
AkshayChandra-IFX
left a comment
AkshayChandra-IFX
left a comment
There was a problem hiding this comment.
Looks good, just some minor points to take care!
|
|
||
| .. image:: img/KIT_PSE84_AI_Pinout.svg | ||
| :width: 400 | ||
|
|
There was a problem hiding this comment.
The back-side pinout diagram (including Arduino pin numbers) is missing. Since the analog pins are located on the back, we can add this as a part of TODO once we have the respective image to attach. This would help avoid user confusion and make analog pin mapping easier to find.
There was a problem hiding this comment.
Right. This is also something we miss for the micropython docs.
Anyhow, that was not prioritized as that interface can only effectively used in you have soldered the connector (+ adapter or specific application break-out board).
So that can be done in upcoming iterations.
|
|
||
| - Expansion header pins include the macros as printed on the board: | ||
| ``SERIAL_INTx`` where ``x`` is the index in the range [0, 3], e.g. | ||
| ``SERIAL_INT0``. |
There was a problem hiding this comment.
we also define i2C/wire, (SDA, SCL, SDA1, SCL etc.) and SPI (MISO/MOSI etc ) macros in variant.h might be worth listing them here too(under macros section), or adding a TODO to cover them later.
There was a problem hiding this comment.
Yes Currently I did not add Todo sections and ofcourse once the features are tested all those can be added accoordingly
There was a problem hiding this comment.
Fair point. we can add spi , i2c etc to the doc once tested. The analog Ax macros are in the same boat since ADC isn't supported/tested yet. Do you want to revisit the analog section later too, or keep it as is for now!
There was a problem hiding this comment.
Yes . This is a living document and we might have to do many iterations as we progress with testing
| suite is vendored as a submodule at ``tests/arduino_core_tests``. Board-specific | ||
| test pin configuration lives in a single file, ``tests/test_config.h``, with one | ||
| ``#if defined(ARDUINO_<BOARD>)`` block per board. ``arduino-cli`` already | ||
| defines ``ARDUINO_{build.board}`` for every compile, so the right block is |
There was a problem hiding this comment.
minor point, should that be ARDUINO_<build.board> ?
There was a problem hiding this comment.
platform.txt literally uses -DARDUINO_{build.board} (curly braces), which is arduino-cli's own property-substitution syntax.
a62f552 to
7727507
Compare
4c736ae to
4f497cb
Compare
4f497cb to
cdd32b4
Compare
3 participants
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.
Summary
Populates the Read the Docs scaffold (from
ifx-readthedocs-setup) with real content for the KIT-PSE84-AI board, based onpsoc-edge-main's existing install/pinout docs and thearduino-core-testsintegration work.Refer here - https://arduinocore-zephyr.readthedocs.io/en/ifx-docs-content/index.html
Pages populated
infineon:zephyr_pse84package index URL (verified againstedge-main's actualpackage/package_infineon_pse84_index.template.json).Dx/Axranges,LED_BUILTIN*,BTN_BUILTIN,SERIAL_INTx) — all cross-checked against the currentvariant.honedge-main.<scope>: <description>commit/PR title convention.tests/test_config.hboard blocks work, with the KIT-PSE84-AItest_digitalio_singleexample (D0/D1 jumper) and theENABLE_SYNCgotcha.Intentionally excluded
ifx-main/edge-main/control-main, rebase policy) — team-internal process, not relevant to external readers.~/.west/configOpenOCD path), rest better suited to an internal wiki.Arduino API Deviations— left asTODO, deferred until peripheral support is further along.Verification
sphinx-build -b html docs docs/_buildsucceeds cleanly (no warnings/errors).edge-mainsource, not just copied from the reference material.Note
run-tests.rstdocuments thetests/arduino_core_testssubmodule andtests/test_config.h, which aren't merged intoifx-mainyet (still onifx-arduino-core-tests/edge-arduino-core-tests-config). The page is accurate for once those land.