BERRYNET(1)

πŸ“¦
version 3.10.2 Β· 3 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu questing

πŸ’Œ BERRYNET(1) β€” the bn_gmail era πŸ’Œ

okay bestie, so this is the manual page for bn_gmail, living under the bn_gmail User Manual umbrella in the BerryNet universe. pull up a chair, grab a boba, we're doing this πŸ§‹βœ¨


✨ NAME ✨

bn_gmail β€” the program that sends your deep learning results from MQTT straight to gmail. like, it's giving personal assistant energy fr fr πŸ’…


πŸŽ€ SYNOPSIS πŸŽ€

bn_gmail --sender-address SENDER_ADDRESS
         --sender-password SENDER_PASSWORD
         --receiver-address RECEIVER_ADDRESS --target-label TARGET_LABEL
         [--broker-ip BROKER_IP] [--broker-port BROKER_PORT]
         [--topic [TOPIC...]] [--topic-action TOPIC_ACTION]
         [--topic-config TOPIC_CONFIG] [--pipeline-compatible]

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

so basically: first form = do the thing. second form = help or debug, pick your fighter ✌️


🌸 DESCRIPTION 🌸

okay so this manual page documents briefly the bn_gmail command. brief queen. short and sweet. slay.

lowkey important lore: this manual page was written for the Debian distribution because the original program does not have a manual page. so we made one. you're welcome 🫢

bn_gmail is a program that send results to gmail. (yes bestie, that grammar is the original's, we don't touch the facts πŸ’€)


πŸ’– OPTIONS πŸ’–

the program follows the usual GNU command line syntax, with long options starting with two dashes (-). a summary of options is included below. no cap, here's the whole roster πŸ‘‘

  • --sender-address SENDER_ADDRESS β€” email address of sender. Ex: foo@email.org
  • --sender-password SENDER_PASSWORD β€” password of sender email address. keep it secret, keep it safe πŸ”
  • --receiver-address RECEIVER_ADDRESS β€” email address of receiver. Ex: bar@email.org~ (yes the tilde is literally in the example, we keep it exactly, iconic πŸ’…)
  • --target-label TARGET_LABEL β€” send notification email if the label is in inference result. like a little vibe check on your detection results ✨
  • --broker-ip BROKER_IP β€” MQTT broker IP.
  • --broker-port BROKER_PORT β€” MQTT broker port.
  • --topic [TOPIC...] β€” the topic to listen, and can be indicated multiple times. stack 'em up 🧚
  • --topic-action TOPIC_ACTION β€” the action for the indicated topics.
  • --topic-config TOPIC_CONFIG β€” path of the MQTT topic subscription JSON.
  • --pipeline-compatible β€” change key of b64 image string in generalized result from bytes to image_blob.
⚠️ Note: this is an experimental parameter. it's giving beta-test main character energy, so don't be shocked if it does experimental things πŸ™ˆ
  • -h, --help β€” show summary of options. the classic "help me bestie" button πŸ†˜
  • --debug β€” debug mode toggle. flip it, watch the chaos πŸ”₯

πŸ¦‹ BUGS πŸ¦‹

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

(found a bug? tell the upstreams, not me, i'm just the messenger 🫢)


🌈 SEE ALSO 🌈

bn_darknet(1), bn_camera(1), bn_data_collector(1)

the whole friend group, honestly. go say hi πŸ‘―β€β™€οΈ


πŸ’œ AUTHOR πŸ’œ

Ying-Chun Liu <paulliu@debian.org>

  • wrote this manpage for the Debian system. absolute legend behavior πŸ‘‘

Copyright Β© 2018 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 whole page bestie!! πŸŽ€ this one's from the bn_gmail manual, version-flavored 03/01/2023, stamped BERRYNET(1) at the top and bottom. mwah, go send some emails πŸ’Œβœ¨

πŸ“¦ where this page comes from