-
Notifications
You must be signed in to change notification settings - Fork 95
Rework reading order and small improvements #270
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
CoMPaTech
wants to merge
6
commits into
ESPresense:main
Choose a base branch
from
CoMPaTech:ct1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
221f8cf
Rework reading order and split out approach details
CoMPaTech 953c5c4
Rework nodes section
CoMPaTech 212c7b2
Fix my homeassistant links
CoMPaTech 79203ec
Rework sitebar accordingly
CoMPaTech 529f1f2
Small fixes
CoMPaTech 0154dd4
CRAI findings
CoMPaTech File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,3 +4,4 @@ node_modules | |
| .DS_Store | ||
| .omc/ | ||
| .playwright-cli/ | ||
| pnpm-lock.yaml | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| title: Approaches | ||
| --- | ||
|
|
||
| :::note | ||
| These are fundamentally different approaches. mqtt_room uses 1 node per room. Companion needs dense coverage (5-8 per floor) with strategic placement. More nodes doesn't make mqtt_room better - pick one approach and commit. | ||
| ::: | ||
|
|
||
| ## Approach 1: mqtt_room (Simple Room Presence) | ||
|
|
||
| **Best for:** Room-based automations like "turn on kitchen lights when I enter" | ||
|
|
||
| | | mqtt_room | | ||
| |:---|:---| | ||
| | **Question Answered** | "Which room is my device in?" | | ||
| | **Output** | Room name (e.g., "kitchen") | | ||
| | **Nodes Needed** | 1 per room | | ||
| | **Setup** | Simple | | ||
|
|
||
| Your device connects to the **single nearest ESPresense node**. The node's configured room name is reported to Home Assistant. | ||
|
|
||
| ``` | ||
| Phone → "I'm 2m from Living Room node" → HA sees "Phone is in Living Room" | ||
| ``` | ||
|
|
||
| **Requirements:** | ||
| - Place **one node per room** where you want detection | ||
| - Each node = one room in your automation | ||
| - No floor plan required | ||
|
|
||
| **When to use:** Turning lights on/off per room, playing announcements, basic presence detection. **Start here if you're new.** | ||
|
|
||
| [Setup mqtt_room →](/integrations/home-assistant) | ||
|
|
||
| ## Approach 2: Companion (Precise Positioning) | ||
|
|
||
| **Best for:** Precise location tracking like "find my phone on the floor plan" | ||
|
|
||
| | | Companion | | ||
| |:---|:---| | ||
| | **Question Answered** | "Where exactly is my device on the floor?" | | ||
| | **Output** | X,Y coordinates on floor plan | | ||
| | **Nodes Needed** | 5-8 per floor | | ||
| | **Setup** | More complex | | ||
|
|
||
| Multiple nodes measure distance to your device simultaneously. Using **multilateration**, Companion calculates precise coordinates. | ||
|
|
||
| ``` | ||
| Phone → 3m from Node A, 5m from Node B, 4m from Node C → Companion: Phone is at (X,Y) | ||
| ``` | ||
|
|
||
| **Additional requirements:** | ||
| - **5-8 nodes per floor** (depending on square footage) | ||
| - **Perimeter nodes help most** - provide strongest positioning | ||
| - **Avoid collinearity** - don't place nodes in straight lines | ||
| - Requires accurate floor plan | ||
| - Obstacles (walls, furniture) drastically affect accuracy | ||
|
|
||
| **When to use:** Finding exact location on a floor plan, tracking movement paths, room-level presence isn't enough. | ||
|
|
||
| [Setup Companion →](/companion) | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 7 additions & 3 deletions
10
src/content/docs/firmware.mdx → src/content/docs/hardware/firmware.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,25 @@ | ||
| --- | ||
| title: Install Firmware | ||
| sidebar: | ||
| order: 2 | ||
| order: 5 | ||
| --- | ||
|
|
||
| import FirmwareInstaller from '../../components/FirmwareInstaller.astro'; | ||
| import FirmwareInstaller from '../../../components/FirmwareInstaller.astro'; | ||
CoMPaTech marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Browser-Based Installer | ||
|
|
||
| Begin by connecting an ESP device to your computer using USB, then click the "Connect" button below: | ||
|
|
||
| <FirmwareInstaller /> | ||
|
|
||
| :::tip | ||
| You must use Edge or Chrome(-based) browser, the above web-based installer does not work on Firefox or Safari. | ||
| ::: | ||
CoMPaTech marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Post-Flashing Steps | ||
|
|
||
| Upon successful firmware flashing, search for an Access Point (AP) with an SSID beginning with "ESPresense-". Connect to this network to access the configuration portal. For setup instructions, visit [Configuration Settings](/configuration/settings). | ||
|
|
||
| ## Alpha / Nightly Builds | ||
|
|
||
| For those interested in experimental features, you can opt for a nightly/alpha build available [here](/alpha). Please note this is for adventurous users and may not be stable. | ||
| For those interested in experimental features, you can opt for a nightly/alpha build available [here](/alpha). Please note this is for experienced and adventurous users and may not be stable. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| --- | ||
| title: Nodes | ||
| sidebar: | ||
| order: 3 | ||
| order: 4 | ||
| --- | ||
|
|
||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Committing
pnpm-lock.yamlis strongly recommended for an application/site.Adding
pnpm-lock.yamlto.gitignorediscards the reproducibility and supply-chain integrity guarantees that lock files provide. Without it,pnpm installwill resolve the latest semver-compatible versions at each point in time, meaning different developers and CI runs can silently receive different (potentially broken or vulnerable) dependency trees.Ignoring lock files is only defensible for publishable npm libraries, where pinning transitive dependencies would conflict with consumer projects. This repository is a documentation website, so the lock file should be committed.
🛡️ Proposed fix
-pnpm-lock.yamlCommit
pnpm-lock.yamlto the repository instead of ignoring it. If there are local developer-specific reasons for regenerating the lock file, those should be handled by individual.git/info/excludeentries rather than the shared.gitignore.📝 Committable suggestion
🤖 Prompt for AI Agents
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@DTTerastar leaving that to you if we want it or not, let me know
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.