Files
UxPlay/Bluetooth_LE_beacon/uxplay-beacon.1
2026-03-09 02:12:36 -04:00

55 lines
1.6 KiB
Groff

.TH UXPLAY 1 2026-01-26 "UxPlay 1.73" "User Commands"
.SH NAME
uxplay-beacon.py \- Python (>= 3.6) script for a Bluetooth LE Service-Discovery beacon.
.SH SYNOPSIS
.B uxplay-beacon.py
[BlueIO] [\fI\, -h, --help] + more options.
.SH DESCRIPTION
.TP
UxPlay 1.73: Standalone Python Script for Bluetooth LE Service Discovery
.nf
Modules for BLE support:
BlueZ: (Linux, with D-Bus)
winrt: (Windows)
BleuIO: (for a BleuIO USB serial device, all platforms, including macOS).
The best choice for host platform is made unless option BleuIO is used.
.SH OPTIONS
.TP
.B
\fB\ BleuIO\fR Force the use of a BleuIO device
.TP
\fB\--file\fR fn Specify configuration file (default: ~/.uxplay.beacon)
.TP
\fB\--path\fR fn Specify a non-default Bluetooth LE data file used by uxplay
.TP
\fB\--ipv4\fR ip Override automatically-found ipv4 address for contacting UxPlay
.TP
\fB\--AdvMin\fR x Minimum Advertising interval in msecs (>= 100)
.TP
\fB\--AdvMax\fR y Maximum Advertising interval in msecs (>= AdvMin, <= 102400)
.TP
\fB\--index\fR x Used to distinguish different instances of beacons
.TP
\fB\--serial\fR p Override automatically-found serial port for BleuIO device
.TP
\fB \-h, --help\fR Show help text.
.SH
FILES
Options in configuration file are applied first (command-line options may modify them).
.TP
Format: one option per line, with initial "--"; lines beginning with "#" ignored.
.SH
AUTHORS
.TP
Various, see website or distribution.
.SH
COPYRIGHT
.TP
Various, see website or distribution. License: GPL v3+:
.TP
GNU GPL version 3 or later. (some parts LGPL v.2.1+ or MIT).
.SH
SEE ALSO
.TP
Website: <https://github.com/FDH2/UxPlay>