Example using ESP32 GPIO pins from CircuitPython

examples/gpio/esp32spi_gpio.py

@@ -0,0 +1,167 @@
+import time
+import random
+import board
+from digitalio import DigitalInOut, Direction
+import pulseio
+from adafruit_esp32spi import adafruit_esp32spi
+
+
+# ESP32SPI Digital and Analog Pin Reads & Writes
+
+# This example targets a Feather M4 or ItsyBitsy M4 as the CircuitPython processor,
+# along with either an ESP32 Feather or ESP32 Breakout as Wi-Fi co-processor.
+# You may need to choose different pins for other targets.
+
+
+def esp_reset_all():
+    # esp.reset() will reset the ESP32 using its RST pin
+    # side effect is re-initializing ESP32 pin modes and debug output
+    esp.reset()
+    time.sleep(1)
+    # (re-)set NINA serial debug on ESP32 TX
+    esp.set_esp_debug(True)  # False, True
+    # (re-)set digital pin modes
+    esp_init_pin_modes(ESP_D_R_PIN, ESP_D_W_PIN)
+
+def esp_init_pin_modes(din, dout):
+    # ESP32 Digital Input
+    esp.set_pin_mode(din, 0x0)
+
+    # ESP32 Digital Output (no output on pins 34-39)
+    esp.set_pin_mode(dout, 0x1)  # Red LED on ESP32 Feather and ESP32 Breakout
+
+def esp_status_text(n):
+    text = 'WL_UNDEFINED'
+    t = {0: 'WL_IDLE_STATUS',
+         1: 'WL_NO_SSID_AVAIL',
+         2: 'WL_SCAN_COMPLETED',
+         3: 'WL_CONNECTED',
+         4: 'WL_CONNECT_FAILED',
+         5: 'WL_CONNECTION_LOST',
+         6: 'WL_DISCONNECTED',
+         7: 'WL_AP_LISTENING',
+         8: 'WL_AP_CONNECTED',
+         9: 'WL_AP_FAILED',
+         10: 'WL_NO_SHIELD', }
+    if n in t:
+        text = t[n]
+    return text
+
+
+# M4 R/W Pin Assignments
+M4_D_W_PIN = DigitalInOut(board.A1)  # digital write to ESP_D_R_PIN
+M4_D_W_PIN.direction = Direction.OUTPUT
+M4_A_R_PIN = pulseio.PulseIn(board.A0, maxlen=64)  # PWM read from ESP_A_W_PIN
+M4_A_R_PIN.pause()
+
+# ESP32 R/W Pin assignments
+ESP_D_R_PIN = 12  # digital read from M4_D_W_PIN
+ESP_D_W_PIN = 13  # digital write to Red LED on Feather ESP32 and ESP32 Breakout
+# ESP32 Analog Input using ADC1
+# esp.set_pin_mode(36, 0x0)  # Hall Effect Sensor
+# esp.set_pin_mode(37, 0x0)  # Not Exposed
+# esp.set_pin_mode(38, 0x0)  # Not Exposed
+# esp.set_pin_mode(39, 0x0)  # Hall Effect Sensor
+# esp.set_pin_mode(32, 0x0)  # INPUT OK
+# esp.set_pin_mode(33, 0x0)  # DO NOT USE: ESP32SPI Busy/!Rdy
+# esp.set_pin_mode(34, 0x0)  # INPUT OK
+# esp.set_pin_mode(35, 0x0)  # INPUT OK (1/2 of Battery on ESP32 Feather)
+ESP_A_R_PIN = 32  # analog read from 10k potentiometer
+# ESP32 Analog (PWM/LEDC) Output (no output on pins 34-39)
+ESP_A_W_PIN = 27  # analog (PWM) write to M4_A_R_PIN
+
+spi = board.SPI()
+# Airlift FeatherWing & Bitsy Add-On compatible
+esp32_cs = DigitalInOut(board.D13)  # M4 Red LED
+esp32_ready = DigitalInOut(board.D11)
+esp32_reset = DigitalInOut(board.D12)
+esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)
+
+esp_reset_all()
+
+espfirmware = ''
+for _ in esp.firmware_version:
+    if _ == 0:
+        break
+    else:
+        espfirmware += "{:c}".format(_)
+print('ESP32 Firmware:', espfirmware)
+
+esp_MAC_address = esp.MAC_address
+print("ESP32 MAC:      {5:02X}:{4:02X}:{3:02X}:{2:02X}:{1:02X}:{0:02X}".format(*esp_MAC_address))
+
+print('ESP32 Status:  ', esp.status, esp_status_text(esp.status), 'Connected?', esp.is_connected)
+
+# initial digital write values
+m4_d_w_val = False
+esp_d_w_val = False
+
+while True:
+    print()
+    print('ESP32 DIGITAL:')
+
+    # ESP32 digital read
+    try:
+        M4_D_W_PIN.value = m4_d_w_val
+        print('M4 wrote:', m4_d_w_val, end=' ')
+        # b/c ESP32 might have reset out from under us
+        esp_init_pin_modes(ESP_D_R_PIN, ESP_D_W_PIN)
+        esp_d_r_val = esp.set_digital_read(ESP_D_R_PIN)
+        print('--> ESP read:', esp_d_r_val)
+    except (RuntimeError, AssertionError) as e:
+        print('ESP32 Error', e)
+        esp_reset_all()
+
+    # ESP32 digital write
+    try:
+        # b/c ESP32 might have reset out from under us
+        esp_init_pin_modes(ESP_D_R_PIN, ESP_D_W_PIN)
+        esp.set_digital_write(ESP_D_W_PIN, esp_d_w_val)
+        print('ESP wrote:', esp_d_w_val, '--> Red LED')
+    except (RuntimeError) as e:
+        print('ESP32 Error', e)
+        esp_reset_all()
+
+    print('ESP32 ANALOG:')
+
+    # ESP32 analog read
+    try:
+        esp_a_r_val = esp.set_analog_read(ESP_A_R_PIN)
+        print('Potentiometer --> ESP read: ', esp_a_r_val,
+              ' (', '{:1.1f}'.format(esp_a_r_val*3.3/65536), 'v)', sep='')
+    except (RuntimeError, AssertionError) as e:
+        print('ESP32 Error', e)
+        esp_reset_all()
+
+    # ESP32 analog write
+    try:
+        # don't set the low end to 0 or the M4's pulseio read will stall
+        esp_a_w_val = random.uniform(0.1, .9)
+        esp.set_analog_write(ESP_A_W_PIN, esp_a_w_val)
+        print('ESP wrote: ', '{:1.2f}'.format(esp_a_w_val),
+              ' (', '{:d}'.format(int(esp_a_w_val*65536)), ')',
+              ' (', '{:1.1f}'.format(esp_a_w_val*3.3), 'v)',
+              sep='', end=' ')
+
+        # ESP32 "analog" write is a 1000Hz PWM
+        # use pulseio to extract the duty cycle
+        M4_A_R_PIN.clear()
+        M4_A_R_PIN.resume()
+        while len(M4_A_R_PIN) < 2:
+            pass
+        M4_A_R_PIN.pause()
+        duty = M4_A_R_PIN[0] / (M4_A_R_PIN[0] + M4_A_R_PIN[1])
+        print('--> M4 read: ', '{:1.2f}'.format(duty),
+              ' (', '{:d}'.format(int(duty*65536)), ')',
+              ' (', '{:1.1f}'.format(duty*3.3), 'v)',
+              ' [len=', len(M4_A_R_PIN), ']', sep='')
+
+    except (RuntimeError) as e:
+        print('ESP32 Error', e)
+        esp_reset_all()
+
+    # toggle digital write values
+    m4_d_w_val = not m4_d_w_val
+    esp_d_w_val = not esp_d_w_val
+
+    time.sleep(5)

