Rename RitAssist component to FleetGO (#9591)

* Rename RitAssist component to FleetGO

The company has been renamed from RitAssist to FleetGO, so this component needed to get renamed.

* Update source/_components/fleetgo.markdown

Co-Authored-By: Klaas Schoute <klaas_schoute@hotmail.com>

* ✏️ Removes obsolete front matter
This commit is contained in:
Wim Haanstra 2019-07-23 12:20:27 +02:00 committed by Franck Nijhof
parent 1226dc7fb5
commit 6fb20a1493
4 changed files with 85 additions and 84 deletions

View File

@ -0,0 +1,85 @@
---
title: "FleetGO"
description: "Instructions on how to use a FleetGO as a device tracker."
logo: fleetgo.png
ha_category:
- Car
ha_iot_class: Cloud Polling
ha_release: 0.76
redirect_from:
- /components/device_tracker.ritassist/
- /components/ritassist
---
The `fleetgo` device tracker platform allows you to integrate your vehicles equipped with [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.
## Setup
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: fleetgo
client_id: YOUR_CLIENT_ID
client_secret: YOUR_CLIENT_SECRET
username: YOUR_FLEETGO_USERNAME
password: YOUR_FLEETGO_PASSWORD
include:
- LICENSE_PLATE
```
{% configuration %}
client_id:
description: The client ID used to connect to the FleetGO API.
required: true
type: string
client_secret:
description: The client secret used to connect to the FleetGO API.
required: true
type: string
username:
description: Your FleetGO username.
required: true
type: string
password:
description: Your FleetGO 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: list
{% endconfiguration %}
See the [device tracker integration 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 |
| current_max_speed | The maximum speed on the road the device is currently on (if available) |
| current_address | Object with address information the device is currently on. This resolves to the closest address to the coordinates of the device. |
[1] Only available on certain cars and hardware revisions.

View File

@ -1,84 +0,0 @@
---
title: "RitAssist"
description: "Instructions on how to use a RitAssist as a device tracker."
logo: ritassist.png
ha_category:
- Car
ha_iot_class: Cloud Polling
ha_release: 0.76
redirect_from:
- /components/device_tracker.ritassist/
---
The `ritassist` device tracker 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.
## Setup
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: list
{% endconfiguration %}
See the [device tracker integration 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 |
| current_max_speed | The maximum speed on the road the device is currently on (if available) |
| current_address | Object with address information the device is currently on. This resolves to the closest address to the coordinates of the device. |
[1] Only available on certain cars and hardware revisions.

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.4 KiB