Skip to main content

Pure-Python interface for WIZNET 5k ethernet modules.

Project description

Introduction

Documentation Status Discord Build Status

Pure-Python interface for WIZNET 5k ethernet modules.

NOTE: This library does not currently contain a DNS client. You will need to include a server ip address and destination port in your code.

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 .env
source .env/bin/activate
pip3 install adafruit-circuitpython-wiznet5k

Usage Example

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

import time

import board
import busio
import digitalio
from adafruit_wiznet5k.adafruit_wiznet5k import WIZNET
import adafruit_wiznet5k.adafruit_wiznet5k_socket as socket

# Name address for wifitest.adafruit.com
SERVER_ADDRESS = (('104.236.193.178'), 80)

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

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

print("DHCP Assigned IP: ", eth.pretty_ip(eth.ip_address))

socket.set_interface(eth)

# Create a new socket
sock = socket.socket()

print("Connecting to: ", SERVER_ADDRESS[0])
sock.connect(SERVER_ADDRESS)

print("Connected to ", sock.getpeername())

# Make a HTTP Request
sock.send(b"GET /testwifi/index.html HTTP/1.1\n")
sock.send(b"Host: 104.236.193.178\n")
sock.send(b"Connection: close\n\n")

bytes_avail = 0
while not bytes_avail:
    bytes_avail = sock.available()
    if bytes_avail > 0:
        data = sock.recv(bytes_avail)
        print(data)
        break
    time.sleep(0.05)

Contributing

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

Documentation

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

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-1.0.0a0.tar.gz (30.9 kB view details)

Uploaded Source

File details

Details for the file adafruit-circuitpython-wiznet5k-1.0.0a0.tar.gz.

File metadata

  • Download URL: adafruit-circuitpython-wiznet5k-1.0.0a0.tar.gz
  • Upload date:
  • Size: 30.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.1

File hashes

Hashes for adafruit-circuitpython-wiznet5k-1.0.0a0.tar.gz
Algorithm Hash digest
SHA256 a692af5207f48912721f076cd41ee6769caacdf84edb0405ac262e10e35a78a2
MD5 e5aaa7afa97c489dfefc9be1d5934e76
BLAKE2b-256 7f2bbd34e1cc59c72db60bcbf6c10136bb3e4cf530d55b286eae0b8eff1ad12d

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