BERRYNET(1)

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

✨ BERRYNET(1) β€” the bn_dashboard glow-up ✨

okay bestie, pull up a chair, we're reading a manual page together and honestly? it's giving iconic. this one lives in section 1 of the manual (that's "user commands", iykyk), and it's all about bn_dashboard. πŸ’–


🌸 NAME 🌸

bn_dashboard β€” a program to display results from MQTT πŸ¦‹


πŸŽ€ SYNOPSIS πŸŽ€

bn_dashboard [--data-dirpath DATA_DIRPATH] [--broker-ip BROKER_IP]
             [--broker-port BROKER_PORT] [--topic [TOPIC...]]
             [--topic-action TOPIC_ACTION] [--topic-config TOPIC_CONFIG]
             [--no-decoration] [--no-full-screen] [--debug-save-frame]

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

πŸ’… DESCRIPTION πŸ’…

so this manual page documents bn_dashboard briefly. that's literally the whole assignment, no cap.

fun lore drop: this manual page was written for the Debian distribution because the original program does not have a manual page. so yeah, we're the ones who showed up with the notes. πŸ“

bn_dashboard is a program that display results. that's it, that's the vibe. ✨


πŸ‘‘ OPTIONS πŸ‘‘

the program follows the usual GNU command line syntax, with long options starting with two dashes (`-`). a summary of options is included below, and bestie, we are going through all of them, no skipping. 🫢

  • --data-dirpath DATA_DIRPATH β€” dirpath where to store collected data. that's the folder, your data goes in it. πŸ“‚
  • --broker-ip BROKER_IP β€” MQTT broker IP. the address of the broker, periodt. πŸ“‘
  • --broker-port BROKER_PORT β€” MQTT broker port. the port number of that same broker. πŸ”Œ
  • --topic [TOPIC...] β€” the topic to listen, and it can be indicated multiple times. so yes, you can stack them. 🎧
  • --topic-action TOPIC_ACTION β€” the action for the indicated topics. ⚑
  • --topic-config TOPIC_CONFIG β€” path of the MQTT topic subscription JSON. πŸ“„
  • --no-decoration β€” display image in payload without applying result information. raw pic energy, no extras. πŸ–ΌοΈ
  • --no-full-screen β€” display fbdashboard in a window. windowed mode, she's small but mighty. πŸͺŸ
  • -h, --help β€” show summary of options. hi, hello, here's the menu. πŸ‘‹
  • --debug β€” debug mode toggle. flip it. πŸ”§
  • --debug-save-frame β€” save frames for debugging. ⚠️ --debug also needs to be set. so don't be out here using this one alone, it needs its plus-one. πŸ’€

πŸ’€ BUGS πŸ’€

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

so if something's cursed, that's where the receipts live. πŸ™ˆ


🌈 SEE ALSO 🌈

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

(the squad. the ensemble cast. go read them too.) πŸ’œ


🧚 AUTHOR 🧚

Ying-Chun Liu <paulliu@debian.org>

  • wrote this manpage for the Debian system. 🫑

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 was bn_dashboard from the bn_dashboard User Manual, dated 03/01/2023. slay, stay hydrated, and may all your MQTT topics behave. πŸŽ€πŸ¦‹πŸŒΈ

πŸ“¦ where this page comes from