Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<img src="custom_components/shade_engine/brand/icon.png" alt="Shade Engine — a half-drawn shade over a sunset window" width="96" align="right">

# Shade Engine

[![Validate](https://github.com/vfilby/shade-engine/actions/workflows/validate.yml/badge.svg)](https://github.com/vfilby/shade-engine/actions/workflows/validate.yml)
Expand Down Expand Up @@ -223,6 +225,19 @@ disabled.)
data: { option: night }
```

## Simulator

[`docs/simulator.html`](docs/simulator.html) is a self-contained, single-page
simulator (no build, no network — open it in any browser). Paste your zone
YAML, pick a date, location, and sky, and it plays the whole stack through a
day: the calculator's glare position (a direct port of `calculator.py`,
eye-zone and reflected-glare constraints included), a lux/elevation policy
ladder with editable thresholds, and the actuator's real semantics — deadband,
rate limiting that defers, and manual-move holds (there's a control to inject
a manual move and watch the hold start and expire). A room cross-section
diagram shows the sun ray, eye zone, and reflector bounce at any scrubbed
minute — useful for sanity-checking a zone's geometry before deploying it.

## Verifying your geometry

Run in shadow mode first: configure zones, restart, and graph
Expand Down
18 changes: 18 additions & 0 deletions assets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Brand assets

`icon.svg` is the source for the integration's brand images. The rasterized
copies live at `custom_components/shade_engine/brand/icon.png` (256×256) and
`icon@2x.png` (512×512): since Home Assistant 2026.3, brand images shipped in
a `brand/` directory inside the integration are served locally and take
priority over the brands CDN, so no submission to
[home-assistant/brands](https://github.com/home-assistant/brands) is needed
(that repo stopped accepting custom-integration PRs in early 2026).

Regenerate the PNGs from the SVG with headless Chrome:

```sh
chrome --headless --default-background-color=00000000 \
--window-size=256,256 --screenshot=icon.png assets/icon.svg
chrome --headless --default-background-color=00000000 \
--window-size=512,512 --screenshot=icon@2x.png assets/icon.svg
```
50 changes: 50 additions & 0 deletions assets/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added custom_components/shade_engine/brand/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added custom_components/shade_engine/brand/icon@2x.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading