Document that hs.wifi.interfaceDetails['bssid'] only appears if hs.lo…

…cation has been started. Closes #2944
Hammerspoon · Dec 13, 2021 · c5259e0 · c5259e0
1 parent f357c47
commit c5259e0
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/extensions/wifi/libwifi.m b/extensions/wifi/libwifi.m
@@ -339,7 +339,7 @@ static int wifi_current_ssid(lua_State* L) {
 ///  * A table containing details about the interface.  The table will contain the following keys:
 ///    * active            - The interface has its corresponding network service enabled.
 ///    * activePHYMode     - The current active PHY mode for the interface.
-///    * bssid             - The current basic service set identifier (BSSID) for the interface.
+///    * bssid             - The current basic service set identifier (BSSID) for the interface. Note that for this key to be available, hs.location needs to have been started
 ///    * cachedScanResults - A table containing the networks currently in the scan cache for the WLAN interface.  See [hs.wifi.backgroundScan](#backgroundScan) for details on the table format.
 ///    * configuration     - A table containing the current configuration for the given WLAN interface.  This table will contain the following keys:
 ///      * networkProfiles                    - A table containing an array of known networks for the interface.  Entries in the array will each contain the following keys: