Python клиент

Общая информация
Клиентские библиотеки
API
Сервер

🚀 Быстрый старт

  1. Зарегистрируйтесь на microcomm.ru
  2. Создайте устройство в личном кабинете — вы получите уникальный UUID
  3. Склонируйте репозиторий:
    bash git clone https://github.com/andreyu-git/microcomm-python.git cd microcomm-python
  4. Запустите клиент, подставив свой UUID:
    bash python microcomm.py --uuid ваш_уникальный_uuid_устройства --debug

Готово! Теперь вы можете отправлять команды устройству через веб-интерфейс или API MicroComm — клиент будет автоматически получать их и возвращать результат.

🛠 Аргументы командной строки

Аргумент Описание По умолчанию
--uuid Обязательный UUID вашего устройства —
--host Адрес сервера MicroComm microcomm.ru
--debug Включить подробное логирование выключен

Конечно! Вот понятный, дружелюбный и структурированный текст для документации или README — как работать с обработчиками команд в MicroComm:

🧩 Обработчики команд

Все ваши команды находятся в папке commands/.
Каждая команда — это отдельный Python-файл, в котором вы описываете:

  • что делает команда,
  • какие параметры она принимает,
  • и как обрабатывать её выполнение.

📌 Пояснение полей

Элемент Назначение
__description__ Краткое описание команды (отображается в интерфейсе)
__param_specs__ Спецификация параметров: тип, обязательность, описание, значение по умолчанию
handler(execution) Основная функция, которая вызывается при получении команды

✅ Как добавить новую команду

  1. Создайте новый файл в папке commands/, например my_command.py.
  2. Опишите __description__, __param_specs__ и функцию handler.
  3. Перезапустите клиент — он автоматически загрузит все команды из этой папки.

Готово! Теперь команда доступна для вызова через веб-интерфейс или API MicroComm.

🌟 Совет: используйте execution.success() и execution.error() — они гарантируют корректный формат ответа и автоматически логируют результат в облаке.

Такой формат помогает быстро понять, как расширять функциональность устройства, и сразу приступить к написанию своих команд.

MicroComm — ваш мост между кодом и реальным миром.
Управляйте устройствами, не думая об инфраструктуре.