
QSerialSevice v 0.2.0

Содержание:
1. О проекте
2. Сборка
3. Установка
4. Лицензия
5. Авторы
6. Ссылки
----------------




1. О проекте.
~~~~~~~~~~~~

QSerialDevice - это кросс-платформенная библиотека для работы с последовательными 
устройствами (портами) основанная на Qt4 (http://qt.nokia.com/).

Внимание: 
В текущей версии - гарантируется безошибочная работа (тестировалась автором) только в операционных системах: 
- Windows XP Pro Sp3
- GNU/Linux
поэтому в других случаях работа не гарантируется!

1.1 О классах.

Библиотека содержит следующие классы:

AbstractSerial      - класс, который предоставляет интерфейс для работы
                      с последовательными устройствами.
SerialDeviceWatcher - класс, который предоставляет интерфейс 
                      нотификации (слежения) за последовательным устройством.
SerialDeviceInfo    - класс, который предоставляет интерфейс 
                      для получения информации о последовательных устройствах.
                          
(подробное описание смотри в документации)

Библиотека может быть собрана как в интегрированном виде (т.е. все классы слинкованы в одну библиотеку),
так и в дифференцированном виде (т.е. каждый класс слинкован в отдельную библиотеку).

1.2 О примерах.

Библиотека в своем составе содержит консольные примеры программ в директории /examples,
утилиты:

writer                  - предназначена для демонстрации использования библиотеки при записи данных в порт.

reader                  - предназначена для демонстрации использования библиотеки при чтении данных из 
                          порта с использованием метода: waitForReadyRead().

sreader                 - предназначена для демонстрации использования библиотеки при чтении данных из
                          порта с использованием сигнала: readyRead().
    
serialdeviceinfo        - предназначена для демонстрации использования библиотеки для получения 
                          информации о последовательных устройствах.
                          
serialdevicewatcher     - предназначена для демонстрации использования библиотеки для нотификации (слежения) 
                          за последовательными устройствами.

(подробнее о сборке библиотеки и примеров см. ниже в разделе №2 "Сборка")

1.3 О Документации.

Документация: (doc/ru/html или doc/en/html) выполнена на двух языках: английском и русском.
(замечание: сгенерирована с помощью Doxygen)




2. Сборка
~~~~~~~~~~~~

2.1 Требования.

Для сборки проекта в OC Windows и GNU/Linux (к примеру) необходимы обязательные условия:
- должна быть установлена библиотека Qt4 > 4.5.0 и правильно настроены её переменные окружения.
- должен быть установлен компилятор и настроены его переменные окружения.

Примечание: для ОС GNU/Linux для сборки классов SerialDeviceWatcher и SerialDeviceInfo 
должен быть установлен UDEV (http://www.kernel.org/pub/linux/utils/kernel/hotplug/udev.html)

2.2 Сборка библиотеки.

Примечание: По умолчанию библиотека собирается с опцией: staticlib, поэтому
все рекомендации по сборке библиотеки и примеров, которые приведены ниже, 
даются только для статической сборке библиотеки. 

    2.2.1 Сборка библиотеки в интегрированном виде.
    
    1. Распакуйте архив с исходными кодами проекта.
    2. Перейдите в директорию с исходными кодами проекта:
        #cd <QSerialDeviceProjectDir>
    3. Выполните следующие команды:
        #qmake BuildIntegratedLibrary.pro
        #make
        
    Результат:
    в директории: <QSerialDeviceProjectDir>/build/lib/qintegratedserialdevice/release 
    появится бинарный файл: libqserialdevice.a библиотеки.
    
    2.2.2 Сборка библиотеки в дифференцированном виде.
    
    1. Распакуйте архив с исходными кодами проекта.
    2. Перейдите в директорию с исходными кодами проекта:
        #cd <QSerialDeviceProjectDir>
    3. Выполните следующие команды:
        #qmake BuildDifferentiatedLibrary.pro
        #make
        
    Результат:
    в директориях:
    <QSerialDeviceProjectDir>/build/lib/qserialdevice/release
    <QSerialDeviceProjectDir>/build/lib/qserialdeviceinfo/release
    <QSerialDeviceProjectDir>/build/lib/qserialdevicewatcher/release
    появятся соответственно бинарные файлы библиотек.
    
    2.2.2 Сборка примеров.
    
    Примечание: перед сборкой примеров необходимо собрать библиотеку в интегрированном виде (см. п. 2.2.1)
    
    1. Примем, что мы уже распаковали исходные коды и собрали библиотеку в интегрированном виде.
    2. Выполните следующие команды:
        #qmake BuildExamples.pro
        #make
        
    Результат:
    в директориях:
    <QSerialDeviceProjectDir>/build/bin/reader/release
    <QSerialDeviceProjectDir>/build/bin/sreader/release
    <QSerialDeviceProjectDir>/build/bin/writer/release
    <QSerialDeviceProjectDir>/build/bin/serialdeviceinfo/release
    <QSerialDeviceProjectDir>/build/bin/serialdevicewatcher/release
    появятся соответственно исполняемые бинарные файлы примеров.
    
2.3 Сборка документации.

Для сборки документации на русском языке - используйте файл Doxyfile_RU, английском - Doxyfile_EN




3. Установка
~~~~~~~~~~~~




4. Лицензия
~~~~~~~~~~~~~
GPL

Copyright (C) 2009 Denis Shienkov <scapig2@yandex.ru>

Подробнее см. файл: copying




5. Авторы
~~~~~~~~~~~~~

Разработчик : Денис Шиенков
ICQ         : 321789831
e-mail      : scapig2@yandex.ru




6. Ссылки
~~~~~~~~~~~~~

Исходные коды проекта v 0.2.0 можно скачать тут:
http://fireforge.net/projects/qserialdevice/

Исходные коды последней ревизии SVN тут:
http://fireforge.net/snapshots.php?group_id=199

Qt4 тут: http://qt.nokia.com/

UDEV тут: http://www.kernel.org/pub/linux/utils/kernel/hotplug/udev.html


