Module lib.wifi.accesspoint
Classes used to manage the wifi access point
Expand source code
# Distributed under Pycameresp License
# Copyright (c) 2023 Remi BERTHOLET
# pylint:disable=consider-using-f-string
""" Classes used to manage the wifi access point """
import sys
import wifi.hostname
import wifi.ip
import tools.jsonconfig
import tools.strings
import tools.logger
class AccessPointConfig(tools.jsonconfig.JsonConfig):
""" Access point configuration class """
def __init__(self):
""" Constructor """
tools.jsonconfig.JsonConfig.__init__(self)
self.activated = False
self.wifi_password = b""
self.ssid = b""
self.authmode = b"WPA2-PSK"
self.ip_address = b"192.168.3.1"
self.netmask = b"255.255.255.0"
self.gateway = b"192.168.3.1"
self.dns = b"192.168.3.1"
def __repr__(self):
""" Display accesspoint informations """
# Get network address
ip_address, netmask, gateway, dns = AccessPoint.wlan.ifconfig()
result = "%s:\n"%tools.strings.tostrings(self.__class__.__name__)
result +=" Ip address :%s\n"%ip_address
result +=" Netmask :%s\n"%netmask
result +=" Gateway :%s\n"%gateway
result +=" Dns :%s\n"%dns
result +=" Ssid :%s\n"%tools.strings.tostrings(self.ssid)
result +=" Password :%s\n"%tools.strings.tostrings(self.wifi_password)
result +=" Authmode :%s\n"%tools.strings.tostrings(self.authmode)
result +=" Activated :%s\n"%tools.strings.tostrings(self.activated)
return result
class AccessPoint:
""" Class to manage access point """
config = None
wlan = None
@staticmethod
def open(ssid=None, password=None, authmode=None):
""" Open access point """
# pylint:disable=multiple-statements
if ssid is not None: AccessPoint.config.ssid = tools.strings.tobytes(ssid)
if password is not None: AccessPoint.config.wifi_password = tools.strings.tobytes(password)
if authmode is not None: AccessPoint.config.authmode = tools.strings.tobytes(authmode)
authmode = wifi.AUTHMODE_DEFAULT
for authmode_num, authmode_name in wifi.AUTHMODE.items():
if authmode_name == AccessPoint.config.authmode:
authmode = authmode_num
break
if sys.platform != "rp2":
AccessPoint.wlan.active(True) # IMPORTANT : For esp32 activate before configure
try:
AccessPoint.wlan.config(\
essid = tools.strings.tostrings(AccessPoint.config.ssid),
password = tools.strings.tostrings(AccessPoint.config.wifi_password),
security = authmode)
except Exception as err:
tools.logger.syslog(err)
if sys.platform == "rp2":
AccessPoint.wlan.active(True) # IMPORTANT : For esp32 activate before configure
@staticmethod
def reload_config():
""" Reload configuration if it changed """
if AccessPoint.config is None:
AccessPoint.config = AccessPointConfig()
if AccessPoint.config.load() is False:
AccessPoint.config.ssid = b"esp%05d"%wifi.hostname.Hostname.get_number()
AccessPoint.config.wifi_password = b"Pycam_%05d"%wifi.hostname.Hostname.get_number()
AccessPoint.config.save()
tools.logger.syslog("Access point not initialized")
else:
AccessPoint.config.refresh()
return AccessPoint.config
@staticmethod
def close():
""" Close access point """
AccessPoint.wlan.active(False)
@staticmethod
def is_active():
""" Indicates if the access point is active or not """
if AccessPoint.wlan is None:
return False
return AccessPoint.wlan.active()
@staticmethod
def is_activated():
""" Indicates if the access point is configured to be activated """
AccessPoint.reload_config()
return AccessPoint.config.activated
@staticmethod
def get_info():
""" Get wifi station informations """
if AccessPoint.wlan is not None and AccessPoint.wlan.active():
return AccessPoint.wlan.ifconfig()
return None
@staticmethod
def configure(ip_address = None, netmask = None, gateway = None, dns = None):
""" Configure the access point """
# pylint:disable=multiple-statements
if ip_address is not None: AccessPoint.config.ip_address = tools.strings.tobytes(ip_address)
if netmask is not None: AccessPoint.config.netmask = tools.strings.tobytes(netmask)
if gateway is not None: AccessPoint.config.gateway = tools.strings.tobytes(gateway)
if dns is not None: AccessPoint.config.dns = tools.strings.tobytes(dns)
if AccessPoint.config.ip_address == b"": AccessPoint.config.ip_address = tools.strings.tobytes(AccessPoint.wlan.ifconfig()[0])
if AccessPoint.config.netmask == b"": AccessPoint.config.netmask = tools.strings.tobytes(AccessPoint.wlan.ifconfig()[1])
if AccessPoint.config.gateway == b"": AccessPoint.config.gateway = tools.strings.tobytes(AccessPoint.wlan.ifconfig()[2])
if AccessPoint.config.dns == b"": AccessPoint.config.dns = tools.strings.tobytes(AccessPoint.wlan.ifconfig()[3])
if AccessPoint.config.ip_address == b"0.0.0.0": AccessPoint.config.ip_address = b""
if AccessPoint.config.netmask == b"0.0.0.0": AccessPoint.config.netmask = b""
if AccessPoint.config.gateway == b"0.0.0.0": AccessPoint.config.gateway = b""
if AccessPoint.config.dns == b"0.0.0.0": AccessPoint.config.dns = b""
try:
if AccessPoint.config.ip_address != b"" and \
AccessPoint.config.netmask != b"" and \
AccessPoint.config.gateway != b"" and \
AccessPoint.config.dns != b"":
if sys.platform != "rp2":
AccessPoint.wlan.ifconfig((
tools.strings.tostrings(AccessPoint.config.ip_address),
tools.strings.tostrings(AccessPoint.config.netmask),
tools.strings.tostrings(AccessPoint.config.gateway),
tools.strings.tostrings(AccessPoint.config.dns)))
except Exception as err:
tools.logger.syslog(err, msg="Cannot configure wifi access point")
@staticmethod
def start(force=False):
""" Start the access point according to the configuration. Force is used to skip configuration activation flag """
result = False
if AccessPoint.is_active() is False:
AccessPoint.reload_config()
if AccessPoint.config.activated or force:
tools.logger.syslog("Start access point")
from network import WLAN, AP_IF
AccessPoint.wlan = WLAN(AP_IF)
AccessPoint.configure()
AccessPoint.open()
print(repr(AccessPoint.config))
result = True
else:
tools.logger.syslog("Access point disabled")
else:
print("%s already opened"%AccessPoint.__class__.__name__)
print(repr(AccessPoint.config))
result = True
return result
@staticmethod
def stop():
""" Stop access point """
if AccessPoint.is_active():
tools.logger.syslog("Stop access point")
AccessPoint.close()
@staticmethod
def is_ip_on_interface(ipAddr):
""" Indicates if the address ip is connected to the wifi access point """
ipInterface = AccessPoint.get_info()
if ipInterface is not None:
return wifi.ip.issameinterface(tools.strings.tostrings(ipAddr), ipInterface[0], ipInterface[1])
return FalseClasses
class AccessPoint-
Class to manage access point
Expand source code
class AccessPoint: """ Class to manage access point """ config = None wlan = None @staticmethod def open(ssid=None, password=None, authmode=None): """ Open access point """ # pylint:disable=multiple-statements if ssid is not None: AccessPoint.config.ssid = tools.strings.tobytes(ssid) if password is not None: AccessPoint.config.wifi_password = tools.strings.tobytes(password) if authmode is not None: AccessPoint.config.authmode = tools.strings.tobytes(authmode) authmode = wifi.AUTHMODE_DEFAULT for authmode_num, authmode_name in wifi.AUTHMODE.items(): if authmode_name == AccessPoint.config.authmode: authmode = authmode_num break if sys.platform != "rp2": AccessPoint.wlan.active(True) # IMPORTANT : For esp32 activate before configure try: AccessPoint.wlan.config(\ essid = tools.strings.tostrings(AccessPoint.config.ssid), password = tools.strings.tostrings(AccessPoint.config.wifi_password), security = authmode) except Exception as err: tools.logger.syslog(err) if sys.platform == "rp2": AccessPoint.wlan.active(True) # IMPORTANT : For esp32 activate before configure @staticmethod def reload_config(): """ Reload configuration if it changed """ if AccessPoint.config is None: AccessPoint.config = AccessPointConfig() if AccessPoint.config.load() is False: AccessPoint.config.ssid = b"esp%05d"%wifi.hostname.Hostname.get_number() AccessPoint.config.wifi_password = b"Pycam_%05d"%wifi.hostname.Hostname.get_number() AccessPoint.config.save() tools.logger.syslog("Access point not initialized") else: AccessPoint.config.refresh() return AccessPoint.config @staticmethod def close(): """ Close access point """ AccessPoint.wlan.active(False) @staticmethod def is_active(): """ Indicates if the access point is active or not """ if AccessPoint.wlan is None: return False return AccessPoint.wlan.active() @staticmethod def is_activated(): """ Indicates if the access point is configured to be activated """ AccessPoint.reload_config() return AccessPoint.config.activated @staticmethod def get_info(): """ Get wifi station informations """ if AccessPoint.wlan is not None and AccessPoint.wlan.active(): return AccessPoint.wlan.ifconfig() return None @staticmethod def configure(ip_address = None, netmask = None, gateway = None, dns = None): """ Configure the access point """ # pylint:disable=multiple-statements if ip_address is not None: AccessPoint.config.ip_address = tools.strings.tobytes(ip_address) if netmask is not None: AccessPoint.config.netmask = tools.strings.tobytes(netmask) if gateway is not None: AccessPoint.config.gateway = tools.strings.tobytes(gateway) if dns is not None: AccessPoint.config.dns = tools.strings.tobytes(dns) if AccessPoint.config.ip_address == b"": AccessPoint.config.ip_address = tools.strings.tobytes(AccessPoint.wlan.ifconfig()[0]) if AccessPoint.config.netmask == b"": AccessPoint.config.netmask = tools.strings.tobytes(AccessPoint.wlan.ifconfig()[1]) if AccessPoint.config.gateway == b"": AccessPoint.config.gateway = tools.strings.tobytes(AccessPoint.wlan.ifconfig()[2]) if AccessPoint.config.dns == b"": AccessPoint.config.dns = tools.strings.tobytes(AccessPoint.wlan.ifconfig()[3]) if AccessPoint.config.ip_address == b"0.0.0.0": AccessPoint.config.ip_address = b"" if AccessPoint.config.netmask == b"0.0.0.0": AccessPoint.config.netmask = b"" if AccessPoint.config.gateway == b"0.0.0.0": AccessPoint.config.gateway = b"" if AccessPoint.config.dns == b"0.0.0.0": AccessPoint.config.dns = b"" try: if AccessPoint.config.ip_address != b"" and \ AccessPoint.config.netmask != b"" and \ AccessPoint.config.gateway != b"" and \ AccessPoint.config.dns != b"": if sys.platform != "rp2": AccessPoint.wlan.ifconfig(( tools.strings.tostrings(AccessPoint.config.ip_address), tools.strings.tostrings(AccessPoint.config.netmask), tools.strings.tostrings(AccessPoint.config.gateway), tools.strings.tostrings(AccessPoint.config.dns))) except Exception as err: tools.logger.syslog(err, msg="Cannot configure wifi access point") @staticmethod def start(force=False): """ Start the access point according to the configuration. Force is used to skip configuration activation flag """ result = False if AccessPoint.is_active() is False: AccessPoint.reload_config() if AccessPoint.config.activated or force: tools.logger.syslog("Start access point") from network import WLAN, AP_IF AccessPoint.wlan = WLAN(AP_IF) AccessPoint.configure() AccessPoint.open() print(repr(AccessPoint.config)) result = True else: tools.logger.syslog("Access point disabled") else: print("%s already opened"%AccessPoint.__class__.__name__) print(repr(AccessPoint.config)) result = True return result @staticmethod def stop(): """ Stop access point """ if AccessPoint.is_active(): tools.logger.syslog("Stop access point") AccessPoint.close() @staticmethod def is_ip_on_interface(ipAddr): """ Indicates if the address ip is connected to the wifi access point """ ipInterface = AccessPoint.get_info() if ipInterface is not None: return wifi.ip.issameinterface(tools.strings.tostrings(ipAddr), ipInterface[0], ipInterface[1]) return FalseClass variables
var configvar wlan
Static methods
def close()-
Close access point
Expand source code
@staticmethod def close(): """ Close access point """ AccessPoint.wlan.active(False) def configure(ip_address=None, netmask=None, gateway=None, dns=None)-
Configure the access point
Expand source code
@staticmethod def configure(ip_address = None, netmask = None, gateway = None, dns = None): """ Configure the access point """ # pylint:disable=multiple-statements if ip_address is not None: AccessPoint.config.ip_address = tools.strings.tobytes(ip_address) if netmask is not None: AccessPoint.config.netmask = tools.strings.tobytes(netmask) if gateway is not None: AccessPoint.config.gateway = tools.strings.tobytes(gateway) if dns is not None: AccessPoint.config.dns = tools.strings.tobytes(dns) if AccessPoint.config.ip_address == b"": AccessPoint.config.ip_address = tools.strings.tobytes(AccessPoint.wlan.ifconfig()[0]) if AccessPoint.config.netmask == b"": AccessPoint.config.netmask = tools.strings.tobytes(AccessPoint.wlan.ifconfig()[1]) if AccessPoint.config.gateway == b"": AccessPoint.config.gateway = tools.strings.tobytes(AccessPoint.wlan.ifconfig()[2]) if AccessPoint.config.dns == b"": AccessPoint.config.dns = tools.strings.tobytes(AccessPoint.wlan.ifconfig()[3]) if AccessPoint.config.ip_address == b"0.0.0.0": AccessPoint.config.ip_address = b"" if AccessPoint.config.netmask == b"0.0.0.0": AccessPoint.config.netmask = b"" if AccessPoint.config.gateway == b"0.0.0.0": AccessPoint.config.gateway = b"" if AccessPoint.config.dns == b"0.0.0.0": AccessPoint.config.dns = b"" try: if AccessPoint.config.ip_address != b"" and \ AccessPoint.config.netmask != b"" and \ AccessPoint.config.gateway != b"" and \ AccessPoint.config.dns != b"": if sys.platform != "rp2": AccessPoint.wlan.ifconfig(( tools.strings.tostrings(AccessPoint.config.ip_address), tools.strings.tostrings(AccessPoint.config.netmask), tools.strings.tostrings(AccessPoint.config.gateway), tools.strings.tostrings(AccessPoint.config.dns))) except Exception as err: tools.logger.syslog(err, msg="Cannot configure wifi access point") def get_info()-
Get wifi station informations
Expand source code
@staticmethod def get_info(): """ Get wifi station informations """ if AccessPoint.wlan is not None and AccessPoint.wlan.active(): return AccessPoint.wlan.ifconfig() return None def is_activated()-
Indicates if the access point is configured to be activated
Expand source code
@staticmethod def is_activated(): """ Indicates if the access point is configured to be activated """ AccessPoint.reload_config() return AccessPoint.config.activated def is_active()-
Indicates if the access point is active or not
Expand source code
@staticmethod def is_active(): """ Indicates if the access point is active or not """ if AccessPoint.wlan is None: return False return AccessPoint.wlan.active() def is_ip_on_interface(ipAddr)-
Indicates if the address ip is connected to the wifi access point
Expand source code
@staticmethod def is_ip_on_interface(ipAddr): """ Indicates if the address ip is connected to the wifi access point """ ipInterface = AccessPoint.get_info() if ipInterface is not None: return wifi.ip.issameinterface(tools.strings.tostrings(ipAddr), ipInterface[0], ipInterface[1]) return False def open(ssid=None, password=None, authmode=None)-
Open access point
Expand source code
@staticmethod def open(ssid=None, password=None, authmode=None): """ Open access point """ # pylint:disable=multiple-statements if ssid is not None: AccessPoint.config.ssid = tools.strings.tobytes(ssid) if password is not None: AccessPoint.config.wifi_password = tools.strings.tobytes(password) if authmode is not None: AccessPoint.config.authmode = tools.strings.tobytes(authmode) authmode = wifi.AUTHMODE_DEFAULT for authmode_num, authmode_name in wifi.AUTHMODE.items(): if authmode_name == AccessPoint.config.authmode: authmode = authmode_num break if sys.platform != "rp2": AccessPoint.wlan.active(True) # IMPORTANT : For esp32 activate before configure try: AccessPoint.wlan.config(\ essid = tools.strings.tostrings(AccessPoint.config.ssid), password = tools.strings.tostrings(AccessPoint.config.wifi_password), security = authmode) except Exception as err: tools.logger.syslog(err) if sys.platform == "rp2": AccessPoint.wlan.active(True) # IMPORTANT : For esp32 activate before configure def reload_config()-
Reload configuration if it changed
Expand source code
@staticmethod def reload_config(): """ Reload configuration if it changed """ if AccessPoint.config is None: AccessPoint.config = AccessPointConfig() if AccessPoint.config.load() is False: AccessPoint.config.ssid = b"esp%05d"%wifi.hostname.Hostname.get_number() AccessPoint.config.wifi_password = b"Pycam_%05d"%wifi.hostname.Hostname.get_number() AccessPoint.config.save() tools.logger.syslog("Access point not initialized") else: AccessPoint.config.refresh() return AccessPoint.config def start(force=False)-
Start the access point according to the configuration. Force is used to skip configuration activation flag
Expand source code
@staticmethod def start(force=False): """ Start the access point according to the configuration. Force is used to skip configuration activation flag """ result = False if AccessPoint.is_active() is False: AccessPoint.reload_config() if AccessPoint.config.activated or force: tools.logger.syslog("Start access point") from network import WLAN, AP_IF AccessPoint.wlan = WLAN(AP_IF) AccessPoint.configure() AccessPoint.open() print(repr(AccessPoint.config)) result = True else: tools.logger.syslog("Access point disabled") else: print("%s already opened"%AccessPoint.__class__.__name__) print(repr(AccessPoint.config)) result = True return result def stop()-
Stop access point
Expand source code
@staticmethod def stop(): """ Stop access point """ if AccessPoint.is_active(): tools.logger.syslog("Stop access point") AccessPoint.close()
class AccessPointConfig-
Access point configuration class
Constructor
Expand source code
class AccessPointConfig(tools.jsonconfig.JsonConfig): """ Access point configuration class """ def __init__(self): """ Constructor """ tools.jsonconfig.JsonConfig.__init__(self) self.activated = False self.wifi_password = b"" self.ssid = b"" self.authmode = b"WPA2-PSK" self.ip_address = b"192.168.3.1" self.netmask = b"255.255.255.0" self.gateway = b"192.168.3.1" self.dns = b"192.168.3.1" def __repr__(self): """ Display accesspoint informations """ # Get network address ip_address, netmask, gateway, dns = AccessPoint.wlan.ifconfig() result = "%s:\n"%tools.strings.tostrings(self.__class__.__name__) result +=" Ip address :%s\n"%ip_address result +=" Netmask :%s\n"%netmask result +=" Gateway :%s\n"%gateway result +=" Dns :%s\n"%dns result +=" Ssid :%s\n"%tools.strings.tostrings(self.ssid) result +=" Password :%s\n"%tools.strings.tostrings(self.wifi_password) result +=" Authmode :%s\n"%tools.strings.tostrings(self.authmode) result +=" Activated :%s\n"%tools.strings.tostrings(self.activated) return resultAncestors
- tools.jsonconfig.JsonConfig