BERRYNET(1)

📦
version 3.10.2 · 3 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu questing

💖 BERRYNET(1) 💖

okay so bestie, welcome to the bn_telegram page from the bn_telegram User Manual — yes she has her own manual, main character energy fr fr ✨

🌸 NAME 🌸

bn_telegram — a program to send deep learning results from MQTT to telegram 💅

🎀 SYNOPSIS 🎀

bn_telegram --token TOKEN [--target-label TARGET_LABEL]
            [--broker-ip BROKER_IP] [--broker-port BROKER_PORT]
            [--topic [TOPIC...]] [--topic-action TOPIC_ACTION]
            [--topic-config TOPIC_CONFIG]

bn_telegram [{-h | --help} | {--debug}]

✨ DESCRIPTION ✨

okay so this manual page documents briefly the bn_telegram command. briefly!! we're keeping it cute and concise 🫶

this manual page was written for the Debian distribution because the original program does not have a manual page. so yeah, no upstream docs, Debian said "fine, i'll do it myself" 💀

bn_telegram is a program that send results to telegram. that's the whole vibe. it takes your deep learning results off MQTT and yeets them into your telegram chat. iconic.

💜 OPTIONS 💜

the program follows the usual GNU command line syntax, with long options starting with two dashes (`-`). a summary of options is included below. lowkey a lot of options but we ball 🌈

  • --token TOKEN — Telegram token got from BotFather, or filepath of a JSON config file with token. yes bestie, either the raw token OR a path to a JSON config that has the token in it. two ways to feed the bot 🍓
  • --target-label TARGET_LABEL — Send notification email if the label is in inference result. (yes it says email, that's literally what the original says, i don't make the rules 🙈)
  • --broker-ip BROKER_IP — MQTT broker IP. that's the address, that's it, that's the whole thing.
  • --broker-port BROKER_PORT — MQTT broker port. the door number. the vibe check entry point 🚪
  • --topic [TOPIC...] — The topic to listen, and can be indicated multiple times. stack 'em up, one bullet per topic, go off 👑
  • --topic-action TOPIC_ACTION — The action for the indicated topics. so like, what do we DO with those topics, bestie
  • --topic-config TOPIC_CONFIG — Path of the MQTT topic subscription JSON. give her the file, she'll read the topics herself ✨
  • --pipeline-compatible — Change key of b64 image string in generalized result from bytes to image_blob.
⚠️ Note: This is an experimental parameter. experimental!! handle with care, no cap 💀
  • -h, --help — Show summary of options. your little cheat sheet, use her 🌸
  • --debug — Debug mode toggle. flip it on when things are giving chaos 😭

🦋 BUGS 🦋

The upstreams BTS can be found at https://github.com/DT42/BerryNet/issues.

found a bug? don't suffer in silence, go tell the upstream girlies 🫶

⭐ SEE ALSO ⭐

bn_darknet(1), bn_camera(1), bn_gmail(1)

the whole squad, go read them too 💖

🧚 AUTHOR 🧚

Ying-Chun Liu <paulliu@debian.org>

  • Wrote this manpage for the Debian system.

Copyright © 2020 Ying-Chun Liu (PaulLiu)

This manual page was written for the Debian system (and may be used by others).

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or (at your option) any later version published by the Free Software Foundation.

On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL-3.

and that's the tea 🎀✨ this was bn_telegram, page BERRYNET(1), from the bn_telegram User Manual, dated 03/01/2023. slay, stay hydrated, and read your licenses bestie 💖

📦 where this page comes from