github/psa_car_controller
1
0
Fork 0
mirror of https://github.com/flobz/psa_car_controller.git synced 2026-08-26 10:17:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

add api doc

Browse Source
This commit is contained in:
Florian Bezannier
2020-11-15 12:20:10 +01:00
parent 9966eb0a49
commit 8c39143c60
132 changed files with 4057 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Adas.md
+23
View File
@@ -0,0 +1,23 @@
# Adas
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**abs** | **bool** | Anti-lock braking system | [optional]
**accr** | **str** | Adaptive Cruise Control Regulation | [optional]
**aebs** | **str** | Advanced Emergency Braking System | [optional]
**afil** | **str** | Lane Departure Warning System | [optional]
**artiv** | **str** | Respect of inter vehicle time assist (ARTIV) | [optional] [default to 'unavailable']
**bsm** | **str** | Blink SpotMonitoring | [optional]
**esp** | **bool** | Electronic Stability Programme | [optional]
**fse** | **bool** | Electric brake service | [optional]
**lrka** | **str** | Lane Keeping Assist left | [optional]
**lvv** | **bool** | | [optional]
**park_assist** | [**AdasParkAssist**](AdasParkAssist.md) | | [optional]
**rlka** | **str** | Lane Keeping Assist right | [optional]
**rvv** | **str** | | [optional]
**sli** | **int** | Speed Limit Information | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/AdasParkAssist.md
+11
View File
@@ -0,0 +1,11 @@
# AdasParkAssist
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**front** | **list[str]** | | [optional]
**rear** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Alert.md
+18
View File
@@ -0,0 +1,18 @@
# Alert
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **datetime** | Date when the resource has been created. | [optional]
**links** | [**AlertLinks**](AlertLinks.md) | | [optional]
**active** | **bool** | | [optional]
**end_at** | **datetime** | | [optional]
**end_position** | [**AlertEndPosition**](AlertEndPosition.md) | | [optional]
**id** | **str** | | [optional]
**start_position** | [**AlertEndPosition**](AlertEndPosition.md) | | [optional]
**started_at** | **datetime** | Date | [optional]
**type** | [**AlertMsgEnum**](AlertMsgEnum.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/AlertEndPosition.md
+9
View File
@@ -0,0 +1,9 @@
# AlertEndPosition
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/AlertLinks.md
+13
View File
@@ -0,0 +1,13 @@
# AlertLinks
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**position** | [**Link**](Link.md) | | [optional]
**_self** | [**Link**](Link.md) | | [optional]
**trip** | [**Link**](Link.md) | | [optional]
**vehicle** | [**Link**](Link.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/AlertMsgEnum.md
+9
View File
@@ -0,0 +1,9 @@
# AlertMsgEnum
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Alerts.md
+10
View File
@@ -0,0 +1,10 @@
# Alerts
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**embedded** | [**AlertsEmbedded**](AlertsEmbedded.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/AlertsEmbedded.md
+10
View File
@@ -0,0 +1,10 @@
# AlertsEmbedded
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**alerts** | [**list[Alert]**](Alert.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Battery.md
+11
View File
@@ -0,0 +1,11 @@
# Battery
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**current** | **float** | | [optional]
**voltage** | **float** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/BoundedProgram.md
+10
View File
@@ -0,0 +1,10 @@
# BoundedProgram
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**duration** | **str** | Duration of the monitor action expressed using [ISO-8601 Duration spec](https://en.wikipedia.org/wiki/ISO_8601#Durations) |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/ChargingStatusEnum.md
+9
View File
@@ -0,0 +1,9 @@
# ChargingStatusEnum
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/CircleZone.md
+11
View File
@@ -0,0 +1,11 @@
# CircleZone
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**coordinates** | [**CircleZoneCoordinates**](CircleZoneCoordinates.md) | | [optional]
**type** | **str** | | [optional] [default to 'extCircle']
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/CircleZoneCoordinates.md
+11
View File
@@ -0,0 +1,11 @@
# CircleZoneCoordinates
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**center** | [**Point**](Point.md) | |
**radius** | **float** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/CollectionResult.md
+14
View File
@@ -0,0 +1,14 @@
# CollectionResult
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**embedded** | **object** | |
**links** | [**TabLinks**](TabLinks.md) | | [optional]
**current_page** | **int** | |
**total** | **int** | |
**total_page** | **int** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Collision.md
+19
View File
@@ -0,0 +1,19 @@
# Collision
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **datetime** | | [optional]
**embedded** | **object** | | [optional]
**front** | [**CollisionObjFront**](CollisionObjFront.md) | | [optional]
**id** | **str** | | [optional]
**lateral** | [**CollisionObjFront**](CollisionObjFront.md) | | [optional]
**pedestrian** | **bool** | | [optional]
**rear** | [**CollisionObjFront**](CollisionObjFront.md) | | [optional]
**roll_over** | **bool** | | [optional]
**updated_at** | **datetime** | | [optional]
**links** | [**CollisionLinks**](CollisionLinks.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/CollisionLinks.md
+12
View File
@@ -0,0 +1,12 @@
# CollisionLinks
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_self** | [**Link**](Link.md) | | [optional]
**trip** | [**Link**](Link.md) | | [optional]
**vehicle** | [**Link**](Link.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/CollisionObj.md
+17
View File
@@ -0,0 +1,17 @@
# CollisionObj
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**embedded** | **object** | | [optional]
**front** | [**CollisionObjFront**](CollisionObjFront.md) | | [optional]
**id** | **str** | | [optional]
**lateral** | [**CollisionObjFront**](CollisionObjFront.md) | | [optional]
**pedestrian** | **bool** | | [optional]
**rear** | [**CollisionObjFront**](CollisionObjFront.md) | | [optional]
**roll_over** | **bool** | | [optional]
**updated_at** | **datetime** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/CollisionObjFront.md
+10
View File
@@ -0,0 +1,10 @@
# CollisionObjFront
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**level** | **str** | | [optional] [default to 'none']
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Collisions.md
+10
View File
@@ -0,0 +1,10 @@
# Collisions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**embedded** | [**CollisionsEmbedded**](CollisionsEmbedded.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/CollisionsEmbedded.md
+10
View File
@@ -0,0 +1,10 @@
# CollisionsEmbedded
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**collisions** | [**list[Collision]**](Collision.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/CreatedAtField.md
+10
View File
@@ -0,0 +1,10 @@
# CreatedAtField
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **datetime** | Date when the resource has been created. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/DataMonitorTrigger.md
+12
View File
@@ -0,0 +1,12 @@
# DataMonitorTrigger
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | **str** | the left operand of the trigger function. | [optional]
**op** | **str** | the operator of the trigger function. | [optional]
**value** | **object** | the right operand of the trigger function. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/DataTrigger.md
+12
View File
@@ -0,0 +1,12 @@
# DataTrigger
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | **str** | The left operand of the trigger function. The following Table details for each operand data its type, the supported operator and the possibly retruned value: |**Data**|**Type**|**Op**|**Value**| |---|---| ---:| ---:| | Vehicle.alert | List of value | OnChange (at least one)/IncludedIn/EqualTo | Value (ObjetAlert) | | Vehicle.odometer | Integer | equalTo/greaterThan/lowerThan/ | Value | | vehicle.engines.running (boolean) | Boolean | OnChange/equalTo | Value (true/false) | | vehicle.engines.thermic.oil.temp | Integer | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.energy.electric.level | Number | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.energy.electric.autonomy | Number | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.energy.fuel.level | Number | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.energy.fuel.autonomy | Number | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.autonomy (global) | Number | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.energy.charging.status | Enum(ChargingStatusEnum) | OnChange/equalTo | Value | | vehicle.energy.charging.plugged | Boolean | OnChange/equalTo | Value | | vehicle.doorsState.lockedState | N/A | OnChange | Value | | vehicle.doorsState.opening | N/A | OnChange | Value | | vehicle.kinetic.moving| Boolean | OnChange/equalTo | Value (true/false) | | vehicle.kinetic.speed | Number | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.trip| Literal | OnChange| Value(IDTRIP) | | vehicle.maintenance.daysBeforeMaintenance, | Number | OnChange/equalTo/ greaterThan/ lowerThan/ | Value | | vehicle.maintenance.mileageBeforeMaintenance| Number | OnChange/equalTo/ greaterThan/ lowerThan/ | Value | | vehicle.safety.beltWarning | Enum(beltWarning) | OnChange/equalTo | Value | | environment.air.temp | Number | equalTo/greaterThan/lowerThan/ | Value | | privacy.state | Enum(Privacy) | equalTo / OnChange/IncludedIN | Value | |
**op** | **str** | The operator of the trigger function. |
**value** | **list[str]** | The right operand of the trigger function. It can be a uniq ```value``` or a list of value ```values```. The choice of one or the other depends on ```OP``` which in the case of ```includedIn``` must be a list. * _Disclaimer_: If the op field is not set to ```includeIn``` then only the first item will be used. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/DefaultAlertPush.md
+11
View File
@@ -0,0 +1,11 @@
# DefaultAlertPush
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**list[DefaultAlertPushAttributes]**](DefaultAlertPushAttributes.md) | | [optional]
**name** | **str** | push event name |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/DefaultAlertPushAttributes.md
+11
View File
@@ -0,0 +1,11 @@
# DefaultAlertPushAttributes
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **str** | |
**value** | **str** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/DoorsState.md
+12
View File
@@ -0,0 +1,12 @@
# DoorsState
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**locked_state** | **list[str]** | | [optional]
**opening** | [**list[DoorsStateOpening]**](DoorsStateOpening.md) | | [optional]
**updated_at** | **datetime** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/DoorsStateOpening.md
+11
View File
@@ -0,0 +1,11 @@
# DoorsStateOpening
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identifier** | **str** | | [optional]
**state** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/ECoaching.md
+12
View File
@@ -0,0 +1,12 @@
# ECoaching
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**embedded** | **object** | | [optional]
**links** | [**ECoachingLinks**](ECoachingLinks.md) | | [optional]
**scores** | [**list[ECoachingScores]**](ECoachingScores.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/ECoachingLinks.md
+12
View File
@@ -0,0 +1,12 @@
# ECoachingLinks
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_self** | [**Link**](Link.md) | | [optional]
**trip** | [**Link**](Link.md) | | [optional]
**vehicle** | [**Link**](Link.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/ECoachingScores.md
+11
View File
@@ -0,0 +1,11 @@
# ECoachingScores
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**category** | **str** | category of the score. Global, ACCELERATION, BREAKING, A/C system, Runing cold engine, Direct Shift Gear, Speed, STT system, ZEV (Zero emission vehicle). | [optional]
**score** | **float** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Energy.md
+9
View File
@@ -0,0 +1,9 @@
# Energy
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Engine.md
+12
View File
@@ -0,0 +1,12 @@
# Engine
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**oil** | [**EngineOil**](EngineOil.md) | | [optional]
**speed** | **float** | | [optional]
**type** | **str** | | [optional] [default to 'Thermic']
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/EngineOil.md
+10
View File
@@ -0,0 +1,10 @@
# EngineOil
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**temp** | **float** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Environment.md
+12
View File
@@ -0,0 +1,12 @@
# Environment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **datetime** | Date when the resource has been created. | [optional]
**air** | [**EngineOil**](EngineOil.md) | | [optional]
**luminosity** | [**EnvironmentLuminosity**](EnvironmentLuminosity.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/EnvironmentLuminosity.md
+10
View File
@@ -0,0 +1,10 @@
# EnvironmentLuminosity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**day** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Event.md
+15
View File
@@ -0,0 +1,15 @@
# Event
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **datetime** | Date when the resource has been created. | [optional]
**embedded** | **object** | | [optional]
**links** | [**EventLinks**](EventLinks.md) | |
**event_id** | **str** | | [optional]
**id** | **str** | | [optional]
**type** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/EventLinks.md
+10
View File
@@ -0,0 +1,10 @@
# EventLinks
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_self** | [**Link**](Link.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Extension.md
+11
View File
@@ -0,0 +1,11 @@
# Extension
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**kinetic** | [**Kinetic**](Kinetic.md) | | [optional]
**odemeter** | [**VehicleOdometer**](VehicleOdometer.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/ExtensionType.md
+9
View File
@@ -0,0 +1,9 @@
# ExtensionType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Geometry.md
+11
View File
@@ -0,0 +1,11 @@
# Geometry
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**coordinates** | **object** | Geometry coordinates |
**type** | **str** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Ignition.md
+10
View File
@@ -0,0 +1,10 @@
# Ignition
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/IndexRange.md
+9
View File
@@ -0,0 +1,9 @@
# IndexRange
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Kinetic.md
+13
View File
@@ -0,0 +1,13 @@
# Kinetic
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**acceleration** | **float** | | [optional]
**moving** | **bool** | | [optional]
**pace** | **float** | | [optional]
**speed** | **float** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Lighting.md
+11
View File
@@ -0,0 +1,11 @@
# Lighting
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**light** | **list[str]** | | [optional]
**turn** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Link.md
+17
View File
@@ -0,0 +1,17 @@
# Link
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deprecation** | [**AlertEndPosition**](AlertEndPosition.md) | | [optional]
**href** | [**Url**](Url.md) | |
**hreflang** | **str** | Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. | [optional]
**name** | **str** | | [optional]
**profile** | **str** | Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). | [optional]
**templated** | **bool** | SHOULD be true when the Link Object's \"href\" property is a URI Template | [optional]
**title** | **str** | Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). | [optional]
**type** | **str** | a hint to indicate the media type expected when dereferencing the target resource. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Maintenance.md
+10
View File
@@ -0,0 +1,10 @@
# Maintenance
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**MaintenanceLinks**](MaintenanceLinks.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MaintenanceLinks.md
+12
View File
@@ -0,0 +1,12 @@
# MaintenanceLinks
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**alerts** | [**Link**](Link.md) | | [optional]
**_self** | [**Link**](Link.md) | | [optional]
**vehicle** | [**Link**](Link.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MaintenanceObj.md
+12
View File
@@ -0,0 +1,12 @@
# MaintenanceObj
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **datetime** | Date when the resource has been created. | [optional]
**days_before_maintenace** | **int** | | [optional]
**mileage_before_maintenance** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Monitor.md
+13
View File
@@ -0,0 +1,13 @@
# Monitor
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**MonitorLinks**](MonitorLinks.md) | | [optional]
**mid** | [**MonitorId**](MonitorId.md) | |
**monitor** | [**MonitorParameter**](MonitorParameter.md) | |
**status** | [**MonitorStatus**](MonitorStatus.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorId.md
+9
View File
@@ -0,0 +1,9 @@
# MonitorId
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorLinks.md
+11
View File
@@ -0,0 +1,11 @@
# MonitorLinks
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**fleet** | [**Link**](Link.md) | | [optional]
**_self** | [**Link**](Link.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorParameter.md
+14
View File
@@ -0,0 +1,14 @@
# MonitorParameter
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**extended_event_param** | **list[object]** | Allow to set extra vehicle data (defined in data model) to add to the monitor event when publishing. The possible values are |value|description|Related model | |----------|:-------------|------:| |vehicle.doorsState|Latest know door state (timestamped)|DoorState| |vehicle.status|Latest know vehicle status (timestamped)|Status| |vehicle.maintenance|Latest know maintenance(timestamped)|Maintenance| |vehicle.position|Last vehicle position (timestamped)|Position| |vehicle.telemetry${.TelemetryEnum}|Latest known telemetry (timestamped). |Telemetry |vehicle.alerts|List of active alerts|Alert| * For telemetry extension: * The suffix ```${.TelemetryEnum}``` can be selected to refine with telemetry type (from the TelemetryEnum list). This value (with suffix) can be selected **_several times_** to included suitable telemetry messages with the extention. * Using ```vehicle.telemetry``` without suffix means to include all available telemetries. | [optional]
**label** | **str** | Monitor lablel (usually its name). |
**locale** | **str** | Locale is used for rendering text according to language and country for. It should match the REGEX ```\\w(-\\w)?```. For more details about possible standard values, please refer to [locals list](https://en.wikipedia.org/wiki/Language_localisation). | [optional]
**subscribe_param** | [**MonitorSubscribe**](MonitorSubscribe.md) | |
**trigger_param** | [**MonitorParameterTriggerParam**](MonitorParameterTriggerParam.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorParameterTriggerParam.md
+13
View File
@@ -0,0 +1,13 @@
# MonitorParameterTriggerParam
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bool_exp** | **str** | A boolean expression that allow defining a logical relationship between triggers. Used Operands with this expression should only be the names of the defined triggers. Grammar: ``` exp ::= exp '&' exp | exp '|' exp | (exp) | !exp ``` * **example**: having two-zone trigger (two towns) named z1 an z2, one time-trigger (8h00 to 20h00) named t1 and finally three data triggerd named as follow: f(fuel), a(autonomy) , o(odometer). we can have a boolean expression such as: : ``` ((z1 & t1) | (z2 & !t1) | (f & z1) | (a & (z1|t)) | (o & (z1 | z2))) ``` |
**data_triggers** | [**list[DataTrigger]**](DataTrigger.md) | Compound data triggers (will be evaluated with an AND relationship) *Note*: ```dataTriggers``` is depricated according the new monitor spec. Please use the new data schema. | [optional]
**time_zone_triggers** | [**TimeZoneTrigger**](TimeZoneTrigger.md) | | [optional]
**triggers** | [**list[MonitorTrigger]**](MonitorTrigger.md) | Compound monitor triggers (will be evaluated using boolean expresion :```boo.exp```) |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorRef.md
+11
View File
@@ -0,0 +1,11 @@
# MonitorRef
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**MonitorRefLinks**](MonitorRefLinks.md) | | [optional]
**monitor_id** | [**MonitorId**](MonitorId.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorRefLinks.md
+12
View File
@@ -0,0 +1,12 @@
# MonitorRefLinks
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**delete** | [**Link**](Link.md) | | [optional]
**monitor** | [**Link**](Link.md) | | [optional]
**vehicle** | [**Link**](Link.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorStatus.md
+9
View File
@@ -0,0 +1,9 @@
# MonitorStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorStatusSetter.md
+10
View File
@@ -0,0 +1,10 @@
# MonitorStatusSetter
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorSubscribe.md
+13
View File
@@ -0,0 +1,13 @@
# MonitorSubscribe
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**batch_notify** | [**MonitorSubscribeBatchNotify**](MonitorSubscribeBatchNotify.md) | | [optional]
**callback** | [**MonitorWebhook**](MonitorWebhook.md) | |
**refresh_event** | **float** | Define the period (in sec.) between two refresh events. The refresh-events are sent when the condition of the monitor is satisfied (Trigger -> toggled true).A kind of periodic reminder. | [optional]
**retry_policy** | [**MonitorSubscribeRetryPolicy**](MonitorSubscribeRetryPolicy.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorSubscribeBatchNotify.md
+11
View File
@@ -0,0 +1,11 @@
# MonitorSubscribeBatchNotify
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**size** | **float** | Batch size | [optional]
**time_window** | **float** | Notification batch window size (expressed in seconds). | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorSubscribeRetryPolicy.md
+12
View File
@@ -0,0 +1,12 @@
# MonitorSubscribeRetryPolicy
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**max_retry_number** | **int** | Maximum number of attempts (to be used with retryPolicy set to Bounded). | [optional]
**policy** | **str** | Defines the retry rules following a WebHook notification failure (ie the return code is not HTTP 2XX). '_None_' means with a single try, '_Bounded_' with a limited number of tries and '_Always_' with an infinite number of tries. |
**retry_delay** | **int** | Time to wait (expressed in seconds) befor retrying to push a notification. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorTrigger.md
+13
View File
@@ -0,0 +1,13 @@
# MonitorTrigger
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**DataTrigger**](DataTrigger.md) | | [optional]
**name** | **str** | The trigger name(should be uniq) |
**time** | [**TimeTrigger**](TimeTrigger.md) | | [optional]
**zone** | [**ZoneTrigger**](ZoneTrigger.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorWebhook.md
+12
View File
@@ -0,0 +1,12 @@
# MonitorWebhook
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**list[MonitorWebhookAttributes]**](MonitorWebhookAttributes.md) | Additional attributes-set that can be used as http header enhencement (such as headers can be used as an authentication parameter when posting the event) or simply added to the notification event body (as set of key/values) or finally as additional query parameters. | [optional]
**name** | **str** | Webhook name. |
**target** | [**Url**](Url.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorWebhookAttributes.md
+12
View File
@@ -0,0 +1,12 @@
# MonitorWebhookAttributes
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **str** | |
**type** | **str** | 3 attributes type: |Attribute-type|Role| |----------|-------------| |Header|-Will be add as http header extension \"x-######:\"| |Body|-Will be simply add to event body map attribute (see monitor event definition in template document)| |Query|-Will set as http query parameter when invoking the Webhook| |
**value** | **object** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Monitors.md
+10
View File
@@ -0,0 +1,10 @@
# Monitors
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**embedded** | [**MonitorsEmbedded**](MonitorsEmbedded.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/MonitorsEmbedded.md
+10
View File
@@ -0,0 +1,10 @@
# MonitorsEmbedded
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**monitors** | [**list[MonitorParameter]**](MonitorParameter.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/OverallAutonomy.md
+10
View File
@@ -0,0 +1,10 @@
# OverallAutonomy
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**autonomy** | **float** | Vehicle global autonomy expressed in KM. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Point.md
+11
View File
@@ -0,0 +1,11 @@
# Point
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**coordinates** | [**Vect2D**](Vect2D.md) | | [optional]
**type** | **str** | | [optional] [default to 'Point']
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/PolygonZone.md
+11
View File
@@ -0,0 +1,11 @@
# PolygonZone
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**coordinates** | [**list[Vect2D]**](Vect2D.md) | | [optional]
**type** | **str** | | [optional] [default to 'Polygon']
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Position.md
+13
View File
@@ -0,0 +1,13 @@
# Position
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **datetime** | Date when the resource has been created. | [optional]
**geometry** | [**Point**](Point.md) | | [optional]
**properties** | [**PositionProperties**](PositionProperties.md) | |
**type** | **str** | | [optional] [default to 'Feature']
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/PositionProperties.md
+12
View File
@@ -0,0 +1,12 @@
# PositionProperties
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**heading** | **float** | | [optional]
**signal_quality** | **float** | | [optional]
**type** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Preconditioning.md
+10
View File
@@ -0,0 +1,10 @@
# Preconditioning
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**air_conditioning** | [**PreconditioningAirConditioning**](PreconditioningAirConditioning.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/PreconditioningAirConditioning.md
+13
View File
@@ -0,0 +1,13 @@
# PreconditioningAirConditioning
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**failure_cause** | **str** | failure cause | [optional]
**programs** | [**list[PreconditioningProgram]**](PreconditioningProgram.md) | | [optional]
**status** | **str** | The status of the preconditionning feature. | [optional]
**updated_at** | **datetime** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/PreconditioningProgram.md
+9
View File
@@ -0,0 +1,9 @@
# PreconditioningProgram
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Privacy.md
+10
View File
@@ -0,0 +1,10 @@
# Privacy
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**state** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Program.md
+12
View File
@@ -0,0 +1,12 @@
# Program
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**occurence** | [**ProgramOccurence**](ProgramOccurence.md) | |
**recurrence** | **str** | Determines the recurrence of the program. * None: means no recurrence. * Daily: repeated over the week. * Weekly: repeated over the weeks of the year from w1 to w52 specified in an array unitary or grouped by ranges (w1, w2,w34-w46, w52). | [default to 'Daily']
**start** | **str** | The program start time formatted using the duration format based on [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) with the schema: P[n]Y[n]M[n]DT[n]H[n]M[n]S _example_: * PT14H30M : 14H30min |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/ProgramOccurence.md
+11
View File
@@ -0,0 +1,11 @@
# ProgramOccurence
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**day** | **list[str]** | |
**week** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Safety.md
+11
View File
@@ -0,0 +1,11 @@
# Safety
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**belt_warning** | **str** | | [optional]
**e_call_triggering_request** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/ServiceType.md
+11
View File
@@ -0,0 +1,11 @@
# ServiceType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | | [optional]
**updated_at** | **datetime** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Status.md
+22
View File
@@ -0,0 +1,22 @@
# Status
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**embedded** | [**StatusEmbedded**](StatusEmbedded.md) | | [optional]
**links** | [**StatusLinks**](StatusLinks.md) | |
**battery** | [**Battery**](Battery.md) | | [optional]
**doors_state** | [**DoorsState**](DoorsState.md) | | [optional]
**energy** | [**list[Energy]**](Energy.md) | Describe vehicle energy supply for thermic, low emission vehicle or both. | [optional]
**environment** | [**Environment**](Environment.md) | | [optional]
**ignition** | [**Ignition**](Ignition.md) | | [optional]
**kinetic** | [**Kinetic**](Kinetic.md) | | [optional]
**last_position** | [**Position**](Position.md) | | [optional]
**preconditionning** | [**Preconditioning**](Preconditioning.md) | | [optional]
**privacy** | [**Privacy**](Privacy.md) | | [optional]
**safety** | [**Safety**](Safety.md) | | [optional]
**service** | [**ServiceType**](ServiceType.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/StatusEmbedded.md
+10
View File
@@ -0,0 +1,10 @@
# StatusEmbedded
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**extension** | [**Extension**](Extension.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/StatusExtensionType.md
+9
View File
@@ -0,0 +1,9 @@
# StatusExtensionType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/StatusLinks.md
+11
View File
@@ -0,0 +1,11 @@
# StatusLinks
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_self** | [**Link**](Link.md) | | [optional]
**vehicle** | [**Link**](Link.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TabLinks.md
+14
View File
@@ -0,0 +1,14 @@
# TabLinks
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**first** | [**Link**](Link.md) | | [optional]
**last** | [**Link**](Link.md) | | [optional]
**next** | [**Link**](Link.md) | | [optional]
**prev** | [**Link**](Link.md) | | [optional]
**_self** | [**Link**](Link.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/Telemetry.md
+10
View File
@@ -0,0 +1,10 @@
# Telemetry
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**embedded** | [**TelemetryEmbedded**](TelemetryEmbedded.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TelemetryEmbedded.md
+10
View File
@@ -0,0 +1,10 @@
# TelemetryEmbedded
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**telemetries** | [**list[TelemetryMessage]**](TelemetryMessage.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TelemetryEnum.md
+9
View File
@@ -0,0 +1,9 @@
# TelemetryEnum
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TelemetryExtension.md
+13
View File
@@ -0,0 +1,13 @@
# TelemetryExtension
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**alerts** | [**list[Alert]**](Alert.md) | | [optional]
**collision** | [**Collision**](Collision.md) | | [optional]
**location** | [**Position**](Position.md) | | [optional]
**maintenance** | [**MaintenanceObj**](MaintenanceObj.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TelemetryExtensionType.md
+9
View File
@@ -0,0 +1,9 @@
# TelemetryExtensionType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TelemetryMessage.md
+15
View File
@@ -0,0 +1,15 @@
# TelemetryMessage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**embedded** | [**TelemetryMessageEmbedded**](TelemetryMessageEmbedded.md) | | [optional]
**links** | [**StatusLinks**](StatusLinks.md) | | [optional]
**environment** | [**Environment**](Environment.md) | | [optional]
**id** | **str** | | [optional]
**privacy** | [**Privacy**](Privacy.md) | | [optional]
**vehicle** | [**TelemetryMessageVehicle**](TelemetryMessageVehicle.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TelemetryMessageEmbedded.md
+10
View File
@@ -0,0 +1,10 @@
# TelemetryMessageEmbedded
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**extension** | [**TelemetryExtension**](TelemetryExtension.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TelemetryMessageVehicle.md
+19
View File
@@ -0,0 +1,19 @@
# TelemetryMessageVehicle
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**adas** | [**Adas**](Adas.md) | | [optional]
**battery** | [**Battery**](Battery.md) | | [optional]
**braking_system** | [**TelemetryMessageVehicleBrakingSystem**](TelemetryMessageVehicleBrakingSystem.md) | | [optional]
**doors_state** | [**DoorsState**](DoorsState.md) | | [optional]
**energy** | [**Energy**](Energy.md) | | [optional]
**engines** | [**list[Engine]**](Engine.md) | | [optional]
**ignition** | [**Ignition**](Ignition.md) | | [optional]
**lighting** | [**Lighting**](Lighting.md) | | [optional]
**safety** | [**Safety**](Safety.md) | | [optional]
**transmission** | [**TelemetryMessageVehicleTransmission**](TelemetryMessageVehicleTransmission.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TelemetryMessageVehicleBrakingSystem.md
+10
View File
@@ -0,0 +1,10 @@
# TelemetryMessageVehicleBrakingSystem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**parking** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TelemetryMessageVehicleTransmission.md
+10
View File
@@ -0,0 +1,10 @@
# TelemetryMessageVehicleTransmission
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**gearbox** | [**TelemetryMessageVehicleTransmissionGearbox**](TelemetryMessageVehicleTransmissionGearbox.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TelemetryMessageVehicleTransmissionGearbox.md
+11
View File
@@ -0,0 +1,11 @@
# TelemetryMessageVehicleTransmissionGearbox
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**gear** | [**TelemetryMessageVehicleTransmissionGearboxGear**](TelemetryMessageVehicleTransmissionGearboxGear.md) | | [optional]
**mode** | [**TelemetryMessageVehicleTransmissionGearboxMode**](TelemetryMessageVehicleTransmissionGearboxMode.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TelemetryMessageVehicleTransmissionGearboxGear.md
+10
View File
@@ -0,0 +1,10 @@
# TelemetryMessageVehicleTransmissionGearboxGear
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**recommended** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TelemetryMessageVehicleTransmissionGearboxMode.md
+12
View File
@@ -0,0 +1,12 @@
# TelemetryMessageVehicleTransmissionGearboxMode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**automatic** | **bool** | | [optional]
**snow** | **bool** | | [optional]
**sport** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TimeMonitorTrigger.md
+11
View File
@@ -0,0 +1,11 @@
# TimeMonitorTrigger
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**times** | [**list[TimeRange]**](TimeRange.md) | | [optional]
**type** | **str** | | [optional] [default to 'Temporal']
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TimeRange.md
+9
View File
@@ -0,0 +1,9 @@
# TimeRange
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TimeStamped.md
+10
View File
@@ -0,0 +1,10 @@
# TimeStamped
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **datetime** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/TimeTrigger.md
+11
View File
@@ -0,0 +1,11 @@
# TimeTrigger
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**time_zone** | **str** | The standard time [zone code](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the region where to apply this time trigger monitor. This allows to adapt this trigger to the time change according to local (region/country) criteria/rules. | [optional] [default to 'Europe/Paris']
**times** | [**list[BoundedProgram]**](BoundedProgram.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Some files were not shown because too many files have changed in this diff Show More