UXPLAY(1)

📦
version 1.73.7 · 2 versions
, in fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu stonking

💖 UXPLAY — uxplay-beacon.py 💖

okay bestie, welcome to the UXPLAY(1) manual page (User Commands energy, we love that for us) 🦋 this is your little group chat briefing on uxplay-beacon.py, the Bluetooth LE beacon script. no cap, it's short, it's sweet, and it's about to be your new obsession. let's get into it ✨

✨ NAME ✨

uxplay-beacon.py — a Python (>= 3.6) script that does a Bluetooth LE Service-Discovery beacon. that's it. that's the whole vibe. 💅

🌸 SYNOPSIS 🌸

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

yeah, she's got options. more options than you can hold in one hand. keep scrolling, bestie 🫶

💜 DESCRIPTION 💜

UxPlay 1.73.6 — Standalone Python Script for Bluetooth LE Service Discovery 👑

so like, there's Modules for BLE support, and you get to pick your fighter:

  • BlueZ: for Linux, and it rides with D-Bus 🐧
  • winrt: for Windows 🪟
  • BleuIO: for a BleuIO USB serial device — and this one works on all platforms, including macOS 🍓
  • HCI: uses the Host Controller Interface, for Linux/*BSD, and heads up bestie it needs elevated privileges (yes, that means sudo. main character energy, but with consequences) 😭
🫶 good news: the best choice for your host platform gets picked for you automatically — unless you go and use the BleuIO or HCI option. then it's on you, diva.

✨ OPTIONS ✨

here's the whole roster, no gatekeeping, no skips 💖

  • <module> — forces the use of a non-default <module>, and your choices are = [BleuIO,HCI] ✨
  • --file fn — points to your configuration file (the default is ~/.uxplay.beacon) 🎀
  • --path fn — sets a non-default Bluetooth LE data file, the one used by uxplay 🦋
  • --ipv4 ip — overrides the automatically-found ipv4 address for contacting UxPlay 🌸
  • --advmin x — minimum Advertising interval in msecs, and it has to be >= 100 ⭐
  • --advmax y — maximum Advertising interval in msecs, and it has to be >= advmin and <= 102400 👑
  • --index x — used to tell different instances of BlueZ beacons apart (iconic, honestly) 💅
  • --device p — specifies an address for a required device 🌈
  • -h, --help — shows you the help text, the classic 🫶

🎀 FILES 🎀

real talk: the options in the configuration file get applied first, and then command-line options may modify them. so order matters, bestie 💜

the Format is giving very simple, very chic:

  • one option per line
  • with an initial "--" at the start
  • and any lines beginning with "#" are ignored (comments, we love a self-care line) 🙈

🌸 AUTHORS 🌸

Various, see website or distribution. lowkey a mystery, highkey a legend 🧚

Various, see website or distribution. License: GPL v3+ 💖

  • GNU GPL version 3 or later. (some parts LGPL v.2.1+ or MIT).

🌈 SEE ALSO 🌈

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

and that's the whole page, bestie! this was UxPlay 1.73.6, dated 2026-03-22, filed under UXPLAY(1) 💅✨ slay, go beacon something, and remember: elevated privileges are a privilege, not a personality trait 🫶💖

📦 where this page comes from