PC библиотека (генерируется uRPC)

Описание

Библиотека - это то, что нужно компьютеру для общения с устройством по вашему протоколу. В библиотеке реализован API для отправки запросов контроллеру, ожидания и распознавания ответов от него. Все другие программы, которые работают с устройством - например, простой Qt отладчик, который генерируется uRPC, python скрипты, TANGO и ваши собственные программы для общения с устройством - все нуждаются в этой библиотеке.
Библиотека предоставляется в виде исходных кодов C\C++ и CMakeLists файла, с помощью которого можно создать файл проекта для любой среды программирования (и любого компилятора C\C++). Например, можно сгенерировать проект для Microsoft Visual Studio, Code::Blocks, GNU Makefile и пр. Для лучшего ознакомления с CMake посмотрите официальную документацию на сайте cmake.
Для сборки библиотеки потребуется релиз библиотеки xibridge, который берется автоматическии.

Инструкция по сборке CMake-проекта библиотеки

Сборка под Windows

1. Сгенерировать библиотеку нажатием кнопки "Generate" под надписью "Library" на главной странице, скачать её и распаковать архив.
2. Запустить CMake GUI.
3. Нажать кнопку "Browse Source..." и указать путь до папки с исходными кодами (в этой папке находится файл CMakeLists.txt).
4. Нажать кнопку "Browse Build..." и указать путь к папке, в которую будут перемещены сгенерированные в ходе работы CMake файлы проекта.
5. Нажать кнопку "Configure".
6. Выбрать среду для сборки. На Windows обычно используется "Visual Studio 12 2013". Стоит обратить внимание на разрядность (Win32 / Win64). В старых версиях CMake она указана в общем списке после имени среды, в новых версиях CMake разрядность задаётся в отдельном списке.
7. Нажать "Finish".
8. Нажать кнопку "Generate".

Теперь у вас есть файлы проекта для интересующей вас IDE/Сборщика!

Для работы библиотеки под Windows понадобятся распространяемые пакеты Visual Studio в зависимости от версии. Пакеты для Visual Studio скачиваются с официального сайта, для VS2013, например, здесь. Заметьте, установщик зависит от битности системы.

Сборка под Linux

1. Установить пакеты разработчика (g++, gcc, make...) через командную строку:

   sudo apt-get install build-essential cmake

2. Загрузить архив с библиотекой, распаковать его.
3. В директории src в распакованном архиве библиотеки запустить командную строку и выполнить cmake:

   cmake CMakeLists.txt

4. В этой же директории выполнить make:

   make

5. В результате сборки получилась библиотека .so. Чтобы ваши программы (и Qt-отладчик) находили библиотеку, добавьте путь к библиотеке в переменную LD_LIBRARY_PATH. Например, если хотите из оболочки запустить программу, которая использует библиотеку, наберите в командной строке:

   export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:путь_к_директории_с_библиотекой

6. Готово. Для использования библиотеки в ваших программах достаточно добавить заголовочный файл <имя_протокола>.h (лежит в директории с распакованным архивом библиотеки).

Сборка под macOS

1. Установить средства разработки командной строки "Command Line Tools". Вы можете попробовать установить "Command Line Tools" через терминал с помощью команды:

   xcode-select --install

   Если установить таким образом не получается, то нужно скачать установщик с сайта Apple.
2. Загрузить архив с библиотекой, распаковать его.
3. В папке с исходными кодами библиотеки (в этой папке находится файл CMakeLists.txt) запустить терминал и выполнить команду:

   cmake CMakeLists.txt

4. В этой же директории выполнить make:

   make

Документация к API

Интерфейс C библиотеки документирован в формате Doxygen. Благодаря правильно оформленным комментариям в C библиотеке с помощью Doxygen можно получить документ с описанием интерфейса всех C функций, с описанием стуктур данных, констант и пр. (обо всех возможностях Doxygen смотрите на официальном сайте).

Сборка Doxygen документации в Linux

1. Установить все необходимые пакеты для работы:

   sudo apt-get install doxygen texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra

2. В директории с архивом сгенерированной библиотеки запустить Doxygen:

   Doxygen .

3. Затем в появившейся папке latex выполнить:

   make

4. Готово, файл refman.pdf появился в директории latex.

Сборка Doxygen документации в Windows

Инструкция сборки для Windows аналогична, но пакеты Doxygen и texlive нужно установить вручную. Texlive для Windows можно взять, например, с miktex, а Doxygen с официального сайта проекта Doxygen.

Пример работы с библиотекой

Пусть в протоколе устройства Foo есть команда supercommand, и устройство подключено к порту 42. Тогда C код для вызова этой команды выглядел бы примерно так:

    #include "foo.h"

    device_t my_device = foo_open_device("com:\\.\COM42");
    foo_supercommand(my_device);
    foo_close_device(&my_device);

Разумеется, файл foo.h из сгенерированного uRPC архива библиотеки должен лежать рядом. Также при компиляции этого примера нужно будет прилинковать собранную библиотеку .lib или .so.