examples/gpio/gpio.md

@@ -0,0 +1,86 @@
+# Using ESP32 co-processor GPIO pins with CircuitPython ESP32SPI
+
+As of NINA firmware version 1.3.1, the ESP32SPI library can be used to write digital values to many of the ESP32 GPIO pins using CircuitPython. It can also write "analog" signals using a float between 0 and 1 as the duty cycle (which is converted to an 8-bit integer for use by the NINA firmware). Keep in mind that these are 1000Hz PWM signals using the ESP32 LED Control peripheral, not true analog signals using an on-chip DAC. More information can be found here:
+<https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/peripherals/ledc.html>
+
+As of NINA firmware version 1.5.0, the ESP32SPI library can be used to read digital signals from many of the ESP32 GPIO pins using CircuitPython. It can also read analog signals using ESP32 on-chip ADC1. The ESP32 can theoretically be set to use between 8 and 12 bits of resolution for analog reads. For our purposes, it is a 12-bit read within the NINA firmware, but the CircuitPython library converts it to a 16-bit integer consistent with CircuitPython `analogio` `AnalogIn`. There's an optional keyword argument in the `set_analog_read(self, pin, atten=ADC_ATTEN_DB_11)` function that changes the attenuation of the analog read, and therefore also changes the effective voltage range of the read. With the default 11dB attenuation, Espressif recommends keeping input voltages between 150mV to 2450mV for best results. More information can be found here:
+<https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/peripherals/adc.html>
+
+## GPIO Pins available to ESP32SPI
+
+```
+    # ESP32_GPIO_PINS:
+    # https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/blob/master/adafruit_esp32spi/digitalio.py
+    # 0, 1, 2, 4, 5, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 23, 25, 26, 27, 32, 33, 34, 35, 36, 39
+    #
+    # Pins Used for ESP32SPI
+    #             5,         14,             18,             23,                 33
+
+    # Avialable ESP32SPI Outputs (digital or 'analog' PWM) with NINA FW >= 1.3.1
+    #
+    # Adafruit ESP32 Breakout
+    # *,    2, 4,    12,  R,     15, 16, 17,     19, 21, 22,     25, 26, 27, 32
+    # Adafruit ESP32 Feather
+    #          4,    12,  R,     15, 16, 17,     19, 21, 22,     25, 26, 27, 32
+    # TinyPICO
+    #          4,                15,             19, 21, 22,     25, 26, 27, 32
+    # Adafruit ESP32 Airlift Breakout†
+    #                                                             G,  R,  B
+    # Adafruit ESP32 Airlift Feather†
+    #                                                             G,  R,  B
+    # Adafruit ESP32 Airlift Bitsy Add-On†
+    #                                                             G,  R,  B
+
+    # Avialable† ESP32SPI Digital Inputs with NINA FW >= 1.5.0
+    #
+    # Adafruit ESP32 Breakout
+    # *,    2, 4,    12,  R,     15, 16, 17,     19, 21, 22,     25, 26, 27, 32,     34, 35, 36, 39
+    # Adafruit ESP32 Feather
+    #          4,    12,  R,     15, 16, 17,     19, 21, 22,     25, 26, 27, 32,     34,     36, 39
+    # TinyPICO
+    #          4,                15,             19, 21, 22,     25, 26, 27, 32      CH
+
+    # Avialable ESP32SPI Analog Inputs (ADC1) with NINA FW >= 1.5.0
+    #
+    # Adafruit ESP32 Breakout
+    # *,                                                                     32,     34, 35, HE, HE
+    # Adafruit ESP32 Feather
+    # *,                                                                     32,     34, BA, HE, HE
+    # TinyPICO
+    #                                                                        32,         BA
+
+Notes:
+ *  Used for bootloading
+ G  Green LED
+ R  Red LED
+ B  Blue LED
+BA  On-board connection to battery via 50:50 voltage divider
+CH  Battery charging state (digital pin)
+HE  Hall Effect sensor
+```
+
+Note that on the Airlift FeatherWing and the Airlift Bitsy Add-On, the ESP32 SPI Chip Select (CS) pin aligns with M4's D13 Red LED pin:
+```
+    esp32_cs = DigitalInOut(board.D13)  # M4 Red LED
+    esp32_ready = DigitalInOut(board.D11)
+    esp32_reset = DigitalInOut(board.D12)
+```
+So the Red LED on the main Feather processor will almost always appear to be ON or slightly flickering when ESP32SPI is active.
+
+## ESP32 Reset
+
+Because the ESP32 may reset without indication to the CircuitPython code, putting ESP32 GPIO pins into input mode, `esp.set_digital_write(pin, val)` should be preceded by `esp.set_pin_mode(pin, 0x1)`, with appropriate error handling. Other non-default `esp` states (e.g., `esp.set_esp_debug()`) will also get re-initialized to default settings upon ESP32 reset, so CircuitPython code should anticipate this.
+
+## GPIO on Airlift add-on boards
+
+It should also be possible to do ESP32SPI reads and writes on the Airlift add-on boards, but other than the SPI pins and the green, blue, and red LEDs, the only pins available are RX (GPIO3), TX (GPIO1), and GPIO0, so function is extremely limited. Analog input is ruled out since none of those pins are on ADC1.
+
+The Airlift Breakout has level-shifting on RX and GPIO0, so those could be digital inputs only. TX could be used as a digital input or as a digital or analog (PWM) output.
+
+The Airlift FeatherWing and Bitsy Add-On have no level-shifting since they're designed to be stacked onto their associated M4 microcontrollers, so theoretically RX, TX, and GPIO0 could be used as digital inputs, or as digital or analog (PWM) outputs. It's hard to find a use case for doing this when stacked since RX, TX, and GPIO0 will be connected to M4 GPIO pins.
+
+The Airlift [Metro / Arduino] Shield has level-shifting on RX and GPIO0, with stacking issues similar to the wings.
+
+The RX, TX, and GPIO0 pins are used for updating the NINA firmware, and have specific behaviors immediately following reboot that need to be considered if reusing them as GPIO. On the Airlift FeatherWing and Bitsy Add-On, there are pads that need to be soldered to connect the pins. NINA does output messages to TX when connected, depending on the esp debug level set.
+
+Ultimately it makes the most sense by far to use a non-stacked full-pinout ESP32 as co-processor for ESP32SPI pin read and write features.