mirror of https://github.com/esphome/esphome.git
119 lines
3.7 KiB
Python
119 lines
3.7 KiB
Python
import esphome.codegen as cg
|
|
import esphome.config_validation as cv
|
|
import esphome.final_validate as fv
|
|
from esphome import pins
|
|
from esphome.const import (
|
|
CONF_CLK_PIN,
|
|
CONF_ID,
|
|
CONF_MISO_PIN,
|
|
CONF_MOSI_PIN,
|
|
CONF_SPI_ID,
|
|
CONF_CS_PIN,
|
|
)
|
|
from esphome.core import coroutine_with_priority, CORE
|
|
|
|
CODEOWNERS = ["@esphome/core"]
|
|
spi_ns = cg.esphome_ns.namespace("spi")
|
|
SPIComponent = spi_ns.class_("SPIComponent", cg.Component)
|
|
SPIDevice = spi_ns.class_("SPIDevice")
|
|
SPIDataRate = spi_ns.enum("SPIDataRate")
|
|
|
|
SPI_DATA_RATE_OPTIONS = {
|
|
80e6: SPIDataRate.DATA_RATE_80MHZ,
|
|
40e6: SPIDataRate.DATA_RATE_40MHZ,
|
|
20e6: SPIDataRate.DATA_RATE_20MHZ,
|
|
10e6: SPIDataRate.DATA_RATE_10MHZ,
|
|
8e6: SPIDataRate.DATA_RATE_8MHZ,
|
|
5e6: SPIDataRate.DATA_RATE_5MHZ,
|
|
4e6: SPIDataRate.DATA_RATE_4MHZ,
|
|
2e6: SPIDataRate.DATA_RATE_2MHZ,
|
|
1e6: SPIDataRate.DATA_RATE_1MHZ,
|
|
2e5: SPIDataRate.DATA_RATE_200KHZ,
|
|
75e3: SPIDataRate.DATA_RATE_75KHZ,
|
|
1e3: SPIDataRate.DATA_RATE_1KHZ,
|
|
}
|
|
SPI_DATA_RATE_SCHEMA = cv.All(cv.frequency, cv.enum(SPI_DATA_RATE_OPTIONS))
|
|
|
|
MULTI_CONF = True
|
|
CONF_FORCE_SW = "force_sw"
|
|
|
|
CONFIG_SCHEMA = cv.All(
|
|
cv.Schema(
|
|
{
|
|
cv.GenerateID(): cv.declare_id(SPIComponent),
|
|
cv.Required(CONF_CLK_PIN): pins.gpio_output_pin_schema,
|
|
cv.Optional(CONF_MISO_PIN): pins.gpio_input_pin_schema,
|
|
cv.Optional(CONF_MOSI_PIN): pins.gpio_output_pin_schema,
|
|
cv.Optional(CONF_FORCE_SW, default=False): cv.boolean,
|
|
}
|
|
),
|
|
cv.has_at_least_one_key(CONF_MISO_PIN, CONF_MOSI_PIN),
|
|
cv.only_on(["esp32", "esp8266", "rp2040"]),
|
|
)
|
|
|
|
|
|
@coroutine_with_priority(1.0)
|
|
async def to_code(config):
|
|
cg.add_global(spi_ns.using)
|
|
var = cg.new_Pvariable(config[CONF_ID])
|
|
await cg.register_component(var, config)
|
|
|
|
clk = await cg.gpio_pin_expression(config[CONF_CLK_PIN])
|
|
cg.add(var.set_clk(clk))
|
|
cg.add(var.set_force_sw(config[CONF_FORCE_SW]))
|
|
if CONF_MISO_PIN in config:
|
|
miso = await cg.gpio_pin_expression(config[CONF_MISO_PIN])
|
|
cg.add(var.set_miso(miso))
|
|
if CONF_MOSI_PIN in config:
|
|
mosi = await cg.gpio_pin_expression(config[CONF_MOSI_PIN])
|
|
cg.add(var.set_mosi(mosi))
|
|
|
|
if CORE.using_arduino:
|
|
cg.add_library("SPI", None)
|
|
|
|
|
|
def spi_device_schema(cs_pin_required=True):
|
|
"""Create a schema for an SPI device.
|
|
:param cs_pin_required: If true, make the CS_PIN required in the config.
|
|
:return: The SPI device schema, `extend` this in your config schema.
|
|
"""
|
|
schema = {
|
|
cv.GenerateID(CONF_SPI_ID): cv.use_id(SPIComponent),
|
|
}
|
|
if cs_pin_required:
|
|
schema[cv.Required(CONF_CS_PIN)] = pins.gpio_output_pin_schema
|
|
else:
|
|
schema[cv.Optional(CONF_CS_PIN)] = pins.gpio_output_pin_schema
|
|
return cv.Schema(schema)
|
|
|
|
|
|
async def register_spi_device(var, config):
|
|
parent = await cg.get_variable(config[CONF_SPI_ID])
|
|
cg.add(var.set_spi_parent(parent))
|
|
if CONF_CS_PIN in config:
|
|
pin = await cg.gpio_pin_expression(config[CONF_CS_PIN])
|
|
cg.add(var.set_cs_pin(pin))
|
|
|
|
|
|
def final_validate_device_schema(name: str, *, require_mosi: bool, require_miso: bool):
|
|
hub_schema = {}
|
|
if require_miso:
|
|
hub_schema[
|
|
cv.Required(
|
|
CONF_MISO_PIN,
|
|
msg=f"Component {name} requires this spi bus to declare a miso_pin",
|
|
)
|
|
] = cv.valid
|
|
if require_mosi:
|
|
hub_schema[
|
|
cv.Required(
|
|
CONF_MOSI_PIN,
|
|
msg=f"Component {name} requires this spi bus to declare a mosi_pin",
|
|
)
|
|
] = cv.valid
|
|
|
|
return cv.Schema(
|
|
{cv.Required(CONF_SPI_ID): fv.id_declaration_match_schema(hub_schema)},
|
|
extra=cv.ALLOW_EXTRA,
|
|
)
|