GithubHelp home page GithubHelp logo

guschinevgeny / autofon-telegram-bot Goto Github PK

View Code? Open in Web Editor NEW

This project forked from romancha/autofon-telegram-bot

0.0 0.0 0.0 1.05 MB

АвтоФон телеграм бот, уведомляет и рисует графики

License: Apache License 2.0

Shell 0.51% Kotlin 99.49%

autofon-telegram-bot's Introduction

АвтоФон Telegram Бот

Self-hosted Телеграм бот для отслеживания устройств АвтоФон.

Функции бота

  • Отслеживание ваших устройств АвтоФон
  • Отправка уведомление в Телеграм с информацией о новом состоянии, включая:
    • Наименование устройства (настраивается в личном кабинете АвтоФон)
    • Время обновления состояния
    • Текущую температуру
    • Напряжение батареи и количество затраченных мАч
    • Текущее местоположение устройства и точность определения
  • Предупреждение о низком балансе на сим-картах
  • Настраиваемый список устройств для отслеживания
  • Формирование графиков на основе истории состояний устройств
  • Получение сводной информации о сохраненных состояниях устройств

Графики

Температура с датчика устройства

Напряжение батареи

Затраченное мАч батареи

Запуск

Для запуска бота через docker compose необходимо:

  1. Установить Docker и Docker Compose.
  2. Создать вашего бота и получить токен у @BotFather.
  3. Узнать свой chat_id у @userinfobot.
  4. Заполнить docker-compose.yml файл обязательными переменными AUTOFON_TELEGRAM_TOKEN, AUTOFON_TELEGRAM_CHAT_ID, AUTOFON_API_KEY, AUTOFON_API_PASSWORD. https://github.com/Romancha/autofon-telegram-bot/blob/7d83bf06cbb0f98672e324e1af602015dbd29768/src/main/docker/docker-compose.yml#L1-L12
  5. В volumes первый путь должен быть указан к папке на вашем устройстве, куда будет сохраняться файл с базой данных бота.
  6. Выполнить команду для запуска docker-compose up -d.

После запуска бота бот отправит приветственное сообщение в указанный чат. Если бот не отправил сообщение, проверьте правильность заполнения переменных и проверьте логи бота docker-compose logs -f.

Для добавления устройства в список отслеживаемых, нажмите на кнопку "Настройка отслеживания" в боте.

Доступные параметры

Параметр Описание
AUTOFON_TELEGRAM_TOKEN Токен телеграм бота, полученный у @BotFather
AUTOFON_TELEGRAM_CHAT_ID Идентификатор чата, куда бот будет слать уведомления. Обычно это ваш чат с ботом, можно воспользоваться @userinfobot для получения id
AUTOFON_API_KEY Api ключ АвтоФон, узнать можно в личном кабинете АвтоФон - API Key
AUTOFON_API_PASSWORD Пароль от вашего аккуанта АвтоФон
AUTOFON_TIME_ZONE Временная зона ZoneId, по умолчанию Europe/Moscow
AUTOFON_HEARTBEAT_ENABLED Включить отправку уведомлений о состоянии бота, по умолчанию false
AUTOFON_HEARTBEAT_INTERVAL_SECONDS Интервал отправки уведомлений о состоянии бота в секундах, по умолчанию 10800 (3 часа)
AUTOFON_CHECK_LAST_UPDATE_INTERVAL_SECONDS Интервал проверки обновлений устройств в секундах, по умолчанию 600 (10 минут)
AUTOFON_SIM_BALANCE_ALARM_THRESHOLD Лимит баланса сим карты для предупреждения о низком балансе, по умолчанию 30

autofon-telegram-bot's People

Contributors

romancha avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.