mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-09 10:26:52 +00:00
Add RitAssist support page (#5549)
* RitAssist documentation added Added RitAssist device tracker documentation. * Add RitAssist logo image * ✏️ Minor tweaks * ⬆️ Upped ha_release to 0.73 * Added FleetGO.com and attribute descriptions * ⬆️ ha_release to 0.74 * Add ha_iot_class and update version
This commit is contained in:
parent
506db85af7
commit
453e9809d2
82
source/_components/device_tracker.ritassist.markdown
Normal file
82
source/_components/device_tracker.ritassist.markdown
Normal file
@ -0,0 +1,82 @@
|
||||
---
|
||||
layout: page
|
||||
title: "RitAssist"
|
||||
description: "Instructions on how to use a RitAssist as a device tracker."
|
||||
date: 2018-06-15 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: ritassist.png
|
||||
ha_category: Presence Detection
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_release: 0.76
|
||||
---
|
||||
|
||||
This platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map.
|
||||
|
||||
## API key
|
||||
To use this component, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key).
|
||||
|
||||
## Configuration
|
||||
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
device_tracker:
|
||||
- platform: ritassist
|
||||
client_id: YOUR_CLIENT_ID
|
||||
client_secret: YOUR_CLIENT_SECRET
|
||||
username: YOUR_RITASSIST_USERNAME
|
||||
password: YOUR_RITASSIST_PASSWORD
|
||||
include:
|
||||
- LICENSE_PLATE
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
client_id:
|
||||
description: The client ID used to connect to the RitAssist API.
|
||||
required: true
|
||||
type: string
|
||||
client_secret:
|
||||
description: The client secret used to connect to the RitAssist API.
|
||||
required: true
|
||||
type: string
|
||||
username:
|
||||
description: Your RitAssist username.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: Your RitAssist password.
|
||||
required: true
|
||||
type: string
|
||||
include:
|
||||
description: A list of license plates to include, if this is not specified, all vehicles will be added.
|
||||
required: false
|
||||
type: strings
|
||||
{% endconfiguration %}
|
||||
|
||||
See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked.
|
||||
|
||||
## Available Attributes
|
||||
|
||||
| Attribute | Description |
|
||||
|---|---|
|
||||
| latitude | The latitude of your vehicle |
|
||||
| longitude | The longitude of your vehicle |
|
||||
| altitude | Altitude of your vehicle |
|
||||
| id | Identifier used to identify your vehicle |
|
||||
| make | The make of the vehicle |
|
||||
| model | Model of your vehicle |
|
||||
| license_plate | License plate number |
|
||||
| active | If the engine is currently active or not |
|
||||
| odo | The odometer in kilometers |
|
||||
| speed | The current speed of your vehicle, in KM/h |
|
||||
| last_seen | The date and time when your vehicle last communicated with the API |
|
||||
| fuel_level | Fuel level of the vehicle [1] |
|
||||
| malfunction_light | Are any malfunction lights burning [1] |
|
||||
| coolant_temperature | Temperature of the coolant [1] |
|
||||
| power_voltage | Power voltage measured by the hardware [1] |
|
||||
| distance_from_home | How far is your vehicle located from your Home Assistant Home location |
|
||||
|
||||
[1] Only available on certain cars and hardware revisions.
|
BIN
source/images/supported_brands/ritassist.png
Normal file
BIN
source/images/supported_brands/ritassist.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 31 KiB |
Loading…
x
Reference in New Issue
Block a user