Add documentation for Traccar Server binary sensors (#32139)

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Joakim Sørensen 2024-04-24 17:25:54 +02:00 committed by GitHub
parent fd0da18bbf
commit fa0429e46c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -11,6 +11,7 @@ ha_codeowners:
- '@ludeeus' - '@ludeeus'
ha_domain: traccar_server ha_domain: traccar_server
ha_platforms: ha_platforms:
- binary_sensor
- device_tracker - device_tracker
- diagnostics - diagnostics
ha_integration_type: integration ha_integration_type: integration
@ -80,11 +81,50 @@ These device representations in Home Assistant will have [entities](#entities) a
The traccar server integration will create entities in with the following domains: The traccar server integration will create entities in with the following domains:
- [Binary Sensor](/integrations/binary_sensor)
- [Device Tracker](/integrations/device_tracker) - [Device Tracker](/integrations/device_tracker)
- [Sensor](/integrations/sensor) - [Sensor](/integrations/sensor)
For more details about each of these, see the sections below. For more details about each of these, see the sections below.
### Binary Sensor - Motion
The Traccar Server integration will create a [binary_sensor](/integrations/binary_sensor) entity for each device registered in Traccar Server to show the motion reported by the Traccar Server.
This entity is disabled by default.
{% configuration_basic %}
Name:
description: The name of the sensor will be set to what you have named it in Traccar Server, followed by the term "Motion". If your device is named "Millennium Falcon", this will be "Millennium Falcon Motion".
Entity ID:
description: This will be a slugified version of the name.
Unique ID:
description: This will be the unique ID of the device tracker in Traccar Server followed by `position_attributes_motion`.
State:
description: This will be `Moving` if the Traccar Server reports that the device is moving, if not this will be `Stopped`.
{% endconfiguration_basic %}
This entity does not have any attributes.
### Binary Sensor - Status
The Traccar Server integration will create a [binary_sensor](/integrations/binary_sensor) entity for each device registered in Traccar Server to show the status reported by the Traccar Server.
This entity is disabled by default.
{% configuration_basic %}
Name:
description: The name of the sensor will be set to what you have named it in Traccar Server followed by the term "Status". If your device is named "Millennium Falcon", this will be "Millennium Falcon Status".
Entity ID:
description: This will be a slugified version of the name.
Unique ID:
description: This will be the unique ID of the device tracker in Traccar Server followed by `device_status`.
State:
description: This will be `Online` if the Traccar Server reports that the device is online. This will be `Offline` if it reports it being offline, or `Unknown` if it is not sure.
{% endconfiguration_basic %}
This entity does not have any attributes.
### Device Tracker ### Device Tracker
The Traccar Server integration will create a [device tracker](/integrations/device_tracker) entity for each device registered in Traccar Server. The Traccar Server integration will create a [device tracker](/integrations/device_tracker) entity for each device registered in Traccar Server.
@ -107,10 +147,6 @@ In addition to the custom attributes you can define in the Traccar Server integr
{% configuration_basic %} {% configuration_basic %}
Category: Category:
description: The category of the device in Traccar if defined. description: The category of the device in Traccar if defined.
Motion:
description: If the device is moving or not.
Status:
description: The status of the device in Traccar.
Traccar ID: Traccar ID:
description: The ID of the device in Traccar. description: The ID of the device in Traccar.
Tracker: Tracker: