add airport -s parser for issue #46

2026-06-19 22:28:17 +02:00 · 2020-03-10 21:51:02 -07:00
parent 553bfbe1a0
commit 12a370deed
8 changed files with 372 additions and 9 deletions
@@ -1,9 +1,9 @@
 # jc.parsers.airport
-jc - JSON CLI output utility airport Parser
+jc - JSON CLI output utility airport -I Parser

 Usage:

-    specify --airport as the first argument if the piped input is coming from airport (OSX)
+    specify --airport as the first argument if the piped input is coming from airport -I (OSX)

    This program can be found at:
    /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport
@@ -0,0 +1,136 @@
+# jc.parsers.airport_s
+jc - JSON CLI output utility airport -s Parser
+
+Usage:
+
+    specify --airport as the first argument if the piped input is coming from airport -s (OSX)
+
+    This program can be found at:
+    /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport
+
+Compatibility:
+
+    'darwin'
+
+Examples:
+
+    $ airport -s | jc --airport-s -p
+    [
+      {
+        "ssid": "DIRECT-4A-HP OfficeJet 3830",
+        "bssid": "00:67:eb:2a:a7:3b",
+        "rssi": -90,
+        "channel": "6",
+        "ht": true,
+        "cc": "--",
+        "security": [
+          "WPA2(PSK/AES/AES)"
+        ]
+      },
+      {
+        "ssid": "Latitude38",
+        "bssid": "c0:ff:d5:d2:7a:f3",
+        "rssi": -85,
+        "channel": "11",
+        "ht": true,
+        "cc": "US",
+        "security": [
+          "WPA2(PSK/AES/AES)"
+        ]
+      },
+      {
+        "ssid": "xfinitywifi",
+        "bssid": "6e:e3:0e:b8:45:99",
+        "rssi": -83,
+        "channel": "11",
+        "ht": true,
+        "cc": "US",
+        "security": [
+          "NONE"
+        ]
+      },
+      ...
+    ]
+
+    $ airport -s | jc --airport -p -r
+    [
+      {
+        "ssid": "DIRECT-F3-HP ENVY 5660 series",
+        "bssid": "b0:5a:da:6f:0a:d4",
+        "rssi": "-93",
+        "channel": "1",
+        "ht": "Y",
+        "cc": "--",
+        "security": "WPA2(PSK/AES/AES)"
+      },
+      {
+        "ssid": "YouAreInfected-5",
+        "bssid": "5c:e3:0e:c2:85:da",
+        "rssi": "-85",
+        "channel": "36",
+        "ht": "Y",
+        "cc": "US",
+        "security": "WPA(PSK/AES,TKIP/TKIP) WPA2(PSK/AES,TKIP/TKIP)"
+      },
+      {
+        "ssid": "YuanFamily",
+        "bssid": "5c:e3:0e:b8:5f:9a",
+        "rssi": "-84",
+        "channel": "11",
+        "ht": "Y",
+        "cc": "US",
+        "security": "WPA(PSK/AES,TKIP/TKIP) WPA2(PSK/AES,TKIP/TKIP)"
+      },
+      ...
+    ]
+
+## info
+```python
+info(self, /, *args, **kwargs)
+```
+
+## process
+```python
+process(proc_data)
+```
+
+Final processing to conform to the schema.
+
+Parameters:
+
+    proc_data:   (dictionary) raw structured data to process
+
+Returns:
+
+    List of dictionaries. Structured data with the following schema:
+    [
+      {
+        "ssid":      string,
+        "bssid":     string,
+        "rssi":      integer,
+        "channel":   string,
+        "ht":        boolean,
+        "cc":        string,
+        "security": [
+                     string,
+        ]
+      }
+    ]
+
+## parse
+```python
+parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) output preprocessed JSON if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of dictionaries. Raw or processed structured data.
+