org.bluez...ngManager(5)

πŸ¦‹ org.bluez.LEAdvertisingManager πŸ¦‹

okay bestie so this is the page for org.bluez...ngManager(5), straight out of the Linux System Administration manual (yes, that's the manual mane, we stan) πŸ’…. Buckle up, we're learning the BlueZ D-Bus LEAvertisingManager API documentation together and honestly it's giving main character energy ✨


🌸 Name 🌸

  • org.bluez.LEAdvertisingManager β€” BlueZ D-Bus LEAvertisingManager API documentation 🫢 (that's the whole name section, we ate and left no crumbs)

πŸŽ€ Interface πŸŽ€

So the Advertising Manager? It's literally the plug πŸ”₯. It lets external applications register Advertisement Data that should be broadcast to devices. And no cap β€” Advertisement Data elements must follow the API for LE Advertisement Data described above. like, that's non-negotiable bestie πŸ’œ

⭐ Service

  • org.bluez

⭐ Interface

  • org.bluez.LEAdvertisingManager1

⭐ Object path

  • /org/bluez/{hci0,hci1,...}

⭐ Used by


✨ Methods ✨

πŸ€– void RegisterAdvertisement(object advertisement, dict options)

Registers an advertisement object to be sent over the LE Advertising channel. Iconic behaviour, honestly πŸ‘‘

Yo, heads up: the service must implement the org.bluez.LEAdvertisement(5) interface. No ifs, no buts, iykyk 🧚

Possible errors (aka the vibe check failures 😭):

  • org.bluez.Error.InvalidArguments β€” indicates that the object has invalid or conflicting properties.
  • org.bluez.Error.AlreadyExists β€” indicates the object is already registered. like bestie it's already in the group chat πŸ™ˆ
  • org.bluez.Error.InvalidLength β€” indicates that the data provided generates a data packet which is too long. too much text, no thoughts, packet said "I'm full" πŸ’€
  • org.bluez.Error.NotPermitted β€” indicates the maximum number of advertisement instances has been reached. capacity is capacity, periodt βœ‹

Examples:

bluetoothctl
       > advertise <on/off/type>

πŸ€– void UnregisterAdvertisement(object advertisement)

Unregisters an advertisement that has been previously registered using RegisterAdvertisement(). It's the "leave the group chat" button, and honestly sometimes you gotta 🌈

The object path parameter must match the same value that has been used on registration. Same path or it's not gonna work, bestie πŸ’…

Possible errors:

  • org.bluez.Error.InvalidArguments
  • org.bluez.Error.DoesNotExist

πŸ”₯ Properties πŸ”₯

πŸ’– byte ActiveInstances [readonly]

Number of active advertising instances. literally just a count, but a cute one πŸŽ€

πŸ’– byte SupportedInstances [readonly]

Number of available advertising instances.

πŸ’– array{string} SupportedIncludes [readonly]

List of supported system includes. πŸ¦‹

Possible values:

  • "tx-power"
  • "appearance"
  • "local-name"
  • "rsi"

πŸ’– array{string} SupportedSecondaryChannels [readonly]

List of supported Secondary channels. Secondary channels can be used to advertise with the corresponding PHY. fancy stuff, obsessed ⭐

Possible values:

  • "1M"
  • "2M"
  • "Coded"

πŸ’– dict SupportedCapabilities [readonly]

Enumerates Advertising-related controller capabilities useful to the client. it's literally the controller's resume πŸ“„βœ¨

Possible Values:

  • byte MaxAdvLen β€” Max advertising data length
  • byte MaxScnRspLen β€” Max advertising scan response length
  • int16 MinTxPower β€” Min advertising tx power (dBm)
  • int16 MaxTxPower β€” Max advertising tx power (dBm)

πŸ’– array{string} SupportedFeatures [readonly,optional]

List of supported platform features. If no features are available on the platform, the SupportedFeatures array will be empty. an empty array is still valid, we don't shame 🫢

Possible values:

  • "CanSetTxPower" β€” Indicates whether platform can specify tx power on each advertising instance.
  • "HardwareOffload" β€” Indicates whether multiple advertising will be offloaded to the controller.

aaaand that's the whole page, bestie πŸ’œ no notes, we understood the assignment. brought to you by BlueZ, dated October 2023 β€” slay forever, mwah 😘🌸

πŸ“¦ where this page comes from