Wiki

Below is the source of this page. To edit this source as well as other pages on the wiki, you must login.
====== What is libm2k? ======


A <nowiki>C++</nowiki> library for interfacing with the ADALM2000, splitted into more correlated components, interconnected by a context.

These m2k components represent the functionalities of ADALM-2000:
  * AnalogIn - oscilloscope or voltmeter
  * AnalogOut - signal generator
  * Digital - logic analyzer or pattern generator
  * PowerSupply - constant voltage generator
  * DMM - digital multimeter

Libm2k can be used for encoding and decoding digital signals, communicating with a wide variety of chips, using some well known protocols, such as SPI, I²C or UART. Created based on no-OS communication headers, libm2k communication segment is build to interact with ADI's chips in a generic way. Regardless of protocol, there are three common steps in any communication process: initialization, writing/reading, freeing the resources. A more detailed view of communicating with a peripheral is documented [[university:tools:m2k:libm2k:digital_communication|here]].

For an easier and faster control of m2k components, libm2k offers a command-line frontend, called m2kcli. This command line tool also includes the fuctionality of encoding and decoding digital signals. More information about m2kcli can be found on our [[university:tools:m2k:libm2k:m2kcli|wiki page]].


===== ADALM2000 drivers =====
<note important>Make sure you install the ADALM2000 drivers for your operating system before using the board.</note>

==== Linux ====
In order to access some USB functions without root privileges, it's recommended to install the ADALM2000 udev rules. Simply download [[https://raw.githubusercontent.com/analogdevicesinc/m2k-fw/master/scripts/53-adi-m2k-usb.rules|53-adi-m2k-usb.rules]] and copy into the ///etc/udev/rules.d/// folder


==== Windows ====
Instructions to install Windows drivers can be found [[university:tools:pluto:drivers:windows|here]].


==== Mac OS X ====
Instructions to install Mac OS X drivers can be found [[university:tools:pluto:drivers:osx|here]].

====== How to install it? ======

===== Download =====

