Vehicles

This interface is included in the Vehicles module.

Description

Shared interface for fleet vehicle asset designs.

Properties

This interface has the following properties.

Property	Value
Name	Vehicles
Code	designInterfaces_vehicles
Type	Interface
Context	Module
AI agent enabled	true
Icon	icon-transport-truck
Colour	-
Title	{{attributes_vehiclesName}}
Subtitle	-

Implements

This interface implements the following interfaces.

Name	Code
Sensors	designInterfaces_sensors
Assets	designInterfaces_assets

Attributes

This interface has the following attributes. It may also inherit attributes from any of the interfaces it implements.

Name

The display name or fleet name for this vehicle.

Property	Value
Name	Name
Code	attributes_vehiclesName
Type	String
Required	true
Unique	false
Read-only	false
AI agent enabled	true

Description

A description of this vehicle asset.

Property	Value
Name	Description
Code	attributes_vehiclesDescription
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true

Make

The manufacturer of this vehicle (e.g., Ford, Volvo).

Property	Value
Name	Make
Code	attributes_vehiclesMake
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 100 }

Model

The model name or designation of this vehicle.

Property	Value
Name	Model
Code	attributes_vehiclesModel
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 100 }

Registration

The vehicle registration number (licence plate) for this vehicle.

Property	Value
Name	Registration
Code	attributes_vehiclesRegistration
Type	String
Required	true
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 16 }

Heading

The current direction or bearing of this vehicle.

Property	Value
Name	Heading
Code	attributes_vehiclesHeading
Type	Number
Required	true
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "decimalPlaces": 0, "min": 0, "max": 360, "defaultValue": 0 }

Odometer

The current odometer reading for this vehicle.

Property	Value
Name	Odometer
Code	attributes_vehiclesOdometer
Type	Number
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "min": 0, "decimalPlaces": 1 }

Snail Trail

The historical GPS tracking trail for this vehicle.

Property	Value
Name	Snail Trail
Code	attributes_vehiclesSnailTrail
Type	GeoJson
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "allows": [ "LineString" ] }

Type

Reference to the vehicle type classification.

Property	Value
Name	Type
Code	attributes_vehiclesType
Type	Link
Required	true
Unique	false
Read-only	false
AI agent enabled	true
Links to	Vehicle Types
Options	{ "code": "designs_vehicleTypes", "graph": "Lookup", "max": 1, "defaultValue": [ "5e96f57044b3d11ef81ee8c9" ] }

Standard paths

This interface doesn't have any standard paths of its own. However, it may inherit standard paths from any of the interfaces it implements.

Permissions

This interface defines the following permissions.

User group	Allowed
Sensor Viewers	Read
Sensor Managers	Read, Create, Edit, Delete

Default attribute permissions

This interface applies the following default permissions to all attributes for the following user groups.

Allowed	User group	Code
ReadOnly	Sensor Viewers	userGroups_sensorViewers
ReadWrite	Sensor Managers	userGroups_sensorManagers