Skip to content

Document the proximity speed #45707

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.

Sign up for GitHub

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
jfsimoneau wants to merge 4 commits into
base: next
Choose a base branch
from
+6 −2
Open

Document the proximity speed #45707

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a0c0df1
Document the proximity speed
jfsimoneau Jun 2, 2026
f08df08
Add the m/s units for the speed threshold
jfsimoneau Jun 2, 2026
cb4d89f
Remove the nearest speed sensor
jfsimoneau Jun 2, 2026
5362452
Merge branch 'next' into update-proximity-speed-doc
jfsimoneau Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions source/_integrations/proximity.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Some examples of its use include:
{% include integrations/config_flow.md %}

{% note %}
When adding the **Proximity** integration, you are prompted to define the **Tolerance distance**. The tolerance distance must be provided in meters (m) and is used to filter out small GPS coordinate changes (_due to inaccuracies of GPS_) to calculate the direction of travel.
When adding the **Proximity** integration, you are prompted to define the **Tolerance distance** and **Speed threshold**. The tolerance distance must be provided in meters (m) and is used to filter out small GPS coordinate changes (_due to inaccuracies of GPS_) to calculate the direction of travel. The speed threshold must be provided in meters per second (m/s) and is used to mark the tracked device or person as stationary.
{% endnote %}
Comment thread
jfsimoneau marked this conversation as resolved.

## Sensors
Expand All @@ -50,8 +50,12 @@ For each tracked device or person, a sensor is created showing the direction of
- `towards`
- `unknown`

### Speed

For each tracked device or person, a sensor is created showing the approximate speed of the tracked device or person.

{% important %}
To calculate the distance and the direction of travel for a tracked device or person, they must specify a geo-location.
To calculate the distance, the direction of travel, and the speed for a tracked device or person, they must specify a geo-location.
{% endimportant %}
Comment thread
jfsimoneau marked this conversation as resolved.

### Nearest device
Expand Down