Update docs for release 2024.10.0

static/bed-presence-mk1/release.md

@@ -9,5 +9,35 @@ breadcrumb_list:
       url: /bed-presence-mk1
 ---
 
+## 2024.10.0
+This is the first firmware update for Bed Presence Mk1. It will be available OTA to managed devices. Devices already imported into the ESPHome Dashboard will need to be recompiled to get access to the new features.
+
+**Eliminate DB Bloat** - The default delta threshold and reporting interval have been updated so that the sensor only reports new values when something actually changes. This will decrease the update frequency dramatically and eliminate bloating the database.
+
+**Improved Sensor Response** - The sensor now uses a window average by default. This helps smooth out any quick movements, while also slightly improving the response time for getting out of bed.
+
+**Calibrated Sensor** - If you're annoyed by a different response from each side of your bed, the `Calibrated Sensor` is for you. This is an additional sensor that scales your raw pressure values between the `Unoccupied Pressure` and `Occupied Pressure`.
+
+**Option to Use Full Range** - By default, Pressure [Right/Left] is focused on the most sensitive zone of the pressure sensor (Full Range = Off). This should perform well for most setups. By turning on Full Range, you can expand it to use the full range of the sensor. Consider turning ON Full Range if slight movements in bed quickly drop the sensor value to zero, causing frequent false negatives.
+
+**Lots of Customization** - If you import the device into the ESPHome Dashboard, there are now lots more substitutions within the package to customize behavior.
+
+See <a href="https://github.com/ElevatedSensors/sensor-configs/blob/main/bed-presence-mk1/sensor.yaml" target="_blank">https://github.com/ElevatedSensors/sensor-configs/blob/main/bed-presence-mk1/sensor.yaml</a> for substitution descriptions.
+
+```
+substitutions:
+- trigger_percentile: '0.75'
+- averaging_window_samples: '5'
+- fast_delayed_on: '0ms'
+- fast_delayed_off: '0ms'
+- standard_delayed_on: '0s'
+- standard_delayed_off: '1s'
+- reporting_delta: '1.0'
+- reporting_interval_max: '180s'
+- calibrate_100: '408000'
+- calibrate_0: '276000'
+```
+
 ## 2024.9.0
 - Initial Release
+

static/bed-presence-mk1/sensors.md

@@ -18,8 +18,9 @@ Learn about the details of each sensor and what they mean.
 | `Bed Occupied [Right/Left]` | Binary (Occupancy) [Detected/Clear]   | The primary sensor that indicates whether this side of the bed is occupied (**Detected**) or not (**Clear**). This sensor is slightly delayed to ensure stability and should be sufficient for most automations. |
 | `Bed Occupied Both`         | Binary (Occupancy) [Detected/Clear]   | Indicates if **Both** sides of the bed are occupied or not. |
 | `Bed Occupied Either`       | Binary (Occupancy) [Detected/Clear]   | Indicates if **Either** side of the bed is occupied or not. |
-| `(Fast) Sensors`            | Binary (Occupancy) [Detected/Clear]   | A copy of the primary occupancy sensors (Right/Left/Both/Either), with less delay. If you need quick response when getting into or out of bed, and can tolerate an increased chance of false negatives, use this sensor. `These sensors are disabled by default and must be manually enabled in the Home Assistant UI.` |
-| `Pressure [Right/Left]`     | Number (Pressure %) [0% - 100%] | Indicates the current pressure reading. This value ranges from 0% to 100%, indicating the full range of the sensor. Do not worry if your unoccupied pressure reading is not 0%, or even if both sides of the bed are not similar. Some beds may swing from 0% (Unoccupied) to 95% (Occupied), while others may start at 70% and only increase to 75%. The important thing is that there is a measureable difference between the bed being occupied and unoccupied. |
+| `(Fast) Sensors`            | Binary (Occupancy) [Detected/Clear]   | A copy of the primary occupancy sensors (Right/Left/Both/Either), with less delay. If you need quick response when getting out of bed, and can tolerate an increased chance of false negatives, use this sensor. `These sensors are disabled by default and must be manually enabled in the Home Assistant UI.` |
+| `Pressure [Right/Left]`     | Number (Pressure %) [0% - 100%] | Indicates the current pressure reading. This value ranges from 0% to 100%, indicating the selected range of the sensor (see `Full Range`). Do not worry if your unoccupied pressure reading is not 0%, or even if both sides of the bed are not similar. Some beds may swing from 0% (Unoccupied) to 95% (Occupied), while others may start at 70% and only increase to 75%. The important thing is that there is a measureable difference between the bed being occupied and unoccupied. |
+| `Calibrated Pressure [Right/Left]`     | Number (Pressure %) [0% - 100%] | Indicates the current calibrated pressure reading. This value ranges from 0% to 100%, but only between the `Unoccupied Pressure` (0%) and `Occupied Pressure` (100%). |
 
 ## Values
 
@@ -29,9 +30,10 @@ Learn about the details of each sensor and what they mean.
 | `[Right/Left] Unoccupied Pressure` | Number (Pressure %) [0% - 100%] | Indicates the sensor value when the bed is unoccupied. Used for calculating the ideal `[Right/Left] Trigger Pressure`. The calibration process will set this value, but it can also be adjust manually. |
 | `[Right/Left] Occupied Pressure`   | Number (Pressure %) [0% - 100%] | Indicates the sensor value when the bed is occupied. Used for calculating the ideal `[Right/Left] Trigger Pressure`. The calibration process will set this value, but it can also be adjusted manually. |
 
-## Calibration
+## Configuration
 
-| Method Name                         | Details                                                                                   |
+| Method/Switch Name                  | Details                                                                                   |
 |-------------------------------------|-------------------------------------------------------------------------------------------|
 | `Calibrate [Right/Left] Unoccupied` | Sets the `[Right/Left] Unoccupied Pressure` using the value from `[Right/Left] Pressure`. |
 | `Calibrate [Right/Left] Occupied`   | Sets the `[Right/Left] Occupied Pressure` using the value from `[Right/Left] Pressure`.   |
+| `Full Range`                        | By default, `Pressure [Right/Left]` is focused on the most sensitive zone of the pressure sensor (`Full Range` = Off). This should perform well for most setups. By turning on `Full Range`, you can expand it to use the full range of the sensor. `Consider turning ON Full Range if slight movements in bed quickly drop the sensor value to zero, causing frequent false negatives`. |