• О проекте
  • Создание проекта
  • Библиотека
  • Документация
  • Прошивка
  • Qt debugger
  • Python
  • C#
  • TANGO
  • Конвертер профилей

    • Библиотека

    Требуется: релиз библиотеки xibridge (берется автоматически).

    Описание

    Библиотека - это то, что нужно компьютеру для общения с устройством по вашему протоколу. В ней реализован API для отправки запросов контроллеру, ожидания и распознавания ответов от него. Таким образом, в этой библиотеке нуждаются все программы, работающие с устройством, например, Qt отладчик, скрипты, TANGO, а также ваши собственные программы.

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

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

    Сборка под Windows

    Для сборки библиотеки выполните шаги:

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

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

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

      Заметьте, установщик зависит от битности системы.
      1. Откройте в Visual Studio сгенерированный CMake-ом файл <имя_проекта>.sln.
      2. Укажите тип сборки Release.
      3. В главном меню выберите BUILD -> Build solution.
      4. Дождитесь успешной сборки.

    Сборка под Linux

    Для сборки библиотеки выполните шаги:

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

      sudo apt-get install build-essential cmake

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

      cmake .

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

      5. 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. С помощью Doxygen можно получить документ с описанием интерфейса всех C функций, стуктур данных, констант и пр. Для этого комментарии в 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

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

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

    Инструкция сборки для Windows аналогична инструкции сборки для Linux, но пакеты 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.