uxplay-beacon - Man Page

Python (>= 3.6) script for a Bluetooth LE Service-Discovery beacon.

Synopsis

uxplay-beacon.py [BlueIO] [ -h, --help] + more options.

Description

UxPlay 1.73.6: Standalone Python Script for Bluetooth LE Service Discovery
Modules for BLE support:

BlueZ: (Linux, with D-Bus)
winrt: (Windows)
BleuIO: (for a BleuIO USB serial device, all platforms, including macOS).
HCI: Use Host Controller Interface (Linux/*BSD, needs elevated privileges)

The best choice for host platform is made unless option BleuIO or HCI is used.

Options

<module>    Force use of non-default <module> = [BleuIO,HCI]

--file
fn   Specify configuration file (default: ~/.uxplay.beacon)
--path
fn   Specify a non-default Bluetooth LE data file used by uxplay
--ipv4
ip   Override automatically-found ipv4 address for contacting UxPlay
--advmin
x  Minimum Advertising interval in msecs (>= 100)
--advmax
y  Maximum Advertising interval in msecs (>= advmin, <= 102400)
--index
x   Used to distinguish different instances of BlueZ beacons
--device
p  Specify an address for a required device
-h,  --help
Show help text.

Files

Options in configuration file are applied first (command-line options may modify them).

Format:  one option per line, with initial  "--"; lines beginning with "#" ignored.

Authors

Various, see website or distribution.

See Also

Website: <https://github.com/FDH2/UxPlay>

Info

2026-03-22 UxPlay 1.73.6