diff --git a/AGENTS.md b/AGENTS.md index 8438e8503f..260932ae39 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -28,6 +28,10 @@ Read the full style guide, but these are the ones worth checking twice: - Product IDs are uppercase with a hyphen: **AIR-1**, **MTR-1**, never `Air-1` or `air1`. +- **R PRO-1** is the exception: a space after the R, not a hyphen, in + all display text. Keep `rpro1`, `r-pro-1`, and `R_PRO-1` only in file + names, URLs, hostnames, and literal device names. +- **US English** spelling: color, center, meter, behavior. - **Apollo addons** (hardware modules) and **Home Assistant apps** (formerly add-ons) are different things and not interchangeable. - **ESPHome** is the only correct casing. diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md index 30e7334cef..c0bf884803 100644 --- a/STYLE_GUIDE.md +++ b/STYLE_GUIDE.md @@ -12,7 +12,7 @@ others) all read from this file. know what an Apollo device does, how to set it up, and how to make it work inside their Home Assistant or Homey setup. They range from first-time Home Assistant users to ESPHome contributors. The docs need -to land for both ends without patronising the first or boring the +to land for both ends without patronizing the first or boring the second. **Why these rules exist.** Without them, every contributor (human or @@ -36,7 +36,7 @@ file layout of the repo, see [CONTRIBUTING.md](CONTRIBUTING.md). | Aim for | Avoid | | --- | --- | -| Respectful | Patronising | +| Respectful | Patronizing | | Confident | Boastful | | Enthusiastic | Breathless | | Direct | Corporate | @@ -52,8 +52,8 @@ explains what the reader is about to unlock (see Use these phrases consistently. They are part of the Apollo voice. -- **Build, learn, automate**: the organising framework -- **Your home, your way**: ownership and personalisation +- **Build, learn, automate**: the organizing framework +- **Your home, your way**: ownership and personalization - **On your own terms**: independence and choice - **Real, working device**: tangible outcome - **Just the beginning**: opens up possibility without overpromising @@ -76,15 +76,22 @@ across the wiki reinforces the message. | Don't say | Why | Use instead | | --- | --- | --- | -| Beginner, basic | Patronising | "Getting started", "First boot" | +| Beginner, basic | Patronizing | "Getting started", "First boot" | | Easy on its own | Vague | Qualify: "easy if you already have X" | | Simply, just | Dismissive | Drop the word entirely | | Powerful | Cliché | Describe what it actually does | -| Seamlessly | Cliché | Describe the specific behaviour | +| Seamlessly | Cliché | Describe the specific behavior | | Genuinely, honestly | Undermines credibility | Drop the word entirely | | "Coding without context" | Intimidating | Say what's actually required | | Excessive "no" framing | Negative tone | Rephrase positively | +### US English + +Write in US English spelling: **color**, **center**, **meter**, +**behavior**, **organize**, **toward**. Quote an on-screen label +exactly as the app shows it, and if the app itself uses a non-US +spelling, flag it so the label can be fixed at the source. + --- ## 5. Product and terminology @@ -92,12 +99,24 @@ across the wiki reinforces the message. ### Product IDs Product IDs are always uppercase with a hyphen: **AIR-1**, **MTR-1**, -**MSR-2**, **BTN-1**, **PLT-1**, **R-PRO-1**, **TEMP-1**, **LED-1**, -**M-1**, **PUMP-1**. +**MSR-2**, **BTN-1**, **PLT-1**, **TEMP-1**, **LED-1**, **M-1**, +**PUMP-1**. Never `Air-1`, `air1`, or `AIR1` in body copy. mkdocs.yml is the source of truth for the canonical form. +**R PRO-1** is the one exception: its name has a space after the R, not +a hyphen. Write **R PRO-1** in titles, headings, nav labels, and body +copy, never `R-PRO-1`. The hyphenated and underscored forms survive +only where a space isn't allowed or where you quote the device +literally, and those must not be changed: + +- File and folder names and URLs: `rpro1/`, `r-pro-1-zone-mapper-tool.md` +- Hostnames: `apollo-r-pro-1-w-xxxxxx.local` +- The firmware repo and installer: `ApolloAutomation/R_PRO-1` +- The device name Home Assistant and Homey show: **Apollo R_PRO-1** +- The setup hotspot: **Apollo R PRO 1 Hotspot** + ### First mention per page On the first mention of a product in body copy, use the full brand name: @@ -123,7 +142,7 @@ user-facing copy unless quoting upstream documentation. ### ESPHome -Always capitalised exactly **ESPHome**. Never `esphome`, `ESPhome`, +Always capitalized exactly **ESPHome**. Never `esphome`, `ESPhome`, `Esphome`, or `ESPHOME`. This matches the upstream project's own brand. When introducing the broader project, prefer **ESPHome ecosystem** over @@ -136,7 +155,7 @@ When introducing the broader project, prefer **ESPHome ecosystem** over > Flash your AIR-1 with the latest firmware. **Install firmware** is acceptable when "flash" would be confusing -context (for example, when the audience may not recognise the term). +context (for example, when the audience may not recognize the term). Avoid **burn** and **load**. --- @@ -164,8 +183,8 @@ Every page has exactly one H1, written as the first line of the body page heading. The front matter `title:` is used by the nav, browser tab, and search snippets, and should match the H1. -All headings use sentence case. The first word is capitalised, and -proper nouns are capitalised. Everything else is lowercase. +All headings use sentence case. The first word is capitalized, and +proper nouns are capitalized. Everything else is lowercase. | Yes | No | | --- | --- | @@ -224,7 +243,7 @@ follow with a quick success check. > reading the sensor takes flows into Home Assistant in real time. Banned softeners inside steps: **simply**, **just**, **easy**. These -either patronise the reader or pad the sentence. +either patronize the reader or pad the sentence. ### Front matter @@ -304,6 +323,36 @@ homeassistant: ![AIR-1 boot button highlighted on the underside of the case](/assets/air1-boot-button.jpg) ``` +### Screen recordings and animations + +Use short MP4 clips instead of GIFs. A looping MP4 is a fraction of the +size of the same GIF and stays sharper, so pages load faster. CI only +shrinks PNGs, so compress video before committing it. + +- **Short loops** (a few seconds to about 30) that show one step sit + right after that step and play on their own, silently: + `autoplay loop muted playsinline`. +- **A full walkthrough** goes in its own **Video walkthrough** section + with `controls` and a `poster` image, and does not autoplay. Long or + narrated videos belong on YouTube, embedded with the `cms-embed` + markup. +- **Phone recordings** (portrait) take `class="phone-media"`, which + caps them at phone width and centers them. The class lives in + `docs/stylesheets/extra.css`; never size media inline. +- **Trim personal details** (names, email addresses, home names, + notifications) out of every recording before it's published. +- **Compress** with H.264, no audio track, and fast start, scaled to + 540px wide for clips and 720px for a full phone walkthrough. Aim for + under 1 MB per clip and a few MB for a walkthrough: + +```bash +ffmpeg -ss 3 -to 26 -i recording.mp4 -an -vf "scale=540:-2,fps=30" -c:v libx264 -preset slow -crf 23 -pix_fmt yuv420p -movflags +faststart docs/assets/product-step-name.mp4 +``` + +```html + +``` + ### Internal links Internal links use site-relative paths in wiki-URL form (trailing @@ -389,14 +438,14 @@ to anyone editing the docs. **When you edit a page in one tree, check the mirror in the other tree and update it too if the change applies.** Cross-tree drift, where the -HA version of a page describes the current product behaviour and the +HA version of a page describes the current product behavior and the Homey version still describes how it worked a year ago, is the biggest source of stale content on the wiki. If a change is platform-specific and genuinely doesn't apply to the other tree, leave a one-line note in the PR description explaining why so reviewers don't flag it. For the full repo layout (where `mkdocs.yml` lives, where redirects go, -how `docs/assets/` is organised), see +how `docs/assets/` is organized), see [CONTRIBUTING.md](CONTRIBUTING.md#key-files-and-folders). --- diff --git a/docs/_snippets/homey-radar-regions.md b/docs/_snippets/homey-radar-regions.md new file mode 100644 index 0000000000..33b61dbb85 --- /dev/null +++ b/docs/_snippets/homey-radar-regions.md @@ -0,0 +1,175 @@ +![Radar regions widget in the Homey app with a Server rectangle, a Table circle, and a Fan area drawn on the radar map](/assets/homey-radar-regions-map.png) + +In Homey, the Zone Mapper tool is a dashboard widget called **Radar regions**. You draw regions on a live map of the radar's view, and each region becomes its own occupancy tile on the device, with flow cards that fire when someone enters or leaves it. + +- The map shows up to three tracked people as moving dots, in real time. +- A region can be a rectangle, a circle, or a polygon, up to 32 per device. +- Each region reports occupied or empty, with a hold time so a brief step outside does not clear it. +- An exclusion region hides a spot the radar misreads, such as a fan, a pet bed, or a doorway into the hall. +- Optionally, regions can be pushed into the radar's own three zone slots for other tools that read them. + +There is nothing extra to install: the widget ships inside the Apollo Automation app for Homey. + +## What you need + +| Item | Why | +| --- | --- | +| Homey Pro, firmware 12.3 or newer | Dashboards and widgets arrived in 12.3. Homey Cloud is not supported. | +| Apollo Automation app 2.4.4 or newer | 2.4.0 added the tool; 2.4.4 draws with taps and adds the **Map range** setting. | +| An MTR-1 or R PRO-1, added to Homey and connected | Both carry the LD2450 radar the map is built on. | +| The Homey mobile app (iOS or Android) | Dashboards only exist in the mobile app. The Homey Web App has none. | + +Multi target tracking on the radar is switched on for you the first time the device connects after the app update. If it was turned off later, the widget shows an **Enable** button at the top. + +## Video walkthrough + +Watch the whole flow on a phone: adding the widget to a new dashboard, drawing a rectangle and a circle, and marking a polygon as an area to ignore. + + + +## Open the tool + +The **Radar regions** widget lives on a dashboard, not on the device page. Once it is placed, the dashboard becomes your live view of the room and the place you draw regions. + +1. In the Homey mobile app, tap **More** in the bottom bar, then **Dashboards**. +2. Tap **New Dashboard**, or open an existing dashboard and start editing it. +3. Tap **Add Widget**, switch to the **Apps** tab, and choose **Radar regions** under **Apollo Automation**. +4. Tap **Select Device**, pick your MTR-1 or R PRO-1, and tap the check mark at the top right. Only devices with an LD2450 radar are listed, and only once they have connected at least once. +5. Optionally, set **Map range**: 6 m (the default) shows the radar's whole field of view, 4 or 5 m zooms in for small rooms, and 7.5 m shows the sensor's full reach. Saved regions beyond the range stay in view either way. +6. Tap **Add Widget**, then **Done**. A new dashboard asks for a name: enter one and tap **Save**. + + + +The widget now shows the live map. If you have several radars, add one widget per device. Each widget keeps its own set of regions. + +## Reading the map + +The map is the radar's own view: the sensor sits at the bottom center, looking up into the room. + +- The shaded wedge is the radar's 120 degree field of view, out to the **Map range** you chose. Nothing outside it is tracked. If a saved region lies further out, the map grows to keep it in view. +- Grid lines are one meter apart, with labels every two meters. +- Dashed lines mark the sensor's zone limit (4.86 m to each side and 7.56 m straight ahead) wherever the map reaches further than that. A note under the map says so. +- Left and right are as the sensor sees them. If the dots move the wrong way, the sensor is mounted mirrored to how you expect, so draw your regions on the side where the dots actually appear. +- Up to three people show as moving dots with a short trail. A hollow dot is a target that an exclusion region is hiding from detection. +- A caption under the map says when nobody is being tracked. A banner says when the device stops sending updates. + +The map does not rotate. Place the sensor so the room is in front of it, and the map matches the room. + +## Draw regions + +Drawing works by tapping, not dragging. Pick a shape, tap its points on the map, and press **Save** when you are done. Nothing reaches the device until you save. + +1. Tap **Rectangle**, **Circle**, or **Polygon** in the toolbar above the map. A hint under the toolbar says what to tap next. +2. Tap the points for your shape: + - **Rectangle**: tap one corner of the area, then the opposite corner. A crosshair marks the first tap. + - **Circle**: tap the center, then a point on the edge. + - **Polygon**: tap each corner in turn. Finish by tapping the first corner again, or press **Done**. +3. Adjust the new region. It appears with a name like Region 1 and its settings open. Use the arrows to move it and **Bigger** or **Smaller** to resize it. +4. Press **Save**, or **Cancel** to throw the unsaved changes away. + +Your region now shows on the map, and a matching occupancy tile appears on the device. + + + +!!! tip "Why taps instead of drags" + + A phone hands a single-finger drag to the dashboard as a scroll before the widget sees it, so dragging is not reliable there. Taps always arrive. + +A few more drawing tips: + +- A region needs at least a fingertip of size. Two taps too close together are refused with a short message. +- Draw regions a little larger than the furniture they cover. The radar places a person by their center, and a seated person can read 30 to 50 cm from where you expect. +- If the dashboard scrolls between your two taps, the first tap is kept. Switching tools drops it. +- With **Select** active (the default tool), swiping on the map scrolls the dashboard as usual, and tapping a region opens its settings. + +## Region settings + +With **Select** active, tap a region to open its settings. Changes apply when you press **Save**. + +| Setting | What it does | +| --- | --- | +| **Name** | The label on the map, the occupancy tile, and the flow cards. Up to 40 characters. | +| **Detect people here** | The region reports occupied while someone is inside it. This is the default. | +| **Ignore this area** | Makes the region an exclusion region, drawn in red. Targets inside it are hidden from every detect region. Use it for a fan, a curtain, a pet bed, or a hallway seen through a doorway. | +| **Move** arrows | Move the region 10 cm per tap: left, right, away from the sensor, or toward it. | +| **Size**: **Bigger**, **Smaller** | Grow or shrink a rectangle or circle by 10 cm on each side, keeping its center. | +| **Hold time** (under **More**) | Seconds the region stays occupied after the last person leaves, 0 to 300, default 5. Set it longer for a sofa or a desk so a short trip to the kitchen keeps the lights on. | +| **Width**, **Depth**, **Radius**, **Center** (under **More**) | Exact values in centimeters: width and depth for a rectangle, radius for a circle, and center position for every shape. A value past the sensor's limits is pulled back inside. | +| **Enabled** | Uncheck it to switch a region off without deleting it. A disabled region is drawn dotted and ignored. | +| **Delete region** | Removes it. Its occupancy tile disappears on save. | + +Regions may overlap. A person inside two detect regions counts for both; a person inside any exclusion region counts for none. + +Here a polygon is drawn over a fan and set to **Ignore this area**: + + + +## Use regions in flows + +This is where regions pay off. Every saved detect region is an occupancy tile on the device, named after the region, and the device gets three region flow cards. + +| Card | Type | Asks for | Tokens | +| --- | --- | --- | --- | +| **A region became occupied** | Trigger (When) | The device, then a region or **Any region** | Region name, Target count | +| **A region became empty** | Trigger (When) | The device, then a region or **Any region** | Region name | +| **A region is occupied** | Condition (And) | The device, then one region | None | + +The tile also shows in Insights, so you can see how long the sofa or the desk was in use. + +Three flows to start with: + +- **Desk lamp**: when **Desk** became occupied, turn on the lamp. When **Desk** became empty, turn it off. Give the region a hold time of 60 seconds so a stretch does not switch the lamp off. +- **One flow for every region**: when **Any region** became occupied, send a notification with the Region name token, or run a HomeyScript that uses it. +- **Keep the lights on while someone is on the sofa**: in your room's lights-off flow, add the condition **Sofa** is not occupied. + +The device's whole-room Occupancy Alarm keeps working as before. Regions add detail inside the room; they do not replace it. + +## Advanced: the radar's own zones + +Homey detects occupancy itself from the target positions, so regions work without touching the radar. The **Advanced** section of the widget is for people who also use the LD2450's built-in zones, for example in ESPHome or Home Assistant on the same sensor. + +- **Sync regions to sensor** writes up to three enabled regions into the radar's three zone slots. Detect regions go in as detection zones. If any exclusion region is enabled, the radar is switched to filter mode and only the exclusion regions are written. +- The radar's zones are rectangles. A circle or polygon is written as the rectangle around it, and the preview text under the button says so. +- The preview also lists which regions will be written and which are skipped because the slots are full. +- **Clear sensor zones** empties all three slots and disables the radar's zone filtering. +- The **Multi target tracking** checkbox controls whether the radar reports up to three people or only one. The app turns it on once by itself; if you turn it off, the app leaves it off. + +## Troubleshooting + +Most problems come down to the device not being connected yet, or a region drawn where the radar does not see people. + +| Symptom | What to check | +| --- | --- | +| The widget is not in the **Add widget** list | Update the Homey mobile app and check the Homey Pro is on firmware 12.3 or newer. Dashboards are not in the Homey Web App. | +| My device is not offered in the widget's device picker | It must have connected at least once since the app update. Open the device and wait for its readings, then try again. | +| No dots on the map | Nobody is in view, or multi target tracking is off: press **Enable** at the top of the widget. A banner says if the device stopped sending updates. | +| Drawing on the phone does nothing or leaves a tiny region | Update the Apollo Automation app to 2.4.4 or newer and draw with two taps: a corner, then the opposite corner. If a tap pair is refused, tap further apart. **Advanced → Touch log** shows what the map received. | +| The area I want is off the map, or the map is too small | Change **Map range** in the widget's settings: 7.5 m shows the sensor's full reach, 4 m zooms in. | +| A region never clears | Lower its hold time. If a chair, fan, or curtain keeps a dot alive, draw an exclusion region over that spot. | +| A region does not trigger when I am clearly in it | The radar places a person by their center. Make the region larger with **Bigger** or the arrows, and check left and right against the dots on the map. | +| My regions disappeared after removing and re-adding the device | They come back by themselves on the first connect: the app keeps a backup per device. | +| Saving fails with a reconnecting message | The device is reconnecting. Wait a moment and press **Save** again; the drawn regions are kept. | + +Regions are stored on the Homey Pro, in the device's own storage, with a backup in the app keyed by the sensor's MAC address. Nothing is written to the radar unless you use **Sync regions to sensor**. For a support request, create a diagnostics report from the app's settings page; the region engine writes its own log lines. + +## Coming from the Home Assistant Zone Mapper + +The Homey widget covers the same job as the [Zone Mapper tool for Home Assistant](../../../../../products/general/calibrating-and-updating/zone-configuration/zone-mapper-tool/) and needs no install. A few things sit in different places or work differently. + +| | Home Assistant Zone Mapper | Homey Radar regions | +| --- | --- | --- | +| Install | Two HACS repositories (integration and card), restart, add integration | Built into the Apollo Automation app | +| Where you draw | A dashboard card on any dashboard, mouse or touch | The **Radar regions** widget on a mobile dashboard, by tapping | +| Shapes | Rectangle, ellipse, polygon | Rectangle, circle, polygon | +| Move or resize after drawing | Redraw | Arrow buttons, **Bigger** and **Smaller**, exact centimeters | +| What a zone becomes | A binary sensor per zone | An occupancy tile per region, plus three flow cards | +| Hold time before empty | No; the sensor turns off at once | Yes, per region, 0 to 300 seconds | +| Exclusion areas | No | Yes, exclude mode | +| People count per zone | No | Yes, as a flow token | +| Map extent, rotation, and units | Rotation slider; configurable grid; mm, cm, m, in, ft | Map range 4 to 7.5 m; no rotation; meters, sensor orientation as mounted | +| Writing to the radar's own zones | No | Yes, optional sync and clear | +| Regions after re-adding the device | Lost | Restored from the app's backup | + +!!! warning "Running both platforms on one sensor" + + Draw your zones in one platform only. Syncing Homey regions to the radar changes the zones the Home Assistant card reads from the LD2450. diff --git a/docs/assets/homey-radar-regions-add-widget.mp4 b/docs/assets/homey-radar-regions-add-widget.mp4 new file mode 100644 index 0000000000..82a5b325b8 Binary files /dev/null and b/docs/assets/homey-radar-regions-add-widget.mp4 differ diff --git a/docs/assets/homey-radar-regions-draw-rectangle.mp4 b/docs/assets/homey-radar-regions-draw-rectangle.mp4 new file mode 100644 index 0000000000..e6214a5c7d Binary files /dev/null and b/docs/assets/homey-radar-regions-draw-rectangle.mp4 differ diff --git a/docs/assets/homey-radar-regions-ignore-area.mp4 b/docs/assets/homey-radar-regions-ignore-area.mp4 new file mode 100644 index 0000000000..90058bb662 Binary files /dev/null and b/docs/assets/homey-radar-regions-ignore-area.mp4 differ diff --git a/docs/assets/homey-radar-regions-map.png b/docs/assets/homey-radar-regions-map.png new file mode 100644 index 0000000000..62a0a19f7a Binary files /dev/null and b/docs/assets/homey-radar-regions-map.png differ diff --git a/docs/assets/homey-radar-regions-walkthrough-poster.jpg b/docs/assets/homey-radar-regions-walkthrough-poster.jpg new file mode 100644 index 0000000000..ca9d58acc1 Binary files /dev/null and b/docs/assets/homey-radar-regions-walkthrough-poster.jpg differ diff --git a/docs/assets/homey-radar-regions-walkthrough.mp4 b/docs/assets/homey-radar-regions-walkthrough.mp4 new file mode 100644 index 0000000000..0631457a16 Binary files /dev/null and b/docs/assets/homey-radar-regions-walkthrough.mp4 differ diff --git a/docs/homey.md b/docs/homey.md index a55a4bc5ea..398e8d7180 100755 --- a/docs/homey.md +++ b/docs/homey.md @@ -21,7 +21,8 @@ description: Guide to integrating Apollo Automation devices with the Homey smart * [Tuning out false positives with the MSR-2](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/mmwave-videos/) * [Setting up zones on MTR-1 with the HLK app](https://wiki.apolloautomation.com/products/mtr1/setup/zones-hlk/) * [Beta test our new Zone Mapper tool!](https://github.com/ApolloAutomation/zone-mapper) - [Use this custom card along with Zone Mapper!](https://github.com/ApolloAutomation/zone-mapper-card) -* [Tune your new R-PRO-1 PoE mmWave sensor](https://wiki.apolloautomation.com/products/rpro1/setup/zones-hlk/) +* [Tune your new R PRO-1 PoE mmWave sensor](https://wiki.apolloautomation.com/products/rpro1/setup/zones-hlk/) +* [Draw occupancy regions in Homey with the Zone Mapper tool for MTR-1](homey/products/mtr1/setup/mtr-1-zone-mapper-tool/) or [R PRO-1](homey/products/rpro1/setup/r-pro-1-zone-mapper-tool/) ### Quick References diff --git a/docs/homey/products/general/calibrating-and-updating/co2-calibration.md b/docs/homey/products/general/calibrating-and-updating/co2-calibration.md index ada6cfbfef..7ddf0f0836 100755 --- a/docs/homey/products/general/calibrating-and-updating/co2-calibration.md +++ b/docs/homey/products/general/calibrating-and-updating/co2-calibration.md @@ -5,7 +5,7 @@ description: "Step by step guide for re-calibrating your SCD40 CO2 sensor" !!! info "Your sensor calibrates itself" - The latest Apollo firmware enables the SCD40's automatic self-calibration by default on every device with the CO2 sensor (AIR-1, R-PRO-1, MSR-2, and MTR-1). As long as the sensor sees fresh air (about 420 ppm) at least once a week, it corrects its own baseline and you never need to calibrate manually. Airing out the room once a week is enough. + The latest Apollo firmware enables the SCD40's automatic self-calibration by default on every device with the CO2 sensor (AIR-1, R PRO-1, MSR-2, and MTR-1). As long as the sensor sees fresh air (about 420 ppm) at least once a week, it corrects its own baseline and you never need to calibrate manually. Airing out the room once a week is enough. If your device sits in a space that rarely gets fresh air (a sealed office, a basement, a grow room), automatic self-calibration will slowly drag the readings down. Turn off the **CO2 Auto Calibration** switch in your device's settings and calibrate manually with the steps below instead. diff --git a/docs/homey/products/general/choosing-an-mmwave-sensor.md b/docs/homey/products/general/choosing-an-mmwave-sensor.md index 7123524c9c..f46d0b5722 100644 --- a/docs/homey/products/general/choosing-an-mmwave-sensor.md +++ b/docs/homey/products/general/choosing-an-mmwave-sensor.md @@ -1,5 +1,5 @@ --- title: Choosing an mmWave Sensor -description: Compare the Apollo MSR-2, MTR-1, and R-PRO-1 mmWave presence sensors and pick the right one for your space. +description: Compare the Apollo MSR-2, MTR-1, and R PRO-1 mmWave presence sensors and pick the right one for your space. --- --8<-- "products/general/choosing-an-mmwave-sensor.md:5:" diff --git a/docs/homey/products/mtr1/setup/mtr-1-zone-mapper-tool.md b/docs/homey/products/mtr1/setup/mtr-1-zone-mapper-tool.md new file mode 100644 index 0000000000..7c299f3e29 --- /dev/null +++ b/docs/homey/products/mtr1/setup/mtr-1-zone-mapper-tool.md @@ -0,0 +1,10 @@ +--- +title: MTR-1 Zone Mapper tool +description: Draw LD2450 mmWave regions for your MTR-1 with the Radar regions widget in Homey, and use each region as its own occupancy tile in flows. +--- + +# MTR-1 Zone Mapper tool + +The Apollo MTR-1's LD2450 mmWave sensor tracks up to three people across the room. With the Zone Mapper tool you turn that map into rooms within a room: a desk, a sofa, a bed, each with its own occupancy and its own flow cards in Homey. + +--8<-- "_snippets/homey-radar-regions.md" diff --git a/docs/homey/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md b/docs/homey/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md index a7f747ce19..7a7ed100d4 100644 --- a/docs/homey/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md +++ b/docs/homey/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md @@ -1,4 +1,4 @@ --- -description: "Tutorial on adding the LD2412 mmwave sensor to your R-PRO-1" +description: "Tutorial on adding the LD2412 mmwave sensor to your R PRO-1" --- --8<-- "products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md:5:" diff --git a/docs/homey/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md b/docs/homey/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md index 7fbe421012..25c80bbcbd 100644 --- a/docs/homey/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md +++ b/docs/homey/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md @@ -1,4 +1,4 @@ --- -description: "Tutorial on installing the ceiling mount addon for the R-PRO-1." +description: "Tutorial on installing the ceiling mount addon for the R PRO-1." --- --8<-- "products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md:5:" diff --git a/docs/homey/products/rpro1/setup/r-pro-1-zone-mapper-tool.md b/docs/homey/products/rpro1/setup/r-pro-1-zone-mapper-tool.md new file mode 100644 index 0000000000..5161d343a2 --- /dev/null +++ b/docs/homey/products/rpro1/setup/r-pro-1-zone-mapper-tool.md @@ -0,0 +1,10 @@ +--- +title: R PRO-1 Zone Mapper tool +description: Draw LD2450 mmWave regions for your R PRO-1 with the Radar regions widget in Homey, and use each region as its own occupancy tile in flows. +--- + +# R PRO-1 Zone Mapper tool + +The Apollo R PRO-1's LD2450 mmWave sensor tracks up to three people across the room. With the Zone Mapper tool you turn that map into rooms within a room: a desk, a sofa, a bed, each with its own occupancy and its own flow cards in Homey. + +--8<-- "_snippets/homey-radar-regions.md" diff --git a/docs/homey/products/rpro1/setup/rpro1-sensor-definitions.md b/docs/homey/products/rpro1/setup/rpro1-sensor-definitions.md index 38e8f42a1a..e655d151bd 100644 --- a/docs/homey/products/rpro1/setup/rpro1-sensor-definitions.md +++ b/docs/homey/products/rpro1/setup/rpro1-sensor-definitions.md @@ -1,4 +1,4 @@ --- -description: "These are all of the entities exposed by the R-PRO-1 to automate on!" +description: "These are all of the entities exposed by the R PRO-1 to automate on!" --- --8<-- "products/rpro1/setup/rpro1-sensor-definitions.md:5:" diff --git a/docs/homey/products/rpro1/setup/zones-hlk.md b/docs/homey/products/rpro1/setup/zones-hlk.md index 30130f34c0..e1500ef3e0 100644 --- a/docs/homey/products/rpro1/setup/zones-hlk.md +++ b/docs/homey/products/rpro1/setup/zones-hlk.md @@ -5,11 +5,11 @@ description: "Tutorial for R-Pro-1 HLKRadarTool app Zone Configuration."
-!!! tip "Finding your R-PRO-1's web server address" +!!! tip "Finding your R PRO-1's web server address" Some steps below require opening your device's web server in a browser. To find your address: - 1. In Homey, open your R-PRO-1 device and note the last 6 characters of its name — for example, **Apollo R_PRO-1 353fd4** gives you `353fd4`. + 1. In Homey, open your R PRO-1 device and note the last 6 characters of its name — for example, **Apollo R_PRO-1 353fd4** gives you `353fd4`. 2. Check whether you set it up over **WiFi** or **Ethernet**. 3. Build your URL: - WiFi: `http://apollo-r-pro-1-w-353fd4.local/` @@ -23,7 +23,7 @@ description: "Tutorial for R-Pro-1 HLKRadarTool app Zone Configuration." The newer version of the firmware includes an "auto calibrate" function so you might want to test it out! -The HLK-LD2450 mmWave sensor is used in the R-PRO-1. Click Here for the datasheet. +The HLK-LD2450 mmWave sensor is used in the R PRO-1. Click Here for the datasheet. === "iPhone" @@ -33,7 +33,7 @@ The Click here to download -1\. Open your R-PRO-1's web server (see address tip above), scroll down until you see **LD2450 Bluetooth**, and toggle it on. +1\. Open your R PRO-1's web server (see address tip above), scroll down until you see **LD2450 Bluetooth**, and toggle it on. ![](/assets/mtr-1-toggle-on-ld2450-bluetooth.png) @@ -51,9 +51,9 @@ The **Disabled**: Disable multi-zone area detection and just tracks one big area.
**Detection**: Only detects targets within each of the three zones.
**Filter**: Excludes a zone from detection and detects presence everywhere else. + You can use any of these three choices to control your R PRO-1 differently. The most common option is "Detection" which lets you setup three areas and track three targets within them.
**Disabled**: Disable multi-zone area detection and just tracks one big area.
**Detection**: Only detects targets within each of the three zones.
**Filter**: Excludes a zone from detection and detects presence everywhere else. Disabled allows you to just use the sensor as a "basic" presence sensor and "Filter" lets you filter out an area and detect everything else, which is useful to avoid a fan! @@ -85,11 +85,11 @@ The same HLKRadarTool app is used for both sensors. Click here to download -1\. Open your R-PRO-1's web server (see address tip above), scroll down until you see **LD2412 Bluetooth**, and toggle it on. +1\. Open your R PRO-1's web server (see address tip above), scroll down until you see **LD2412 Bluetooth**, and toggle it on. ![](/assets/r-pro-1-toggle-on-ld2412-bluetooth.gif) -2\. Open the HLKRadarTool app. Your R-PRO-1 should appear in the device list. Tap it to connect. +2\. Open the HLKRadarTool app. Your R PRO-1 should appear in the device list. Tap it to connect. !!! success "You need to be close to your device!" @@ -117,7 +117,7 @@ The same HLKRadarTool app is used for both sensors. ![](/assets/r-pro-1-ld2412-detection-range.gif) -6\. To fine-tune which distances trigger detection, open your R-PRO-1's web server and use the gate sensitivity sliders there. +6\. To fine-tune which distances trigger detection, open your R PRO-1's web server and use the gate sensitivity sliders there. - **Raise** a gate's sensitivity to make it harder to trigger at that distance (useful for ignoring a fan, HVAC vent, or a window where cars pass). - **Lower** a gate's sensitivity to make it more sensitive at that distance (useful for reliably detecting someone sitting still in a chair). @@ -126,5 +126,5 @@ The same HLKRadarTool app is used for both sensors. 7\. Tap **Settings** at the top of the app and set the **Unmanned Duration**. This controls how many seconds the sensor waits after it stops detecting before it reports "no one present." The default is 10 seconds — increase it if you're getting false "nobody home" readings in your space. In the Apollo web server, this same setting is called **LD2412 Timeout**. -8\. Head back to your R-PRO-1's web server and toggle **LD2412 Bluetooth** back off. Leaving Bluetooth on increases power consumption and can interfere with nearby Bluetooth devices. +8\. Head back to your R PRO-1's web server and toggle **LD2412 Bluetooth** back off. Leaving Bluetooth on increases power consumption and can interfere with nearby Bluetooth devices. diff --git a/docs/homey/products/rpro1/troubleshooting/rpro1-boot-mode.md b/docs/homey/products/rpro1/troubleshooting/rpro1-boot-mode.md index 5fd7115c72..10126808a2 100644 --- a/docs/homey/products/rpro1/troubleshooting/rpro1-boot-mode.md +++ b/docs/homey/products/rpro1/troubleshooting/rpro1-boot-mode.md @@ -1,4 +1,4 @@ --- -description: "Step by step guide for putting The R-PRO-1 In Boot Mode." +description: "Step by step guide for putting The R PRO-1 In Boot Mode." --- --8<-- "products/rpro1/troubleshooting/rpro1-boot-mode.md:5:" diff --git a/docs/homey/products/rpro1/troubleshooting/rpro1-code.md b/docs/homey/products/rpro1/troubleshooting/rpro1-code.md index 6f622f8313..d9b5f4f45a 100644 --- a/docs/homey/products/rpro1/troubleshooting/rpro1-code.md +++ b/docs/homey/products/rpro1/troubleshooting/rpro1-code.md @@ -1,4 +1,4 @@ --- -description: "Step by step guide for re-flashing the R-PRO-1 back to factory firmware." +description: "Step by step guide for re-flashing the R PRO-1 back to factory firmware." --- --8<-- "products/rpro1/troubleshooting/rpro1-code.md:5:" diff --git a/docs/homey/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md b/docs/homey/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md index ca6b39ca40..9f83d73dc3 100644 --- a/docs/homey/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md +++ b/docs/homey/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md @@ -1,4 +1,4 @@ --- -description: "Step by step guide for resetting the Wi-Fi Credentials on your R-PRO-1." +description: "Step by step guide for resetting the Wi-Fi Credentials on your R PRO-1." --- --8<-- "products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md:5:" diff --git a/docs/homey/products/rpro1/troubleshooting/rpro1-teardown.md b/docs/homey/products/rpro1/troubleshooting/rpro1-teardown.md index 6c6479942c..ca39cdc04e 100644 --- a/docs/homey/products/rpro1/troubleshooting/rpro1-teardown.md +++ b/docs/homey/products/rpro1/troubleshooting/rpro1-teardown.md @@ -1,4 +1,4 @@ --- -description: "Step by step guide for tearing down your R-PRO-1 to replace parts, clean it, swap cases, etc." +description: "Step by step guide for tearing down your R PRO-1 to replace parts, clean it, swap cases, etc." --- --8<-- "products/rpro1/troubleshooting/rpro1-teardown.md:5:" diff --git a/docs/index.md b/docs/index.md index c0cdcbb493..e738a7c661 100755 --- a/docs/index.md +++ b/docs/index.md @@ -84,7 +84,7 @@ flowchart LR MSR(("MSR-2
Best still detection · Single person")) MTR(("MTR-1
Up to 3 people · Up to 3 zones")) - RPRO(("R-PRO-1
PoE · Ethernet · Best of both worlds")) + RPRO(("R PRO-1
PoE · Ethernet · Best of both worlds")) classDef product fill:#4379AA,stroke:#2d5a8a,color:#fff,font-weight:bold class MSR,MTR,RPRO product @@ -109,7 +109,7 @@ flowchart LR * [Tuning out false positives with the MSR-2](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/mmwave-videos/) * [Setting up zones on MTR-1 with the HLK app](https://wiki.apolloautomation.com/products/mtr1/setup/zones-hlk/) * [Beta test our new Zone Mapper tool!](https://github.com/ApolloAutomation/zone-mapper) - [Use this custom card along with Zone Mapper!](https://github.com/ApolloAutomation/zone-mapper-card) -* [Tune your new R-PRO-1 PoE mmWave sensor](https://wiki.apolloautomation.com/products/rpro1/setup/zones-ha/) +* [Tune your new R PRO-1 PoE mmWave sensor](https://wiki.apolloautomation.com/products/rpro1/setup/zones-ha/) ### Quick References diff --git a/docs/products/general/calibrating-and-updating/co2-calibration-quick.md b/docs/products/general/calibrating-and-updating/co2-calibration-quick.md index 17d6dcbed9..19aeaebcfb 100755 --- a/docs/products/general/calibrating-and-updating/co2-calibration-quick.md +++ b/docs/products/general/calibrating-and-updating/co2-calibration-quick.md @@ -6,7 +6,7 @@ description: Step by step guide for re-calibrating your SCD40 CO2 sensor !!! info "Your sensor calibrates itself" - The latest Apollo firmware enables the SCD40's automatic self-calibration by default on every device with the CO2 sensor (AIR-1, R-PRO-1, MSR-2, and MTR-1), so you only need this guide if you turned the **CO2 Auto Calibration** switch off. See the [full calibration guide](co2-calibration.md) for how auto calibration works and when to turn it off. + The latest Apollo firmware enables the SCD40's automatic self-calibration by default on every device with the CO2 sensor (AIR-1, R PRO-1, MSR-2, and MTR-1), so you only need this guide if you turned the **CO2 Auto Calibration** switch off. See the [full calibration guide](co2-calibration.md) for how auto calibration works and when to turn it off. !!! tip "Calibrate manually every 1 to 2 years when auto calibration is off" diff --git a/docs/products/general/calibrating-and-updating/co2-calibration.md b/docs/products/general/calibrating-and-updating/co2-calibration.md index 548734965f..a26c9c0340 100755 --- a/docs/products/general/calibrating-and-updating/co2-calibration.md +++ b/docs/products/general/calibrating-and-updating/co2-calibration.md @@ -6,7 +6,7 @@ description: Step by step guide for re-calibrating your SCD40 CO2 sensor !!! info "Your sensor calibrates itself" - The latest Apollo firmware enables the SCD40's automatic self-calibration by default on every device with the CO2 sensor (AIR-1, R-PRO-1, MSR-2, and MTR-1). As long as the sensor sees fresh air (about 420 ppm) at least once a week, it corrects its own baseline and you never need to calibrate manually. Airing out the room once a week is enough. + The latest Apollo firmware enables the SCD40's automatic self-calibration by default on every device with the CO2 sensor (AIR-1, R PRO-1, MSR-2, and MTR-1). As long as the sensor sees fresh air (about 420 ppm) at least once a week, it corrects its own baseline and you never need to calibrate manually. Airing out the room once a week is enough. If your device sits in a space that rarely gets fresh air (a sealed office, a basement, a grow room), automatic self-calibration will slowly drag the readings down. Turn off the **CO2 Auto Calibration** switch on the device page in Home Assistant and calibrate manually with the steps below instead. diff --git a/docs/products/general/calibrating-and-updating/zone-configuration/zone-mapper-tool.md b/docs/products/general/calibrating-and-updating/zone-configuration/zone-mapper-tool.md index 663b419d8c..b86f87c451 100755 --- a/docs/products/general/calibrating-and-updating/zone-configuration/zone-mapper-tool.md +++ b/docs/products/general/calibrating-and-updating/zone-configuration/zone-mapper-tool.md @@ -5,6 +5,6 @@ description: Install and use the Zone Mapper tool to draw LD2450 mmWave detectio # Zone Mapper tool -Apollo's LD2450-based presence sensors, like the MTR-1 and R-PRO-1, track up to three targets across the room. With the Zone Mapper tool you draw their detection zones on a visual grid in Home Assistant, watch targets move in real time, and get an occupancy sensor for every zone you draw. +Apollo's LD2450-based presence sensors, like the MTR-1 and R PRO-1, track up to three targets across the room. With the Zone Mapper tool you draw their detection zones on a visual grid in Home Assistant, watch targets move in real time, and get an occupancy sensor for every zone you draw. --8<-- "_snippets/zone-mapper-tool.md" diff --git a/docs/products/general/choosing-an-mmwave-sensor.md b/docs/products/general/choosing-an-mmwave-sensor.md index a581b29f2b..f41ff5b3c5 100644 --- a/docs/products/general/choosing-an-mmwave-sensor.md +++ b/docs/products/general/choosing-an-mmwave-sensor.md @@ -1,6 +1,6 @@ --- title: Choosing an mmWave Sensor -description: Compare the Apollo MSR-2, MTR-1, and R-PRO-1 mmWave presence sensors and pick the right one for your space. +description: Compare the Apollo MSR-2, MTR-1, and R PRO-1 mmWave presence sensors and pick the right one for your space. --- # Choosing an mmWave Sensor @@ -24,19 +24,19 @@ Apollo mmWave sensors detect the **moving** and **still** energy of people and a [:octicons-arrow-right-24: MTR-1 overview](https://wiki.apolloautomation.com/products/mtr1/introduction/) -- :material-ethernet:{ .lg .middle } **R-PRO-1** +- :material-ethernet:{ .lg .middle } **R PRO-1** --- Best of both worlds, plus PoE. - [:octicons-arrow-right-24: R-PRO-1 overview](https://wiki.apolloautomation.com/products/rpro1/introduction/) + [:octicons-arrow-right-24: R PRO-1 overview](https://wiki.apolloautomation.com/products/rpro1/introduction/) ## Compare -| | MSR-2 | MTR-1 | R-PRO-1 | +| | MSR-2 | MTR-1 | R PRO-1 | |---|:---:|:---:|:---:| | **Targets tracked** | 1 | Up to 3 | Up to 3 | | **Multi-zone tracking** | :material-minus: | :material-check: 3 zones | :material-check: 3 zones | @@ -63,7 +63,7 @@ Each sensor watches a **cone** that fans out in front of it, like the beam of a 120° sensor -
Horizontal FoV: 120° side to side (up to 150° on the R-PRO-1 with the LD2412)
+
Horizontal FoV: 120° side to side (up to 150° on the R PRO-1 with the LD2412)
@@ -81,7 +81,7 @@ Each sensor watches a **cone** that fans out in front of it, like the beam of a -## Zone tracking (MTR-1 and R-PRO-1) +## Zone tracking (MTR-1 and R PRO-1) The LD2450 module tracks up to three moving targets and reports each one's X and Y position. You draw rectangular zones in those coordinates to decide where presence counts. @@ -93,7 +93,7 @@ The LD2450 module tracks up to three moving targets and reports each one's X and - The Plotly chart still draws the rectangles even if the X1/X2 or Y1/Y2 values are reversed, so double-check the order. - Zones cannot overlap. -To set up zones, follow the guide for your device: [MTR-1 zones](https://wiki.apolloautomation.com/products/mtr1/setup/zones-ha/) or [R-PRO-1 (LD2450) zones](https://wiki.apolloautomation.com/products/rpro1/setup/zones-ha/). +To set up zones, follow the guide for your device: [MTR-1 zones](https://wiki.apolloautomation.com/products/mtr1/setup/zones-ha/) or [R PRO-1 (LD2450) zones](https://wiki.apolloautomation.com/products/rpro1/setup/zones-ha/). !!! tip "Beta: try the Zone Mapper" @@ -101,9 +101,9 @@ To set up zones, follow the guide for your device: [MTR-1 zones](https://wiki.ap Check it out on GitHub: [Zone Mapper integration](https://github.com/ApolloAutomation/zone-mapper) and [Zone Mapper card](https://github.com/ApolloAutomation/zone-mapper-card). -## Still detection (MSR-2 and R-PRO-1 with the LD2412) +## Still detection (MSR-2 and R PRO-1 with the LD2412) -The MSR-2, and the R-PRO-1 once you add the optional LD2412, detect a single target using gates: fixed distance bands rather than X and Y coordinates. This is what makes them so good at catching someone who is barely moving, like sleeping or sitting still. To add the second module to an R-PRO-1, follow [Add the LD2412 to your R-PRO-1](https://wiki.apolloautomation.com/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1/). +The MSR-2, and the R PRO-1 once you add the optional LD2412, detect a single target using gates: fixed distance bands rather than X and Y coordinates. This is what makes them so good at catching someone who is barely moving, like sleeping or sitting still. To add the second module to an R PRO-1, follow [Add the LD2412 to your R PRO-1](https://wiki.apolloautomation.com/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1/). ### Reducing false triggers @@ -114,6 +114,6 @@ mmWave detects motion, so things that move or reflect the radar signal can trigg - Moving air from HVAC vents and registers - Curtains, blinds, or plants swaying in a draft -The **MSR-2 (LD2410)** and the **R-PRO-1 with the LD2412** let you tune the sensitivity of each gate, so you can dial down the distance bands where a fan or vent sits and tune these false positives out. With the **LD2450 (MTR-1 and R-PRO-1)** you can instead draw your zones to exclude the problem area. +The **MSR-2 (LD2410)** and the **R PRO-1 with the LD2412** let you tune the sensitivity of each gate, so you can dial down the distance bands where a fan or vent sits and tune these false positives out. With the **LD2450 (MTR-1 and R PRO-1)** you can instead draw your zones to exclude the problem area. See the [Radar Tuning guide](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/radar-tuning/zones-ha/) to adjust sensitivity. diff --git a/docs/products/general/co2-installation.md b/docs/products/general/co2-installation.md index c48bcbd205..7ba330c4cf 100755 --- a/docs/products/general/co2-installation.md +++ b/docs/products/general/co2-installation.md @@ -4,7 +4,7 @@ description: QR Code for the CO2 addon points here --- # CO2 Installation -We have the CO2 Addon for the MSR-2, MTR-1, AIR-1, and new R-PRO-1. Choose your specific Apollo sensor below to head to that wiki article! +We have the CO2 Addon for the MSR-2, MTR-1, AIR-1, and new R PRO-1. Choose your specific Apollo sensor below to head to that wiki article! [MSR-2 Click Here!](https://wiki.apolloautomation.com/products/msr2/addons/adding-co2-to-msr-2/){ .md-button .md-button--primary } @@ -12,4 +12,4 @@ We have the CO2 Addon for the MSR-2, MTR-1, AIR-1, and new R-PRO-1. C [AIR-1 Click Here!](https://wiki.apolloautomation.com/products/air1/addons/adding-co2-to-air-1/){ .md-button .md-button--primary } -[R-PRO-1 Click Here!](https://wiki.apolloautomation.com/products/rpro1/addons/adding-co2-to-r-pro-1/){ .md-button .md-button--primary } \ No newline at end of file +[R PRO-1 Click Here!](https://wiki.apolloautomation.com/products/rpro1/addons/adding-co2-to-r-pro-1/){ .md-button .md-button--primary } \ No newline at end of file diff --git a/docs/products/general/links.md b/docs/products/general/links.md index 036c6ced5e..89b7896ddf 100755 --- a/docs/products/general/links.md +++ b/docs/products/general/links.md @@ -19,7 +19,7 @@ description: Links to our github, printables, and discord! * [H-2 Holiday Ornament for Charity](https://www.printables.com/model/1508535-apollo-automation-h-2-holiday-ornament-for-charity){ target=_blank } * [BTN-1 Macro Deck](https://www.printables.com/model/1464125-apollo-automation-btn-1-macro-deck){ target=_blank } * [M-1 LED Matrix Stand (HUB75)](https://www.printables.com/model/1361828-apollo-automation-m-1-led-matrix-stand-hub75){ target=_blank } - * [R-PRO-1 Dual mmWave Multisensor](https://www.printables.com/model/1349017-apollo-automation-r-pro-1-dual-mmwave-multisensor){ target=_blank } + * [R PRO-1 Dual mmWave Multisensor](https://www.printables.com/model/1349017-apollo-automation-r-pro-1-dual-mmwave-multisensor){ target=_blank } * [TEMP-1 Temperature Sensor](https://www.printables.com/model/1170218-apollo-temp-1-temperature-sensor){ target=_blank } * [H-1 Holiday Ornament for Charity](https://www.printables.com/model/1102996-apollo-automation-h-1-holiday-ornament-for-charity){ target=_blank } * [PLT-1 Ultimate Plant Sensor](https://www.printables.com/model/1021588-apollo-plt-1-ultimate-plant-sensor){ target=_blank } diff --git a/docs/products/general/setup/bluetooth-proxy.md b/docs/products/general/setup/bluetooth-proxy.md index 0b0688740c..9cc7bb670b 100755 --- a/docs/products/general/setup/bluetooth-proxy.md +++ b/docs/products/general/setup/bluetooth-proxy.md @@ -26,7 +26,7 @@ Select your product below to see the full walkthrough. --8<-- "_snippets/bluetooth-proxy/method1-mtr-1.md" -=== "R-PRO-1" +=== "R PRO-1" --8<-- "_snippets/bluetooth-proxy/no-ble-fork-tab.md" diff --git a/docs/products/general/tutorials/minimize-mmwave-activity-spam.md b/docs/products/general/tutorials/minimize-mmwave-activity-spam.md index 8e44cbe57e..a72e83569c 100644 --- a/docs/products/general/tutorials/minimize-mmwave-activity-spam.md +++ b/docs/products/general/tutorials/minimize-mmwave-activity-spam.md @@ -38,7 +38,7 @@ Apollo mmWave sensors report frequently by design, which can cause internal rada - sensor.*target_count* ``` -=== "R-PRO-1" +=== "R PRO-1" ```yaml logbook: diff --git a/docs/products/rpro1/additional-info/bluetooth-proxy.md b/docs/products/rpro1/additional-info/bluetooth-proxy.md index b9b50a2561..9055986fbb 100644 --- a/docs/products/rpro1/additional-info/bluetooth-proxy.md +++ b/docs/products/rpro1/additional-info/bluetooth-proxy.md @@ -1,8 +1,8 @@ --- -title: R-PRO-1 Bluetooth Proxy -description: Tutorial for how to turn your R-PRO-1 into a BLE proxy! +title: R PRO-1 Bluetooth Proxy +description: Tutorial for how to turn your R PRO-1 into a BLE proxy! --- -# R-PRO-1 Bluetooth Proxy +# R PRO-1 Bluetooth Proxy --8<-- "_snippets/bluetooth-proxy/intro.md" diff --git a/docs/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md b/docs/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md index d186b932db..3ac4ddd8f5 100755 --- a/docs/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md +++ b/docs/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md @@ -1,16 +1,16 @@ --- -title: Add the LD2412 mmwave sensor to your R-PRO-1 -description: Tutorial on adding the LD2412 mmwave sensor to your R-PRO-1 +title: Add the LD2412 mmwave sensor to your R PRO-1 +description: Tutorial on adding the LD2412 mmwave sensor to your R PRO-1 --- -# Install the LD2412 in R-PRO-1 +# Install the LD2412 in R PRO-1 ![](/assets/r-pro-1-ld2412-install.webp) !!! tip "Check out the gif above or step by step directions below!" - The gif above shows all the steps needed to take apart and add your ld2412 to the R-PRO-1 or you can follow the step by step tutorial with images below! + The gif above shows all the steps needed to take apart and add your ld2412 to the R PRO-1 or you can follow the step by step tutorial with images below! -1\. Unplug your R-PRO-1 from power and remove the back. +1\. Unplug your R PRO-1 from power and remove the back. ![](/assets/rpro-1-add-co2-lift-lid-1.webp)![](/assets/rpro-1-add-co2-remove-lid.webp) diff --git a/docs/products/rpro1/addons/adding-co2-to-r-pro-1.md b/docs/products/rpro1/addons/adding-co2-to-r-pro-1.md index 2b47a3d708..7fbc6d7335 100755 --- a/docs/products/rpro1/addons/adding-co2-to-r-pro-1.md +++ b/docs/products/rpro1/addons/adding-co2-to-r-pro-1.md @@ -2,9 +2,9 @@ title: Add the SCD40 CO2 sensor to your R-Pro-1 description: Tutorial on adding the SCD40 CO2 sensor to your R-Pro-1. --- -# Adding CO2 To R-PRO-1 +# Adding CO2 To R PRO-1 -1\. Unplug your R-PRO-1 from power and remove the back. +1\. Unplug your R PRO-1 from power and remove the back. ![](/assets/rpro-1-add-co2-lift-lid-1.webp)![](/assets/rpro-1-add-co2-remove-lid.webp) @@ -19,9 +19,9 @@ description: Tutorial on adding the SCD40 CO2 sensor to your R-Pro-1. ![](/assets/rpro-1-add-co2-seat-scd40.jpg)![](/assets/rpro-1-add-co2-scd40-installed.jpg) -4\. Slide the case back over the R-PRO-1, making sure that the case has the hole for the USB-C port and the SCD40 facing toward you. +4\. Slide the case back over the R PRO-1, making sure that the case has the hole for the USB-C port and the SCD40 facing toward you. -5\. Gently press the backplate of the R-PRO-1 case onto the R-PRO-1 until it lightly snaps into place. Please do not force it, if necessary please repeat steps above until it seats in the case without any force required. +5\. Gently press the backplate of the R PRO-1 case onto the R PRO-1 until it lightly snaps into place. Please do not force it, if necessary please repeat steps above until it seats in the case without any force required. ![](/assets/r-pro-1-scd40-installed-press-case-down.jpg) diff --git a/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md b/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md index d5aa13e316..fe7ef71573 100755 --- a/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md +++ b/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md @@ -2,11 +2,11 @@ title: Add the gang box mounts to your R-Pro-1 description: Tutorial on adding the gang box mounts to your R-Pro-1. --- -# Adding Gang Box Mounts To R-PRO-1 +# Adding Gang Box Mounts To R PRO-1 ###### Attaching Mounts -1\. Unplug your R-PRO-1 from power and remove the back. +1\. Unplug your R PRO-1 from power and remove the back. ![](/assets/rpro-1-add-co2-lift-lid-1.webp)![](/assets/rpro-1-add-co2-remove-lid.webp) @@ -18,7 +18,7 @@ description: Tutorial on adding the gang box mounts to your R-Pro-1. !!! danger "Before continuing and sliding the mounts on, please verify you have the pieces oriented as shown in the images below." - If the mounts are not put on properly the R-PRO-1 could be damaged! + If the mounts are not put on properly the R PRO-1 could be damaged! 3\. Gently push the top mount labeled "TOP" into the pcb as shown below. Make sure the orientation is identical to the image below! diff --git a/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md b/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md index 81e0635dc8..58d271f9a2 100755 --- a/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md +++ b/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md @@ -1,16 +1,16 @@ --- title: Add the ceiling mounts to your R PRO-1 -description: Tutorial on installing the ceiling mount addon for the R-PRO-1. +description: Tutorial on installing the ceiling mount addon for the R PRO-1. --- -# Install Ceiling Mount for R-PRO-1 +# Install Ceiling Mount for R PRO-1 -Watch our step by step video on installing the R-PRO-1 using the Ceiling Mount. We have images showing how to assemble the mount below. +Watch our step by step video on installing the R PRO-1 using the Ceiling Mount. We have images showing how to assemble the mount below.
###### Attaching Mounts -1\. Unplug your R-PRO-1 from power and remove the back. +1\. Unplug your R PRO-1 from power and remove the back. ![](/assets/rpro-1-add-co2-lift-lid-1.webp) @@ -24,7 +24,7 @@ Watch our step by step video on installing the R-PRO-1 using the Ceiling Mount. !!! danger "Before continuing and sliding the mounts on, please verify you have the pieces oriented as shown in the images below." - If the mounts are not put on properly the R-PRO-1 could be damaged! + If the mounts are not put on properly the R PRO-1 could be damaged! 3\. Gently push the top mount labeled "TOP" into the pcb as shown below. Make sure the orientation is identical to the image below! @@ -52,11 +52,11 @@ The Ceiling Mount needs a 3.5 inch (around 89mm) circular hole in the ceiling. C ![](/assets/r-pro-1-ceiling-mount-plug-in-eth.webp) -3\. Gently slide R-PRO-1 into the Ceiling Mount. +3\. Gently slide R PRO-1 into the Ceiling Mount. ![](/assets/r-pro-1-ceiling-mount-insert-r-pro-1.webp) -4\. Push the R-PRO-1 back 1inch (around 2.5cm) to make sure the lip of the cover fits over the Ceiling Mount. +4\. Push the R PRO-1 back 1inch (around 2.5cm) to make sure the lip of the cover fits over the Ceiling Mount. ![](/assets/r-pro-1-ceiling-mount-recess-r-pro-1.webp) diff --git a/docs/products/rpro1/calibrating-co2.md b/docs/products/rpro1/calibrating-co2.md index 2fbede7edc..4427c558c6 100755 --- a/docs/products/rpro1/calibrating-co2.md +++ b/docs/products/rpro1/calibrating-co2.md @@ -4,9 +4,9 @@ description: Step by step guide for re-calibrating your SCD40 CO2 sensor --- # CO2 Calibration - The Quick method - Desktop Only not mobile -!!! info "Your R-PRO-1 calibrates itself" +!!! info "Your R PRO-1 calibrates itself" - The R-PRO-1 enables the SCD40's automatic self-calibration by default. As long as the sensor sees fresh air (about 420 ppm) at least once a week, it corrects its own baseline and you never need to calibrate manually. You only need this guide if the device sits in a space that rarely gets fresh air (a sealed office, a basement, a grow room), where auto calibration slowly drags the readings down. In that case, turn off the **CO2 Auto Calibration** switch on the device page and calibrate manually with the steps below. + The R PRO-1 enables the SCD40's automatic self-calibration by default. As long as the sensor sees fresh air (about 420 ppm) at least once a week, it corrects its own baseline and you never need to calibrate manually. You only need this guide if the device sits in a space that rarely gets fresh air (a sealed office, a basement, a grow room), where auto calibration slowly drags the readings down. In that case, turn off the **CO2 Auto Calibration** switch on the device page and calibrate manually with the steps below. !!! tip "Calibrate manually every 1 to 2 years when auto calibration is off" diff --git a/docs/products/rpro1/faq.md b/docs/products/rpro1/faq.md index eeb60d35ff..df2f3f4410 100755 --- a/docs/products/rpro1/faq.md +++ b/docs/products/rpro1/faq.md @@ -2,9 +2,9 @@ title: R-Pro-1 FAQ description: Frequently asked questions about the R-Pro-1 PoE mmWave sensor. --- -1\. **What sensors are included in the R-PRO-1?** +1\. **What sensors are included in the R PRO-1?** -* The R-PRO-1 includes several built-in sensors such as a LD2450 mmWave radar sensor and optional LD2412 mmWave radar for presence detection, a LUX and UV sensor, and an optional CO2 sensor. +* The R PRO-1 includes several built-in sensors such as a LD2450 mmWave radar sensor and optional LD2412 mmWave radar for presence detection, a LUX and UV sensor, and an optional CO2 sensor. 2\. **How does the mmWave radar sensor work?** @@ -15,9 +15,9 @@ description: Frequently asked questions about the R-Pro-1 PoE mmWave sensor. * The HLK-LD2450 mmWave radar sensor has a maximum detection range of about 6 meters (19.6 feet) with multi-target tracking capabilities, making it ideal for room-wide monitoring. * The optional HLK-LD2412 mmWave radar sensor has a maximum detection range of about 9 meters (29.5 feet) with single tracking capabilities and ability to tune moving and still energy which is perfect for still targets like sleeping in a bed, laying on a couch, etc. -4\. **Can the R-PRO-1 detect multiple people?** +4\. **Can the R PRO-1 detect multiple people?** -* Yes, the R-PRO-1 comes with a LD2450 which can detect 3 people in up to 3 zones. The optional ld2412 addon will only detect one person. +* Yes, the R PRO-1 comes with a LD2450 which can detect 3 people in up to 3 zones. The optional ld2412 addon will only detect one person. 5\. **What is the benefit of the LUX and UV sensor?** @@ -30,11 +30,11 @@ description: Frequently asked questions about the R-Pro-1 PoE mmWave sensor. * The optional SCD-40 CO2 sensor provides accurate carbon dioxide measurements and is useful for tracking air quality in enclosed spaces. This sensor can be used to automate HVAC systems, sending alerts when CO2 levels are too high and suggesting when to ventilate the area. -7\. **How do I connect the R-PRO-1 to Home Assistant?** +7\. **How do I connect the R PRO-1 to Home Assistant?** -* The R-PRO-1 connects to your Home Assistant instance through ESPHome using WiFi. Once connected, you can switch to using the ethernet firmware. You can also reflash it to Ethernet firmware here. +* The R PRO-1 connects to your Home Assistant instance through ESPHome using WiFi. Once connected, you can switch to using the ethernet firmware. You can also reflash it to Ethernet firmware here. -8\. **What kind of automations can I create with the R-PRO-1?** +8\. **What kind of automations can I create with the R PRO-1?** * You can create a variety of automations, such as turning on lights when motion is detected, adjusting ventilation when CO2 levels rise, or triggering alarms based on motion or environmental changes. @@ -50,47 +50,47 @@ description: Frequently asked questions about the R-Pro-1 PoE mmWave sensor. * Yes, the mmWave sensor can detect movement through certain materials like drywall and thin wood. In some instances it will need to be tuned to make sure adjacent rooms are not triggering the sensor. -12\. **Can the R-PRO-1 be used outdoors?** +12\. **Can the R PRO-1 be used outdoors?** -* No, the R-PRO-1 is primarily designed for indoor use and high humidity or temperatures too high or low could damage the device. +* No, the R PRO-1 is primarily designed for indoor use and high humidity or temperatures too high or low could damage the device. -13\. **Can the R-PRO-1 track the exact location of people in a room?** +13\. **Can the R PRO-1 track the exact location of people in a room?** * Yes with the LD2450 mmWave sensor, it is able to reliably detect people in x/y coordinate 'zones' that you setup here. -* Yes, the R-PRO-1 uses multi-zone mmWave radar technology to track the approximate location of people within a room. It can determine whether someone is sitting, walking, or standing in different areas of the space. +* Yes, the R PRO-1 uses multi-zone mmWave radar technology to track the approximate location of people within a room. It can determine whether someone is sitting, walking, or standing in different areas of the space. -14\. **What kind of power supply is required for the R-PRO-1?** +14\. **What kind of power supply is required for the R PRO-1?** -* The R-PRO-1 is powered via Ethernet (802.3 compliant) or USB-C and can be plugged into a standard wall outlet using a 5V 2A or bigger power supply. +* The R PRO-1 is powered via Ethernet (802.3 compliant) or USB-C and can be plugged into a standard wall outlet using a 5V 2A or bigger power supply. -15\. **Can I customize the R-PRO-1 functionality?** +15\. **Can I customize the R PRO-1 functionality?** -* Absolutely! With ESPHome, users can modify firmware, settings, and even print custom cases for the R-PRO-1. Our YAML is on Github and our .STEP and .STL CAD files are available for community use. +* Absolutely! With ESPHome, users can modify firmware, settings, and even print custom cases for the R PRO-1. Our YAML is on Github and our .STEP and .STL CAD files are available for community use. -16\. **How often does the R-PRO-1 report sensor data?** +16\. **How often does the R PRO-1 report sensor data?** * The reporting frequency can be customized through the ESPHome YAML configuration. You can set it to report data as frequently as every second or reduce the frequency to save energy or bandwidth. Defaults will be 60 seconds for most sensors, but the mmWave sensors will report immediately on change. -17\. **Is the R-PRO-1 compatible with other smart home platforms?** +17\. **Is the R PRO-1 compatible with other smart home platforms?** * Yes, it is compatible with any system that can integrate with the ESPHome API. We also have a list of supported platforms. -18\. **Can I use multiple R-PRO-1 sensors in my Home Assistant setup?** +18\. **Can I use multiple R PRO-1 sensors in my Home Assistant setup?** -* Yes, you can have multiple R-PRO-1 sensors connected to the same Home Assistant instance. Each R-PRO-1 will show up as a separate device with a lot of entities to configure and automate on, allowing you to monitor and automate different rooms or areas in your home. +* Yes, you can have multiple R PRO-1 sensors connected to the same Home Assistant instance. Each R PRO-1 will show up as a separate device with a lot of entities to configure and automate on, allowing you to monitor and automate different rooms or areas in your home. -19\. **What addons are available for the R-PRO-1?** +19\. **What addons are available for the R PRO-1?** -* The R-PRO-1 has a mezzanine port for an optional SCD40 CO2 sensor. We also sell a gang box mount and a ceiling mount kit. +* The R PRO-1 has a mezzanine port for an optional SCD40 CO2 sensor. We also sell a gang box mount and a ceiling mount kit. -20\. **Is the R-PRO-1 secure?** +20\. **Is the R PRO-1 secure?** -* The R-PRO-1 communicates over your local network using encrypted traffic with the ESPHome API. This provides a secure, local connection without the need for cloud services. No data is sent to external servers, ensuring privacy. +* The R PRO-1 communicates over your local network using encrypted traffic with the ESPHome API. This provides a secure, local connection without the need for cloud services. No data is sent to external servers, ensuring privacy. -21\. **What makes the R-PRO-1 stand out from other motion sensors?** +21\. **What makes the R PRO-1 stand out from other motion sensors?** -* The R-PRO-1 is the only dual mmWave sensor with PoE and ability to integrate with multiple smart home platforms seamlessly. It combines the MSR-2's ability to detect still detection perfectly and the MTR-1's ability to detect up to three targets in three zones! +* The R PRO-1 is the only dual mmWave sensor with PoE and ability to integrate with multiple smart home platforms seamlessly. It combines the MSR-2's ability to detect still detection perfectly and the MTR-1's ability to detect up to three targets in three zones! -22\. **What is the warranty for the R-PRO-1?** +22\. **What is the warranty for the R PRO-1?** -* The R-PRO-1 comes with a standard one-year warranty. If you experience any issues, our support team is available through Discord, email, or the website to assist with troubleshooting or replacement. \ No newline at end of file +* The R PRO-1 comes with a standard one-year warranty. If you experience any issues, our support team is available through Discord, email, or the website to assist with troubleshooting or replacement. \ No newline at end of file diff --git a/docs/products/rpro1/introduction.md b/docs/products/rpro1/introduction.md index 21e363c2d6..dc2439e4cf 100755 --- a/docs/products/rpro1/introduction.md +++ b/docs/products/rpro1/introduction.md @@ -4,7 +4,7 @@ description: Documentation for R-Pro-1, including setup, usage, and best practic ---
-!!! tip "R-PRO-1 ships with Wi-Fi firmware because some people might not have ethernet or PoE." +!!! tip "R PRO-1 ships with Wi-Fi firmware because some people might not have ethernet or PoE." Your device needs to be able to [connect to the internet to switch between firmware files](https://wiki.apolloautomation.com/products/rpro1/setup/rpro1-switch-firmware/). If you are connecting to an IoT network on a subnet/vlan unable to access github.com then this will not work. You can also manually reflash your device serially (usb) by following our flashing guide! diff --git a/docs/products/rpro1/rpro1-reviews.md b/docs/products/rpro1/rpro1-reviews.md index 7da9dceca9..13a3303341 100755 --- a/docs/products/rpro1/rpro1-reviews.md +++ b/docs/products/rpro1/rpro1-reviews.md @@ -4,10 +4,10 @@ description: Youtuber reviews and feedback about the R-Pro-1 sensor from Apollo ---   -# Simon Says Home Assistant R-PRO-1 Review +# Simon Says Home Assistant R PRO-1 Review -# [Smart Home Scene R-PRO-1 Review](https://smarthomescene.com/reviews/apollo-r-pro-1-review-dual-mmwave-presence-multisensor-with-poe-support/) +# [Smart Home Scene R PRO-1 Review](https://smarthomescene.com/reviews/apollo-r-pro-1-review-dual-mmwave-presence-multisensor-with-poe-support/) -# [MostlyChris R-PRO-1 Review](https://www.youtube.com/watch?v=wVgNE8UtsAM) +# [MostlyChris R PRO-1 Review](https://www.youtube.com/watch?v=wVgNE8UtsAM) -# Pete Scargill R-PRO-1 Review \ No newline at end of file +# Pete Scargill R PRO-1 Review \ No newline at end of file diff --git a/docs/products/rpro1/setup/r-pro-1-zone-mapper-tool.md b/docs/products/rpro1/setup/r-pro-1-zone-mapper-tool.md index 3c07b29078..725ce1e045 100755 --- a/docs/products/rpro1/setup/r-pro-1-zone-mapper-tool.md +++ b/docs/products/rpro1/setup/r-pro-1-zone-mapper-tool.md @@ -1,10 +1,10 @@ --- -title: R-PRO-1 Zone Mapper tool -description: Install and use the Zone Mapper tool to draw LD2450 mmWave detection zones for your R-PRO-1 in Home Assistant. +title: R PRO-1 Zone Mapper tool +description: Install and use the Zone Mapper tool to draw LD2450 mmWave detection zones for your R PRO-1 in Home Assistant. --- -# R-PRO-1 Zone Mapper tool +# R PRO-1 Zone Mapper tool -The Apollo R-PRO-1's LD2450 mmWave sensor tracks up to three targets across the room. With the Zone Mapper tool you draw its detection zones on a visual grid in Home Assistant, watch targets move in real time, and get an occupancy sensor for every zone you draw. +The Apollo R PRO-1's LD2450 mmWave sensor tracks up to three targets across the room. With the Zone Mapper tool you draw its detection zones on a visual grid in Home Assistant, watch targets move in real time, and get an occupancy sensor for every zone you draw. --8<-- "_snippets/zone-mapper-tool.md" diff --git a/docs/products/rpro1/setup/rpro1-general-tips.md b/docs/products/rpro1/setup/rpro1-general-tips.md index 830f086057..f3e2dfb474 100755 --- a/docs/products/rpro1/setup/rpro1-general-tips.md +++ b/docs/products/rpro1/setup/rpro1-general-tips.md @@ -1,5 +1,5 @@ --- -title: R-PRO-1 General Tips +title: R PRO-1 General Tips description: Multiple helpful images for mounting, lux/rgb, and gate and zone visualization. --- # General Tips @@ -8,7 +8,7 @@ description: Multiple helpful images for mounting, lux/rgb, and gate and zone vi ![20240514_123742.jpg](/assets/rpro-ltr-390.jpg) -The R-PRO-1 doesn't have any slits on the front of the case, so UV rays can't directly reach the sensor for UV detection. However, light can still enter from around the edges or behind the front panel, allowing the lux readings to spike when ambient light is present. +The R PRO-1 doesn't have any slits on the front of the case, so UV rays can't directly reach the sensor for UV detection. However, light can still enter from around the edges or behind the front panel, allowing the lux readings to spike when ambient light is present. !!! warning "The RGB LED will trigger the Light sensor!" @@ -16,13 +16,13 @@ The R-PRO-1 doesn't have any slits on the front of the case, so UV rays can't di ##### **Wall Mounting** -The R-PRO-1 should be mounted 1.5-2 meters off the ground which will then provide a nice even 120 degree FOV for the LD2450 and 150 degree FOV for the LD2412. +The R PRO-1 should be mounted 1.5-2 meters off the ground which will then provide a nice even 120 degree FOV for the LD2450 and 150 degree FOV for the LD2412. ![ld2410_mounting_hor-1.jpeg](/assets/ld2412-wall-mount-radar-cone.png) ##### **Ceiling Mounting** -The R-PRO-1 should be mounted 2.6-3 meters (8-10 feet) high when mounted on the ceiling using our ceiling mount kit. +The R PRO-1 should be mounted 2.6-3 meters (8-10 feet) high when mounted on the ceiling using our ceiling mount kit. ![LD2410 Gates.png](/assets/ld2412-ceiling-mount-radar-cone.png) diff --git a/docs/products/rpro1/setup/rpro1-sensor-definitions.md b/docs/products/rpro1/setup/rpro1-sensor-definitions.md index 47a0ab63f5..b322aa5727 100755 --- a/docs/products/rpro1/setup/rpro1-sensor-definitions.md +++ b/docs/products/rpro1/setup/rpro1-sensor-definitions.md @@ -1,12 +1,12 @@ --- -title: R-PRO-1 Sensor Definitions -description: These are all of the entities exposed by the R-PRO-1 to automate on! +title: R PRO-1 Sensor Definitions +description: These are all of the entities exposed by the R PRO-1 to automate on! --- # Sensor Definitions -Once added to Home Assistant you can configure different settings for your R-PRO-1. Use the tabs below to see what each entity does, grouped the same way Home Assistant displays them. +Once added to Home Assistant you can configure different settings for your R PRO-1. Use the tabs below to see what each entity does, grouped the same way Home Assistant displays them. -The R-PRO-1 pairs two radars: an **LD2450** that tracks the position of up to three targets and reports zone occupancy, and an **LD2412** that handles presence and per-gate sensitivity tuning. It also carries an LTR390 light sensor and an optional SCD40 CO₂ module. +The R PRO-1 pairs two radars: an **LD2450** that tracks the position of up to three targets and reports zone occupancy, and an **LD2412** that handles presence and per-gate sensitivity tuning. It also carries an LTR390 light sensor and an optional SCD40 CO₂ module. !!! note "How often readings update" @@ -101,7 +101,7 @@ The R-PRO-1 pairs two radars: an **LD2450** that tracks the position of up to th | **LD2412 Light Function** | — | Selects how the LD2412 uses its light reading. Disabled by default. | | **LD2412 Hardware output pin level** | — | Output pin level for the LD2412. Disabled by default. | | **LD2412 Distance resolution** | — | Distance resolution for the LD2412. Disabled by default. | - | **LD2412 baud rate** | from module | Serial baud rate the LD2412 uses to talk to the R-PRO-1 (default 115200). Disabled by default; no need to change. | + | **LD2412 baud rate** | from module | Serial baud rate the LD2412 uses to talk to the R PRO-1 (default 115200). Disabled by default; no need to change. | #### LD2450 radar @@ -114,7 +114,7 @@ The R-PRO-1 pairs two radars: an **LD2450** that tracks the position of up to th | **LD2450 Zone-1 / Zone-2 / Zone-3 X1, X2** | — | Start and end X coordinates of the zone in mm (-3000 left to 3000 right). | | **LD2450 Zone-1 / Zone-2 / Zone-3 Y1, Y2** | — | Start and end Y coordinates of the zone in mm (0 to 6000). | | **LD2450 Factory Reset** | — | Resets the LD2450 radar module to its factory settings. | - | **LD2450 Baud rate** | from module | Serial baud rate the LD2450 uses to talk to the R-PRO-1 (default 256000). Disabled by default; no need to change. | + | **LD2450 Baud rate** | from module | Serial baud rate the LD2450 uses to talk to the R PRO-1 (default 256000). Disabled by default; no need to change. | === "Diagnostic" diff --git a/docs/products/rpro1/setup/rpro1-switch-firmware.md b/docs/products/rpro1/setup/rpro1-switch-firmware.md index 51489dfb9d..ac5aea3fb0 100755 --- a/docs/products/rpro1/setup/rpro1-switch-firmware.md +++ b/docs/products/rpro1/setup/rpro1-switch-firmware.md @@ -1,18 +1,18 @@ --- -title: R-PRO-1 Switch Firmware +title: R PRO-1 Switch Firmware description: >- Step by step guide to switching between Wi-Fi and Ethernet firmware on - R-PRO-1. + R PRO-1. --- # Firmware Switching Guide -!!! tip "R-PRO-1 ships with Wi-Fi firmware because some people might not have ethernet or PoE." +!!! tip "R PRO-1 ships with Wi-Fi firmware because some people might not have ethernet or PoE." Your device needs to be able to connect to the internet to switch between firmware files. If you are connecting to an IoT network on a subnet/vlan unable to access github.com then this will not work. You can also manually reflash your device serially (usb) by following our flashing guide! ###### Switch to Ethernet -1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on "1 device" below your Apollo R-PRO-1. +1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on "1 device" below your Apollo R PRO-1. ![](/assets/select-r-pro-1-device.png) @@ -30,7 +30,7 @@ description: >- ###### Switch to Wi-Fi -1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on "1 device" below your Apollo R-PRO-1. +1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on "1 device" below your Apollo R PRO-1. ![](/assets/select-r-pro-1-device.png) diff --git a/docs/products/rpro1/setup/zones-ha-new.md b/docs/products/rpro1/setup/zones-ha-new.md index 503e657172..5f892d5ce1 100755 --- a/docs/products/rpro1/setup/zones-ha-new.md +++ b/docs/products/rpro1/setup/zones-ha-new.md @@ -2,11 +2,11 @@ title: MSR-2 Home Assistant Zone Configuration description: Tutorial for R-Pro-1 Home Assistant Zone Configuration. --- -# How To Tune The R-PRO-1 Using Home Assistant +# How To Tune The R PRO-1 Using Home Assistant -!!! info "Your R-PRO-1 has two unique mmWave sensors that both need to be tuned!" +!!! info "Your R PRO-1 has two unique mmWave sensors that both need to be tuned!" - The R-PRO-1 comes with an LD2450 mmwave sensor and an optional secondary LD2412 mmWave sensor. + The R PRO-1 comes with an LD2450 mmwave sensor and an optional secondary LD2412 mmWave sensor. The LD2450 allows for up to three targets tracked in up to three zones but can have issues with "still detection". diff --git a/docs/products/rpro1/setup/zones-ha.md b/docs/products/rpro1/setup/zones-ha.md index faaf78fd6d..46450e9fef 100755 --- a/docs/products/rpro1/setup/zones-ha.md +++ b/docs/products/rpro1/setup/zones-ha.md @@ -1,18 +1,18 @@ --- -title: R-PRO-1 Home Assistant Zone Configuration -description: Tutorial for R-PRO-1 Home Assistant Zone Configuration. +title: R PRO-1 Home Assistant Zone Configuration +description: Tutorial for R PRO-1 Home Assistant Zone Configuration. --- -# How To Tune The R-PRO-1 Using Home Assistant +# How To Tune The R PRO-1 Using Home Assistant -!!! info "Your R-PRO-1 has two unique mmWave sensors that both need to be tuned!" +!!! info "Your R PRO-1 has two unique mmWave sensors that both need to be tuned!" - The R-PRO-1 comes with an LD2450 mmwave sensor and an optional secondary LD2412 mmWave sensor. + The R PRO-1 comes with an LD2450 mmwave sensor and an optional secondary LD2412 mmWave sensor. The LD2450 allows for up to three targets tracked in up to three zones but can have issues with "still detection". The optional LD2412 mmWave sensor allows you to have perfect still detection for one target at up to 9 meters so it's a great addition to the sensor. -Manually enter in the X and Y coordinates for each zone in Home Assistant or directly from the device's webserver by visiting the IP address or hostname.local. It's much easier to tune using the HLK Radartool App and we suggest using that to set up your R-PRO-1 LD2450. +Manually enter in the X and Y coordinates for each zone in Home Assistant or directly from the device's webserver by visiting the IP address or hostname.local. It's much easier to tune using the HLK Radartool App and we suggest using that to set up your R PRO-1 LD2450. ###### LD2450 Configuration @@ -94,7 +94,7 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir ###### LD2412 Configuration -1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on "1 device" below the Apollo R-PRO-1. +1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on "1 device" below the Apollo R PRO-1. ![](/assets/select-r-pro-1-device.png) diff --git a/docs/products/rpro1/setup/zones-hlk.md b/docs/products/rpro1/setup/zones-hlk.md index 5c8027d8b3..c5bcfb48e9 100755 --- a/docs/products/rpro1/setup/zones-hlk.md +++ b/docs/products/rpro1/setup/zones-hlk.md @@ -12,7 +12,7 @@ description: Tutorial for R-Pro-1 HLKRadarTool app Zone Configuration. The newer version of the firmware includes an "auto calibrate" function so you might want to test it out! -The HLK-LD2450 mmWave sensor is used in the R-PRO-1. Click Here for the datasheet. +The HLK-LD2450 mmWave sensor is used in the R PRO-1. Click Here for the datasheet. === "iPhone" @@ -22,7 +22,7 @@ The Click here to download -1\. Head to the ESPHome Integrations page then select your R-PRO-1 and scroll down until you see LD2450 Bluetooth. +1\. Head to the ESPHome Integrations page then select your R PRO-1 and scroll down until you see LD2450 Bluetooth. ![](/assets/mtr-1-toggle-on-ld2450-bluetooth.png) @@ -40,9 +40,9 @@ The **Disabled**: Disable multi-zone area detection and just tracks one big area.
**Detection**: Only detects targets within each of the three zones.
**Filter**: Excludes a zone from detection and detects presence everywhere else. + You can use any of these three choices to control your R PRO-1 differently. The most common option is "Detection" which lets you setup three areas and track three targets within them.
**Disabled**: Disable multi-zone area detection and just tracks one big area.
**Detection**: Only detects targets within each of the three zones.
**Filter**: Excludes a zone from detection and detects presence everywhere else. Disabled allows you to just use the sensor as a "basic" presence sensor and "Filter" lets you filter out an area and detect everything else, which is useful to avoid a fan! @@ -94,11 +94,11 @@ The same HLKRadarTool app is used for both sensors. Click here to download -1\. Head to the ESPHome Integrations page then select your R-PRO-1 and scroll down until you see **LD2412 Bluetooth**. Toggle it on. +1\. Head to the ESPHome Integrations page then select your R PRO-1 and scroll down until you see **LD2412 Bluetooth**. Toggle it on. ![](/assets/r-pro-1-toggle-on-ld2412-bluetooth.gif) -2\. Open the HLKRadarTool app. Your R-PRO-1 should appear in the device list. Tap it to connect. +2\. Open the HLKRadarTool app. Your R PRO-1 should appear in the device list. Tap it to connect. !!! success "You need to be close to your device!" @@ -126,7 +126,7 @@ The same HLKRadarTool app is used for both sensors. ![](/assets/r-pro-1-ld2412-detection-range.gif) -6\. To fine-tune which distances trigger detection, head to the ESPHome Integrations page, select your R-PRO-1, and use the gate sensitivity sliders on the device page. +6\. To fine-tune which distances trigger detection, head to the ESPHome Integrations page, select your R PRO-1, and use the gate sensitivity sliders on the device page. - **Raise** a gate's sensitivity to make it harder to trigger at that distance (useful for ignoring a fan, HVAC vent, or a window where cars pass). - **Lower** a gate's sensitivity to make it more sensitive at that distance (useful for reliably detecting someone sitting still in a chair). @@ -135,5 +135,5 @@ The same HLKRadarTool app is used for both sensors. 7\. Tap **Settings** at the top of the app and set the **Unmanned Duration**. This controls how many seconds the sensor waits after it stops detecting before it reports "no one present." The default is 10 seconds — increase it if you're getting false "nobody home" readings in your space. In Home Assistant, this same setting is called **LD2412 Timeout**. -8\. Head back to the ESPHome Integrations page, select your R-PRO-1, and toggle **LD2412 Bluetooth** back off. Leaving Bluetooth on increases power consumption and can interfere with nearby Bluetooth devices. +8\. Head back to the ESPHome Integrations page, select your R PRO-1, and toggle **LD2412 Bluetooth** back off. Leaving Bluetooth on increases power consumption and can interfere with nearby Bluetooth devices. diff --git a/docs/products/rpro1/troubleshooting/rpro1-boot-mode.md b/docs/products/rpro1/troubleshooting/rpro1-boot-mode.md index 43b13bdbc7..7c170e56cd 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-boot-mode.md +++ b/docs/products/rpro1/troubleshooting/rpro1-boot-mode.md @@ -1,16 +1,16 @@ --- -title: Putting The R-PRO-1 In Boot Mode -description: Step by step guide for putting The R-PRO-1 In Boot Mode. +title: Putting The R PRO-1 In Boot Mode +description: Step by step guide for putting The R PRO-1 In Boot Mode. --- -# Putting The R-PRO-1 In Boot Mode +# Putting The R PRO-1 In Boot Mode -!!! info "This will cover how to put the R-PRO-1 into boot mode." +!!! info "This will cover how to put the R PRO-1 into boot mode." This is needed to force the device into boot mode to reflash the firmware. ##### Method 1: Boot Button Only -1\. Unplug your R-PRO-1 from power and remove the back. +1\. Unplug your R PRO-1 from power and remove the back. ![](/assets/rpro-1-add-co2-lift-lid-1.webp)![](/assets/rpro-1-add-co2-remove-lid.webp) @@ -22,13 +22,13 @@ description: Step by step guide for putting The R-PRO-1 In Boot Mode. ![](/assets/r-pro-1-boot-button.jpg) -4\. Push and hold the boot button. While still holding the button down, plug in a USB-C cable into the USB-C port of your R-PRO-1 then let go of the button. +4\. Push and hold the boot button. While still holding the button down, plug in a USB-C cable into the USB-C port of your R PRO-1 then let go of the button. 5\. Continue with uploading the firmware document. ##### Method 2: Boot and Reset Buttons -1\. Unplug your R-PRO-1 from power and remove the back. +1\. Unplug your R PRO-1 from power and remove the back. ![](/assets/rpro-1-add-co2-lift-lid-1.webp)![](/assets/rpro-1-add-co2-remove-lid.webp) diff --git a/docs/products/rpro1/troubleshooting/rpro1-code.md b/docs/products/rpro1/troubleshooting/rpro1-code.md index 6c845946d9..6921bd527f 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-code.md +++ b/docs/products/rpro1/troubleshooting/rpro1-code.md @@ -1,8 +1,8 @@ --- -title: Factory Re-Flash R-PRO-1 -description: Step by step guide for re-flashing the R-PRO-1 back to factory firmware. +title: Factory Re-Flash R PRO-1 +description: Step by step guide for re-flashing the R PRO-1 back to factory firmware. --- -# Factory Re-Flash R-PRO-1 +# Factory Re-Flash R PRO-1 !!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below." @@ -10,11 +10,11 @@ description: Step by step guide for re-flashing the R-PRO-1 back to factory firm If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing. -1\. Locate the boot button as shown here. Push and hold the boot button. While still holding the button down, plug in a USB-C cable into the USB-C port of your R-PRO-1 then let go of the button. +1\. Locate the boot button as shown here. Push and hold the boot button. While still holding the button down, plug in a USB-C cable into the USB-C port of your R PRO-1 then let go of the button. ![](/assets/r-pro-1-boot-button.jpg) -3\. Navigate to our installer page and click connect under Apollo R-PRO-1 Installer. +3\. Navigate to our installer page and click connect under Apollo R PRO-1 Installer. 3\. Click the big "Connect" button. @@ -24,7 +24,7 @@ If your device has already been connected to Home Assistant please - R-PRO-1 Plotly YAML Generator with Custom Zone Names + R PRO-1 Plotly YAML Generator with Custom Zone Names -

R-PRO-1 Plotly YAML Generator

+

R PRO-1 Plotly YAML Generator


@@ -100,7 +100,7 @@

R-PRO-1 Plotly YAML Generator

} const yaml = `type: custom:plotly-graph -title: R-PRO-1 Target Positions +title: R PRO-1 Target Positions refresh_interval: 1 hours_to_show: current_day layout: diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 3088acbb3d..a27818e735 100755 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -54,6 +54,18 @@ article.md-typeset .cms-embed iframe { border: 0; } +/* Phone screen recordings and screenshots: portrait media capped at + phone width so a tall clip doesn't fill the page. Use + class="phone-media" on