'\" t
.\"     Title: Berrynet
.\"    Author: Ying-Chun Liu <paulliu@debian.org>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 02/12/2021
.\"    Manual: bn_telegram User Manual
.\"    Source: bn_telegram
.\"  Language: English
.\"
.TH "BERRYNET" "1" "02/12/2021" "bn_telegram" "bn_telegram User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bn_telegram \- program to send deep learning results from MQTT to telegram
.SH "SYNOPSIS"
.HP \w'\fBbn_telegram\fR\ 'u
\fBbn_telegram\fR \fB\-\-token\ \fR\fB\fITOKEN\fR\fR [\fB\-\-target\-label\ \fR\fB\fITARGET_LABEL\fR\fR] [\fB\-\-broker\-ip\ \fR\fBBROKER_IP\fR] [\fB\-\-broker\-port\ \fR\fBBROKER_PORT\fR] [\fB\-\-topic\ \fR\fB[\fITOPIC\fR...]\fR] [\fB\-\-topic\-action\ \fR\fBTOPIC_ACTION\fR] [\fB\-\-topic\-config\ \fR\fBTOPIC_CONFIG\fR]
.HP \w'\fBbn_telegram\fR\ 'u
\fBbn_telegram\fR [{\fB\-h\fR\ |\ \fB\-\-help\fR} | {\fB\-\-debug\fR}]
.SH "DESCRIPTION"
.PP
This manual page documents briefly the
\fBbn_telegram\fR
command\&.
.PP
This manual page was written for the Debian distribution because the original program does not have a manual page\&.
.PP
\fBbn_telegram\fR
is a program that send results to telegram\&.
.SH "OPTIONS"
.PP
The program follows the usual GNU command line syntax, with long options starting with two dashes (`\-\*(Aq)\&. A summary of options is included below\&.
.PP
\fB\-\-token \fR\fB\fITOKEN\fR\fR
.RS 4
Telegram token got from BotFather, or filepath of a JSON config file with token\&.
.RE
.PP
\fB\-\-target\-label \fR\fB\fITARGET_LABEL\fR\fR
.RS 4
Send notification email if the label is in inference result\&.
.RE
.PP
\fB\-\-broker\-ip \fR\fB\fIBROKER_IP\fR\fR
.RS 4
MQTT broker IP\&.
.RE
.PP
\fB\-\-broker\-port \fR\fB\fIBROKER_PORT\fR\fR
.RS 4
MQTT broker port\&.
.RE
.PP
\fB\-\-topic \fR\fB[\fITOPIC\fR...]\fR
.RS 4
The topic to listen, and can be indicated multiple times\&.
.RE
.PP
\fB\-\-topic\-action \fR\fB\fITOPIC_ACTION\fR\fR
.RS 4
The action for the indicated topics\&.
.RE
.PP
\fB\-\-topic\-config \fR\fB\fITOPIC_CONFIG\fR\fR
.RS 4
Path of the MQTT topic subscription JSON\&.
.RE
.PP
\fB\-\-pipeline\-compatible\fR
.RS 4
Change key of b64 image string in generalized result from bytes to image_blob\&. Note: This is an experimental parameter\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Show summary of options\&.
.RE
.PP
\fB\-\-debug\fR
.RS 4
Debug mode toggle\&.
.RE
.SH "BUGS"
.PP
The upstreams
BTS
can be found at
\m[blue]\fB\%https://github.com/DT42/BerryNet/issues\fR\m[]\&.
.SH "SEE ALSO"
.PP
\fBbn_darknet\fR(1),
\fBbn_camera\fR(1),
\fBbn_gmail\fR(1)
.SH "AUTHOR"
.PP
\fBYing\-Chun Liu\fR <\&paulliu@debian\&.org\&>
.RS 4
Wrote this manpage for the Debian system\&.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2020 Ying-Chun Liu (PaulLiu)
.br
.PP
This manual page was written for the Debian system (and may be used by others)\&.
.PP
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\&.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in
/usr/share/common\-licenses/GPL\-3\&.
.sp