hassio-addons/addon-traccar
1
0
Fork 0
mirror of https://github.com/hassio-addons/addon-traccar.git synced 2025-05-03 18:41:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

📚 Updates README to match recent changes

Browse source
This commit is contained in:
Franck Nijhof 2018-11-27 22:59:53 +01:00
parent 5493b719ca
commit 73e681f56f
No known key found for this signature in database
GPG key ID: D62583BA8AB11CA3
3 changed files with 65 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -18,9 +18,22 @@
Modern GPS Tracking Platform.
![Traccar in the Home Assistant Frontend](images/screenshot.png)
## About
Lorem ipsum.
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.
## Installation
@ -56,7 +69,7 @@ Example add-on configuration:
```json
{
"log_level": "info",
"port": 8082,
"port": 8072,
"ssl": true,
"certfile": "fullchain.pem",
"keyfile": "privkey.pem"
@ -105,6 +118,41 @@ The private key file to use for SSL.
**Note**: _The file MUST be stored in `/ssl/`, which is the default for Hass.io_
## Integrating into Home Assistant
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.
```yaml
device_tracker:
- platform: traccar
host: a0d7b954-traccar
port: 8072
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
Restart Home Assistant.
## Embedding into Home Assistant
It is possible to embed Traccar directly into Home Assistant, allowing you to
access your Traccar instance through the Home Assistant frontend.
Home Assistant provides the `panel_iframe` component, for these purposes.
Example configuration:
```yaml
panel_iframe:
traccar:
title: Traccar
icon: mdi:car-connected
url: https://addres.to.your.hass.io:8072
```
## Changelog & Releases
This repository keeps a change log using [GitHub's releases][releases]

BIN
images/screenshot.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 342 KiB

16
traccar/.README.j2
View file

@ -10,9 +10,22 @@
Modern GPS Tracking Platform.
![Traccar in the Home Assistant Frontend][screenshot]
## About
Lorem ipsum.
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.
[Click here for the full documentation][docs]
@ -68,3 +81,4 @@ If you are more interested in stable releases of our add-ons:
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
[release-shield]: https://img.shields.io/badge/version-{{ version }}-blue.svg
[release]: {{ repo }}/tree/{{ version }}
[screenshot]: https://github.com/hassio-addons/addon-traccar/raw/master/images/screenshot.png