mirror of
https://github.com/paeber/led-driver-starfish.git
synced 2026-01-18 06:22:02 +01:00
Update README.md
This commit is contained in:
parent
367f0d5814
commit
60fdb711ee
1 changed files with 105 additions and 0 deletions
105
README.md
105
README.md
|
|
@ -18,3 +18,108 @@ The pcb is designed with KiCad and has a ESP32-S3 with power and usb circuit. A
|
||||||
- WS2812 LED
|
- WS2812 LED
|
||||||
- Multiple headers for further peripherals (I2C, 3V3, 5V, GPIOs)
|
- Multiple headers for further peripherals (I2C, 3V3, 5V, GPIOs)
|
||||||
- 6V to 15V Input
|
- 6V to 15V Input
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## ESPHome Code
|
||||||
|
|
||||||
|
YAML configuration for ESPHome. Adapt as you need for your setup. Code is relevant for latest version (rev B).
|
||||||
|
|
||||||
|
### Base
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
substitutions:
|
||||||
|
dev_name: Kitchen
|
||||||
|
|
||||||
|
esphome:
|
||||||
|
name: kitchen-starfish
|
||||||
|
friendly_name: kitchen-starfish
|
||||||
|
comment: ESP32 based LED driver for 12 V LED Strips
|
||||||
|
|
||||||
|
on_boot:
|
||||||
|
light.turn_on:
|
||||||
|
id: status_led
|
||||||
|
brightness: 20%
|
||||||
|
green: 30%
|
||||||
|
|
||||||
|
esp32:
|
||||||
|
variant: esp32s3
|
||||||
|
board: esp32-s3-devkitc-1
|
||||||
|
framework:
|
||||||
|
type: arduino
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Internal LED
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
light:
|
||||||
|
- platform: esp32_rmt_led_strip
|
||||||
|
id: status_led
|
||||||
|
rgb_order: GRB
|
||||||
|
pin: GPIO38
|
||||||
|
num_leds: 1
|
||||||
|
rmt_channel: 0
|
||||||
|
chipset: ws2812
|
||||||
|
name: "Status"
|
||||||
|
internal: true
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### PWM Output
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
output:
|
||||||
|
- platform: ledc
|
||||||
|
id: output_component1
|
||||||
|
pin: GPIO6
|
||||||
|
frequency: 19531
|
||||||
|
|
||||||
|
- platform: ledc
|
||||||
|
id: output_component2
|
||||||
|
pin: GPIO5
|
||||||
|
frequency: 19531
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Dimmable Light
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
light:
|
||||||
|
- platform: monochromatic
|
||||||
|
name: ${dev_name} Ceiling
|
||||||
|
output: output_component1
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Buttons
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
binary_sensor:
|
||||||
|
- platform: gpio
|
||||||
|
pin:
|
||||||
|
number: GPIO8
|
||||||
|
inverted: True
|
||||||
|
name: ${dev_name} BTN_1
|
||||||
|
|
||||||
|
- platform: gpio
|
||||||
|
pin:
|
||||||
|
number: GPIO11
|
||||||
|
inverted: True
|
||||||
|
name: ${dev_name} BTN_2
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### I2C Header
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
i2c:
|
||||||
|
scl: GPIO9
|
||||||
|
sda: GPIO10
|
||||||
|
```
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue