Skip to content

Commit

Permalink
Wifi Entity for Linux and Mac (richibrics#111)
Browse files Browse the repository at this point in the history 
* init fanspeed and first mock

* working for linux, still wip

* add readme and todos

* rename venv to be ignored

* cleanup

* remove debug prints

* add Rotation ValueFormat as rpm

* rename and create link to Deployments

* change to hardlink, add units, move test to correct location, update images

* addd .vsode

* move network to deploy

* ignore .code-workspace

* update class organization

* update methods

* first mock of config and wifi signal strength update

* remove vscoe dev dir

* cleanup workspace

* restore gitignore to head

* if wireless from iwconfig "interfacename" output

* first speed calculations

* separate Wifi from network entity

* add pattern matching for iwconfig

* linux wifi implementation working

* checkSystemSupport for linux

* chcekSystemSupport windows

* add valueformatter, uppdate extra keys, first half of updates

* add todo

* RunCommand to OsD

* rearrange fix percent and dbm

* windows implementation feature complete, needs refactoring

* remove network fix linux implementation

* cleanup

* move logic to checksystemspport

* check returncode instead of output

* windows fix

* show only available attributes

* HAss entity properties

* Fix extra attribute and macos: regex, command, language

* macos: use full airport path

* Remove Hass unit

* change configuration for windows

* change locale to defaultlocale for windows support. fix problems on windows

* reduce amount of extraAttributes, cleanup

* ctypes boilerplate

* first mock ctypes

* iw switch

* macos systemsupport check fix

* refactor for linux, remove windows stuff

* refactoring for linux and mac support

* format extra attributes with their respecting options

---------

Co-authored-by: infeeeee <[email protected]>
Co-authored-by: Riccardo Briccola <[email protected]>
  • Loading branch information
@lockenkop @infeeeee @richibrics
3 people authored Jun 19, 2024
1 parent 0b72833 commit d2899c2
Show file tree
Hide file tree
Showing 8 changed files with 377 additions and 22 deletions.
2 changes: 1 addition & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ IoTuring/Configurator/configurations.json*
IoTuring/Configurator/dontmoveconf.itg*
.venv
build
*.egg-info
*.egg-info
6 changes: 3 additions & 3 deletions IoTuring/Configurator/Configurator.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ def OpenConfigInEditor(self):
editor_command = next(
(e for e in editors if OsD.CommandExists(e)), "")
if editor_command:
subprocess.run(f'{editor_command} "{config_path}"',
shell=True, close_fds=True)
return
OsD.RunCommand(f'{editor_command} "{config_path}"',
shell=True, close_fds=True, capture_output=False)
return

self.Log(self.LOG_WARNING, "No editor found")

Expand Down
270 changes: 270 additions & 0 deletions IoTuring/Entity/Deployments/Wifi/Wifi.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,270 @@
import re
from socket import AddressFamily

import psutil
import locale

from IoTuring.Configurator.MenuPreset import MenuPreset
from IoTuring.Entity.Entity import Entity
from IoTuring.Entity.EntityData import EntitySensor
from IoTuring.Entity.ValueFormat import ValueFormatterOptions
from IoTuring.MyApp.SystemConsts import OperatingSystemDetection as OsD

VALUEFORMATTEROPTIONS_DBM = ValueFormatterOptions(ValueFormatterOptions.TYPE_RADIOPOWER)
VALUEFORMATTEROPTIONS_BYTES = ValueFormatterOptions(ValueFormatterOptions.TYPE_BYTE)
VALUEFORMATTEROPTIONS_BIT_PER_SECOND = ValueFormatterOptions(ValueFormatterOptions.TYPE_BIT_PER_SECOND)

WIFI_CHOICE_STRING = "Name: {:<15}, IP: {:<16}, MAC: {:<11}"

CONFIG_KEY_WIFI = "wifi"

SIGNAL_UNIT = "dBm" # windows also supports "%"
SHOW_NA = False # don't show not available extraAttributes

KEY_SIGNAL_STRENGTH_DBM = "signal_strength_dbm"

# LINUX
EXTRA_KEY_NAME = "name"
EXTRA_KEY_DESCRIPTION = "description"
EXTRA_KEY_PHYSICAL_ADDRESS = "physical_address"
EXTRA_KEY_STATE = "state"
EXTRA_KEY_BSSID = "BSSID"
EXTRA_KEY_SSID = "ssid"
EXTRA_KEY_FREQUENCY = "Frequency"
EXTRA_KEY_SIGNAL = "Signal"
EXTRA_KEY_RX_BYTES = "RX_Bytes"
EXTRA_KEY_TX_BYTES = "TX_Bytes"
EXTRA_KEY_RX_BITRATE = "RX_Bitrate"
EXTRA_KEY_TX_BITRATE = "TX_Bitrate"
EXTRA_KEY_BSS_FLAGS = "BSS_Flags"
EXTRA_KEY_DTIM_PERIOD = "DTIM_Period"
EXTRA_KEY_BEACON_INTERVAL = "Beacon_Interval"

# MACOS
EXTRA_KEY_AGRCTLRSSI = "agrCtlRSSI"
EXTRA_KEY_AGREXTRSSI = "agrExtRSSI"
# state already in linux config
EXTRA_KEY_OP_MODE = "OP_mode"
EXTRA_KEY_LASTTXRATE = "Last_TX_Rate"
EXTRA_KEY_MAXRATE = "Max_Rate"
# BSSID already in linux config
# SSID already in linux config
EXTRA_KEY_CHANNEL = "Channel"



class Wifi(Entity):
NAME = "Wifi"
ALLOW_MULTI_INSTANCE = True

def Initialize(self):
self.platform = OsD.GetOs()
self.locale_str, _ = locale.getdefaultlocale()
self.language: str = self.locale_str.split("_")[0]
self.showNA = SHOW_NA

self.wifiInterface = self.GetFromConfigurations(CONFIG_KEY_WIFI)

self.commands = {
OsD.LINUX: ["iw", "dev", self.wifiInterface, "link"],
OsD.MACOS: [
"/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport",
"-I",
],
}
self.patterns = {
OsD.LINUX: {
"BSSID": r'Connected to (\S+) \(on \S+\)',
"SSID": r'SSID: (.+)',
"Frequency": r'freq: ([\d.]+)',
"RX_bytes": r'RX: (\d+) bytes \(\d+ packets\)',
"TX_bytes": r'TX: (\d+) bytes \(\d+ packets\)',
"Signal": r'signal: (-?\d+) dBm',
"RX_bitrate": r'rx bitrate: ([\d.]+) MBit/s',
"TX_bitrate": r'tx bitrate: ([\d.]+) MBit/s',
"BSS_flags": r'bss flags: (.+)',
"DTIM_period": r'dtim period: (\d+)',
"Beacon_interval": r'beacon int: (\d+)'
},
OsD.MACOS: { # no language differentiation in macos: always english
"agrCtlRSSI": r"[^\n][\s]*agrCtlRSSI:\s+(-?\d+)\n",
"agrExtRSSI": r"[^\n][\s]*agrExtRSSI:\s+(-?\d+)\n",
"state": r"[^\n][\s]*state:\s+(\w+)\n",
"op mode": r"[^\n][\s]*op mode:\s+(\w+)\n",
"lastTxRate": r"[^\n][\s]*lastTxRate:\s+(\d+)\n",
"maxRate": r"[^\n][\s]*maxRate:\s+(\d+)\n",
"BSSID": r"[^\n][\s]*BSSID:\s+([\w:]+)\n",
"SSID": r"\n[\s]*SSID:\s+([\w\s]+)\n",
"channel": r"[^\n][\s]*channel:\s+([\d,]+)\n",
},
}

self.keySignalStrength = KEY_SIGNAL_STRENGTH_DBM

self.valueFormatterOptions: dict = {
KEY_SIGNAL_STRENGTH_DBM : VALUEFORMATTEROPTIONS_DBM,
EXTRA_KEY_RX_BITRATE : VALUEFORMATTEROPTIONS_BIT_PER_SECOND,
EXTRA_KEY_RX_BYTES : VALUEFORMATTEROPTIONS_BYTES
}

self.RegisterEntitySensor(
EntitySensor(
self,
key=self.keySignalStrength,
supportsExtraAttributes=True,
valueFormatterOptions=self.valueFormatterOptions[KEY_SIGNAL_STRENGTH_DBM],
),
)

def Update(self):
p = self.RunCommand(self.commands[self.platform])
if not p.stdout:
raise Exception("error in GetWirelessInfo\n", p.stderr)
wifiInfo = self.GetWirelessInfo(p.stdout)
if not wifiInfo:
raise Exception("error while parsing wirelessInfo")
# set signal strength
elif self.platform == OsD.LINUX and "Signal" in wifiInfo:
self.SetEntitySensorValue(
key=self.keySignalStrength, value=wifiInfo["Signal"]
)
elif self.platform == OsD.MACOS and "agrCtlRSSI" in wifiInfo:
self.SetEntitySensorValue(
key=self.keySignalStrength, value=wifiInfo["agrCtlRSSI"]
)
else: # if there is no signal level found the interface might not be connected to an access point
self.SetEntitySensorValue(key=self.keySignalStrength, value="not connected")

# Extra attributes
for key in self.patterns[self.platform]:
extraKey = "EXTRA_KEY_" + key.upper().replace(" ", "_").replace(".", "_")
if key in wifiInfo:
attributevalue = wifiInfo[key]
elif self.showNA:
attributevalue = "not available"
else:
continue

self.SetEntitySensorExtraAttribute(
sensorDataKey=self.keySignalStrength,
attributeKey=globals()[extraKey],
attributeValue=attributevalue,
valueFormatterOptions = self.valueFormatterOptions[extraKey] if extraKey in self.valueFormatterOptions else None
)

def GetWirelessInfo(self, stdout):
wifi_info = {}
for key, pattern in self.patterns[self.platform].items():
match = re.search(pattern, stdout, re.IGNORECASE)
if match:
wifi_info[key] = match.group(1) if match.group(1) else match.group(0)
return wifi_info

@classmethod
def ConfigurationPreset(cls) -> MenuPreset:
NIC_CHOICES = Wifi.GetWifiNics(getInfo=True)

preset = MenuPreset()
preset.AddEntry(
name="Interface to check",
key=CONFIG_KEY_WIFI,
mandatory=True,
question_type="select",
choices=NIC_CHOICES,
)
return preset

@staticmethod
def GetWifiNics(getInfo=True):
interfaces = psutil.net_if_addrs()
NIC_CHOICES = []

def appendNicChoice(interfaceName, nicip4="", nicip6="", nicmac=""):
NIC_CHOICES.append(
{
"name": WIFI_CHOICE_STRING.format(
interfaceName,
nicip4 if nicip4 else nicip6, # defaults to showing ipv4
nicmac,
),
"value": interfaceName,
}
)

ip4 = ""
ip6 = ""
mac = ""

if OsD.IsLinux():
for interface in interfaces:
p = OsD.RunCommand(["iw", "dev", interface, "link"])
if (
p.returncode > 0
): # if the returncode is 0 iwconfig succeeded, else continue with next interface
continue
if not getInfo:
appendNicChoice(interface)
continue
else:
nicinfo = interfaces[interface] # TODO Typehint
for nicaddr in nicinfo:
if nicaddr.family == AddressFamily.AF_INET:
ip4 = nicaddr.address
continue
elif nicaddr.family == AddressFamily.AF_INET6:
ip6 = nicaddr.address
continue
elif nicaddr.family == psutil.AF_LINK:
mac = nicaddr.address
continue
appendNicChoice(interface, ip4, ip6, mac)
return NIC_CHOICES

elif OsD.IsMacos():
for interface in interfaces:
p = OsD.RunCommand(["airport", interface])
if (
p.returncode > 0
): # if the returncode is 0 iwconfig succeeded, else continue with next interface
continue
nicinfo = interfaces[interface] # TODO Typehint
if not getInfo:
appendNicChoice(interface)
continue
else:
for nicaddr in nicinfo:
if nicaddr.family == AddressFamily.AF_INET:
ip4 = nicaddr.address
continue
elif nicaddr.family == AddressFamily.AF_INET6:
ip6 = nicaddr.address
continue
elif nicaddr.family == psutil.AF_LINK:
mac = nicaddr.address
continue

appendNicChoice(interface, ip4, ip6, mac)
return NIC_CHOICES

@classmethod
def CheckSystemSupport(cls):
if OsD.IsLinux():
if not OsD.CommandExists("iw"):
raise Exception("iw not found")
wifiNics = Wifi.GetWifiNics(getInfo=False)
if not wifiNics:
raise Exception("no wireless interface found")

elif OsD.IsWindows():
# Windows support is WIP https://github.com/richibrics/IoTuring/pull/89
raise Exception("Windows is not supported at the moment")

elif OsD.IsMacos():
if not OsD.CommandExists("/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport"):
raise Exception("airport not found")
wifiNics = Wifi.GetWifiNics(getInfo=False)
if not wifiNics:
raise Exception("no wireless interface found")

else:
raise Exception("OS detection failed")
20 changes: 3 additions & 17 deletions IoTuring/Entity/Entity.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,29 +187,14 @@ def RunCommand(self,
subprocess.CompletedProcess: See subprocess docs
"""

# different defaults than in subprocess:
defaults = {
"capture_output": True,
"text": True
}

for param, value in defaults.items():
if param not in kwargs:
kwargs[param] = value

try:
if shell == False and isinstance(command, str):
runcommand = command.split()
else:
runcommand = command

if command_name:
command_name = self.NAME + "-" + command_name
else:
command_name = self.NAME

p = subprocess.run(
runcommand, shell=shell, **kwargs)
p = OsD.RunCommand(command, shell=shell, **kwargs)

self.Log(self.LOG_DEBUG, f"Called {command_name} command: {p}")

Expand All @@ -218,11 +203,12 @@ def RunCommand(self,
if p.stderr:
self.Log(error_loglevel,
f"Error during {command_name} command: {p.stderr}")

return p

except Exception as e:
raise Exception(f"Error during {command_name} command: {str(e)}")

return p

@classmethod
def CheckSystemSupport(cls):
Expand Down
Loading

0 comments on commit d2899c2

Please sign in to comment.