projects:ad7191_iio:Added the AD7191 Documentation #100
Conversation
Kantipudi-Supriya
commented
Oct 1, 2024
Kantipudi-Supriya
commented
- Added the AD7191 Documentation
|
|
| This page gives an overview of using the ARM platforms supported | ||
| firmware example with Analog Devices AD7191 Evaluation board and SDP-K1 controller board. | ||
| This example code leverages the ADI developed IIO (Industrial Input Output) ecosystem to | ||
| evaluate the AD7191 device by providing a device debug and data capture support. |
There was a problem hiding this comment.
nit: Can continue the default statement here: The code provides support for STM32 platform using the SDP-K1 controller board.
|
|
||
| This code has been developed and tested on the SDP-K1 Controller Board with | ||
| Arduino headers. However, the same code can be used with minimal modifications | ||
| on any STM32 enabled board which has Arduino Header support on it. |
There was a problem hiding this comment.
nit: We probably need to rephrase this or remove this altogether. STM32 enabled boards doesn't make sense!
There was a problem hiding this comment.
Doesn't this still hold valid @SaikiranGudla ?
There was a problem hiding this comment.
It still holds valid, but Mbed enabled boards emphasizes the mbed-os uniform apis, ecosystem of boards and easy portability however, the code changes in case of STM32 will not be as minimal as mbed.
There was a problem hiding this comment.
We have to remove enabled word for sure, though!
There was a problem hiding this comment.
Can we say on any STM32 target instead
doc/sphinx/source/useful_links.rst
Outdated
| @@ -8,7 +8,7 @@ Useful Links | |||
|
|
|||
| * `Keil Studio Web IDE/Compiler <https://studio.keil.arm.com/auth/login/>`_ | |||
There was a problem hiding this comment.
We cannot remove the mbed references in this file. We instead need to create another file for STM32 imo
|
|
||
| * Stack the EVAL-AD7191-ASDZ on the Arduino connectors of the SDP-K1 board. | ||
| * Connect a male-to-male jumper wire between D3 and D12 on Arduino connectors. | ||
| * Set the LK7 and LK8 jumper headers to 3.3V. |
There was a problem hiding this comment.
Why is the jumper setting needed in AD7191?
| **EVAL-AD7191:** | ||
|
|
||
| * Stack the EVAL-AD7191-ASDZ on the Arduino connectors of the SDP-K1 board. | ||
| * Connect a male-to-male jumper wire between D3 and D12 on Arduino connectors. |
There was a problem hiding this comment.
Can it be mnetioned that this is needed for data capture
|
@Kantipudi-Supriya the commit message needs to be updated to the format we follow. You can have 2 separate commits - 1 commit for AD7191 and the other commit for stm32 restructure. In my opinion it is better if both these were not mixed. |
doc/sphinx/source/projects/index.rst
Outdated
| @@ -24,6 +24,7 @@ Firmware Applications | |||
| /source/projects/ad717x_console/ad717x_console.rst | |||
| /source/projects/ad717x_iio/ad717x_iio.rst | |||
| /source/projects/ad719x_iio/ad719x_iio.rst | |||
| /source/projects/ad7191_iio/ad7191_iio.rst | |||
There was a problem hiding this comment.
Shall this be removed if we're not adding the project doco for now?
|
Can we squash the commits to a single commit with relevant commit message @Kantipudi-Supriya ? |
|
@Kantipudi-Supriya the cla-license needs to be signed. |
restructuring 1)Added the project_build_stm32.rst file and useful_links_stm32.rst Signed-off-by: Kantipudi-Supriya <[email protected]>
Kantipudi-Supriya
force-pushed
the
ad7191
branch
from
3c04e39 to
24e48bb
Compare
