forked from analogdevicesinc/libiio
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix analogdevicesinc#59 - add a readme to the examples directory
Signed-off-by: Robin Getz <[email protected]>
- Loading branch information
Showing
1 changed file
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# libiio Examples | ||
|
||
The libiio is a cross platform library for interfacing with Linux IIO devices. | ||
|
||
These are some primitive examples of using the libiio library. | ||
These are not compiled or tested during a nominal library cmake/make process and must be compiled separately. | ||
A linux Makefile is included. | ||
While the libiio library is tested on many operating systems, these examples are only tested on Linux. | ||
|
||
More examples using all languages supported by libiio are encouraged to be added here. | ||
When adding a new example, please update this list. | ||
|
||
## ad9361-iiostream | ||
* Language : C | ||
|
||
This example libiio program is meant to exercise the features of IIO functionality on the AD9361 found on the AD-FMCOMMS2-EBZ, AD-FMCOMMS3-EBZ, and the ADRV9361-Z7035 RF SOM. | ||
It takes the uri as the only argument. for example : `./ad9361-iiostream usb:3.32.5` | ||
|
||
## ad9371-iiostream | ||
* Language : C | ||
|
||
This example libiio program is meant to exercise the features of IIO functionality on the AD9371. | ||
It takes the uri as the only argument. for example : `./ad9371-iiostream ip:192.168.2.1` | ||
|
||
## adrv9009-iiostream | ||
* Language : C | ||
|
||
This example libiio program is meant to exercise the features of IIO functionality on the ADRV9009. | ||
It takes the uri as the only argument. for example : `./adrv9009-iiostream ip:192.168.2.1` | ||
|
||
## dummy-iiostream | ||
* Language : C | ||
|
||
This example libiio program is meant to exercise the features of IIO present in the sample dummy IIO device in the linux kernel. | ||
For buffered access it relies on the hrtimer trigger but could be modified to use the sysfs trigger. | ||
No hardware should be required to run this program. | ||
|
||
## iio-monitor | ||
* Language : C | ||
* Requirements : Curses Development Kit (libcdk5-dev); pthreads; ncurses; libiio | ||
|
||
A Curses based application which implements real time monitoring of IIO non-buffer samples. |