Introduction

This is MATES API documentation. The API is organized as follows:

All API functions are available in single DLL file: mates.dll.
The API functions are declared in mates.h.
The MATES registers enumeration is defined in mates_regs.h.
The Python MATES wrapper is provided by viresco.mates.
The Python MATES registers definitions are in viresco.mates.regs.
The C# wrapper class is defined in Mates.cs in Viresco.Mates namespace.
The C# registers definitions are in MatesRegs.cs.

All mentioned files are included in the MATES installer (most recent version is MATES-full-2.5.55.3587-setup.exe). The location of files within the installation directory is described in the "Installation directory content" section of the MATES system manual: MATES.pdf.

Quick start

To link to the DLL you can use (example for MinGW port of GCC):

gcc main.c mates.dll -o main.exe

To run the example programs, you have to have the following DLLs present on your PATH (or in the current directory):

mates.dll (2.7.0.0 or higher)
uOS_monitor.dll (3.4.0.0 or higher)
libxml2.dll (2.7.8)
pcre3.dll (6.4.2194.685)
zlib1.dll (1.2.5.0)

Besides the C DLL itself, the MATES API also has Python and C# wrappers. They are both using the same DLL.

The following Python modules need to be importable to use the Python wrapper:

mates.py
mates_regs.py

You can use the following code to add directory where these files are to Python search path:

 import sys
 sys.path.append("your directory")
 import mates
 ...

Alternatively, you can use one of the Wheel packages available in installation folder:

1 pip install "c:\Program Files (x86)\Viresco\MATES\bin\viresco.mates-1.0.0-py3-none-win32.whl"

And then simply import mates from viresco namespace:

1 from viresco import mates

2 ...

The Python wrapper was written against Python 2.7 32-bit and Python 3.6 32-bit.

To use the C# wrapper, add reference to the Viresco.Mates.dll assembly to your project and make sure the DLLs mentioned above are visible to your program. The Viresco.Mates.dll targets .NET 4.5.2.

All access methods were tested under Windows XP 32-bit, Windows Vista 32-bit, Windows 7 64-bit and Windows 10 64-bit.

Finally, the configuration file default.mon used in all examples need to be in the current directory (the one provided with installation is configured to use COM1 serial port, edit the file to fit your needs).

Before starting code development, you should be familiar with the MATES system manual: MATES.pdf. This document contains - among others - MATES registers descriptions.

Introduction

Quick start

Further reading