<WRAP round download>
Go to the [[https://github.com/analogdevicesinc/libm2k/releases/latest| latest release page]] and download the package that fits your system.
</WRAP>

===== Installation =====

**libm2k for Windows **
  * Download the **libm2k-Windows-setup.exe** and run through all the required steps.
<note important>For libm2k versions starting with v0.6.0: The libm2k Windows installer does not include Python bindings. Check the Python bindings section for more details.</note>
<note warning>For libm2k versions older than v0.6.0: Make sure you only select the libm2k Python bindings that correspond to your installed Python version.</note>

**libm2k for Linux **
  * Download the **libiio-ubuntu.deb** for your system (from the [[https://github.com/analogdevicesinc/libiio/blob/master/README.md| nightly builds]]) and install it by running **sudo apt install -f ./libiio-package.deb**.
  * Download the **libm2k-ubuntu.deb** for your system and install it by running **sudo apt install -f ./libm2k-package.deb**.

**libm2k for OSX **
  * Download the **libiio-darwin.pkg** for your system (from the [[https://github.com/analogdevicesinc/libiio/blob/master/README.md| nightly builds]]) and install it by running **sudo installer -pkg /path/to/package.pkg -target /**.
  * Download the **libm2k-darwin.pkg** for your system and install it by running **sudo installer -pkg /path/to/package.pkg -target /**.
  * The m2kcli command line tool is also installed with the package. In order to access it, the full path to it must be used (///Library/Frameworks/libm2k.framework/Tools/m2kcli//) or a symbolic link can be created in the following way:
<xterm>
ln -s  /Library/Frameworks/libm2k.framework/Tools/m2kcli <path-to-accessible-location>/m2kcli
</xterm>
  * <path-to-accessible-location>: choose any location that is listed in the PATH (example: /usr/local/bin or /usr/bin)


====== How to build it? ======

===== Building and installing bindings =====

==== Python bindings ====

  * **Option 1 - Download wheel packages**: The easiest way to use the libm2k Python bindings is to install them using **pip**. Starting with version v0.6.0, libm2k releases provide an archive containing **wheels** for Windows, Linux, MacOS corresponding to Python versions 3.7, 3.8, 3.9 and 3.10.
<xterm>python3 -m pip install ./libm2k-0.6.0-cp310-cp310-win_amd64.whl</xterm>

  * **Option 2 - Use test.pypi.org**: For every release starting with v0.6.0, all the Python wheels for libm2k will be uploaded to test.pypi.org. [[https://test.pypi.org/project/libm2k/#description|Check the files and install instructions here.]]

  * **Option 3 - Conda packages**: If you are using Conda, libm2k packages are made available and updated at every major release. [[:university:tools:conda|Check out more details here.]]

  * **Option 4 - Build the bindings**: The Python bindings are **enabled** by default if SWIG and a correct Python version are detected on your system. They can be specifically enabled or disabled by using the following:
<xterm>
~/libm2k/build$ **cmake -DENABLE_PYTHON=ON/OFF ..**
</xterm>

==== C# bindings ====

The C# bindings are **disabled** by default. They can be specifically enabled(requires SWIG and a correct C# compiler) or disabled by using the following:
<xterm>
~/libm2k/build$ **cmake -DENABLE_CSHARP=ON/OFF ..**
</xterm>

==== MATLAB bindings ====

MATLAB bindings come pre-packaged through installers for Linux and Windows. [[:university/tools/m2k/matlab|Further documentation is provided on a separate page]].


==== LabVIEW bindings ====

LabVIEW bindings come pre-packaged through a .vip installer for Windows. [[:university/tools/m2k/labview|Further documentation is provided on a separate page]].


===== Other features =====

==== Build m2k tools - m2kcli ====

Building m2kcli is disabled by default. It can be enabled by running the following
<xterm>
~/libm2k/build$ **cmake -DENABLE_TOOLS=ON ..**
</xterm>


==== Building with logging support ====
The logging system is **disabled** by default. It can be specifically enabled(requires glog library) or disabled by using the following:
<xterm>
~/libm2k/build$ **cmake -DENABLE_LOG=ON/OFF ..**
</xterm>

There is one more layer of controlling the logging. After building libm2k with logging support the user must enable the logging system from code, calling the method **enableLogging(true)**. By default the logging system is disabled.


==== Building the examples ====

Building the examples is disabled by default. It can be enabled by running the following
<xterm>
~/libm2k/build$ **cmake -DENABLE_EXAMPLES=ON ..**
</xterm>

===== Building on Linux =====

==== Dependencies ====
Install git, cmake, swig, python:
<xterm>
~$ **sudo apt-get install git cmake swig <nowiki>g++</nowiki> python3-dev python3-setuptools libgoogle-glog-dev**
</xterm>
Build and install libiio. Instructions can be found [[/resources/eval/user-guides/ad-fmcdaq2-ebz/software/linux/applications/libiio#how_to_build_it|here]].

==== Install libm2k ====
Build and install libm2k:
<xterm>
~$ **git clone https://github.com/analogdevicesinc/libm2k.git**
~$ **cd libm2k**
~/libm2k$ **mkdir build**
~/libm2k$ **cd build**
~/libm2k/build$ **cmake ../**
~/libm2k/build$ **make**
~/libm2k/build$ **sudo make install**
</xterm>

If the Python bindings were enabled, they will be **automatically** installed in the site-packages folder specific for Python, once sudo make install is called.

===== Building on OSX =====

==== Dependencies ====
Install git, cmake, swig and python:
<xterm>
~$ **brew install git cmake <nowiki>g+</nowiki>+ swig python3 libusb**
</xterm>

Download and install [[https://github.com/analogdevicesinc/libiio/releases | libiio]].

==== Install libm2k ====
Build and install libm2k: 
<xterm>
~$ **git clone https://github.com/analogdevicesinc/libm2k.git**
~$ **cd libm2k**
~/libm2k$ **mkdir build**
~/libm2k$ **cd build**
~/libm2k/build$ **cmake ../**
~/libm2k/build$ **make**
~/libm2k/build$ **sudo make install**
</xterm>

==== Install libm2k Python bindings ====
Make sure you installed libm2k first then run the following commands in order to install the Python bindings in your system.
<xterm>
~/libm2k$ **cd libm2k/build**
~/libm2k$ **python3 setup.py install_lib**
</xterm>
This will install **libm2k.py** and **_libm2k.so** in the site-packages folder used by your **python3** executable.

===== Building on Windows =====

Get the latest installer from [[https://ci.appveyor.com/project/analogdevicesinc/libm2k/build/artifacts | here]].

==== Dependencies ====
  * libiio
        * Download the libiio zip from [[https://github.com/analogdevicesinc/libiio/releases | this page]].
        * Choose a location and extract libiio.
  * CMake
        * Install CMake using an installer from the [[https://cmake.org/download/ | official page]].
  * Swig
        * Download the SWIG zip from [[https://sourceforge.net/projects/swig/files/swigwin/swigwin-4.0.0/swigwin-4.0.0.zip/download?use_mirror=netix | this page]].
        * Choose a location and extract SWIG.
  * Python3
        * Download and install Python3 from the [[https://www.python.org/downloads/ | official page]].
        * Set path to program files or ''C:\Python37''.
  * glog
        * Clone [[https://github.com/google/glog|glog]].
        * Use the CMake-gui. At startup, select your platform.
        * Enable BUILD_SHARED_LIBS and disable WITH_GFLAGS.
        * Set CMAKE_CONFIGURATION_TYPES to Release
        * Press 'Configure' button.
        * Press 'Generate' button.
        * Click 'Open Project' and build the solution.
        * Note: glog.dll should be placed next to your libm2k application or in your system

==== Install libm2k ====
  - Clone libm2k or download zip and extract it.
  - Use the CMake-gui and open ''libm2k/CMakeLists.txt''. At startup, select platform x64. {{:libm2k_windows_cmake.png?400|}}
  - Press the Configure button. Some of the parameters will be set to their correct value.
  - Browse the location where you extracted libiio and set ''IIO_LIBRARIES'' to ''libiio/MS64/libiio.lib'' and ''IIO_INCLUDE_DIRS'' ''libiio/include''.
  - (Only if logging is enabled) Browse the location where glog was built. Set ''GLOG_LIBRARIES'' to ''glog_build_dir/Release/glog.lib'' and ''GLOG_INCLUDE_DIRS'' to your ''glog_build_dir''.
  - Press the Configure button again.
  - Set the ''PYTHON_EXECUTABLE'' to have the python install folder (''C:/Python37/python.exe'').
  - Press the Configure button again.
  - Browse the location where you extracted SWIG and the SWIG_DIR to that location.
  - Press the Configure button again.
  - If no errors, click Generate button in CMake-gui
  - Click Open Project in CMake-gui - this will open Visual Studio.

\\
**Build solution in visual studio**

If you want to install the library in the system:
  - Open a Command Prompt in the libiio folder and copy all the .dll files in ''C:\Windows\System32''.
  - Open a Command Prompt in the build folder and copy libm2k.dll in ''C:\Windows\System32''.

\\
**C# bindings**
  - The C# bindings are built by default. In order to disable them, set ''ENABLE_CSHARP=OFF'' in the CMake configuration.
  - In order to use the C# bindings, you need to copy the following dlls in your build folder: ''libm2k-sharp.dll'' and ''libm2k-sharp-cxx-wrap.dll'' . These can be found in ''C:\Program Files\Common Files\libm2k'' if you installed libm2k using the system installer. Otherwise, you can download the latest archive from appveyor: Appveyor artifacts and get the dlls from there.
  - Add ''libm2k-sharp.dll'' as a reference in your project.
  - Check the examples from [[https://github.com/analogdevicesinc/libm2k/tree/master/bindings/csharp/examples | the source code]].


====== Documentation ======

===== API reference =====
An automatically generated documentation of the API can be found here: [[https://analogdevicesinc.github.io/libm2k/annotated.html]].

===== calibration =====
Libm2k offers a software solution for calibrating the board. Please visit the dedicated [[university:tools:m2k:libm2k:calibration|page]] for more information.

===== m2kcli =====
Documentation can be found [[university:tools:m2k:libm2k:m2kcli|here]].

===== digital communication =====
See the dedicated [[university:tools:m2k:libm2k:digital_communication|page]].
Analog Devices Wiki

Page Tools
