Skip to content

Add sensors to the Traccar Server documentation #31624

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

Merged
merged 5 commits into from
Mar 20, 2024
Merged

Add sensors to the Traccar Server documentation #31624

merged 5 commits into from
Mar 20, 2024

Conversation

ludeeus
Copy link
Member

@ludeeus ludeeus commented Feb 26, 2024

Proposed change

Adds documentation for the new sensors that are being added with home-assistant/core#111374

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Feb 26, 2024
Copy link

netlify bot commented Feb 26, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 429c129
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/65fa75bdb5aab80008cef2a0
😎 Deploy Preview https://deploy-preview-31624--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Name:
description: The name of the sensor will be set to what you have named it in Traccar Server followed by Address.
Entity ID:
description: This will be a slugified version of the name.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think an example could be helpful here, as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As we can not guarantee this, I think adding that can cause more confusion.
If you have to sensors that want the same entity ID, the second one to be loaded will get a _2 suffix.

Unique ID:
description: This will be the unique ID of the device tracker in Traccar Server followed by `position_address`.
State:
description: This will be the address reported by the Traccar Server, if geo detection is not configured this will be unknown`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: This will be the address reported by the Traccar Server, if geo detection is not configured this will be unknown`.
description: This will be the address reported by the Traccar Server, if geofence is not configured, this will be unknown`.

Should this be geofence? This is the only occurrence of geo detection I find here. or is this something else?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Geo detection is a setting that needs to be enabled on the server.

Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some examples could be helpful

@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft March 15, 2024 16:37
@ludeeus ludeeus marked this pull request as ready for review March 20, 2024 05:37
@home-assistant home-assistant bot requested a review from c0ffeeca7 March 20, 2024 05:37
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @ludeeus 👍

@c0ffeeca7 c0ffeeca7 merged commit b748073 into next Mar 20, 2024
@c0ffeeca7 c0ffeeca7 deleted the ts_sensor branch March 20, 2024 08:17
ludeeus added a commit that referenced this pull request Mar 20, 2024
ludeeus added a commit that referenced this pull request Mar 20, 2024
ludeeus added a commit that referenced this pull request Mar 20, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Mar 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants