Home ▸ Integrations ▸

Traccar Server

Traccar uses GPS for tracking and has support for over 1500 different types of devices. You can use the Traccar Server integration to communicate with your own Traccar Server, which is also available as Home Assistant add-on.

Tip

Looking for documentation on how to setup the Traccar Client with webhooks in Home Assistant? See the Traccar Client integration documentation.

Configuration

To add the Traccar Server integration to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

Browse to your Home Assistant instance.
Go to Settings > Devices & Services.
In the bottom right corner, select the Add Integration button.
From the list, select Traccar Server.
Follow the instructions on screen to complete the setup.

Events

The Traccar Server integration options allow you to define a list of events you want to listen for. These events will be sent to Home Assistant as events.

All events will be prefixed with traccar_ followed by a snake_cased version of the event name. Examples:

The deviceMoving will be fired in Home Assistant as traccar_device_moving.
The geofenceExit will be fired in Home Assistant as traccar_geofence_exit.
The alarm will be fired in Home Assistant as traccar_alarm.

All events will also have the following data:

Device ID

(device_traccar_id) This will be the device ID that the event is related to.

Device name

(device_name) This will be the name of the device that the event is related to.

Type

(type) This will be the type of the event.

Server time

(serverTime) This will be the time the event was received by the Traccar Server.

Attributes

(attributes) This will be a dictionary of attributes related to the event.

Example

{
    "device_traccar_id": 24,
    "device_name": "My Device",
    "type": "alarm",
    "serverTime": "1970-01-01T00:00:00.000Z",
    "attributes": {
      "custom_attribute": "value"
    },
}

Devices

The Traccar Server integration will create devices for each device registered in the Traccar Server with at least one position update.

These device representations in Home Assistant will have entities associated with them, which you can use in automations, scripts, and display on your dashboard.

Entities

The traccar server integration will create entities in with the following domains:

For more details about each of these, see the sections below.

Binary Sensor - Motion

The Traccar Server integration will create a 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.

Name

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

This will be a slugified version of the name.

Unique ID

This will be the unique ID of the device tracker in Traccar Server followed by position_attributes_motion.

State

This will be Moving if the Traccar Server reports that the device is moving, if not this will be Stopped.

This entity does not have any attributes.

Binary Sensor - Status

The Traccar Server integration will create a 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.

Name

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

This will be a slugified version of the name.

Unique ID

This will be the unique ID of the device tracker in Traccar Server followed by device_status.

State

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.

This entity does not have any attributes.

Device Tracker

The Traccar Server integration will create a device tracker entity for each device registered in Traccar Server.

Name

The name of the device tracker will be set to what you have named it in Traccar Server.

Entity ID

This will be a slugified version of the name of the device tracker.

Unique ID

This will be the unique ID of the device tracker in Traccar Server.

State

As a device tracker, the state will be home or not_home.

Attributes

In addition to the custom attributes you can define in the Traccar Server integration options, the device tracker entity will have the following attributes:

Sensor - Address

The Traccar Server integration will create a sensor entity for each device registered in Traccar Server to show the address reported by the Traccar Server.

This entity is disabled by default.

Name

The name of the sensor will be set to what you have named it in Traccar Server followed by Address. If your device is named “Millennium Falcon”, this will be “Millennium Falcon Address”.

Entity ID

This will be a slugified version of the name.

Unique ID

This will be the unique ID of the device tracker in Traccar Server followed by position_address.

State

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

This entity does not have any attributes.

Sensor - Altitude

The Traccar Server integration will create a sensor entity for each device registered in Traccar Server to show the altitude reported by the Traccar Server.

This entity is disabled by default.

Name

The name of the sensor will be set to what you have named it in Traccar Server followed by Altitude. If your device is named “Millennium Falcon”, this will be “Millennium Falcon Altitude”.

Entity ID

This will be a slugified version of the name.

Unique ID

This will be the unique ID of the device tracker in Traccar Server followed by position_altitude.

State

This will be the altitude in meters. You can select a different unit in the entity options if you want.

This entity does not have any attributes.

Sensor - Battery

The Traccar Server integration will create a sensor entity for each device registered in Traccar Server to show the remaining battery percentage reported by the Traccar Server.

This entity is disabled by default.

Name

The name of the sensor will be set to what you have named it in Traccar Server followed by Battery. If your device is named “Millennium Falcon”, this will be “Millennium Falcon Battery”.

Entity ID

This will be a slugified version of the name.

Unique ID

This will be the unique ID of the device tracker in Traccar Server followed by position_attributes.batteryLevel.

State

This will be the battery percentage (level) as reported by the tracked device, if the device does not have a battery this will be unknown.

This entity does not have any attributes.

Sensor - Geofence

The Traccar Server integration will create a sensor entity for each device registered in Traccar Server to show the geofence reported by the Traccar Server.

This entity is disabled by default.

Name

The name of the sensor will be set to what you have named it in Traccar Server followed by Geofence. If your device is named “Millennium Falcon”, this will be “Millennium Falcon Geofence”.

Entity ID

This will be a slugified version of the name.

Unique ID

This will be the unique ID of the device tracker in Traccar Server followed by geofence_geofence.

State

This will be geofence that the device is in, if you have overlapping geofences it will show the first one as reported by the Traccar Server.

This entity does not have any attributes.

Sensor - Speed

The Traccar Server integration will create a sensor entity for each device registered in Traccar Server to show the speed reported by the Traccar Server.

This entity is disabled by default.

Name

The name of the sensor will be set to what you have named it in Traccar Server followed by Speed. If your device is named “Millennium Falcon”, this will be “Millennium Falcon Speed”.

Entity ID

This will be a slugified version of the name.

Unique ID

This will be the unique ID of the device tracker in Traccar Server followed by position_speed.

State

This will be the speed of the device in knots. You can select a different unit in the entity options if you want.

This entity does not have any attributes.

Examples

So you set up the integration and it pulled in all your devices. Now what? Below are some examples of what you can do with the data provided by Traccar Server integration.

Automations

In this section you will find some example automations that you can use to get started with the Traccar Server integration.

Do something when a device enters a geofence

The allows you to do something when the device “Millennium Falcon” enters the defined geofence.

Show me the YAML!

triggers:
  - trigger: state
    entity_id: sensor.millennium_falcon_geofence
    to: 'Tatooine'
actions:
  ...

Do something when a device are speeding

The allows you to do something when the device “Millennium Falcon” exceeds a defined speed.

Show me the YAML!

triggers:
  - trigger: numeric_state
    entity_id: sensor.millennium_falcon_speed
    above: 1337
actions:
  ...

If you want to include the speed in a notification, you can use the `` template.

Partial example:

triggers:
  ...
actions:
  - action: notify.notify
    data:
      message: "The current speed of the Millennium falcon is !"

Help us improve our documentation

Suggest an edit to this page, or provide/view feedback for this page.

Edit Provide feedback View pending feedback