Skip to main content

Pure-Python interface for WIZNET 5k ethernet modules.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

Pure-Python interface for WIZNET 5k ethernet modules.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-wiznet5k

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-wiznet5k

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-wiznet5k

Usage Example

This example demonstrates making a HTTP GET request to wifitest.adafruit.com.

import board
import busio
import digitalio
import adafruit_requests as requests
from adafruit_wiznet5k.adafruit_wiznet5k import WIZNET5K
import adafruit_wiznet5k.adafruit_wiznet5k_socket as socket

print("Wiznet5k WebClient Test")

TEXT_URL = "http://wifitest.adafruit.com/testwifi/index.html"
JSON_URL = "http://api.coindesk.com/v1/bpi/currentprice/USD.json"

cs = digitalio.DigitalInOut(board.D10)
spi_bus = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)

# Initialize ethernet interface with DHCP
eth = WIZNET5K(spi_bus, cs)

# Initialize a requests object with a socket and ethernet interface
requests.set_socket(socket, eth)

print("Chip Version:", eth.chip)
print("MAC Address:", [hex(i) for i in eth.mac_address])
print("My IP address is:", eth.pretty_ip(eth.ip_address))
print("IP lookup adafruit.com: %s" %eth.pretty_ip(eth.get_host_by_name("adafruit.com")))


#eth._debug = True
print("Fetching text from", TEXT_URL)
r = requests.get(TEXT_URL)
print('-'*40)
print(r.text)
print('-'*40)
r.close()

print()
print("Fetching json from", JSON_URL)
r = requests.get(JSON_URL)
print('-'*40)
print(r.json())
print('-'*40)
r.close()

print("Done!")

This example demonstrates a simple web server that allows setting the Neopixel color.

import board
import busio
import digitalio
import neopixel

from adafruit_wiznet5k.adafruit_wiznet5k import WIZNET5K
import adafruit_wiznet5k.adafruit_wiznet5k_wsgiserver as server
from adafruit_wsgi.wsgi_app import WSGIApp

print("Wiznet5k Web Server Test")

# Status LED
led = neopixel.NeoPixel(board.NEOPIXEL, 1)
led.brightness = 0.3
led[0] = (0, 0, 255)

# W5500 connections
cs = digitalio.DigitalInOut(board.D10)
spi_bus = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)

# Initialize Ethernet interface with DHCP
eth = WIZNET5K(spi_bus, cs)

# Here we create our application, registering the
# following functions to be called on specific HTTP GET requests routes

web_app = WSGIApp()

@web_app.route("/led/<r>/<g>/<b>")
def led_on(request, r, g, b):
    print("LED handler")
    led.fill((int(r), int(g), int(b)))
    return ("200 OK", [], ["LED set!"])

@web_app.route("/")
def root(request):
    print("Root handler")
    return ("200 OK", [], ["Root document"])

@web_app.route("/large")
def large(request):
    print("Large pattern handler")
    return ("200 OK", [], ["*-.-" * 2000])


# Here we setup our server, passing in our web_app as the application
server.set_interface(eth)
wsgiServer = server.WSGIServer(80, application=web_app)

print("Open this IP in your browser: ", eth.pretty_ip(eth.ip_address))

# Start the server
wsgiServer.start()
while True:
    # Our main loop where we have the server poll for incoming requests
    wsgiServer.update_poll()
    # Maintain DHCP lease
    eth.maintain_dhcp_lease()
    # Could do any other background tasks here, like reading sensors

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

License

This library was written by Arduino LLC. We’ve converted it to work with CircuitPython and made changes so it works similarly to CircuitPython’s WIZNET5k wrapper for the WIZnet 5500 Ethernet interface and CPython’s Socket low-level networking interface module.

This open source code is licensed under the LGPL license (see LICENSE for details).

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-wiznet5k-2.5.2.tar.gz (69.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-wiznet5k-2.5.2.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-wiznet5k-2.5.2.tar.gz
Algorithm Hash digest
SHA256 ce10dc2a60396992808613ce6b2e81cd6468b280a04b12f22e5fe09fe8cbbe80
MD5 4cf137626035cfe9775b188f5a954fce
BLAKE2b-256 0e4a1c7660a7b0b9b3a6c2e5a2dcd2187941cd29d9444398f9cf33ded81b25a4

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_wiznet5k-2.5.2-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_wiznet5k-2.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 64aed93487a8baf698ae64364fcbc0baad6172655662a38fc06da6e26b179a98
MD5 edab3b82cbc9b72bece14756e6c45582
BLAKE2b-256 894653fe4eab4e5135684f108335b28d06f27d6c15761b1d83163c200b37a45d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page