LUASTATUS-PLUGIN-DBUS(7)

💖 NAME 💖

okay so this is the luastatus-plugin-dbus(7) page from the Miscellaneous Information Manual — and it’s literally the D-Bus plugin for luastatus, bestie. 💅

✨ OVERVIEW ✨

This plugin subscribes to D-Bus signals. That’s the whole vibe check: it’s here to listen for signals and hand them to your widget. 🦋

🎀 OPTIONS 🎀

The following options are supported, no cap:

• greet: boolean — whether or not a first call to cb with what="hello" should be made as soon as the widget starts. Defaults to false. 🫶
• timeout: number — if specified and not negative, this plugin calls cb with what="timeout" if no D-Bus signal has been received in timeout seconds. ⏰
• signals: array of tables — an array of tables with the following entries (all are optional, bestie):
  • sender: string — sender name to match on (unique or well-known name).
  • interface: string — D-Bus interface name to match on.
  • signal: string — D-Bus signal name to match on.
  • object_path: string — object path to match on.
  • arg0: string — contents of first string argument to match on.
  • flags: array of strings — the following flags are recognized:
    • "match_arg0_namespace" — match first arguments that contain a bus or interface name with the given namespace.
    • "match_arg0_path" — match first arguments that contain an object path that is either equivalent to the given path, or one of the paths is a subpath of the other.
  • bus: string — specify the bus to subscribe to the signal on: either "system" or "session"; default is "session". 🌈

🦋 CB ARGUMENT 🦋

A table with a what entry. It’s giving “here’s what just happened” energy:

• If what is "hello", this is the first call to cb (only if the greet option was set to true). 👋
• If what is "timeout", a signal has not been received for the number of seconds specified as the timeout option. 😭
• If what is "signal", a signal has been received. In this case, the table has the following additional entries:
  • sender: string — unique sender name.
  • object_path: string — object path.
  • interface: string — D-Bus interface name.
  • signal: string — signal name.
  • parameters: D-Bus object — signal arguments. 🫶

🌸 D-BUS OBJECTS 🌸

D-Bus objects are marshalled as follows:

• boolean → boolean
• byte, int16, uint16, int32, uint32, int64, uint64 → string
• double → number
• string, object path, signature → string
• maybe → as-is, or as a special object with value "nothing"
• handle → special object with value "handle"
• array, tuple, dict entry → array

If an object cannot be marshalled, a special object with an error is generated instead. 💀

🧚 SPECIAL OBJECTS 🧚

Special objects represent D-Bus objects that cannot be marshalled to Lua.

A special object is a function that, when called, returns either of:

• value;
• nil, error.

👑 COPYRIGHT 👑

LGPLv3

---

that’s the whole page, bestie — luastatus-plugin-dbus(7) signing off 💅✨ (the footer is just that manual name; no extra version/date tea in the source 🫶)