homebridge-ecobee-security 0.9.0 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,50 @@
 # Changelog
 
+## 1.0.0
+
+- New setting **Quick Responses** (`quickResponses`, `quickResponseMessages`) in the Doorbell camera card:
+  short messages the doorbell plays on its speaker. They appear as one "Quick Responses" tile in the Home app
+  with a switch per message (open the tile to pick one; tapping the tile itself plays nothing), which you can
+  add to the live view's Nearby Accessories or use from Siri and automations. New setting
+  `quickResponseVolume` (default 40%) sets how loud they play. Three come built in (Leave
+  Delivery, Hang On, Not Home), each with a Preview button in the settings; remove the ones you don't want
+  (and add them back). With Piper installed you can also reword them and add your own.
+  The doorbell needs to accept audio from the plugin, as for two-way talk, but two-way talk doesn't have to be
+  on. If the doorbell connection is down, a message waits up to 20 seconds for it to come back; it doesn't
+  play while another message is playing or someone is talking in a live view, and the log says why.
+- The built-in messages come as recordings made with Piper's ryan voice (RyanSpeech, CC BY-NC-SA 4.0; see
+  `assets/quick-responses/LICENSE`). Changed or new wording needs [Piper](https://github.com/OHF-Voice/piper1-gpl)
+  on the Homebridge machine (`piperPath`, `piperVoice`; see "Custom wording with Piper" in the README).
+- Two-way talk is no longer a beta.
+- New **Doorbell Pressed** occupancy sensor on the video doorbell (with the doorbell link): Detected for 10
+  seconds after each press of any kind, for automations. It shows No Response while the link is down.
+
+## 0.9.1
+
+- New setting **Add Comfort Setting switches** (`comfortSetting`, `comfortHoldType`): a Comfort Setting
+  accessory with a switch for each ecobee comfort setting (Home, Away, Sleep and your own). Turning one on
+  holds it, turning it off goes back to the schedule, and holds set in the ecobee app show up too.
+- New setting **Two-way talk (beta)** (`twoWayAudio`, off by default): talk through the doorbell from the Home
+  app's live view. Needs the doorbell to accept audio from the plugin; the log says what it answered. With it
+  on, `twoWayAudioTest` (config only) plays a 3-second tone on the doorbell when a live view starts.
+- New setting **Enable presence sensors for household members** (`memberPresence`, `presenceMembers`):
+  an occupancy sensor per person, Occupied while the ecobee app's location says they are home, for Home
+  app conditions like "only if Alex is home". Needs location set to Always in the ecobee app on that
+  person's phone; shows No Response while unknown.
+- New setting **Home Occupied source** (`occupancySource`): besides your own Home app automations
+  (the default), Home Occupied can follow **ecobee Autopilot**, the ecobee app's location on household
+  members' phones, which arms and disarms like the switch does. ecobee's Smart Home & Away stays as the
+  third choice, now labelled beta.
+- Two new settings with the Vacation Mode switch (off by default; they need the Home Occupied switch and
+  a source other than ecobee Smart Home & Away): **Start a vacation when the home has been empty for**
+  (`vacationWhenEmpty`, `vacationEmptyHours`), a safety net that starts a vacation once, and **End the
+  vacation when someone comes home** (`vacationEndOnArrival`), which also ends dated vacations.
+- When the last hold is released (a robot back on its base, say) and it had switched Away to Home, Away is
+  armed again after a 3-second countdown instead of the full exit delay. The house was already empty, so
+  the delay only left it unarmed longer. Away you asked for during the hold still gets the normal exit delay.
+- Fixed: turning Vacation Mode on in the Home app didn't start a vacation (ecobee rejected the vacation's
+  name).
+
 ## 0.9.0
 
 ### Doorbell camera (beta)

package/README.md

@@ -38,6 +38,7 @@ GraphQL at `federated-api.prod.federated-graph.generacapis.com`), which ecobee c
 - **Vacation Mode** switch that follows, and starts, an ecobee vacation.
 - **Security holds** let other plugins, like a robot vacuum, keep the system from arming Away while they work.
 - **Doorbell camera** with HomeKit Secure Video, live view and snapshots; with the **doorbell link**, instant ring and motion, the sensors the doorbell bridges to HomeKit, and its Chime, Status Light and Night Vision switches.
