Modern GPS Tracking Platform.
Traccar is modern GPS Tracking Platform, which is now available as an Hass.io add-on and allows you to run your GPS Tracking software without any cloud.
Traccar supports more protocols and device models than any other GPS tracking system on the market, straight from your Hass.io instance. You can select GPS trackers from a variety of vendors from low-cost Chinese models to high-end quality brands.
Traccar also has native mobile apps available for Android and iOS platforms
so that you can track those as well. AND! With the Home Assistant traccar
component (introduced in 0.83) the data in Traccar will be sent back into
your Home Assistant instance as well.
The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.
- Add our Hass.io add-ons repository to your Hass.io instance.
- Install the "Traccar" add-on.
- Start the "Traccar" add-on
- Check the logs of the "Traccar" add-on to see if everything went well.
- Click the "OPEN WEB UI" button and log in using
admin
/admin
. - Be sure to change the username and password!
- After testing, please consider using MariaDB, since it makes the add-on far more stable. Please, consult the add-on manual on how to configure this.
NOTE: Do not add this repository to Hass.io, please use:
https://github.com/hassio-addons/repository
.
Note: Remember to restart the add-on when the configuration is changed.
Example add-on configuration:
{
"log_level": "info",
"port": 8072,
"ssl": true,
"certfile": "fullchain.pem",
"keyfile": "privkey.pem"
}
Note: This is just an example, don't copy and past it! Create your own!
The log_level
option controls the level of log output by the addon and can
be changed to be more or less verbose, which might be useful when you are
dealing with an unknown issue. Possible values are:
trace
: Show every detail, like all called internal functions.debug
: Shows detailed debug information.info
: Normal (usually) interesting events.warning
: Exceptional occurrences that are not errors.error
: Runtime errors that do not require immediate action.fatal
: Something went terribly wrong. Add-on becomes unusable.
Please note that each level automatically includes log messages from a
more severe level, e.g., debug
also shows info
messages. By default,
the log_level
is set to info
, which is the recommended setting unless
you are troubleshooting.
The port
setting allows you to change the port the web interface
Traccar is running on.
Enables/Disables SSL (HTTPS) on the web interface.
Set it true
to enable it, false
otherwise.
The certificate file to use for SSL.
Note: The file MUST be stored in /ssl/
, which is the default for Hass.io
The private key file to use for SSL.
Note: The file MUST be stored in /ssl/
, which is the default for Hass.io
By default, Traccar uses a database that is called H2. It is sweet, since it works out of the box. However, it is not considered stable for production use, so only use it for evaluation and testing purposes.
It is highly recommended to use a MySQL database with this add-on. For example you could install the MariaDB add-on that is in the add-on store.
Add the following configuration to your traccar.xml
that is stored in your
Home Assistant configuration directory (/config/traccar.xml
):
<entry key='database.driver'>com.mysql.jdbc.Driver</entry>
<entry key='database.url'>jdbc:mysql://core-mariadb:3306/traccar?serverTimezone=UTC&useSSL=false&allowMultiQueries=true&autoReconnect=true&useUnicode=yes&characterEncoding=UTF-8&sessionVariables=sql_mode=''</entry>
<entry key='database.user'>USERNAME</entry>
<entry key='database.password'>PASSWORD</entry>
The above template is already in the config file on newer installations and can be simply commented out to be activated.
Don't forget to add the database traccar
to the MariaDB add-on configuration
and add the username (with its password) to have access to that database as
well.
Don't forget to restart the add-on after making changes.
The traccar
component of Home Assistant makes it possible to transfer all
assets tracked by Traccar to appear in Home Assistant as a tracked device.
Add the following snippet to your Home Assistant configuration.yaml
file.
device_tracker:
- platform: traccar
host: a0d7b954-traccar
port: 8072
username: YOUR_USERNAME
password: YOUR_PASSWORD
Restart Home Assistant.
This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.
Releases are based on Semantic Versioning, and use the format
of MAJOR.MINOR.PATCH
. In a nutshell, the version will be incremented
based on the following:
MAJOR
: Incompatible or major changes.MINOR
: Backwards-compatible new features and enhancements.PATCH
: Backwards-compatible bugfixes and package updates.
Got questions?
You have several options to get them answered:
- The Community Hass.io Add-ons Discord chat server for add-on support and feature requests.
- The Home Assistant Discord chat server for general Home Assistant discussions and questions.
- The Home Assistant Community Forum.
- Join the Reddit subreddit in /r/homeassistant
You could also open an issue here GitHub.
This is an active open-source project. We are always open to people who want to use the code or contribute to it.
We have set up a separate document containing our contribution guidelines.
Thank you for being involved! 😍
The original setup of this repository is by Franck Nijhof.
For a full list of all authors and contributors, check the contributor's page.
Want some more functionality to your Hass.io Home Assistant instance?
We have created multiple add-ons for Hass.io. For a full list, check out our GitHub Repository.
MIT License
Copyright (c) 2018-2019 Franck Nijhof
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.