# Vehicles

## Action buttons

the action buttons are in the upper right corner

### Refresh button

Refreshes the list of of vehicles

### Add vehicle button

Opens the dialog to add a new vehicle. See [below](#vehicle) for an explanation of the different properties.

See [below](#add-new-vehicle-to-the-carsharing-app) for a step by step explanation on how to a new vehicle.

{% hint style="info" %}
If you are adding a vehicle where the owner of the vehicle is an end-user and the owner should be able to manage the vehicle in the portal app, immediately skip to [Add vehicle to a community group](#add-vehicle-to-a-community-group)
{% endhint %}

### Switch between list view and map view button

The *list view* displays a list of all vehicles with their main information, while the *map view* show all vehicles (as an icon) with their live location on a map. 

## Vehicle

A physical vehicle is uniquely defined by license plate. For vehicles without a license plate, like a bike, the name is used. 

### Vehicle properties

| Property      | Explanation                                                                                                                                                                        | shown in the app                                 |
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| Name          | name for this vehicle                                                                                                                                                              | yes, name is used to create default group access |
| Model         | brand and model of this vehicle                                                                                                                                                    | [see below](#vehicle-model)                      |
| Hardware type | type of hardware installed in the vehicle.                                                                                                                                         | no                                               |
| Hardware ID   | <ul><li>Cloudboxx: QNR number</li><li>Teltonika: device ID (<strong>not</strong> the EMEI number)</li><li>iLOCKIT: ISHAREIT-XXXXX number</li><li>offline: not applicable</li></ul> | no                                               |
| Groups        | Fleet group this vehicle should be added to                                                                                                                                        | no                                               |
| Place         | Name of the home location this vehicle will be stationed                                                                                                                           | yes                                              |

### Vehicle model

A vehicle model is a specific type of vehicle. For example a Renault Zoe Z.E.50 with CSS charger.

You can add a new vehicle model when adding a new vehicle or when updating an existing one.

| Property        | Explanation                              | shown in the app?                                             |
| --------------- | ---------------------------------------- | ------------------------------------------------------------- |
| Name            | name of the vehicle model                | yes, but only if there is no description                      |
| Category        | type of vehicle                          | determines app icon                                           |
| Range           | range with full battery                  | yes, used to calculate displayed range                        |
| Number of seats | amount of people that fit in the vehicle | yes                                                           |
| Description     | extra info about the vehicle model       | yes                                                           |
| Picture         | generic picture of the vehicle model     | yes, shown when the vehicle is selected on the map in the app |

{% hint style="info" %}
If the model of a recently added vehicle is an MG4 of an other model where the ignition of the vehicle does not turn off, please let support know.&#x20;
{% endhint %}

### Settings

<table><thead><tr><th width="255">Setting</th><th>Explanation</th></tr></thead><tbody><tr><td>Hardware type</td><td>type of hardware installed in the vehicle</td></tr><tr><td>Hardware ID</td><td>unique identifier of the hardware installed in the vehicle</td></tr><tr><td>Auto lock</td><td>this vehicle will be automatically locked if all conditions for auto locking apply. See documentation about <a href="../reservering-and-using-vehicles/automatic-locking-of-vehicles">auto lock</a>. </td></tr><tr><td>Check for key fob</td><td>If set to true reservations cannot be ended by the user if the key fob is not in place. A key fob should be installed in the vehicle.</td></tr><tr><td>Check for rfid tag</td><td>If set to true reservations cannot be ended by the user if the rfid tag is not in place. An rfid tag reader should be installed in the vehicle</td></tr><tr><td>Position quality</td><td>read more about this <a href="../reservering-and-using-vehicles/parking-underground">here</a>.</td></tr></tbody></table>

### App notifications

For more details about app notifications see the specific documentation page about [app notifications](https://handbook.themobilityfactory.coop/tmf-platform-documentation/notifying-users/notify-of-changes-to-vehicle-home-location).

## Group access

The group access describes how the vehicle is shown in the app and which groups have acces to it. If you are familiar with the old control center, what used to be called *car configs* in the old one is now part of group access.

To make the vehicle available to a another fleet group you should add a new group access using the button.

| Property             | Explanation                                                                                              | shown in the app?                                                           |
| -------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| default app listing  | only one group access can be default. The default group access is shown on the list item of the vehicle. | no                                                                          |
| published            | a group access could be (temporarily) hidden from the app.                                               | if it is published, the vehicle is visible on the app. Otherwise it is not. |
| reservations allowed | disabling this means that the vehicle can only be reserved and used on the fly.                          | if disabled, only the "use now" button is visible.                          |
| fleet group          | the fleet group for this new group access                                                                | no                                                                          |
| price model          | defines how the costs of reserving and using this vehicle                                                | no                                                                          |
| name                 | how the vehicle should be named in the app                                                               | yes                                                                         |
| vehicle info         | description for this vehicle.                                                                            | yes, when the user has an active or pending reservation                     |
| picture              | picture of this specific vehicle                                                                         | yes, when the user has an active or pending reservation                     |

## Home location

Defines the home location of the vehicle. The home location of a vehicle is where users pick-up the vehicle and drop-off the vehicle.  A vehicle can only have 1 home location.

If you want a new home location for this vehicle, you should first create it. More information [here](https://handbook.themobilityfactory.coop/tmf-platform-documentation/control-center/home-locations).&#x20;

## Future reservations

The calendar of this vehicle.

## Add new vehicle to the carsharing app

{% hint style="info" %}
Vehicles shared through a community group will appear automatically in the carsharing app. See below in [#add-vehicle-to-a-community-group](#add-vehicle-to-a-community-group "mention")
{% endhint %}

1. Make sure the hardware is installed in the vehicle according to the specific hardware installation instructions (if applicable)
2. Go to Vehicles in the Control Center
3. Click the [#add-vehicle](#add-vehicle "mention")action button
4. Fill in the necessary properties. For an explanation of every property see [#vehicle-properties](#vehicle-properties "mention")
5. Click *Save*. A new vehicle is now created.&#x20;
6. Verify the vehicle has a home location in the Home Locations tab
7. Verify the vehicle has a price model in the Price model tab. Modify if necessary The system assigns the default price model if there is a default price model configured.&#x20;

## Add vehicle to a community group.

### Add existing vehicle

* Go to the community group in the control center
* Choose "add vehicle" from the right top corner of the dialog
* Select the existing vehicle from the drop-down or search if the list is too long

### Add new vehicle

* Go to the community group in the control center
* Choose "add vehicle"
* Choose the plus button next to the input field for vehicle
* Enter the details of the vehicle

The physical vehicle will now be added and will appear in the vehicles menu. At the same time, the vehicle is linked to the community group and a group access is created, making the vehicle visible in the carsharing app to members of that community group.&#x20;