Adafruit_CircuitPython_ESP3.../adafruit_esp32spi.py
2019-01-26 21:29:28 -05:00

268 lines
8.5 KiB
Python

import struct
import time
import board
import busio
from digitalio import DigitalInOut, Direction, Pull
from micropython import const
class ESP_SPIcontrol:
SET_NET_CMD = const(0x10)
SET_PASSPHRASE_CMD = const(0x11)
GET_CONN_STATUS_CMD = const(0x20)
GET_IPADDR_CMD = const(0x21)
GET_MACADDR_CMD = const(0x22)
GET_CURR_SSID_CMD = const(0x23)
GET_CURR_RSSI_CMD = const(0x25)
GET_CURR_ENCT_CMD = const(0x26)
SCAN_NETWORKS = const(0x27)
GET_IDX_RSSI_CMD = const(0x32)
GET_IDX_ENCT_CMD = const(0x33)
START_SCAN_NETWORKS = const(0x36)
GET_FW_VERSION_CMD = const(0x37)
START_CMD = const(0xE0)
END_CMD = const(0xEE)
ERR_CMD = const(0xEF)
REPLY_FLAG = const(1<<7)
CMD_FLAG = const(0)
WL_NO_SHIELD = const(0xFF)
WL_NO_MODULE = const(0xFF)
WL_IDLE_STATUS = const(0)
WL_NO_SSID_AVAIL = const(1)
WL_SCAN_COMPLETED = const(2)
WL_CONNECTED = const(3)
def __init__(self, spi, cs_pin, ready_pin, reset_pin, gpio0_pin, *, debug=False):
self._debug = debug
self._buffer = bytearray(10)
self._pbuf = bytearray(1) # buffer for param read
self._spi = spi
self._cs = cs_pin
self._ready = ready_pin
self._reset = reset_pin
self._gpio0 = gpio0_pin
self._cs.direction = Direction.OUTPUT
self._ready.direction = Direction.INPUT
self._reset.direction = Direction.OUTPUT
self._gpio0.direction = Direction.OUTPUT
print("Nina reset")
self._gpio0.value = True # not bootload mode
self._cs.value = True
self._reset.value = False
time.sleep(0.01) # reset
self._reset.value = True
time.sleep(0.75) # wait for it to boot up
self._gpio0.direction = Direction.INPUT
def spi_slave_select(self):
while not self._spi.try_lock():
pass
self._spi.configure(baudrate=100000) # start slow
self._cs.value = False # the actual select
times = time.monotonic()
while (time.monotonic() - times) < 0.1: # wait up to 100ms
if self._ready.value:
return
raise RuntimeError("ESP32 timed out on SPI select")
def slave_deselect(self):
self._cs.value = True
self._spi.unlock()
def slave_ready(self):
return self._ready.value == False
def wait_for_slave_ready(self):
if self._debug:
print("Wait for slave ready", end='')
while not self.slave_ready():
if self._debug:
print('.', end='')
time.sleep(0.01)
if self._debug:
print()
def wait_for_slave_select(self):
self.wait_for_slave_ready()
self.spi_slave_select()
def send_command(self, cmd, params=None):
if not params:
params = []
packet = []
packet.append(START_CMD)
packet.append(cmd & ~REPLY_FLAG)
packet.append(len(params))
# handle parameters here
for param in params:
packet.append(len(param))
packet += (param)
packet.append(END_CMD)
if self._debug:
print("packet len:", len(packet))
while len(packet) % 4 != 0:
packet.append(0xFF)
self.wait_for_slave_select()
self._spi.write(bytearray(packet))
if self._debug:
print("Wrote: ", [hex(b) for b in packet])
self.slave_deselect()
def get_param(self):
self._spi.readinto(self._pbuf)
if self._debug:
print("Read param", hex(self._pbuf[0]))
return self._pbuf[0]
def wait_spi_char(self, desired):
times = time.monotonic()
while (time.monotonic() - times) < 0.1:
r = self.get_param()
if r == ERR_CMD:
raise RuntimeError("Error response to command")
if r == desired:
return True
else:
raise RuntimeError("Timed out waiting for SPI char")
def check_data(self, desired):
r = self.get_param()
if r != desired:
raise RuntimeError("Expected %02X but got %02X" % (desired, r))
def wait_response_cmd(self, cmd, num_responses=None):
self.wait_for_slave_ready()
self.spi_slave_select()
self.wait_spi_char(START_CMD)
self.check_data(cmd | REPLY_FLAG)
if num_responses is not None:
self.check_data(num_responses)
else:
num_responses = self.get_param()
responses = []
for num in range(num_responses):
response = []
param_len = self.get_param()
print("parameter #%d length is %d" % (num, param_len))
for j in range(param_len):
response.append(self.get_param())
responses.append(bytes(response))
self.check_data(END_CMD)
self.slave_deselect()
return responses
def send_command_get_response(self, cmd, params=None, *, reply_params=1):
self.send_command(cmd, params)
return self.wait_response_cmd(cmd, reply_params)
@property
def status(self):
print("Connection status")
resp = self.send_command_get_response(GET_CONN_STATUS_CMD)
print("Status:", resp[0][0])
return resp[0][0] # one byte response
@property
def firmware_version(self):
print("Firmware version")
resp = self.send_command_get_response(GET_FW_VERSION_CMD)
return resp[0]
@property
def MAC_address(self):
print("MAC address")
resp = self.send_command_get_response(GET_MACADDR_CMD, [b'\xFF'])
return resp[0]
def start_scan_networks(self):
print("Start scan")
resp = self.send_command_get_response(START_SCAN_NETWORKS)
if resp[0][0] != 1:
raise RuntimeError("Failed to start AP scan")
def get_scan_networks(self):
self.send_command(SCAN_NETWORKS)
names = self.wait_response_cmd(SCAN_NETWORKS)
print("SSID names:", names)
APs = []
for i, name in enumerate(names):
AP = {'ssid': name}
rssi = self.send_command_get_response(GET_IDX_RSSI_CMD, [[i]])[0]
AP['rssi'] = struct.unpack('<i', rssi)[0]
encr = self.send_command_get_response(GET_IDX_ENCT_CMD, [[i]])[0]
AP['encryption'] = encr[0]
APs.append(AP)
return APs
def scan_networks(self):
self.start_scan_networks()
APs = None
for _ in range(10): # attempts
time.sleep(2)
APs = self.get_scan_networks()
if len(APs):
break
return APs
def wifi_set_network(self, ssid):
print("Set Network")
resp = self.send_command_get_response(SET_NET_CMD, [ssid])
if resp[0][0] != 1:
raise RuntimeError("Failed to set network")
def wifi_set_passphrase(self, ssid, passphrase):
print("Set passphrase")
resp = self.send_command_get_response(SET_PASSPHRASE_CMD, [ssid, passphrase])
print(resp)
if resp[0][0] != 1:
raise RuntimeError("Failed to set passphrase")
@property
def ssid(self):
resp = self.send_command_get_response(GET_CURR_SSID_CMD, [b'\xFF'])
return resp[0]
@property
def rssi(self):
resp = self.send_command_get_response(GET_CURR_RSSI_CMD, [b'\xFF'])
return struct.unpack('<i', resp[0])[0]
@property
def network_data(self):
resp = self.send_command_get_response(GET_IPADDR_CMD, [b'\xFF'], reply_params=3)
return {'ip_addr': resp[0], 'netmask': resp[1], 'gateway': resp[2]}
@property
def ip_address(self):
raw_ip = self.network_data['ip_addr']
return "%d.%d.%d.%d" % (raw_ip[0], raw_ip[1], raw_ip[2], raw_ip[3])
def connect_AP(self, ssid, password):
print("Connect AP")
if password:
self.wifi_set_passphrase(ssid, password)
else:
self.wifi_set_network(ssid)
for i in range(10): # retries
stat = self.status
if stat == WL_CONNECTED:
return stat
time.sleep(1)
if stat in (WL_CONNECT_FAILED, WL_CONNECTION_LOST, WL_DISCONNECTED):
raise RuntimeError("Failed to connect to ssid", ssid)
if stat == WL_NO_SSID_AVAIL:
raise RuntimeError("No such ssid", ssid)
raise RuntimeError("Unknown error 0x%02X" % stat)