WIZNEt -> WIZNET5K to match https://circuitpython.readthedocs.io/en/latest/shared-bindings/wiznet/wiznet5k.html

Author: brentru

adafruit_wiznet5k/adafruit_wiznet5k.py

@@ -137,8 +137,8 @@
             'remote_ip': 0,
             'remote_port': 0}
 
-class WIZNET:
-    """Interface for WIZNET5k module.
+class WIZNET5K:
+    """Interface for WIZNET5K module.
     :param ~busio.SPI spi_bus: The SPI bus the Wiznet module is connected to.
     :param ~digitalio.DigitalInOut cs: Chip select pin.
     :param ~digitalio.DigitalInOut rst: Optional reset pin.

adafruit_wiznet5k/adafruit_wiznet5k_dhcp.py

@@ -75,7 +75,7 @@
 BROADCAST_SERVER_ADDR = 255, 255, 255, 255
 
 # pylint: enable=bad-whitespace
-_buff = bytearray(317)
+_BUFF = bytearray(317)
 
 class DHCP:
     """W5k DHCP Client implementation.
@@ -87,7 +87,7 @@ class DHCP:
 
     """
 
-    # pylint: disable=too-many-arguments, too-many-instance-attributes
+    # pylint: disable=too-many-arguments, too-many-instance-attributes, invalid-name
     def __init__(self, eth, mac_address, timeout=1, timeout_response=1):
         self._timeout = timeout
         self._response_timeout = timeout_response
@@ -124,95 +124,95 @@ def send_dhcp_message(self, state, time_elapsed):
                                   attempted to acquire/renew a lease.
         """
         # OP
-        _buff[0] = DHCP_BOOT_REQUEST
+        _BUFF[0] = DHCP_BOOT_REQUEST
         # HTYPE
-        _buff[1] = DHCP_HTYPE10MB
+        _BUFF[1] = DHCP_HTYPE10MB
         # HLEN
-        _buff[2] = DHCP_HLENETHERNET
+        _BUFF[2] = DHCP_HLENETHERNET
         # HOPS
-        _buff[3] = DHCP_HOPS
+        _BUFF[3] = DHCP_HOPS
 
         # Transaction ID (xid)
         self._initial_xid = htonl(self._transaction_id)
         self._initial_xid = self._initial_xid.to_bytes(4, 'l')
-        _buff[4:7] = self._initial_xid
+        _BUFF[4:7] = self._initial_xid
 
         # seconds elapsed
-        _buff[8] = ((int(time_elapsed) & 0xff00) >> 8)
-        _buff[9] = (int(time_elapsed) & 0x00ff)
+        _BUFF[8] = ((int(time_elapsed) & 0xff00) >> 8)
+        _BUFF[9] = (int(time_elapsed) & 0x00ff)
 
         # flags
         flags = htons(0x8000)
         flags = flags.to_bytes(2, 'b')
-        _buff[10] = flags[1]
-        _buff[11] = flags[0]
+        _BUFF[10] = flags[1]
+        _BUFF[11] = flags[0]
 
         # NOTE: Skipping cidaddr/yiaddr/siaddr/giaddr
         # as they're already set to 0.0.0.0
 
         # chaddr
-        _buff[28:34] = self._mac_address
+        _BUFF[28:34] = self._mac_address
 
         # NOTE:  192 octets of 0's, BOOTP legacy
 
         # Magic Cookie
-        _buff[236] = ((MAGIC_COOKIE >> 24)& 0xFF)
-        _buff[237] = ((MAGIC_COOKIE >> 16)& 0xFF)
-        _buff[238] = ((MAGIC_COOKIE >> 8)& 0xFF)
-        _buff[239] = (MAGIC_COOKIE& 0xFF)
+        _BUFF[236] = ((MAGIC_COOKIE >> 24)& 0xFF)
+        _BUFF[237] = ((MAGIC_COOKIE >> 16)& 0xFF)
+        _BUFF[238] = ((MAGIC_COOKIE >> 8)& 0xFF)
+        _BUFF[239] = (MAGIC_COOKIE& 0xFF)
 
         # Option - DHCP Message Type
-        _buff[240] = 53
-        _buff[241] = 0x01
-        _buff[242] = state
+        _BUFF[240] = 53
+        _BUFF[241] = 0x01
+        _BUFF[242] = state
 
         # Option - Client Identifier
-        _buff[243] = 61
+        _BUFF[243] = 61
         # Length
-        _buff[244] = 0x07
+        _BUFF[244] = 0x07
         # HW Type - ETH
-        _buff[245] = 0x01
+        _BUFF[245] = 0x01
         # Client MAC Address
         for mac in range(0, len(self._mac_address)):
-            _buff[246+mac] = self._mac_address[mac]
+            _BUFF[246+mac] = self._mac_address[mac]
 
         # Option - Host Name
-        _buff[252] = 12
-        _buff[253] = len(b"Wiznet") + 6
-        _buff[254:260] = b"WIZnet"
+        _BUFF[252] = 12
+        _BUFF[253] = len(b"Wiznet") + 6
+        _BUFF[254:260] = b"WIZnet"
 
         for mac in range(0, 5):
-            _buff[260+mac] = self._mac_address[mac]
+            _BUFF[260+mac] = self._mac_address[mac]
 
         if state == DHCP_REQUEST:
             # Set the parsed local IP addr
-            _buff[266] = 50
-            _buff[267] = 0x04
+            _BUFF[266] = 50
+            _BUFF[267] = 0x04
 
-            _buff[268:272] = self.local_ip
+            _BUFF[268:272] = self.local_ip
             # Set the parsed dhcp server ip addr
-            _buff[272] = 54
-            _buff[273] = 0x04
-            _buff[274:278] = self.dhcp_server_ip
+            _BUFF[272] = 54
+            _BUFF[273] = 0x04
+            _BUFF[274:278] = self.dhcp_server_ip
 
-        _buff[278] = 55
-        _buff[279] = 0x06
+        _BUFF[278] = 55
+        _BUFF[279] = 0x06
         # subnet mask
-        _buff[280] = 1
+        _BUFF[280] = 1
         # routers on subnet
-        _buff[281] = 3
+        _BUFF[281] = 3
         # DNS
-        _buff[282] = 6
+        _BUFF[282] = 6
         # domain name
-        _buff[283] = 15
+        _BUFF[283] = 15
         # renewal (T1) value
-        _buff[284] = 58
+        _BUFF[284] = 58
         # rebinding (T2) value
-        _buff[285] = 59
-        _buff[286] = 255
+        _BUFF[285] = 59
+        _BUFF[286] = 255
 
         # Send DHCP packet
-        self._sock.send(_buff)
+        self._sock.send(_BUFF)
 
     def parse_dhcp_response(self, response_timeout):
         """Parse DHCP response from DHCP server.
