diff --git a/doc/html/img/ADI_Logo_AWP.png b/doc/html/img/ADI_Logo_AWP.png new file mode 100644 index 000000000..231fa1087 Binary files /dev/null and b/doc/html/img/ADI_Logo_AWP.png differ diff --git a/doc/html/img/Chromium-OS-Logo.png b/doc/html/img/Chromium-OS-Logo.png new file mode 100644 index 000000000..e26ec35b8 Binary files /dev/null and b/doc/html/img/Chromium-OS-Logo.png differ diff --git a/doc/html/img/GNURadio_logo.png b/doc/html/img/GNURadio_logo.png new file mode 100644 index 000000000..e9936c07d Binary files /dev/null and b/doc/html/img/GNURadio_logo.png differ diff --git a/doc/html/img/PyADI-IIO_Logo_72.png b/doc/html/img/PyADI-IIO_Logo_72.png new file mode 100644 index 000000000..2cf275ad7 Binary files /dev/null and b/doc/html/img/PyADI-IIO_Logo_72.png differ diff --git a/doc/html/img/ez.png b/doc/html/img/ez.png new file mode 100644 index 000000000..66cc22f1c Binary files /dev/null and b/doc/html/img/ez.png differ diff --git a/doc/html/img/favicon.ico b/doc/html/img/favicon.ico new file mode 100644 index 000000000..0faa5e991 Binary files /dev/null and b/doc/html/img/favicon.ico differ diff --git a/doc/html/img/fb.png b/doc/html/img/fb.png new file mode 100644 index 000000000..d2c8b5df7 Binary files /dev/null and b/doc/html/img/fb.png differ diff --git a/doc/html/img/gp.png b/doc/html/img/gp.png new file mode 100644 index 000000000..7eced6ee0 Binary files /dev/null and b/doc/html/img/gp.png differ diff --git a/doc/html/img/ig.png b/doc/html/img/ig.png new file mode 100644 index 000000000..e443eedfe Binary files /dev/null and b/doc/html/img/ig.png differ diff --git a/doc/html/img/iio_logo.png b/doc/html/img/iio_logo.png new file mode 100644 index 000000000..2c2b91f7b Binary files /dev/null and b/doc/html/img/iio_logo.png differ diff --git a/doc/html/img/legato_logo.png b/doc/html/img/legato_logo.png new file mode 100644 index 000000000..7fcee38dd Binary files /dev/null and b/doc/html/img/legato_logo.png differ diff --git a/doc/html/img/li.png b/doc/html/img/li.png new file mode 100644 index 000000000..fd12daf40 Binary files /dev/null and b/doc/html/img/li.png differ diff --git a/doc/html/img/mangOH_logo.png b/doc/html/img/mangOH_logo.png new file mode 100644 index 000000000..7162378ce Binary files /dev/null and b/doc/html/img/mangOH_logo.png differ diff --git a/doc/html/img/mathworks_logo.png b/doc/html/img/mathworks_logo.png new file mode 100644 index 000000000..ba21f31ad Binary files /dev/null and b/doc/html/img/mathworks_logo.png differ diff --git a/doc/html/img/osc128.png b/doc/html/img/osc128.png new file mode 100644 index 000000000..cc85232dd Binary files /dev/null and b/doc/html/img/osc128.png differ diff --git a/doc/html/img/scopy.png b/doc/html/img/scopy.png new file mode 100644 index 000000000..714dcef71 Binary files /dev/null and b/doc/html/img/scopy.png differ diff --git a/doc/html/img/sdrangel.png b/doc/html/img/sdrangel.png new file mode 100644 index 000000000..d29e063fd Binary files /dev/null and b/doc/html/img/sdrangel.png differ diff --git a/doc/html/img/ss.png b/doc/html/img/ss.png new file mode 100644 index 000000000..5e7df963e Binary files /dev/null and b/doc/html/img/ss.png differ diff --git a/doc/html/img/style.css b/doc/html/img/style.css new file mode 100644 index 000000000..7696a31c6 --- /dev/null +++ b/doc/html/img/style.css @@ -0,0 +1,191 @@ +body{ + font-family: "Helvetica Neue", sans-serif; + font-size: 16px; + font-weight: normal; + line-height: 1.3em; + color: #636363; + padding: 0 20px 0; + max-width: 1024px; + margin: auto; +} +hr{ + color: #ccc; + margin: 0px 0 20px; +} +h1, h3{ + font-family: "Arial Regular", sans-serif; + font-weight: bold; + margin-bottom:0; +} +h1{ + font-size: 32px; + color: #1e4056; + margin-bottom: 40px; +} +h3{ + font-size: 24px; +} +header{ + margin-bottom: 20px; +} +header img{ + margin-top: 10px; + margin-bottom: 0px; + height: 75px; + vertical-align: middle +} +nav{ + margin-bottom: 20px; +} +ul{ + margin-top: 0px; + padding-left: 20px; +} +table{ + width: 100%; +} +th{ + background-color: #33b3ca; + color: #fff; + font-weight: normal; + padding: 10px; + text-align: left; +} +td{ + background-color: #f5f5f5; + font-size: 14px; + padding: 5px 10px; +} +th:first-of-type, +td:first-of-type{ + width: 25%; + font-weight: bold; +} +#versiontest{ + color: #27B34F; +} +a{ + color: #33b3ca; + text-decoration: none; +} +.button{ + background-color: #33b3ca; + border-radius: 15px; + color: #ffffff; + margin: 15px 10px 15px 10px; + padding: 5px 15px; + cursor: pointer; +} +.buttons{ + text-align: justify; + display: inline-block; + width: 100%; + top: 1.25em; + margin-bottom: 0em; +} +.buttons:after { + content: ''; + display: inline-block; + margin-bottom: 0; + width: 100%; +} +.buttons:before { + content: ''; + display: block; +} +.foo{ + display: inline-block; + font: 1em/1.5 sans-serif; + margin-right: -.25em; + position: relative; + top: 1.25em; +} +.dropdown { + position: relative; + text-align: left; + display: inline-block; +} +.dropdown-content { + display: none; + position: absolute; + background-color: #f9f9f9; + min-width: 200px; + border-radius: 15px; + box-shadow: 0px 8px 24px 0px rgba(0,0,0,0.2); + padding: 10px 10px; + z-index: 1; +} +.dropdown:hover .dropdown-content { + display: block; +} +.download{ + background-image: url("download.png"); + padding: 1em 1em .5em 70px; + margin-bottom: 1.5em; + min-height: 68px; + background-position: 10px 50%; + background-repeat: no-repeat; + color: #000; + overflow: hidden; + box-sizing: border-box; + background-color: #d6efc2; + border-radius: 1.4em; +} +.quicklinks{ + float: right; + -webkit-column-count: 2; /* Chrome, Safari, Opera */ + -moz-column-count: 2; /* Firefox */ + column-count: 2; + -webkit-column-gap: 20px; /* Chrome, Safari, Opera */ + -moz-column-gap: 20px; /* Firefox */ + column-gap: 20px; + -webkit-column-rule: 1px solid lightblue; /* Chrome, Safari, Opera */ + -moz-column-rule: 1px solid lightblue; /* Firefox */ + column-rule: 1px solid lightblue; + list-style: none; + list-style-type: none; + list-style-image: none; + list-style-position: outside; + font-size: 12px; + line-height: 18px; + font-family: Helvetica,Arial,sans-serif; + margin-top: 2em; + margin-bottom: 0em; +} +.colLeft, .colRight{ + float: left; +} +.colLeft{ + width: 60%; +} +.colRight{ + width: 40%; + text-align: center; +} +.anchor{ + float: right; +} +.boxed { + box-sizing: border-box; + padding: 10px; + border: 1px solid; + border-color: #636363; + border-radius: 5px; +} +pre { + display: inline; + margin: 0; +} +.xterm { + color:#333; + display:block; + font-family:Monaco,Menlo,Consolas,"Courier New",monospace; + padding:9.5px; + margin:0 0 10px; + font-size:13px; + word-break:break-all; + word-wrap:break-word; + background-color:#f5f5f5; + border:1px solid #ccc; + border-radius:4px; +} diff --git a/doc/html/img/sw.png b/doc/html/img/sw.png new file mode 100644 index 000000000..50aa946f0 Binary files /dev/null and b/doc/html/img/sw.png differ diff --git a/doc/html/img/tw.png b/doc/html/img/tw.png new file mode 100644 index 000000000..afab2a989 Binary files /dev/null and b/doc/html/img/tw.png differ diff --git a/doc/html/img/yk.png b/doc/html/img/yk.png new file mode 100644 index 000000000..bcb5cf5d6 Binary files /dev/null and b/doc/html/img/yk.png differ diff --git a/doc/html/img/yt.png b/doc/html/img/yt.png new file mode 100644 index 000000000..566a3bba6 Binary files /dev/null and b/doc/html/img/yt.png differ diff --git a/doc/html/index.html b/doc/html/index.html new file mode 100644 index 000000000..179da299c --- /dev/null +++ b/doc/html/index.html @@ -0,0 +1,616 @@ + + + + + + + + the libIIO documentation + + + + + + + + + +
+ IIO logo A cross-platform user + library to access Industrial Input Output (IIO) devices +
+ +
+
+

Welcome to the libIIO

+

Thanks for your interest in the libIIO, a + C/C++ library that provides generic access to Industrial Input Output (IIO) + devices. IIO started as a Linux + kernel subsystem to support for devices that that included + analog-to-digital convertors (ADCs) and/or digital-to-analog convertors + (DACs). While the libIIO continues to provide an easy interface to the + Linux kernel IIO subsystem, it has also expanded beyond that, and is now + just as common to see this used inside an embedded system or hypervisor as + it is on a host PC.

+

It is portable: Using a single cross-platform + API, it provides access to IIO devices on Linux, macOS, Windows, etc across + local and remote (USB, Network, Serial) devices. The library is composed by + one high-level API, and several backends:

+ +

It is entirely user-mode: No special privilege or elevation is required + for the application to communicate with a device. One of the most powerful + things about libiio is its Remote Procedure + Call style interface. Moving backends from USB to Networking to local + embedded does not require any code changes. The users of the libIIO do not + need to code any differently for the remote interaction, making it easy to + move from remote (debug on PC over Ethernet) to local (deployed on embedded + Linux).

+

What platforms are supported?

+

Any host running Linux, macOS, Windows, or OpenBSD/NetBSD, should be + trivial to get libIIO running on. If you are interested in porting to other + hosts that support either networking (socket interface), libusb or serial, it should be very + straightforward. Pull Requests are + always reviewed, and well written ones are normally accepted.

+

The local backend and Linux daemon can run on any embedded Linux based + system, from purpose built systems like PlutoSDR or ADALM2000 to Raspberry Pi or BeagleBoard to Jetson. + tiny-iiod + requires a modern C compiler and is known to work on a variety of non-Linux + frameworks including Mbed and FreeRTOS.

+

Sounds good! How do I get started?

+

If you are using Linux, chances are your distribution already includes + libIIO, so you probably just need to reference the iio.h + header in your source.

+

For other platforms, you are encouraged to use one of our release + builds. If if you want to use the very latest, you have the option to + use a nightly build or build from source. Please check the Downloads + menu.

+

If you prefer, you can also access the source directly from github.

+

Once you have secured your access to the library and its header, please + check the libIIO API or the libIIO examples.

+

Where is (insert my favourite language) support?

+

The mainline library is built in C, can be used in C++, and has built in + bindings for Python and C# (C-Sharp). Node.js and Rust are maintained + outside the main repo. If you are interested in creating more language + bindings, please reach out to the + developers by posting an issue on github.

+
+
+

Help and Support

+

If you have any questions regarding the libIIO or are experiencing any + problems following the documentation, or examples, feel free to ask us a + question. Generic libIIO questions can be asked on Github Issue + tracker. Since libIIO provides connectivity to the kernel's IIO + framework - many times the problem is actually in the driver. In this case, + contact your favourite kernel developer. If you are using an Analog Devices' component, feel free + to ask on their Linux support + forums.

+
+
+
+ Back to top +

Frameworks

+

Use the libIIO with your favourite open source or commercial signal + processing framework, visualization tool or application.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Frameworks or Applications which use libIIOOSDescription
+ + IIO Command Line Tools + Windows, Linux, macOS + + iio_info, + iio_attr, + iio_readdev, + iio_writedev, + iio_reg for interacting with IIO devices from your favorite + shell. These are included in the default builds, but many + distributions package them into a separate libiio-utils package. + When you want to try a simple example, check these out. +
+ Peyote logo + Windows, Linux, macOS + Pyadi-iio + (pronounced peyote) is a python abstraction module for ADI hardware + with IIO drivers to make them easier to use. The libIIO interface, + although extremely flexible, can be cumbersome to use due to the + amount of boilerplate code required. This Python module has custom + interfaces classes for specific parts and development systems which + can generally make them easier to understand and use. +
+ + Chromium OS Logo + Chrome OS + the + libmems provides a set of wrapper and test helpers around + libIIO. + It is meant to provide a common foundation for Chrome OS to access + and interface IIO sensors +
+ MathWorks logo + + Windows, + Linux, macOS + + Use libIIO to Connect MATLAB® and Simulink® to + PlutoSDR, ADRV9361-Z7035 + RF SoM, or AD9361 based evaluation boards, and other + RF + platforms, high + speed converters, and sensors + to prototype, verify, and test practical systems. Request a + + zero-cost trial and then explore and experiment with a variety + of + signal processing and radio examples. +
+ GNU Radio logo + Linux, macOS + GNU Radio is a Free and Open-Source Toolkit for Software Radio, + primarily supported on Linux operating systems. It has both + + generic IIO blocks, and blocks for specific IIO devices like + the PlutoSDR +
+ + + IIO + Oscilloscope + Windows, LinuxThe IIO Oscilloscope is an application, which demonstrates how to + interface various IIO devices to different visualization methods on + Linux and Windows
+ SDRAngel logo + Windows, Linux + SDRangel is + an Open Source Qt5 / OpenGL 3.0+ SDR and signal analyzer frontend + to various hardware. Check the discussion group and wiki. While SDRangel + seeks to be approachable, it is targeted towards the experienced + SDR user with some digital signal processing understanding. It + supports libIIO for the PlutoSDR, and can be extended to support + many other IIO devices. +
+ + Scopy + Windows, Linux, macOS + Scopy is a multi-functional software toolset that supports + traditional instrument interfaces with Oscilloscope, Spectrum + Analyzer, Network Analyzer, Signal Generator, Logic Analyzer, + Pattern Generator, Digital IO, Voltmeter, Power Supply interfaces + for the ADALM2000. It + is built in Qt5 in C++, and is available under a open source + license on github. +
+ + + + The Legato Application Framework started out as an initiative by + Sierra Wireless Inc. to provide an open, secure and easy to use + Application Framework to grow the "Internet of + Everything". Legato uses libIIO + to interface with real world sensors. +
+ + + + From idea to prototype to product, mangOH® is industrial-grade open + source hardware designed to address common IoT pain points and + deliver 90% of your prototype out-of-the-box so you can focus your + time and resources building the next killer IoT application and + bringing your products to market sooner. mangOH uses libIIO to interface with + real world sensors. +
Reference on this page to any specific open source, or + commercial product, project, process, or service, or the use of any trade, + firm or corporation name is for the information and convenience of the + public, and does not constitute endorsement, recommendation, or favoring by + any libIIO developer. If you want to add your project to this doc, please + send a pull + request +
+
+
+
+ +
+

Contributors

+
+

+ The libIIO would not exist without the generous + support of Analog Devices (Nasdaq: + ADI), a leading global + high-performance analog technology company dedicated to solving the + toughest engineering challenges. While many of the developers + are full time ADI employees, libIIO is released and distributed as an + open source (LGPL and GPL) library for all to use (under the terms and + obligations of the License).

+
+
+

Follow Analog Devices on your favourite social media site:

+
+
+

+ + + + Google+ Logo + + + + + + SlideShare Logo

+
+
+
+ + +