SFWBAR-WIFI(1)

🎀 NAME 🎀

okay so bestie, meet sfwbar-wifi — it's the Sfwbar Wifi interface 💖 like, the whole vibe is talking to your wifi and making it do stuff.

• Filename: wifi-iwd.so
• Filename: wifi-nm.so
• Requires: none

---

✨ SYNOPSIS ✨

The Wifi module interface is your backstage pass to query and control the wifi network 💅. Right now there are exactly two modules serving up this interface: wifi-iwd, which holds it down for the IWD daemon, and wifi-nm, which does the exact same thing for NetworkManager.

🌸 no cap, important: to use the wifi-iwd module, the user has to have permission to control the iwd daemon. usually you get that by adding the user to the netdev or wheel user group 🌸

---

💫 EXPRESSION FUNCTIONS 💫

WifiGet(Property)

The WifiGet function queries a property for a currently advertised iwd network 👑. These are the properties it supports, and yes, you need all of them:

• "Path" — an object path of the device. this is literally the unique id, and it's what you use to get notifications about changes or destruction of the device, and to control the device. it's only valid once you've received the wifi_updated trigger 🦋
• "RemovedPath" — an object path of the most recently removed device. it gets populated the moment the wifi_removed trigger is emitted 💀
• "SSID" — an SSID of the network 🌈
• "Type" — a Type of the network ('open', 'wep', 'psk' or '8021x')
• "Known" — an indicator of whether this is a known network ("1" = known, "0" = new) 🙈
• "Strength" — signal strength of the network, and it's a string containing a number in range 1-100 ⭐
• "Connected" — an indicator of whether the daemon is connected to the network ("1" = connected, "0" = not connected)

---

🔥 ACTIONS 🔥

WifiScan <Duration>

Initiate scan for wireless networks 🔍 periodt.

WifiAck

Notify the module that all information for the currently advertised network has been processed ✅. once you do that, the module may then emit another wifi_updated event if there are further network updates available.

WifiAckRemoved

Notify the module that all information for the currently advertised network removal has been processed ✅. after that, the module may then emit another wifi_removed event if further network removals are queued.

WifiConnect <path>

Attempt to connect to a network specified by the path 🫶.

WifiDisconnect <path>

Disconnect from a network specified by the path 😭.

WifiForget <path>

Forget a known network specified by the path 💔.

---

🦋 TRIGGERS 🦋

the module defines these triggers, and honestly they're the main characters:

• "wifi_level" — this signal is emitted when signal strength for the current connection changes 📶
• "wifi_updated" — this trigger is emitted when a new network is discovered, or when properties of a network are changed. once it's emitted, the info for the relevant network will be available via the WifiGet expression function. once your config is done handling the network update, it should call the action WifiAck. upon receipt of this action, the module may emit wifi_updated again if further network updates are queued 🔁
• "wifi_removed" — this trigger is emitted when a network is no longer available and should be removed from the layout. the path of the removed network is available via WifiGet("RemovedPath"). once your config is done removing the network, it should call the action WifiAckRemoved. upon receipt of this action, the module may emit another wifi_removed trigger if further networks have been removed 🗑️
• "wifi_scan" — this trigger is emitted when a scan for networks has been initiated ✨
• "wifi_scan_complete" — this trigger is emitted when a scan for networks is complete 🎉

---

👑 COPYRIGHT 👑

GPLv3+ — that's the license, bestie, respect it 💜

---

and that's the whole page 🎀 it lives in the General Commands Manual, and the footer at the bottom just says SFWBAR-WIFI(1) all over again with no date attached, which is very much its own vibe. go forth and control your wifi, you icon 💅