+- **Quick Responses**: short messages the doorbell plays on its speaker ("Leave Delivery", "Hang On", "Not Home"), one Quick Responses tile in the Home app, plus a **Doorbell Pressed** sensor for automations.
 
 ## Contents
 
@@ -49,6 +50,7 @@ GraphQL at `federated-api.prod.federated-graph.generacapis.com`), which ecobee c
 - [Keypad unlock](#keypad-unlock)
 - [Security holds](#security-holds)
 - [Doorbell camera](#doorbell-camera)
+- [Quick Responses](#quick-responses)
 - [Home Occupied switch](#home-occupied-switch)
 - [Vacation Mode switch](#vacation-mode-switch)
 - [Smoke alarm and air quality](#smoke-alarm-and-air-quality)
@@ -150,6 +152,12 @@ Sign-in: see [Sign-in](#sign-in).
 | `doorbellCamera` | `false` | Adds the doorbell camera (beta). Restart the bridge after changing it. |
 | `motionGrace` | `15` | Seconds the motion sensor stays on after the doorbell's motion ends (6 to 120). |
 | `ffmpegPath` | `/usr/local/bin/ffmpeg` if it exists, else `ffmpeg` | The ffmpeg to use. |
+| `twoWayAudio` | `false` | Talk through the doorbell from the Home app's live view (see [Two-way talk](#two-way-talk)). |
+| `twoWayAudioTest` | `false` | With `twoWayAudio`: plays a 3-second tone on the doorbell when a live view starts (config file only). |
+| `quickResponses` | `false` | Adds a switch per message that plays it on the doorbell (see [Quick Responses](#quick-responses)). Restart the bridge after changing it. |
+| `quickResponseVolume` | `40` | How loud messages play at the door, in percent (5 to 100). Doesn't change two-way talk. |
+| `quickResponseMessages` | the three built-ins | The messages: a list of `{ "id", "name", "phrase" }`; a built-in with `"enabled": false` is removed but keeps its wording. `id` never changes (it is the switch's identity in the Home app), `name` is the tile name (14 characters at most), `phrase` is what is said. |
+| `piperPath`, `piperVoice` | none | Piper and its voice, only for changed or new wording (see [Custom wording with Piper](#custom-wording-with-piper)). |
 | `debugRecordings` | `false` | Keeps the last five recordings for troubleshooting (config file only; see [Troubleshooting](#troubleshooting)). |
 
 ### Switches and sensors settings
@@ -157,7 +165,14 @@ Sign-in: see [Sign-in](#sign-in).
 | Setting | Default | |
 |---|---|---|
 | `occupancySwitch` | `false` | Adds a **Home Occupied** switch for your presence automations (see [Home Occupied switch](#home-occupied-switch)). |
+| `occupancySource` | `"home"` | Who sets Home Occupied: `"home"` (your automations), `"autopilot"` or `"ecobee"` (see [Home Occupied source](#home-occupied-source)). |
+| `memberPresence` | `false` | Adds a presence sensor for each household member in `presenceMembers` (see [Member presence sensors](#member-presence-sensors)). |
+| `presenceMembers` | none | The ecobee account ids of the people to add; the settings page lists them. |
 | `vacationSwitch` | `false` | Adds a **Vacation Mode** switch that is on while an ecobee vacation is running (see [Vacation Mode switch](#vacation-mode-switch)). |
+| `vacationWhenEmpty` | `false` | Starts a vacation when Home Occupied has been off for `vacationEmptyHours` (default 24; see [Vacations that follow Home Occupied](#vacations-that-follow-home-occupied)). |
+| `vacationEndOnArrival` | `false` | Ends running vacations when Home Occupied turns on. |
+| `comfortSetting` | `false` | Adds a **Comfort Setting** accessory with a switch per ecobee comfort setting (see [Comfort Setting](#comfort-setting)). |
+| `comfortHoldType` | `"nextTransition"` | How long a comfort setting turned on is held: `"nextTransition"` or `"indefinite"`. |
 | `smokeSensor` | `true` | Adds a separate **Smoke Alarm** accessory (a Smoke Sensor) that detects smoke while ecobee has a smoke-alarm incident open, for automations and Home app smoke notifications. Set to `false` to remove it. |
 | `airQuality` | `true` | For each thermostat with an air quality sensor: an accessory "<thermostat> Air Quality" with an **Air Quality Sensor** (overall level; VOC as ecobee reports it, in ppb, which the Home app labels µg/m³) and a **Carbon Dioxide Sensor** (ppm). Read every 5 minutes. The level follows the ecobee app's Clean–Poor bar: its first two segments are Excellent, then Good, Fair, Inferior, Poor; Unknown while the sensor calibrates. |
 | `co2Alert` | `1000` | CO2 (ppm) at or above which the Carbon Dioxide Sensor reports abnormal levels. |
@@ -231,9 +246,9 @@ Using a robot vacuum as the example:
 
 | Situation | What the security system does |
 |---|---|
-| The robot starts cleaning while the system is armed **Away** | Switches to Home, and goes back to Away when the robot is done. |
+| The robot starts cleaning while the system is armed **Away** | Switches to Home, and goes back to Away when the robot is done, after a 3-second countdown. |
 | The robot starts while the system is set to **Home**, **Night** or **Off** | Nothing changes. |
-| You arm **Away in the Home app** while the robot is cleaning (the tile, a scene, an automation or Siri) | Stays in Home until the robot is done, then arms Away. The tile shows "Arming…" meanwhile. |
+| You arm **Away in the Home app** while the robot is cleaning (the tile, a scene, an automation or Siri) | Stays in Home until the robot is done, then arms Away with the normal exit delay. The tile shows "Arming…" meanwhile. |
 | You want Away **now** | Turn on the **Arm Away Now** switch (see [Hold options](#hold-options)). It arms Away right away and sends the robot home. |
 | You arm **Away in the ecobee app** while the robot is cleaning | Sends the robot home, and gives it up to 2 extra minutes on the countdown. It arms as soon as the robot is docked, but never earlier than your normal countdown. If the robot won't make it in time, it stops where it is before the sensors arm. |
 | You arm **Away at the keypad** while the robot is cleaning | Stops the robot where it is. ecobee doesn't report keypad countdowns, so this happens once Away is already armed: there's a window of up to 10 seconds in which a motion sensor could still catch the robot. |
@@ -313,7 +328,7 @@ camera isn't published and the log says why.
 
 Skip steps 2 to 4 to run the camera without the link: it is then a second tile, a plain camera named
 "<name> Camera", next to ecobee's own doorbell tile, which keeps the ring, motion and recordings. With the
-link the camera replaces ecobee's doorbell. Two-way talk isn't supported yet (see the notes above).
+link the camera replaces ecobee's doorbell.
 
 Notes:
 
@@ -339,7 +354,8 @@ the Home app. You get:
   occupancy and battery state;
 - the doorbell's own switches: **Chime Doorbell**, **Camera Status Light** and **Night Vision Light**.
   Changes in the Home app are sent to the doorbell, and changes made at the doorbell show up in the Home
-  app. While the link is down, setting one fails.
+  app. While the link is down, setting one fails;
+- a **Doorbell Pressed** sensor (see below).
 
 The pairing is kept in `ecobee-security/doorbell-pairing.json` in the Homebridge folder. **Unlink** in the
 settings removes it from the doorbell as well (restart the bridge afterwards). If the link drops, the
@@ -347,6 +363,13 @@ plugin looks for the doorbell again and reconnects by itself; the ring, motion,
 sensors show **No Response** while it has been down for a minute. The video still comes from the
 cloud session (the doorbell's own stream isn't used).
 
+### Doorbell Pressed sensor
+
+With the doorbell link, the video doorbell also has an occupancy sensor named **Doorbell Pressed**. Each press
+(single, double or long) sets it to Detected for 10 seconds; another press starts the 10 seconds again.
+The Home app can't start an automation from a video doorbell's ring, but it can from a sensor. It shows No
+Response while the doorbell link is down.
+
 ### HomeKit Secure Video
 
 The camera records for HomeKit Secure Video (a home hub and an iCloud+ plan are needed, as for any
@@ -369,6 +392,63 @@ person, animal and package detection, are then made by HomeKit.
 
 To inspect recordings, see [Troubleshooting](#troubleshooting).
 
+### Two-way talk
+
+Turn on **Two-way talk** (`twoWayAudio`) and restart the bridge to talk through the doorbell from the Home app's
+live view (the microphone button). Whether the doorbell accepts audio from the plugin can depend on its firmware, and talking adds a little delay. The log says at start-up what the doorbell answered ("two-way
+talk: the camera answered audio sendrecv" is good; anything else means it can't take audio and the plugin carries
+on receive-only, as before). The live view's picture and sound are not affected.
+
+To check that audio reaches the doorbell, set `"twoWayAudioTest": true` in the config (there is no settings-page
+switch), open the live view while standing at the door, and listen for a 3-second tone; the log says "test tone
+sent". Turn it off afterwards.
+
+## Quick Responses
+
+Quick Responses are short messages the doorbell plays on its speaker, for the person at your door: "You can just leave it", "We'll be right there". Turn on **Quick Responses** (`quickResponses`, in the **Doorbell camera** card, which needs the doorbell camera) and restart the bridge. It needs the doorbell to accept audio from the plugin, the same as [Two-way talk](#two-way-talk) (the log says what it answered), but **Two-way talk** itself doesn't have to be on.
+
+There are three built-in messages:
+
+| Tile | Says |
+|---|---|
+| Leave Delivery | "Hi there. You can just leave it. Thanks!" |
+| Hang On | "Just a sec, we'll be right there." |
+| Not Home | "Hi there, no one can answer the door right now, but we'll be notified that you stopped by." |
+
+The messages appear in the Home app as **one tile, "Quick Responses"**, which holds a switch per message. Tapping the tile itself turns all of them on at once, which the plugin recognises and ignores (it plays nothing and the switches turn back off; the log says so). **Open the tile** (long-press, or tap its settings) and pick one message instead. If you prefer a tile per message, turn on **Show as Separate Tiles** in the accessory's settings in the Home app. In the doorbell's live view, the group appears as one tile in **Nearby Accessories**: add it there and tap the message you want. Turning a message's switch on plays it and it turns itself off when the message ends. Siri works too ("Hey Siri, turn on Not Home"), and so do automations and scenes. Messages play at the volume you set (`quickResponseVolume`, 40% by default).
+
+In the settings, each message is a row: the **title** (the tile name, 14 characters at most), **what is said**, and **Preview**, which plays it in your browser. Without Piper, the three built-in messages are fixed: the rows show their title and wording as text, and you can preview them. Once [Piper](#custom-wording-with-piper) is installed, each built-in row has **Replace** (edit its title and wording; **Restore** goes back to the shipped wording and audio) and **Add a message** adds your own, with a remove button. The built-in messages can be removed (×) and added back from the line under the rows, with or without Piper; a removed message's switch leaves the Home app after a bridge restart, and returns with the same identity when added back. Changing a title or the wording takes effect after a bridge restart.
+
+An example automation: when someone rings and nobody is home, tell them so.
+
+1. **Trigger:** An Accessory is Controlled > **Doorbell Pressed** detects occupancy ([Doorbell Pressed sensor](#doorbell-pressed-sensor)).
+2. **Condition:** only if **Home Occupied** is off ([Home Occupied switch](#home-occupied-switch)).
+3. **Action:** turn on **Not Home**.
+
+How it works: the message is played into the plugin's session with the doorbell, so it can't play while the session is down, while the camera hasn't accepted audio from us, while another message is playing, or while someone is talking in a live view (the microphone has priority; a message that is playing stops when someone starts talking). The switch then turns itself back off after a second, and the log says why. One message plays at a time. The log line "Quick Response "<name>" played" shows how many audio packets were sent. Each switch's identity comes from the message's `id`, not its title or wording, so you can rename a message without breaking the automations that use it. Messages you remove from the settings disappear from the Home app after a restart.
+
+### Custom wording with Piper
+
+The three built-in messages come as recordings with the plugin. Anything else, meaning reworded built-ins and your own messages, is turned into speech on your Homebridge machine with [Piper](https://github.com/OHF-Voice/piper1-gpl), a local text-to-speech program that doesn't send your text anywhere. That is optional: without Piper the built-ins work as they are, and a message that needs it is left out, with a warning in the log.
+
+1. Install Piper into a folder the Homebridge user can read, for example a Python virtual environment:
+
+   ```sh
+   sudo -u homebridge python3 -m venv /var/lib/homebridge/piper
+   sudo -u homebridge /var/lib/homebridge/piper/bin/pip install piper-tts
+   ```
+
+2. Download a voice: an `.onnx` file and its `.onnx.json` file, side by side, from [rhasspy/piper-voices on Hugging Face](https://huggingface.co/rhasspy/piper-voices). The built-in messages use the English (US) **ryan**, **high** quality voice, which is a good place to start.
+3. In the settings, under **Piper settings** in the Quick Responses box, fill in **Piper path** (the `piper` program, for example `/var/lib/homebridge/piper/bin/piper`) and **Piper voice** (the `.onnx` file). The page says whether Piper was found. **Preview** then plays your wording.
+
+The plugin makes the audio for your messages when the bridge starts (one at a time, in the background) and keeps it in `ecobee-security/quick-responses` in the Homebridge folder, and removes it when no message uses it any more. A message shows up in the Home app once its audio is ready. All messages are spoken with the same speed and voice settings as the built-ins.
+
+Tips: a bare "Hi!" can come out as "Aye". Writing "Hi there" usually helps, or give Piper the exact sounds: text between `[[` and `]]` is read as phonemes, for example `[[ hˈaɪ ðɛɹ ]]`. Phonemes are passed through unchanged.
+
+### Voice licensing
+
+The recordings of the built-in messages (in `assets/quick-responses`) were made with Piper's **ryan** voice, whose training data (RyanSpeech) is licensed **CC BY-NC-SA 4.0**. The recordings are therefore licensed under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) too: free for non-commercial use, with attribution: "RyanSpeech (CC BY-NC-SA 4.0), synthesized with Piper". The rest of the plugin stays MIT licensed. A voice you use for your own wording has its own license; check it before sharing recordings made with it.
+
 ## Home Occupied switch
 
 Apple Home asks you to confirm (a notification you have to tap) whenever a people-arrive or
@@ -404,6 +484,42 @@ What each direction does:
 > or from a shared home member's phone, turns off an Away system, so treat it as as sensitive as the
 > security tile itself.
 
+### Home Occupied source
+
+Who sets the switch is the **Home Occupied source** (`occupancySource`), shown once the switch is on.
+Restart the bridge after changing it.
+
+| Source | `occupancySource` | What decides |
+|---|---|---|
+| **Set via Home App Automations** | `"home"` (default) | You do, with Home app arrive/leave automations, which use Apple's location of each person in your Home. Fastest, and you keep the most control. Nothing to set up in ecobee. |
+| **ecobee Autopilot** | `"autopilot"` | The ecobee app's location on each household member's phone, read every 30 seconds. Location must be set to **Always** in the ecobee app on every phone that counts. Reacts quickly, but doesn't see guests or people without the ecobee app. |
+| **ecobee Smart Home & Away (beta)** | `"ecobee"` | The thermostat, part of ecobee's eco+: it decides from motion on ecobee sensors, plus phones when Autopilot is on. It notices anyone in the house, but can take a long time to decide the home is empty. Paused during an ecobee vacation. Doesn't arm or disarm anything. |
+
+With Autopilot, someone home is any member whose phone is tracked and reads home; nobody home is all of
+those reading away. If some are unknown and none is home, the switch keeps its last state, and so it
+does if no member is tracked or ecobee can't be reached (the log says which). After a restart, Autopilot's first reading only brings the switch up to date, without arming or disarming
+anything; later changes arm and disarm exactly as the switch does. With either ecobee source the switch follows ecobee, so changing it
+in the Home app is undone.
+
+> [!NOTE]
+> If ecobee's own Autopilot is set to arm and disarm by itself in the ecobee app, ecobee and the plugin
+> both act on the same arrivals and departures. Pick one.
+
+## Member presence sensors
+
+Turn on **Enable presence sensors for household members** (`memberPresence`) and tick the people in the
+settings (`presenceMembers`, their ecobee account ids). Each gets an occupancy sensor named after them,
+**Occupied** while the ecobee app's location says they are home, for Home app conditions like "only if
+Alex is home" or "only when nobody else is home". The plugin reads ecobee every 30 seconds and logs
+when someone comes or goes. Restart the bridge after changing the setting.
+
+- The person's phone must report to ecobee with location set to **Always** in the ecobee app. A person
+  for whom that isn't so isn't listed as available in the settings, and gets no sensor until it is.
+- Only household members count. Guests, and people without the ecobee app, aren't seen.
+- **No Response** means unknown: ecobee doesn't know where the phone is, the person is no longer tracked,
+  or ecobee couldn't be reached for a while.
+- Anyone you share your Home with can see these sensors, and so where the people are.
+
 ## Vacation Mode switch
 
 Turn on **Vacation Mode switch** (`vacationSwitch`) and the plugin adds a switch named **Vacation Mode**
@@ -421,6 +537,47 @@ ends.
 - Like the other sensors, the switch shows No Response while ecobee can't be reached or you're
   signed out. Restart the bridge after changing the setting.
 
+### Vacations that follow Home Occupied
+
+Two optional settings in the Vacation Mode section (off by default). They need both the Home Occupied
+and the Vacation Mode switches, and a [Home Occupied source](#home-occupied-source) other than ecobee
+Smart Home & Away, which ecobee pauses during a vacation.
+
+- **Start a vacation when the home has been empty for** (`vacationWhenEmpty`, `vacationEmptyHours`,
+  24 by default, 1 to 720): once Home Occupied has been off that long and no vacation is running, the
+  plugin starts one as the switch does. It does this at most once per empty period, so a vacation you
+  end by hand while still away stays ended. Treat it as a safety net and start vacations deliberately,
+  with the switch or dated in the ecobee app: a wrongly "empty" home (say, a phone without location
+  set to Always under ecobee Autopilot) would start one, which is why the default is long.
+- **End the vacation when someone comes home** (`vacationEndOnArrival`): when Home Occupied turns on,
+  every running ecobee vacation ends, including dated ones from the ecobee app. The reading right
+  after a restart doesn't count.
+
+Visitors while you're away aren't household members, so Home Occupied stays off and the vacation keeps
+running. They disarm with their keypad code and arm Away from the ecobee keypad when they leave. If
+they forget, the Home app's security notification shows the disarm, and you can arm from your phone.
+
+## Comfort Setting
+
+Turn on **Add Comfort Setting switches** (`comfortSetting`) and the plugin adds one accessory,
+**Comfort Setting**, with a switch for each of your ecobee comfort settings (Home, Away, Sleep and your own,
+read from the thermostats' program; with several thermostats, a setting any of them has). It is for
+automations such as "Home Occupied off → Away on".
+
+- Turning a switch **on** holds that comfort setting on the thermostats that have it, and the others
+  turn off. How long: `comfortHoldType`, `"nextTransition"` (default, until the next scheduled change)
+  or `"indefinite"` (until you change it).
+- Turning the active switch **off** goes back to your schedule, so all off means following the schedule.
+- A hold set in the ecobee app or on the thermostat lights the matching switch (read every minute). A
+  temperature-only hold lights none.
+- During an ecobee vacation all switches are off and changes are refused (the log says so).
+- Like the other sensors, the switches show No Response while ecobee can't be reached. Restart the
+  bridge after changing the setting.
+
+> [!NOTE]
+> The Home app shows the switches as one tile, and tapping the tile toggles all of them. Open the tile
+> and pick one, or use **Show as Separate Tiles** in the accessory's settings.
+
 ## Smoke alarm and air quality
 
 - **Smoke Alarm** (`smokeSensor`, on by default) is its own accessory, a Smoke Sensor that detects smoke while ecobee has a smoke-alarm incident open. It is separate from the security tile (the Home app would otherwise merge it into the tile with a cloud icon).

package/assets/quick-responses/LICENSE

@@ -0,0 +1,19 @@
+The audio files in this folder (leave-delivery.wav, hang-on.wav, not-home.wav) are licensed under the
+Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International license (CC BY-NC-SA 4.0).
+
+  https://creativecommons.org/licenses/by-nc-sa/4.0/
+  Legal code: https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode
+
+You may copy and redistribute the recordings and adapt them, for non-commercial purposes only, if you give
+appropriate credit, indicate changes, and share your adaptations under the same license.
+
+Attribution:
+
+  RyanSpeech (CC BY-NC-SA 4.0), synthesized with Piper
+
+The recordings were synthesized with the Piper text-to-speech program (https://github.com/OHF-Voice/piper1-gpl)
+and its "ryan" voice (en_US-ryan-high), which was trained on the RyanSpeech dataset,
+licensed CC BY-NC-SA 4.0.
+
+The rest of this package is licensed under the MIT license (see the LICENSE file in the package root); this
+license applies only to the files in this folder.

package/config.schema.json

@@ -106,17 +106,121 @@
         "default": false,
         "description": "Adds a Home Occupied switch to the Home app, with an occupancy sensor. By default your own people-arrive and people-leave automations set it, and it does the rest: off (nobody home) arms Away, on (someone home) turns Away off. Switches don't ask for confirmation the way automations that change the security system do. See \"Home Occupied switch\" in the README."
       },
+      "occupancySource": {
+        "title": "Home Occupied source",
+        "type": "string",
+        "default": "home",
+        "oneOf": [
+          {
+            "title": "Set via Home App Automations",
+            "enum": [
+              "home"
+            ]
+          },
+          {
+            "title": "ecobee Autopilot",
+            "enum": [
+              "autopilot"
+            ]
+          },
+          {
+            "title": "ecobee Smart Home & Away (beta)",
+            "enum": [
+              "ecobee"
+            ]
+          }
+        ],
+        "description": "Who sets Home Occupied. Home App Automations: your arrive/leave automations. ecobee Autopilot: the ecobee app's location on household members' phones, which need location set to Always in the ecobee app. ecobee Smart Home & Away: the thermostat decides from motion on ecobee sensors (plus phones when Autopilot is on); it can be slow to notice an empty home, and it doesn't arm or disarm. See \"Home Occupied source\" in the README.",
+        "condition": {
+          "functionBody": "return model.occupancySwitch === true;"
+        }
+      },
+      "memberPresence": {
+        "title": "Presence sensors for household members",
+        "type": "boolean",
+        "default": false,
+        "description": "Adds an occupancy sensor for each person in presenceMembers, for Home app conditions like \"only if Alex is home\". Anyone you share your Home with can see them. Each person's phone needs location set to Always in the ecobee app. See \"Member presence sensors\" in the README."
+      },
+      "presenceMembers": {
+        "title": "People with a presence sensor",
+        "type": "array",
+        "items": {
+          "type": "string"
+        },
+        "description": "ecobee account ids of the people to add (the settings page lists them). With no list, none.",
+        "condition": {
+          "functionBody": "return model.memberPresence === true;"
+        }
+      },
       "vacationSwitch": {
         "title": "Vacation Mode switch",
         "type": "boolean",
         "default": false,
         "description": "Shows when an ecobee vacation is on, for other accessories to follow. Turn it on to start a vacation now, until you turn it off; set dated vacations in the ecobee app."
       },
+      "vacationWhenEmpty": {
+        "title": "Start a vacation when the home has been empty for",
+        "type": "boolean",
+        "default": false,
+        "description": "A safety net if you forget to turn Vacation Mode on: starts an ecobee vacation once Home Occupied has been off for vacationEmptyHours. Needs the Home Occupied and Vacation Mode switches, and a Home Occupied source other than ecobee Smart Home & Away.",
+        "condition": {
+          "functionBody": "return model.vacationSwitch === true && model.occupancySwitch === true && model.occupancySource !== 'ecobee';"
+        }
+      },
+      "vacationEmptyHours": {
+        "title": "Hours empty before the vacation starts",
+        "type": "integer",
+        "default": 24,
+        "minimum": 1,
+        "maximum": 720,
+        "description": "How long the home has to be empty first.",
+        "condition": {
+          "functionBody": "return model.vacationWhenEmpty === true && model.vacationSwitch === true && model.occupancySwitch === true && model.occupancySource !== 'ecobee';"
+        }
+      },
+      "vacationEndOnArrival": {
+        "title": "End the vacation when someone comes home",
+        "type": "boolean",
+        "default": false,
+        "description": "Ends any running ecobee vacation, including dated ones from the ecobee app, when Home Occupied turns on. Needs the Home Occupied and Vacation Mode switches, and a Home Occupied source other than ecobee Smart Home & Away.",
+        "condition": {
+          "functionBody": "return model.vacationSwitch === true && model.occupancySwitch === true && model.occupancySource !== 'ecobee';"
+        }
+      },
+      "comfortSetting": {
+        "title": "Add Comfort Setting switches",
+        "type": "boolean",
+        "default": false,
+        "description": "One switch per ecobee comfort setting (Home, Away, Sleep and your own). Turning one on holds it; turning it off goes back to your schedule. Restart the bridge after changing this."
+      },
+      "comfortHoldType": {
+        "title": "Comfort setting hold",
+        "type": "string",
+        "default": "nextTransition",
+        "oneOf": [
+          {
+            "title": "Until the next scheduled change",
+            "enum": [
+              "nextTransition"
+            ]
+          },
+          {
+            "title": "Until I change it",
+            "enum": [
+              "indefinite"
+            ]
+          }
+        ],
+        "description": "How long a comfort setting you turn on in the Home app is held.",
+        "condition": {
+          "functionBody": "return model.comfortSetting === true;"
+        }
+      },
       "doorbellCamera": {
         "title": "Doorbell camera",
         "type": "boolean",
         "default": false,
-        "description": "Brings the ecobee doorbell into HomeKit Secure Video: recordings, activity zones and Apple's person and package detection in the Home app, plus live view. With the doorbell link it replaces ecobee's doorbell (instant ring and motion). Two-way talk isn't supported yet. Restart the bridge after changing this. Add it in the Home app with the setup code shown in the Homebridge log. Needs an ffmpeg with libfdk_aac and libx264. See \"Doorbell camera\" in the README."
+        "description": "Brings the ecobee doorbell into HomeKit Secure Video: recordings, activity zones and Apple's person and package detection in the Home app, plus live view. With the doorbell link it replaces ecobee's doorbell (instant ring and motion). Restart the bridge after changing this. Add it in the Home app with the setup code shown in the Homebridge log. Needs an ffmpeg with libfdk_aac and libx264. See \"Doorbell camera\" in the README."
       },
       "motionGrace": {
         "title": "Motion grace period (seconds)",
@@ -129,6 +233,97 @@
           "functionBody": "return model.doorbellCamera === true;"
         }
       },
+      "twoWayAudio": {
+        "title": "Two-way talk",
+        "type": "boolean",
+        "default": false,
+        "description": "Talk through the doorbell from the Home app's live view.",
+        "condition": {
+          "functionBody": "return model.doorbellCamera === true;"
+        }
+      },
+      "twoWayAudioTest": {
+        "title": "Two-way talk test tone",
+        "type": "boolean",
+        "default": false,
+        "description": "Plays a 3-second tone on the doorbell when live view starts, to check that audio reaches it. Turn it off afterwards.",
+        "condition": {
+          "functionBody": "return model.doorbellCamera === true && model.twoWayAudio === true;"
+        }
+      },
+      "quickResponses": {
+        "title": "Quick Responses",
+        "type": "boolean",
+        "default": false,
+        "description": "Short messages the doorbell can play. They appear as one Quick Responses tile in the Home app, with a switch per message, which you can add to the live view's Nearby Accessories. Restart the bridge after changing this. See \"Quick Responses\" in the README.",
+        "condition": {
+          "functionBody": "return model.doorbellCamera === true;"
+        }
+      },
+      "quickResponseVolume": {
+        "title": "Quick Response volume (%)",
+        "type": "integer",
+        "default": 40,
+        "minimum": 5,
+        "maximum": 100,
+        "description": "How loud messages play at the door.",
+        "condition": {
+          "functionBody": "return model.doorbellCamera === true && model.quickResponses === true;"
+        }
+      },
+      "quickResponseMessages": {
+        "title": "Quick Response messages",
+        "type": "array",
+        "description": "The messages, each with an id that stays the same (it keeps the switch's identity in the Home app), a name of up to 14 characters, and what is said. With no list, the three built-in messages (Leave Delivery, Hang On, Not Home).",
+        "items": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "title": "Id",
+              "type": "string"
+            },
+            "name": {
+              "title": "Name",
+              "type": "string",
+              "maxLength": 14
+            },
+            "phrase": {
+              "title": "What is said",
+              "type": "string"
+            },
+            "enabled": {
+              "title": "Enabled",
+              "type": "boolean",
+              "default": true,
+              "description": "Only for the built-in messages: false removes the switch from the Home app and keeps the wording."
+            }
+          },
+          "required": [
+            "id",
+            "name",
+            "phrase"
+          ]
+        },
+        "condition": {
+          "functionBody": "return model.doorbellCamera === true && model.quickResponses === true;"
+        }
+      },
+      "piperPath": {
+        "title": "Piper path",
+        "type": "string",
+        "description": "Only for changed or new wording: the piper program you installed (see \"Custom wording with Piper\" in the README).",
+        "condition": {
+          "functionBody": "return model.doorbellCamera === true && model.quickResponses === true;"
+        }
+      },
+      "piperVoice": {
+        "title": "Piper voice",
+        "type": "string",
+        "description": "Path to the voice (.onnx) Piper speaks with.",
+        "condition": {
+          "functionBody": "return model.doorbellCamera === true && model.quickResponses === true;"
+        }
+      },
       "ffmpegPath": {
         "title": "ffmpeg path",
         "type": "string",