Skip to content

Commit 452a45d

Browse files
jvelasc2jvelasc2
committed
projects: CN0561: Added readme doc
Signed-off-by: Joyce Velasco <[email protected]>
1 parent 78703a5 commit 452a45d

File tree

2 files changed

+263
-0
lines changed

2 files changed

+263
-0
lines changed

‎doc/sphinx/source/projects/eval/cn0561.rst‎

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

‎projects/cn0561/README.rst‎

Lines changed: 262 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,262 @@
1+
CN0561 no-OS Example Project
2+
============================
3+
4+
.. contents::
5+
:depth: 3
6+
7+
Supported Evaluation Boards
8+
---------------------------
9+
10+
- :adi:`EVAL-CN0561-ARDZ`
11+
12+
Overview
13+
--------
14+
15+
The EVAL-CN0561-ARDZ is a data acquisition system tailored for vibration
16+
analysis, primarily utilizing IEPE sensors. Designed to evaluate and
17+
forecast mechanical health, it employs a precise 24-bit AD4134 ADC
18+
capable of continuous-time sampling at 1.496 MSPS. Supplementing this is
19+
the LTC6373, a differential output instrumentation amplifier, and the
20+
LT3092, a programmable two-terminal current source, enhancing data
21+
processing efficiency. Its compatibility with Arduino systems
22+
facilitates integration with diverse platforms, offering robust fault
23+
detection for increased system reliability.
24+
25+
Applications
26+
------------
27+
28+
- Data Acquisition for IEPE Sensors
29+
- Temperature Monitoring
30+
- Strain Measurement
31+
- Shock Detection
32+
- Displacement Sensing
33+
- Condition-Based Monitoring
34+
35+
Hardware Specifications
36+
-----------------------
37+
38+
Power Supply Requirements
39+
~~~~~~~~~~~~~~~~~~~~~~~~~
40+
41+
The EVAL-CN0561-ARDZ requires a DC power supply input ranging from 9V to
42+
12V. The board is designed to draw power from a microcontroller or
43+
development board via Arduino-style or FMCZ-type connectors. It handles
44+
an initial inrush current of up to 200mA for power-up, while steady
45+
state operation needs around 250mA. The power system within the board
46+
generates necessary operational voltages: 5V and 1.8V for the AD4134
47+
ADC, and ±15V for the instrumentation amplifier and current source
48+
circuits. The LT3092 component provides a constant current of 2.5mA to
49+
IEPE sensors. To accommodate potential power fluctuations, a power
50+
source capable of delivering 1.5A consistently is recommended.
51+
52+
Connectors
53+
~~~~~~~~~~~
54+
55+
+-----------------------+-----------------------+-----------------------+
56+
| Connector | Type | Description |
57+
+-----------------------+-----------------------+-----------------------+
58+
| P1, P2, P3, P4, P5 | Arduino Connectors | General data |
59+
| | | interfacing with the |
60+
| | | evaluation board |
61+
+-----------------------+-----------------------+-----------------------+
62+
| P17 | Arduino Zio Connector | Supports additional |
63+
| | | Arduino expansions |
64+
+-----------------------+-----------------------+-----------------------+
65+
| P3 | FMCZ Connector | Used for high-speed |
66+
| | | data acquisition |
67+
+-----------------------+-----------------------+-----------------------+
68+
| P6, P7, J6, J8 | SMA Connectors | Interface for IEPE |
69+
| | | sensor connections |
70+
| | | and analog signals |
71+
+-----------------------+-----------------------+-----------------------+
72+
| P8 | Analog Input | Primary input for |
73+
| | | data acquisition |
74+
| | | processes |
75+
+-----------------------+-----------------------+-----------------------+
76+
| P9 | External Power Input | Supports 9V to 12V DC |
77+
| | | power for board |
78+
| | | operation |
79+
+-----------------------+-----------------------+-----------------------+
80+
| P14 | External Supply | Provides ±15V for |
81+
| | | analog front-end |
82+
| | | capabilities |
83+
+-----------------------+-----------------------+-----------------------+
84+
| J5, J7 | Additional SMA | Amenities for further |
85+
| | Connectors | analog channels |
86+
+-----------------------+-----------------------+-----------------------+
87+
| P11, P12 | Optional Connectors | To accommodate extra |
88+
| | | analog inputs as |
89+
| | | required |
90+
+-----------------------+-----------------------+-----------------------+
91+
92+
No-OS Build Setup
93+
-----------------
94+
95+
Please see: `https://wiki.analog.com/resources/no-os/build`
96+
97+
No-OS Supported Examples
98+
-------------------------
99+
100+
The initialization data used in the examples is taken out from the
101+
`Project Source Data Path <https://github.com/analogdevicesinc/no-OS/tree/main/projects/cn0561/src>`__.
102+
103+
UART example
104+
~~~~~~~~~~~~
105+
106+
In the CN0561 no-OS project, the UART example code establishes
107+
communication by configuring the UART interface with key parameters such
108+
as ``UART_DEVICE_ID``, ``UART_IRQ_ID``, and ``UART_BAUDRATE``. This
109+
setup allows communication at a baud rate of 115200. The UART
110+
configuration is conditionally included when IIO_SUPPORT is enabled,
111+
integrating the UART for data exchange within the IIO application. This
112+
interface supports interaction with the AD713x ADC device, facilitating
113+
data acquisition and communication with external applications necessary
114+
for industrial diagnostics.
115+
116+
In order to build the uart example, make sure you have the following
117+
configuration in the build.json file:
118+
119+
.. code-block:: bash
120+
121+
#Use this if you are using a Zedboard as carrier
122+
NEW_CFLAGS=-DCN0561_ZED_CARRIER
123+
124+
#Use this if you are using Cora Z7S as carrier
125+
NEW_CFLAGS=-DCN0561_CORAZ7S_CARRIER
126+
127+
IIO example
128+
~~~~~~~~~~~
129+
130+
The IIO demo is a standard example, provided in most `no-OS
131+
projects <https://github.com/analogdevicesinc/no-OS/tree/main/projects>`__,
132+
that launches an IIOD server on the board so that the user may connect
133+
to it via an IIO client. Using the IIO Oscilloscope application, users
134+
can configure the ADC for data acquisition, using DMA to transfer ADC
135+
data to memory and converting raw data into voltage readings accessible
136+
via the IIO interface.
137+
138+
If you are not familiar with ADI IIO Application, please take a look at:
139+
`IIO No-OS <https://wiki.analog.com/resources/tools-software/no-os-software/iio>`__
140+
141+
If you are not familiar with ADI IIO Oscilloscope Client, please take a
142+
look at:
143+
`IIO Oscilloscope <https://wiki.analog.com/resources/tools-software/linux-software/iio_oscilloscope>`__.
144+
145+
To build the IIOD demo, add the following flags when invoking make. This
146+
will build the IIOD server and the IIO section of the driver:
147+
148+
.. code-block:: bash
149+
150+
#Use this if you are using a Zedboard as carrier
151+
IIOD=y NEW_CFLAGS=-DCN0561_ZED_CARRIER
152+
153+
#Use this if you are using Cora Z7S as carrier
154+
IIOD=y NEW_CFLAGS=-DCN0561_CORAZ7S_CARRIER
155+
156+
No-OS Supported Platforms
157+
-------------------------
158+
159+
Xilinx
160+
~~~~~~~
161+
162+
Hardware Used
163+
^^^^^^^^^^^^^
164+
165+
- EVAL-CN0561-ARDZ
166+
- Cora Z7-07S Zynq-7000 or ZedBoard
167+
168+
Connections
169+
^^^^^^^^^^^
170+
171+
+-----------------+-----------------+-----------------+-----------------+
172+
| **Carrier | **Connection | **CN0561 | **Function** |
173+
| Board** | Point** | Interface** | |
174+
+-----------------+-----------------+-----------------+-----------------+
175+
| ZedBoard | FMC Connector | FMC Interface | Connect CN0561 |
176+
| | (P3) | | to ZedBoard via |
177+
| | | | FMC for data |
178+
| | | | and power |
179+
+-----------------+-----------------+-----------------+-----------------+
180+
| Power Supply | CN0561 Board | 9V to 12V | |
181+
| Input | | input, | |
182+
| | | typically | |
183+
| | | supplied by | |
184+
| | | ZedBoard | |
185+
+-----------------+-----------------+-----------------+-----------------+
186+
| Gigabit | Host PC | Connect | |
187+
| Ethernet Port | | Ethernet cable | |
188+
| | | for network | |
189+
| | | communication | |
190+
+-----------------+-----------------+-----------------+-----------------+
191+
| SMA Connectors | IEPE Sensor | Connect IEPE | |
192+
| | Inputs | sensors to | |
193+
| | | CN0561 SMA | |
194+
| | | connectors | |
195+
+-----------------+-----------------+-----------------+-----------------+
196+
197+
+-----------------+-----------------+-----------------+-----------------+
198+
| **Carrier | **Connection | **CN0561 | **Function** |
199+
| Board** | Point** | Interface** | |
200+
+-----------------+-----------------+-----------------+-----------------+
201+
| Cora Z7S | Arduino/chipKIT | Arduino | Plug CN0561 |
202+
| | Shield Header | Compatible | directly onto |
203+
| | | Header | Cora Z7S shield |
204+
| | | | connector |
205+
+-----------------+-----------------+-----------------+-----------------+
206+
| Analog Inputs | XADC Inputs | Routed from | |
207+
| A0 to A11 | (FPGA) | CN0561 analog | |
208+
| | | channels; | |
209+
| | | follow Arduino | |
210+
| | | convention | |
211+
+-----------------+-----------------+-----------------+-----------------+
212+
| I/O Voltage | CN0561 Shield | Max 3.4V | |
213+
| Limit | | (absolute max | |
214+
| | | 3.75V); CN0561 | |
215+
| | | must not exceed | |
216+
| | | this | |
217+
+-----------------+-----------------+-----------------+-----------------+
218+
| Analog Input | CN0561 Shield | Differential: | |
219+
| Range | | 0V to 1V; | |
220+
| | | Single-ended: | |
221+
| | | scaled to | |
222+
| | | 0V to 3.3V via | |
223+
| | | resistor | |
224+
| | | divider | |
225+
+-----------------+-----------------+-----------------+-----------------+
226+
| Power Input | Main Power | Do not power | |
227+
| | Connector | through CN0561 | |
228+
| | | shield; use | |
229+
| | | Cora Z7S main | |
230+
| | | input only | |
231+
+-----------------+-----------------+-----------------+-----------------+
232+
233+
Build Command
234+
^^^^^^^^^^^^^
235+
236+
ZedBoard:
237+
238+
.. code-block:: bash
239+
240+
cp <SOME_PATH>/system_top.xsa .
241+
# to delete current build
242+
make reset
243+
# to build the project
244+
make PLATFORM=xilinx
245+
246+
make TARGET=cn0561_zed IIOD=y NEW_CFLAGS=-DCN0561_ZED_CARRIER
247+
# to flash the code
248+
make run
249+
250+
Cora Z7S:
251+
252+
.. code-block:: bash
253+
254+
cp <SOME_PATH>/system_top.xsa .
255+
# to delete current build
256+
make reset
257+
# to build the project
258+
make PLATFORM=xilinx
259+
260+
make TARGET=cn0561_coraz7sIIOD=y NEW_CFLAGS=-DCN0561_CORAZ7S_CARRIER
261+
# to flash the code
262+
make run

0 commit comments

Comments
 (0)