Skip to content

Commit c3abf33

Browse files
jvelasc2jvelasc2
committed
projects: AD7746-EBZ: Added readme doc
Signed-off-by: Joyce Velasco <Joyce.Velasco@analog.com>
1 parent de8f3e9 commit c3abf33

File tree

3 files changed

+202
-1
lines changed

3 files changed

+202
-1
lines changed

‎doc/sphinx/source/projects/cdc/ad7746-ebz.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../../projects/ad7746-ebz/README.rst

‎doc/sphinx/source/projects_doc.rst‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,12 @@ GYROSCOPES
9898
:maxdepth: 1
9999
:glob:
100100

101-
projects/gyroscope/*
101+
projects/gyroscope/*
102+
103+
CAPACITANCE-TO-DIGITAL CONVERTER
104+
=================================
105+
.. toctree::
106+
:maxdepth: 1
107+
:glob:
108+
109+
projects/cdc/*

‎projects/ad7746-ebz/README.rst‎

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
AD7746-EBZ no-OS Example Project
2+
================================
3+
4+
.. contents::
5+
:depth: 3
6+
7+
Supported Evaluation Boards
8+
---------------------------
9+
10+
- :adi:`EVAL-AD7746EBZ`
11+
12+
Overview
13+
--------
14+
15+
The EVAL-AD7746EBZ is an evaluation board specifically designed to
16+
facilitate the testing and development of applications using the AD7746
17+
capacitance-to-digital converter. It features dedicated connectors for
18+
all capacitive input and excitation signals, flexible configuration
19+
options for interfacing via I²C, and supports both single-ended and
20+
differential capacitance measurements.
21+
22+
Applications
23+
------------
24+
25+
- Pressure measurement
26+
- Position sensing
27+
- Level sensing
28+
- Flowmeters
29+
- Humidity sensing
30+
- Impurity detection
31+
32+
Hardware Specifications
33+
-----------------------
34+
35+
Power Supply Requirements
36+
~~~~~~~~~~~~~~~~~~~~~~~~~
37+
38+
The EVAL-AD7746EBZ evaluation board primarily operates on a 5V power
39+
supply through a USB connector (J1), utilizing an on-board 3.3V
40+
regulator (ADP3303) to deliver the regulated voltage needed for optimal
41+
performance. Additionally, the board supports alternative power supply
42+
options of either 3V or 5V via an external input (J2), providing
43+
flexibility for various configurations. A power indicator LED (D1) is
44+
included to signal the presence of power when connected via USB,
45+
streamlining setup by combining power supply with data communication
46+
through the same USB interface, allowing efficient integration with
47+
PC-based applications such as the AD7746 Evaluation Software
48+
without needing an additional power source.
49+
50+
On-board Connectors
51+
~~~~~~~~~~~~~~~~~~~
52+
53+
+-----------------------------------+-----------------------------------+
54+
| Connector Type | Description |
55+
+-----------------------------------+-----------------------------------+
56+
| USB connector | Provides 5V power supply and |
57+
| | data communication interface via |
58+
| | J1. |
59+
+-----------------------------------+-----------------------------------+
60+
| External Power Input | Alternative power supply option |
61+
| | of 3V or 5V via connector J2. |
62+
+-----------------------------------+-----------------------------------+
63+
| SMB connectors (CIN1+, CIN1−, | Used for direct interfacing with |
64+
| EXCA, EXCB) | capacitive inputs and excitation |
65+
| | outputs, supporting capacitive |
66+
| | measurement. |
67+
+-----------------------------------+-----------------------------------+
68+
69+
No-OS Build Setup
70+
-----------------
71+
72+
Please see: `https://wiki.analog.com/resources/no-os/build`
73+
74+
No-OS Supported Examples
75+
------------------------
76+
77+
The initialization data used in the example is taken out from the
78+
`Project Data Source Path <https://github.com/analogdevicesinc/no-OS/tree/main/projects/ad7746-ebz/src/app>`__
79+
80+
IIO example
81+
~~~~~~~~~~~
82+
83+
The IIO example code within the EVAL-AD7746EBZ project initializes an
84+
IIOD server on the AD7746 evaluation board, enabling it to connect with
85+
IIO clients. The setup is implemented through the IIO application, which
86+
initiates the AD7746 sensor for capacitive and temperature measurements.
87+
This configuration includes enabling capacitance channels and setting
88+
temperature read modes. Users can connect using an IIO client like the
89+
IIO Oscilloscope to manage device settings, such as offset, sampling
90+
frequency, and transform raw ADC data into voltage values. Communication
91+
is handled via a UART interface, ensuring continuous data interaction
92+
and flexible ADC usage.
93+
94+
If you are not familiar with ADI IIO Application, please take a look at:
95+
`IIO No-OS <https://wiki.analog.com/resources/tools-software/no-os-software/iio>`__
96+
97+
If you are not familiar with ADI IIO Oscilloscope Client, please take a
98+
look at:
99+
`IIO Oscilloscope <https://wiki.analog.com/resources/tools-software/linux-software/iio_oscilloscope>`__
100+
101+
To build the IIOD demo, add the following flag when invoking make. This
102+
will build the IIOD server and the IIO section of the driver:
103+
104+
.. code-block:: bash
105+
106+
IIOD = y
107+
108+
No-OS Supported Platforms
109+
-------------------------
110+
111+
ADuCM3029 Platform
112+
~~~~~~~~~~~~~~~~~~
113+
114+
Hardware Used
115+
^^^^^^^^^^^^^
116+
117+
- :adi:`EVAL-AD7746EBZ`
118+
- :adi:`EVAL-ADICUP3029` (ADUCM3029 Evaluation Board)
119+
120+
Connections
121+
^^^^^^^^^^^
122+
123+
Pin-level Mapping
124+
125+
+-----------------------+-----------------------+-----------------------+
126+
| EVAL-AD7746EBZ LK2 | EVAL-ADICUP3029 Pin | Function |
127+
| Pin | | |
128+
+-----------------------+-----------------------+-----------------------+
129+
| VDD (3.3V) | 3.3V Output (or input | Power supply |
130+
| | if powered | |
131+
| | externally) | |
132+
+-----------------------+-----------------------+-----------------------+
133+
| GND | GND | Ground |
134+
+-----------------------+-----------------------+-----------------------+
135+
| SDA | I²C SDA (e.g., P0.14) | I²C data line |
136+
+-----------------------+-----------------------+-----------------------+
137+
| SCL | I²C SCL (e.g., P0.15) | I²C clock line |
138+
+-----------------------+-----------------------+-----------------------+
139+
| ADDR (optional) | GND or VDD | Sets I²C address |
140+
| | | (0x48 or 0x49) |
141+
+-----------------------+-----------------------+-----------------------+
142+
| CAP/DIG pins | — | For sensing, leave |
143+
| | | connected as designed |
144+
+-----------------------+-----------------------+-----------------------+
145+
146+
Board-level Mapping
147+
148+
+-----------------------+-----------------------+-----------------------+
149+
| | **Connection Point** | **Function** |
150+
+-----------------------+-----------------------+-----------------------+
151+
| EVAL-AD7746EBZ | LK2 (SDA, SCL, RDY) | Remove links to |
152+
| | | disconnect USB |
153+
| | | microcontroller from |
154+
| | | I²C bus |
155+
+-----------------------+-----------------------+-----------------------+
156+
| | USB Connector | Optional power source |
157+
+-----------------------+-----------------------+-----------------------+
158+
159+
+-----------------------+-----------------------+-----------------------+
160+
| | **Connection Point** | **Function** |
161+
+-----------------------+-----------------------+-----------------------+
162+
| EVAL-ADICUP3029 | 3.3V Rail | Can power the |
163+
| | | EVAL-AD7746EBZ |
164+
+-----------------------+-----------------------+-----------------------+
165+
| | Header J2 | Alternative power |
166+
| | | source |
167+
+-----------------------+-----------------------+-----------------------+
168+
169+
**Additional Notes**
170+
171+
- The I2C lines (SDA, SCL) should have pull-up resistors (typically
172+
4.7 kΩ or 10 kΩ) to the EVAL-AD7746EBZ supply voltage if not already
173+
present on the board.
174+
175+
- Confirm voltage compatibility between the I/O voltage levels of the
176+
ADuCM3029 and the EVAL-AD7746EBZ.
177+
178+
Build Command
179+
^^^^^^^^^^^^^
180+
181+
.. code-block:: bash
182+
183+
cd no-OS/projects/ad7746-ebz
184+
185+
# to delete current build
186+
make clean
187+
# to build the project
188+
make
189+
# to set hardware target
190+
make PLATFORM=aducm3029
191+
# to flash the code
192+
make run

0 commit comments

Comments
 (0)