homebridge-sleep-wake 1.7.2

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,371 @@
+# homebridge-sleep-wake
+
+## What This Plugin Is
+This is a plugin for [homebridge](https://github.com/homebridge/homebridge). It allows for management of the [Philips Somneo HF3670/60](https://www.usa.philips.com/c-p/HF3670_60/smartsleep-connected-sleep-and-wake-up-light). Additionally, it provides sensor data from the clock.
+
+## How the Plugin Works
+The Somneo Clock has a small HTTP server running inside with a limited API. Through Googling and trial-and-error, I've found commands that work to replicate the SleepMapper app.
+
+This server is very low powered though and if you see error messages in your logs it's most likely that two connections were trying to be processed at once.
+
+### Conflicting Accessories
+
+In the physical world, the Somneo clock is a single device. But in the HomeBridge world, it is multiple. For this reason, I've created the concept of *Conflicting Accessories*.
+
+A *Conflicting Accessory* means an accessory that needs full control over a physical device. In the case of the Somneo clock, there are two physical devices:
+
+1. The LED light.
+2. The audio speaker.
+
+If a program requires light, it will turn off all other devices that require light. If it requires audio it will turn off all that require audio.
+
+Below, is a chart explaining what will be turned off (if on) when an accessory is turned on.
+
+| | Main Light | Night Light | Sunset Program | RelaxBreathe Program | Audio |
+| --- | :---: | :----------: | :------------: | :------------------: | :---: |
+| Main Light<br />Turns On | N/A | **Turns Off** | **Turns Off** | **Turns Off** | Unaffected |
+| Night Light<br />Turns On| **Turns Off** | N/A | **Turns Off** | **Turns Off** | Unaffected |
+| Sunset <br />Turns On | **Turns Off** | **Turns Off** | N/A | **Turns Off** | **Turns Off**
+| RelaxBreathe<br />Turns On | **Turns Off** | **Turns Off** | **Turns Off** | N/A | **Turns Off**|
+| Audio<br/>Turns On | Unaffected | Unaffected | **Turns Off** | **Turns Off** | N/A
+
+## Installation
+
+Before installing this plugin, you should install Homebridge using the [official instructions](https://github.com/homebridge/homebridge/wiki).
+
+### Install via Homebridge Config UI X
+
+1. Search for `Homebridge Sleep Wake` on the Plugins tab of [Config UI X](https://www.npmjs.com/package/homebridge-config-ui-x).
+2. Install the `Homebridge Sleep Wake` plugin and use the form to enter your configuration.
+
+### Manual Installation
+
+1. Install this plugin using: `sudo npm install -g homebridge-sleep-wake --unsafe-perm`.
+2. Edit `config.json` manually to add your information. See below for instructions on that.
+
+## Manual Configuration
+
+### Platform Schema
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :--------: | ----------------------------- | :----------: |
+| **platform** | *Yes* | string | Must always be set to `HomebridgeSomneo`.| N/A |
+| **name** | *Yes* | string | Set the platform name for display in the Homebridge logs. | `Homebridge Sleep Wake` |
+| **somneos** | *Yes* | object[] | An array of configurations for Somneo clocks | N/A |
+| **pollingSeconds**| No | number | Time in seconds for how often to ping the clock. | `30` (30000 milliseconds) |
+| **webhookApi**| No | object | Optional local HTTP API for Shortcuts and other LAN automations. | Disabled |
+
+#### WebhookApi Schema
+
+Use this when you want iPhone Shortcuts to control alarms. The Somneo itself uses self-signed HTTPS, so iPhone Shortcuts cannot call it directly. This local HTTP API runs on the Homebridge machine and proxies simple alarm requests to the native Somneo wake endpoints.
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **isEnabled** | No | boolean | Enables the local webhook API. | `false` |
+| **bindHost** | No | string | Host/IP address to bind the local API to. Use `0.0.0.0` to allow requests from your iPhone on the same LAN. | `0.0.0.0` |
+| **port** | No | number | TCP port for the local API server. | `8585` |
+| **token** | No | string | Optional shared secret. If set, send it as a Bearer token, `X-Somneo-Token` header, or `token` query parameter. | Unset |
+
+#### Somneo Schema
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **name** | *Yes* | string | The name of the clock. It will be used as a prefix for all of the accessories it exposes. | N/A |
+| **host** | *Yes* | string | IP address or hostname of the Somneo clock. | N/A |
+| **sensors** | *Yes* | object | Settings for sensors in the Somneo clock. | N/A |
+| **lights** | *Yes* | object | Settings for lights in the Somneo clock. | N/A |
+| **switches** | *Yes* | object | Settings for switches in the Somneo clock. | N/A |
+| **audio** | *Yes* | object | Settings for the audio device in the Somneo clock. | N/A |
+
+##### Sensors Schema
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **humidity** | *Yes* | object | Settings for the humidity sensor. | N/A |
+| **lux** | *Yes* | object | Settings for the lux (light) sensor. | N/A |
+| **temperature** | *Yes* | object | Settings for the temperature sensor. | N/A |
+
+###### Humidity Schema
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **isEnabled** | No | boolean | Determines whether or not to expose the humidity sensor. | `true` |
+
+###### Lux Schema
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **isEnabled** | No | boolean | Determines whether or not to expose the lux (light) sensor. | `true` |
+
+###### Temperature Schema
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **isEnabled** | No | boolean | Determines whether or not to expose the temperature sensor. | `true` |
+
+##### Lights Schema
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **mainLight** | *Yes* | object | Settings for the main (dimmable) light. | N/A |
+| **nightLight** | *Yes* | object | Settings for the (on/off) night light. | N/A |
+
+###### MainLight Schema
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **isEnabled** | No | boolean | Determines whether or not to expose the main light. | `true` |
+
+###### NightLight Schema
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **isEnabled** | No | boolean | Determines whether or not to expose the night light. | `true` |
+
+##### Switches Schema
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **relaxBreathe** | *Yes* | object | Settings for the RelaxBreathe Program switch. | N/A |
+| **sunset** | *Yes* | object | Settings for the Sunset Program switch. | N/A |
+| **wakeAlarm** | No | object | Settings for native wake alarm controls. | Disabled |
+
+###### RelaxBreathe Schema
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **isEnabled** | No | boolean | Determines whether or not to expose the RelaxBreathe Program switch. | `true` |
+| **breathsPerMin**| No| number | How many breaths you want to take per minute. | `4` (BPM converted to the Philips value 1) |
+| **duration** | No | number | How long the RelaxBreathe Program should run for. | `10` (minutes) |
+| **guidanceType** | No | number | What kind of guided RelaxBreathe program to run.<br /><br />Possible values:<ul><li>Light = `0`</li><li>Sound = `1`</li></ul> | `0` (Light) |
+| **lightIntensity** | No | number | How bright the RelaxBreathe Program be at its peak. The value is a percentage that will be converted to a number between `1 and 25`. | `80` (80% converted to the the Philips API value 20) |
+| **volume** | No | number | How loud the RelaxBreathe Program should be at its peak. The value is a percentage that will be converted to a number between `1 and 25`. | `48` (48% converted to the the Philips API value 12) |
+
+###### Sunset Schema
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **isEnabled** | No | boolean | Determines whether or not to expose the Sunset Program switch. | `true` |
+| **duration** | No | number | How long the Sunset Program should run for. | `30` (minutes) |
+| **lightIntensity** | No | number | How bright the Sunset Program be at the start. The value is a percentage that will be converted to a number between `1 and 25`. | `80` (80% converted to the the Philips API value 20) |
+| **colorScheme** | No | string | What color pattern should play during the Sunset Program.<br /><br />Possible values:<ul><li>Sunny Day = `'0'`</li><li>Island Red = `'1'`</li><li>Nordic White = `'2'`</li><li>Carribean Red = `'3'`</li></ul> | `'0'` (Sunny Day) |
+| **ambientSounds** | No | string | What sounds should play during the Sunset Program.<br /><br />Possible values:<ul><li>Soft Rain = `'1'`</li><li>Ocean Waves = `'2'`</li><li>Under Water = `'3'`</li><li>Summer Lake = `'4'`</li><li>No Sound = `'0'`</li></ul> | `'1'` (Soft Rain) |
+| **volume** | No | number | How loud the Sunset Program should be at the start. The value is a percentage that will be converted to a number between `1 and 25`. | `48` (48% converted to the the Philips API value 12) |
+
+###### WakeAlarm Schema
+
+The Wake Alarm controls the currently configured Somneo wake profile. Use the Philips app to set the wake time, days, sunrise ramp, and sound. HomeKit can then arm/disarm that profile and optionally expose native snooze and dismiss actions.
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **isEnabled** | No | boolean | Determines whether or not to expose the main Wake Alarm switch. | `false` |
+| **showSnoozeSwitch** | No | boolean | Exposes a momentary `Snooze Alarm` switch that sends the native snooze action. Useful in Favorites or scenes while an alarm is active. | `false` |
+| **showDismissSwitch** | No | boolean | Exposes a momentary `Dismiss Alarm` switch that sends the native dismiss action. Useful in Favorites or scenes while an alarm is active. | `false` |
+
+##### Audio Schema
+
+| Field | Required | Data Type | Description                   | Default Value |
+| ------| :------: | :-------: | ----------------------------- | :-----------: |
+| **isEnabled** | No | boolean |  Determines whether or not to expose the Audio Device.  | `true` |
+| **favoriteInput** | No | number | Numeric value specifying the input for the Somneo Audio to go to the first time its turned on in a session.<br /><br />After changing the input, the Somneo will go to the last used input.<br /><br />Possible values:<ul><li>FM Preset 1 = `1`</li><li>FM Preset 2 = `2`</li><li>FM Preset 3 = `3`</li><li>FM Preset 4 = `4`</li><li>FM Preset 5 = `5`</li><li>Auxiliary = `6`</li></ul> | `1` (FM Preset 1) |
+
+### Somneo Audio Device Note
+
+The Somneo clock has 5 FM radio presets and an auxiliary input. To help accomodate this, an audio receiver called `Somneo Audio` is available. You can turn in on and it will default to `FM Preset 1`. Additionally, you can raise and lower the volume with the Remote widget in iOS/iPadOS's Control Center.
+
+However, due the way that audio receivers are implemented in Homebridge, they must be exposed as an *External Plugin*. This means that the `Somneo Audio` will need to be onboarded separately from the other accessories.
+
+#### Onboarding Instructions for Somneo Audio
+
+1. Select `Add Accessory` in the Home app.
+2. Then select `I Don't Have a Code or Cannot Scan`.
+3. Then the `Somneo Audio` receiver should show as an option. It should look like:
+<img src="https://user-images.githubusercontent.com/5261774/112217388-f5632d80-8bf8-11eb-83e1-2ce41e83fd20.jpg" width="320" />
+4. Enter your Homebridge PIN and the device will connect to your home.
+
+### Config Examples
+
+#### Simplest Configuration
+
+This configuration will expose all items and use the default polling interval with the least work.
+
+```json
+{
+  "name": "Homebridge Somneo",
+  "somneos": [
+    {
+      "name": "Master Bedroom Somneo",
+      "host": "[INSERT_IP_ADDRESS_HERE]"
+    }
+  ],
+  "platform": "HomebridgeSomneo"
+}
+```
+
+#### Most Verbose Configuration
+
+This configuration will expose all items with default values, but is very verbose. It is presented here to help visualize the JSON structure.
+
+```json
+{
+  "name": "Homebridge Somneo",
+  "somneos": [
+    {
+      "name": "Master Bedroom Somneo",
+      "host": "[INSERT_IP_ADDRESS_HERE]",
+      "sensors": {
+        "humidity": {
+          "isEnabled": true
+        },
+        "lux": {
+          "isEnabled": true
+        },
+        "temperature": {
+          "isEnabled": true
+        }
+      },
+      "lights": {
+        "mainLight": {
+          "isEnabled": true
+        },
+        "nightLight": {
+          "isEnabled": true
+        }
+      },
+      "switches": {
+        "relaxBreathe": {
+          "isEnabled": true,
+          "breathsPerMin": 4,
+          "duration": 10,
+          "guidanceType": 0,
+          "lightIntensity": 80,
+          "volume": 48
+        },
+        "sunset": {
+          "isEnabled": true,
+          "duration": 30,
+          "lightIntensity": 80,
+          "colorScheme": 0,
+          "ambientSounds": "1",
+          "volume": 48
+        },
+        "wakeAlarm": {
+          "isEnabled": true,
+          "showSnoozeSwitch": false,
+          "showDismissSwitch": false
+        }
+      },
+      "audio": {
+        "isEnabled": true,
+        "favoriteInput": 1
+      }
+    }
+  ],
+  "pollingSeconds": 30,
+  "webhookApi": {
+    "isEnabled": true,
+    "bindHost": "0.0.0.0",
+    "port": 8585,
+    "token": "replace-me"
+  },
+  "platform": "HomebridgeSomneo"
+}
+```
+
+## Local Shortcut API
+
+Base URL:
+
+```text
+http://homebridge.local:8585/somneo/v1
+```
+
+If only one Somneo clock is configured, the `clock` field is optional. If multiple clocks are configured, set `clock` to the configured clock name or host.
+
+If `webhookApi.token` is configured, include it in one of these ways:
+
+- Query string: `?token=replace-me`
+- Header: `Authorization: Bearer replace-me`
+- Header: `X-Somneo-Token: replace-me`
+
+### Endpoints
+
+| Method | Path | Purpose |
+| ------ | ---- | ------- |
+| `GET` | `/somneo/v1/health` | Health check for the local API server. |
+| `GET` | `/somneo/v1/clocks` | Lists configured Somneo clocks. |
+| `GET` | `/somneo/v1/alarm` | Reads the current Somneo wake alarm. |
+| `GET` | `/somneo/v1/alarm/set?time=07:00` | Shortcut-friendly create/update endpoint using query parameters. |
+| `POST` / `PUT` | `/somneo/v1/alarm` | Create or update the current Somneo wake alarm with JSON. |
+| `POST` / `GET` | `/somneo/v1/alarm/enable` | Arm the current wake alarm profile. |
+| `POST` / `GET` | `/somneo/v1/alarm/disable` | Disarm the current wake alarm profile. |
+| `DELETE` | `/somneo/v1/alarm` | Delete alias. This disables the current wake alarm profile and keeps the saved settings. |
+| `POST` / `GET` | `/somneo/v1/alarm/delete` | Same as `DELETE /somneo/v1/alarm`. |
+| `POST` / `GET` | `/somneo/v1/alarm/snooze` | Sends the native Somneo snooze action. |
+| `POST` / `GET` | `/somneo/v1/alarm/dismiss` | Sends the native Somneo dismiss action. |
+| `POST` / `GET` | `/somneo/v1/alarm/snooze-duration` | Sets the global snooze duration in minutes. |
+
+### Simple Alarm Payload
+
+`POST /somneo/v1/alarm`
+
+```json
+{
+  "clock": "Bedroom Somneo",
+  "time": "07:00",
+  "enabled": true,
+  "sunriseMinutes": 30,
+  "lightTheme": 0,
+  "soundSource": "wus",
+  "sound": "1",
+  "volume": 12,
+  "powerWake": false,
+  "powerWakeTime": "08:17"
+}
+```
+
+Supported fields:
+
+- `clock`: optional when only one Somneo is configured
+- `time`: `HH:MM` in 24-hour format
+- `enabled`: `true` or `false`
+- `sunriseMinutes`: Somneo sunrise ramp duration
+- `lightTheme`: native Somneo light theme value
+- `soundSource`: native sound source value such as `wus`
+- `sound`: native sound/channel value such as `1`
+- `volume`: native Somneo sound level
+- `powerWake`: `true` or `false`
+- `powerWakeTime`: `HH:MM` in 24-hour format
+
+If you set `time` and omit `enabled`, the plugin will automatically arm the alarm.
+
+### Shortcut Examples
+
+Create or update an alarm with a plain URL:
+
+```text
+http://homebridge.local:8585/somneo/v1/alarm/set?time=07:00&token=replace-me
+```
+
+Disable the current alarm:
+
+```text
+http://homebridge.local:8585/somneo/v1/alarm/delete?token=replace-me
+```
+
+Read the current alarm:
+
+```text
+http://homebridge.local:8585/somneo/v1/alarm?token=replace-me
+```
+
+## Future Plans
+- No support for sound sensor. HomeKit does not have a sound level sensor. I thought about having an motion sensor, but would need to know what sound level motion detected/not should be considered.
+- Better error handling. I am a Java developer by trade and am still learning Typescript :).
+
+## Recognition
+Thanks to:
+
+* [homebridge](https://github.com/homebridge/homebridge-plugin-template) - For creating a great template to get started with.
+* [fototeddy](https://github.com/fototeddy/homebridge-somneo-sensors) - For creating a Homebridge Somneo plugin that reads the sensors.
+* [DeKnep](https://www.domoticz.com/forum/viewtopic.php?t=33033) - For creating a similar plugin in another platform and exposing endpoints for control.