Introduction¶
CircuitPython driver library for using ESP32 as WiFi co-processor using SPI. The companion firmware is available on GitHub. Please be sure to check the example code for any specific firmware version dependencies that may exist.
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-esp32spi
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-esp32spi
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-esp32spi
Usage Example¶
Check the examples folder for various demos for connecting and fetching data!
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.
Table of Contents¶
Examples
API Reference
adafruit_esp32spi
ESP_SPIcontrol
ESP_SPIcontrol.MAC_address
ESP_SPIcontrol.MAC_address_actual
ESP_SPIcontrol.ap_listening
ESP_SPIcontrol.bssid
ESP_SPIcontrol.connect()
ESP_SPIcontrol.connect_AP()
ESP_SPIcontrol.create_AP()
ESP_SPIcontrol.disconnect()
ESP_SPIcontrol.firmware_version
ESP_SPIcontrol.get_host_by_name()
ESP_SPIcontrol.get_remote_data()
ESP_SPIcontrol.get_scan_networks()
ESP_SPIcontrol.get_socket()
ESP_SPIcontrol.get_time()
ESP_SPIcontrol.ip_address
ESP_SPIcontrol.is_connected
ESP_SPIcontrol.network_data
ESP_SPIcontrol.ping()
ESP_SPIcontrol.pretty_ip()
ESP_SPIcontrol.reset()
ESP_SPIcontrol.rssi
ESP_SPIcontrol.scan_networks()
ESP_SPIcontrol.server_state()
ESP_SPIcontrol.set_analog_read()
ESP_SPIcontrol.set_analog_write()
ESP_SPIcontrol.set_certificate()
ESP_SPIcontrol.set_digital_read()
ESP_SPIcontrol.set_digital_write()
ESP_SPIcontrol.set_dns_config()
ESP_SPIcontrol.set_esp_debug()
ESP_SPIcontrol.set_hostname()
ESP_SPIcontrol.set_ip_config()
ESP_SPIcontrol.set_pin_mode()
ESP_SPIcontrol.set_private_key()
ESP_SPIcontrol.socket_available()
ESP_SPIcontrol.socket_close()
ESP_SPIcontrol.socket_connect()
ESP_SPIcontrol.socket_connected()
ESP_SPIcontrol.socket_open()
ESP_SPIcontrol.socket_read()
ESP_SPIcontrol.socket_status()
ESP_SPIcontrol.socket_write()
ESP_SPIcontrol.ssid
ESP_SPIcontrol.start_scan_networks()
ESP_SPIcontrol.start_server()
ESP_SPIcontrol.status
ESP_SPIcontrol.unpretty_ip()
ESP_SPIcontrol.wifi_set_entenable()
ESP_SPIcontrol.wifi_set_entidentity()
ESP_SPIcontrol.wifi_set_entpassword()
ESP_SPIcontrol.wifi_set_entusername()
ESP_SPIcontrol.wifi_set_network()
ESP_SPIcontrol.wifi_set_passphrase()
adafruit_esp32spi_socket
getaddrinfo()
set_interface()
socket
timeout
adafruit_esp32spi_wifimanager
ESPSPI_WiFiManager
ESPSPI_WiFiManager.connect()
ESPSPI_WiFiManager.connect_enterprise()
ESPSPI_WiFiManager.connect_normal()
ESPSPI_WiFiManager.create_ap()
ESPSPI_WiFiManager.delete()
ESPSPI_WiFiManager.get()
ESPSPI_WiFiManager.ip_address()
ESPSPI_WiFiManager.patch()
ESPSPI_WiFiManager.ping()
ESPSPI_WiFiManager.pixel_status()
ESPSPI_WiFiManager.post()
ESPSPI_WiFiManager.put()
ESPSPI_WiFiManager.reset()
ESPSPI_WiFiManager.signal_strength()
digitalio
DigitalInOut
Direction
DriveMode
Pin
PWMOut
PWMOut