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
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**When it powers on, your iPhone runs a Shortcut.**

<p align="center">
<a href="https://mattboxx.github.io/Esp32_Iphone_shortcuts_bluetooth_trigger/">
<a href="https://mattboxx.github.io/esp32-bt-trigger/">
<img src="docs/img/hero.svg" width="560" alt="Power on → the ESP32 connects over Bluetooth → the iPhone runs a Shortcut">
</a>
</p>
Expand All @@ -12,11 +12,11 @@ A tiny open-source firmware that turns a $3 ESP32 board into a **Bluetooth trigg
for iPhone Shortcuts automations**. No app on the phone, no Wi-Fi, no cloud, no NFC
tag to tap. Power it up → it connects → iOS runs your automation.

[![Firmware](https://github.com/Mattboxx/Esp32_Iphone_shortcuts_bluetooth_trigger/actions/workflows/firmware.yml/badge.svg)](https://github.com/Mattboxx/Esp32_Iphone_shortcuts_bluetooth_trigger/actions/workflows/firmware.yml)
[![Firmware](https://github.com/Mattboxx/esp32-bt-trigger/actions/workflows/firmware.yml/badge.svg)](https://github.com/Mattboxx/esp32-bt-trigger/actions/workflows/firmware.yml)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Ko-fi](https://img.shields.io/badge/Ko--fi-support-ff5e5b?logo=ko-fi&logoColor=white)](https://ko-fi.com/mattboxx)

### ⚡ [Install it from your browser →](https://mattboxx.github.io/Esp32_Iphone_shortcuts_bluetooth_trigger/)
### ⚡ [Install it from your browser →](https://mattboxx.github.io/esp32-bt-trigger/)

Plug the board into your computer, pick a name and options, click **Install**.
Two minutes, nothing to install, no code to edit. (Chrome or Edge on a computer.)
Expand Down Expand Up @@ -74,7 +74,7 @@ clicked.
| ESP32-H2 / C2 / C5 | BLE | 🔜 Planned |

Any flash size **from 2 MB** works. If you test a beta chip, please
[open an issue](https://github.com/Mattboxx/Esp32_Iphone_shortcuts_bluetooth_trigger/issues)
[open an issue](https://github.com/Mattboxx/esp32-bt-trigger/issues)
with the result, even if it's just "works on my C3 SuperMini".

> The BLE variant is a real HID mouse over Bluetooth LE (the same protocol BLE mice
Expand All @@ -83,7 +83,7 @@ with the result, even if it's just "works on my C3 SuperMini".

## Settings (no code to edit)

Everything is set in the [web installer](https://mattboxx.github.io/Esp32_Iphone_shortcuts_bluetooth_trigger/).
Everything is set in the [web installer](https://mattboxx.github.io/esp32-bt-trigger/).
Connect the board again later: your settings are read back, and **Save settings only**
rewrites them in a second without touching the pairing.

Expand All @@ -105,7 +105,7 @@ rewrites them in a second without touching the pairing.

## Quick start

1. **Flash:** open the [web installer](https://mattboxx.github.io/Esp32_Iphone_shortcuts_bluetooth_trigger/), click **Connect**, choose your settings, click **Install**.
1. **Flash:** open the [web installer](https://mattboxx.github.io/esp32-bt-trigger/), click **Connect**, choose your settings, click **Install**.
2. **Pair (once):** iPhone → **Settings → Bluetooth** → tap your device under *Other Devices*. No PIN.
3. **Automate:** **Shortcuts → Automation → + → Bluetooth** → choose your device →
**Is Connected** → **Run Immediately** → add your actions.
Expand All @@ -116,7 +116,7 @@ Every time the board powers up (or the switch/button fires) and connects, the au
<summary><b>Flash without the browser (esptool)</b></summary>

Download the file for your chip from [`firmware/`](firmware) or the
[Releases](https://github.com/Mattboxx/Esp32_Iphone_shortcuts_bluetooth_trigger/releases)
[Releases](https://github.com/Mattboxx/esp32-bt-trigger/releases)
page. Each file is a merged image written at `0x0`:

```bash
Expand Down Expand Up @@ -185,7 +185,7 @@ for new test boards and iOS update testing:
[![GitHub Sponsors](https://img.shields.io/badge/♥_Sponsor-GitHub-db61a2)](https://github.com/sponsors/Mattboxx)

Not in a position to donate? A ⭐ or a hardware test report in the
[issues](https://github.com/Mattboxx/Esp32_Iphone_shortcuts_bluetooth_trigger/issues) helps just as much.
[issues](https://github.com/Mattboxx/esp32-bt-trigger/issues) helps just as much.

## License

Expand Down
16 changes: 8 additions & 8 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<meta property="og:title" content="ESP32 BT Trigger – a Bluetooth trigger for iPhone Shortcuts">
<meta property="og:description" content="When it powers on, your iPhone runs a Shortcut. Flash it from the browser in 2 minutes. Open source, no app, no cloud.">
<meta property="og:type" content="website">
<meta property="og:image" content="https://mattboxx.github.io/Esp32_Iphone_shortcuts_bluetooth_trigger/img/og.png">
<meta property="og:image" content="https://mattboxx.github.io/esp32-bt-trigger/img/og.png">
<meta name="twitter:card" content="summary_large_image">
<link rel="icon" href="img/icon.svg" type="image/svg+xml">
<link rel="stylesheet" href="css/style.css">
Expand All @@ -27,7 +27,7 @@
<a href="#iphone">iPhone setup</a>
<a href="#faq">FAQ</a>
<a class="support-link" id="btn-support" href="#support" role="button" aria-haspopup="dialog">♥ Support</a>
<a class="gh" href="https://github.com/Mattboxx/Esp32_Iphone_shortcuts_bluetooth_trigger">GitHub</a>
<a class="gh" href="https://github.com/Mattboxx/esp32-bt-trigger">GitHub</a>
</nav>
</div>
</header>
Expand All @@ -43,7 +43,7 @@ <h1>When it turns on,<br>your iPhone <span class="accent">does something.</span>
no extra app, no Wi-Fi and no cloud.</p>
<div class="cta">
<a class="btn primary" href="#install">Install it from your browser</a>
<a class="btn ghost" href="https://github.com/Mattboxx/Esp32_Iphone_shortcuts_bluetooth_trigger">Source code</a>
<a class="btn ghost" href="https://github.com/Mattboxx/esp32-bt-trigger">Source code</a>
</div>
<ul class="pills">
<li>2-minute setup</li><li>No code to write</li><li>Reconnects by itself</li><li>MIT licensed</li>
Expand Down Expand Up @@ -355,7 +355,7 @@ <h2>FAQ</h2>
<p>With a pin trigger the board stays visible until a phone is paired, so you can pair it before wiring anything. After that it only connects when the pin is active.</p></details>
<details><summary>Which boards work?</summary>
<p><b>Any original ESP32</b> (DevKit, WROOM, WROVER, PICO, D1 mini32, M5 Atom, ESP32-CAM, TTGO…), including single-core and 26 MHz-crystal variants. It uses <b>Classic Bluetooth HID</b>, the mode this project was first tested with on iPhone (v1; the v2 rewrite is being verified).</p>
<p><b>ESP32-C3, ESP32-S3 and ESP32-C6</b> have no Classic Bluetooth, so they get a <b>Bluetooth LE HID mouse</b> (HID over GATT, the same protocol as BLE mice and keyboards). <span class="tag ok">tested</span> on iPhone with a Waveshare ESP32-S3-Zero. ESP32-C3 and C6 run the same code but are still <span class="tag">beta</span> until someone confirms them: if you try one, please <a href="https://github.com/Mattboxx/Esp32_Iphone_shortcuts_bluetooth_trigger/issues/new?template=hardware-report.yml">report back</a>.</p>
<p><b>ESP32-C3, ESP32-S3 and ESP32-C6</b> have no Classic Bluetooth, so they get a <b>Bluetooth LE HID mouse</b> (HID over GATT, the same protocol as BLE mice and keyboards). <span class="tag ok">tested</span> on iPhone with a Waveshare ESP32-S3-Zero. ESP32-C3 and C6 run the same code but are still <span class="tag">beta</span> until someone confirms them: if you try one, please <a href="https://github.com/Mattboxx/esp32-bt-trigger/issues/new?template=hardware-report.yml">report back</a>.</p>
<p><b>Not compatible:</b> ESP32-S2 and ESP8266 (no Bluetooth). Any flash size from 2 MB works.</p></details>
<details><summary>Why a mouse and not a keyboard or a "beacon"?</summary>
<p>The Shortcuts "Bluetooth" automation only lists accessories paired in Settings, and iOS only pairs certain device types from there: audio, keyboards, mice, game controllers. A plain BLE beacon never shows up. A keyboard would hide your on-screen keyboard while connected. A mouse has no side effects except an optional on-screen pointer.</p></details>
Expand All @@ -378,8 +378,8 @@ <h2>FAQ</h2>
<h2>Free, and staying that way</h2>
<p>No ads, no accounts, no paid features. A commercial smart button costs $30–40 and needs its own app.
If this saved you that (or an afternoon of fighting Bluetooth stacks), you can chip in for new test boards and iOS updates.</p>
<p class="small">Not in a position to donate? A <a href="https://github.com/Mattboxx/Esp32_Iphone_shortcuts_bluetooth_trigger">⭐ on GitHub</a>
or a <a href="https://github.com/Mattboxx/Esp32_Iphone_shortcuts_bluetooth_trigger/issues">hardware test report</a> helps just as much.</p>
<p class="small">Not in a position to donate? A <a href="https://github.com/Mattboxx/esp32-bt-trigger">⭐ on GitHub</a>
or a <a href="https://github.com/Mattboxx/esp32-bt-trigger/issues">hardware test report</a> helps just as much.</p>
</div>
<div class="support-buttons">
<a class="btn kofi" href="https://ko-fi.com/mattboxx" target="_blank" rel="noopener">☕ Buy me a coffee</a>
Expand All @@ -391,7 +391,7 @@ <h2>Free, and staying that way</h2>

<footer class="foot">
<div class="wrap">
<p>ESP32 BT Trigger · MIT License · <a href="https://github.com/Mattboxx/Esp32_Iphone_shortcuts_bluetooth_trigger">GitHub</a> ·
<p>ESP32 BT Trigger · MIT License · <a href="https://github.com/Mattboxx/esp32-bt-trigger">GitHub</a> ·
<a href="https://ko-fi.com/mattboxx">Ko-fi</a> · <a href="https://github.com/sponsors/Mattboxx">Sponsor</a> ·
flashing by <a href="https://github.com/espressif/esptool-js">esptool-js</a> (Apache-2.0).
Not affiliated with Apple or Espressif. iPhone and Shortcuts are trademarks of Apple Inc.</p>
Expand All @@ -409,7 +409,7 @@ <h2 id="sd-title">Thanks for thinking of it ♥</h2>
<a class="sd-opt" href="https://github.com/sponsors/Mattboxx" target="_blank" rel="noopener">
<span class="sd-ico">♥</span><span><b>GitHub Sponsors</b><small>Monthly or one-time, with your GitHub account.</small></span></a>
</div>
<p class="sd-free">Can't donate? A <a href="https://github.com/Mattboxx/Esp32_Iphone_shortcuts_bluetooth_trigger">⭐ on GitHub</a> helps just as much.</p>
<p class="sd-free">Can't donate? A <a href="https://github.com/Mattboxx/esp32-bt-trigger">⭐ on GitHub</a> helps just as much.</p>
</form>
</dialog>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/js/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ function renderDownloads() {
const tb = $("dl-table").querySelector("tbody");
if (!state.manifest) {
tb.innerHTML = `<tr><td colspan="4">Firmware files not found. Get them from the
<a href="https://github.com/Mattboxx/Esp32_Iphone_shortcuts_bluetooth_trigger/releases">Releases page</a>.</td></tr>`;
<a href="https://github.com/Mattboxx/esp32-bt-trigger/releases">Releases page</a>.</td></tr>`;
return;
}
tb.innerHTML = "";
Expand Down
2 changes: 1 addition & 1 deletion firmware/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ready-to-flash firmware

The easiest way is the **[web installer](https://mattboxx.github.io/Esp32_Iphone_shortcuts_bluetooth_trigger/)**:
The easiest way is the **[web installer](https://mattboxx.github.io/esp32-bt-trigger/)**:
it picks the right file for your chip and writes your settings (name, trigger mode,
LED, button…) at the same time.

Expand Down
2 changes: 1 addition & 1 deletion marketing/CAMPAIGN.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Campagna di lancio: ESP32 BT Trigger v2

Link da usare ovunque: **https://mattboxx.github.io/Esp32_Iphone_shortcuts_bluetooth_trigger/**
Link da usare ovunque: **https://mattboxx.github.io/esp32-bt-trigger/**
(il sito, non il repo: il sito converte, il repo spaventa chi non è sviluppatore).

---
Expand Down
Loading