README.md

   1 # NooLite MTRF MQTT
   2
   3 Ретранслятор сообщений с последовательного порта MTRF в MQTT сообщения
   4
   5 ## Установка
   6
   7 Для установки проекта нужен Python 3.5+ и pip
   8
   9 ### Из репозитория
  10
  11 В системе должны быть установлены:
  12
  13 - pip для третий версии python
  14
  15 - git
  16
  17 ```bash
  18 $ pip3 install git+https://bitbucket.org/AlekseevAV/noolite-mtrf-to-mqtt
  19 ```
  20
  21 К примеру установка проекта на ArchLinux будет выглядеть следующим образом:
  22 ```bash
  23 # Устанавливаем необходимые пакеты
  24 $ pacman -S python python-pip git
  25 # Устанавливаем noolite_api
  26 $ pip3 install git+https://bitbucket.org/AlekseevAV/noolite-mtrf-to-mqtt
  27 ```
  28
  29 ### Из исходников
  30
  31 ```bash
  32 # Клонируем репозиторий
  33 $ git clone https://bitbucket.org/AlekseevAV/noolite-mtrf-to-mqtt
  34
  35 # Заходим в созданную папку репозитория
  36 $ cd noolite-mtrf-to-mqtt
  37
  38 # Устанавливаем сервер
  39 $ python setup.py install
  40 ```
  41
  42 ## Запуск
  43
  44 ```
  45 $ noolite_mtrf_mqtt
  46 ```
  47
  48 ## Работа
  49
  50 MQTT топики для работы:
  51 - noolite/mtrf/send - топик для отправки сообщений на адаптер
  52 - noolite/mtrf/receive - топик, куда публикуются все принятые сообщения с адаптера