@@ -228,44 +228,44 @@ def parse_dhcp_response(self, response_timeout):
                 return 255
             time.sleep(0.05)
         # store packet in buffer
-        _buff = self._sock.recv(packet_sz)[0]
+        _BUFF = self._sock.recv(packet_sz)[0]
 
         # Check OP, if valid, let's parse the packet out!
-        assert _buff[0] == DHCP_BOOT_REPLY, "Malformed Packet - \
+        assert _BUFF[0] == DHCP_BOOT_REPLY, "Malformed Packet - \
             DHCP message OP is not expected BOOT Reply."
 
         # Client Hardware Address (CHADDR)
         chaddr = bytearray(6)
         for mac, _ in enumerate(chaddr):
-            chaddr[mac] = _buff[28+mac]
+            chaddr[mac] = _BUFF[28+mac]
 
         if chaddr != 0:
-            xid = _buff[4:8]
+            xid = _BUFF[4:8]
             if bytes(xid) < self._initial_xid:
                 return 0, 0
 
         # Your IP Address (YIADDR)
-        self.local_ip = _buff[16:20]
+        self.local_ip = _BUFF[16:20]
 
         # Gateway IP Address (GIADDR)
-        self.gateway_ip = _buff[20:24]
+        self.gateway_ip = _BUFF[20:24]
 
         # NOTE: Next 192 octets are 0's for BOOTP legacy
 
         # DHCP Message Type
-        msg_type = _buff[242]
+        msg_type = _BUFF[242]
         # DHCP Server ID
-        self.dhcp_server_ip = _buff[245:249]
+        self.dhcp_server_ip = _BUFF[245:249]
         # Lease Time, in seconds
-        self._lease_time = int.from_bytes(_buff[251:255], 'l')
+        self._lease_time = int.from_bytes(_BUFF[251:255], 'l')
         # T1 value
-        self._t1 = int.from_bytes(_buff[257:261], 'l')
+        self._t1 = int.from_bytes(_BUFF[257:261], 'l')
         # T2 value
-        self._t2 = int.from_bytes(_buff[263:267], 'l')
+        self._t2 = int.from_bytes(_BUFF[263:267], 'l')
         # Subnet Mask
-        self.subnet_mask = _buff[269:273]
+        self.subnet_mask = _BUFF[269:273]
         # DNS Server
-        self.dns_server_ip = _buff[285:289]
+        self.dns_server_ip = _BUFF[285:289]
 
         return msg_type, xid
 

examples/wiznet5k_simpletest.py

@@ -3,7 +3,7 @@
 import board
 import busio
 import digitalio
-from adafruit_wiznet5k.adafruit_wiznet5k import WIZNET
+from adafruit_wiznet5k.adafruit_wiznet5k import WIZNET5K
 import adafruit_wiznet5k.adafruit_wiznet5k_socket as socket
 
 # Name address for wifitest.adafruit.com
@@ -13,7 +13,7 @@
 spi_bus = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
 
 # Initialize ethernet interface with DHCP
-eth = WIZNET(spi_bus, cs)
+eth = WIZNET5K(spi_bus, cs)
 
 print("DHCP Assigned IP: ", eth.pretty_ip(eth.ip_address))