Skip to content

Commit

Permalink
Convert old/deprecated ref format in relative refs for interfaces and…
Browse files Browse the repository at this point in the history
… types

Signed-off-by: Andreas Heinrich <andreas.heinrich@rwth-aachen.de>
  • Loading branch information
andistorm committed Oct 18, 2023
1 parent 9e72594 commit 8e114a0
Show file tree
Hide file tree
Showing 31 changed files with 167 additions and 167 deletions.
36 changes: 18 additions & 18 deletions interfaces/ISO15118_charger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ cmds:
debug_mode:
description: The various debug modes
type: string
$ref: /iso15118_charger#/DebugMode
$ref: '../types/iso15118_charger.yaml#/types/DebugMode'
set_Auth_Okay_EIM:
description: >-
Response on Require_Auth_EIM - Set this element if the authorization
Expand All @@ -127,11 +127,11 @@ cmds:
status:
description: Authorization status of the ID Token
type: string
$ref: /authorization#/AuthorizationStatus
$ref: '../types/authorization.yaml#/types/AuthorizationStatus'
certificateStatus:
description: Certificate status information
type: string
$ref: /authorization#/CertificateStatus
$ref: '../types/authorization.yaml#/types/CertificateStatus'
set_FAILED_ContactorError:
description: >-
Any Time - Set this error when the contactor is opened or closed
Expand Down Expand Up @@ -164,7 +164,7 @@ cmds:
EVSEPresentVoltage_Current:
description: Present values (current and voltage) for the EVSE
type: object
$ref: /iso15118_charger#/DC_EVSEPresentVoltage_Current
$ref: '../types/iso15118_charger.yaml#/types/DC_EVSEPresentVoltage_Current'
set_AC_EVSEMaxCurrent:
description: >-
ChargeParameterDiscovery and during charging - Set the Maximum allowed
Expand All @@ -183,7 +183,7 @@ cmds:
EVSEMaximumLimits:
description: Maximum Values (current, power and voltage) the EVSE can deliver
type: object
$ref: /iso15118_charger#/DC_EVSEMaximumLimits
$ref: '../types/iso15118_charger.yaml#/types/DC_EVSEMaximumLimits'
set_DC_EVSEMinimumLimits:
description:
ChargeParameterDiscovery - Set the minimum current and voltage for
Expand All @@ -192,7 +192,7 @@ cmds:
EVSEMinimumLimits:
description: Minimum Values (current and voltage) the EVSE can deliver
type: object
$ref: /iso15118_charger#/DC_EVSEMinimumLimits
$ref: '../types/iso15118_charger.yaml#/types/DC_EVSEMinimumLimits'
set_EVSEIsolationStatus:
description: >-
From ChargeParameterDiscovery to WeldingDetection (Optional) - Set
Expand All @@ -201,7 +201,7 @@ cmds:
EVSEIsolationStatus:
description: Set the isolation status
type: string
$ref: /iso15118_charger#/IsolationStatus
$ref: '../types/iso15118_charger.yaml#/types/IsolationStatus'
set_EVSE_UtilityInterruptEvent:
description: >-
From ChargeParameterDiscovery to WeldingDetection - Utility Interrupt
Expand Down Expand Up @@ -235,7 +235,7 @@ cmds:
powermeter:
description: Measured dataset
type: object
$ref: /powermeter#/Powermeter
$ref: '../types/powermeter.yaml#/types/Powermeter'
contactor_closed:
description: >-
Response on AC_Close_Contactor - Set this element if the contactor
Expand Down Expand Up @@ -278,7 +278,7 @@ cmds:
Existream_Status:
description: The response raw exi stream and the status from the CSMS system
type: object
$ref: /iso15118_charger#/Response_Exi_Stream_Status
$ref: '../types/iso15118_charger.yaml#/types/Response_Exi_Stream_Status'
dlink_ready:
description: >-
Signals dlink_ready from SLAC layer according to ISO15118-3
Expand All @@ -295,7 +295,7 @@ vars:
The EVCC provides the payment details for a PnC authorization by sending
the signature certificate chain and eMAID.
type: object
$ref: /authorization#/ProvidedIdToken
$ref: '../types/authorization.yaml#/types/ProvidedIdToken'
AC_Close_Contactor:
description: The contactor should be closed
type: "null"
Expand Down Expand Up @@ -328,13 +328,13 @@ vars:
SelectedPaymentOption:
description: This element is used for indicating the payment type
type: string
$ref: /iso15118_charger#/PaymentOption
$ref: '../types/iso15118_charger.yaml#/types/PaymentOption'
RequestedEnergyTransferMode:
description:
Selected energy transfer mode for charging that is requested by the
EVCC.
type: string
$ref: /iso15118_charger#/EnergyTransferMode
$ref: '../types/iso15118_charger.yaml#/types/EnergyTransferMode'
DepartureTime:
description: >-
Optional: [RFC3339 UTC] This element is used to indicate when the
Expand Down Expand Up @@ -395,7 +395,7 @@ vars:
DC_EVStatus:
description: Current status of the EV
type: object
$ref: /iso15118_charger#/DC_EVStatusType
$ref: '../types/iso15118_charger.yaml#/types/DC_EVStatusType'
DC_BulkChargingComplete:
description: >-
Optional: If set to TRUE, the EV indicates that bulk charge (approx.
Expand All @@ -409,24 +409,24 @@ vars:
DC_EVTargetVoltageCurrent:
description: Target voltage and current requested by the EV
type: object
$ref: /iso15118_charger#/DC_EVTargetValues
$ref: '../types/iso15118_charger.yaml#/types/DC_EVTargetValues'
DC_EVMaximumLimits:
description:
Maximum Values (current, power and voltage) supported and allowed
by the EV
type: object
$ref: /iso15118_charger#/DC_EVMaximumLimits
$ref: '../types/iso15118_charger.yaml#/types/DC_EVMaximumLimits'
DC_EVRemainingTime:
description: Estimated or calculated time until bulk and full charge is complete
type: object
$ref: /iso15118_charger#/DC_EVRemainingTime
$ref: '../types/iso15118_charger.yaml#/types/DC_EVRemainingTime'
Certificate_Request:
description: >-
The vehicle requests the SECC to deliver the certificate that belong
to the currently valid contract of the vehicle.
Response will be reported async via set_Get_Certificate_Response
type: object
$ref: /iso15118_charger#/Request_Exi_Stream_Schema
$ref: '../types/iso15118_charger.yaml#/types/Request_Exi_Stream_Schema'
dlink_terminate:
description: Terminate the data link and become UNMATCHED.
type: "null"
Expand Down Expand Up @@ -489,4 +489,4 @@ vars:
Debug - This element contains all V2G elements and should be used
for debug purposes only
type: object
$ref: /iso15118_charger#/V2G_Messages
$ref: '../types/iso15118_charger.yaml#/types/V2G_Messages'
2 changes: 1 addition & 1 deletion interfaces/ISO15118_ev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ cmds:
EV_Parameters:
description: Target parameters for dc charging
type: object
$ref: /iso15118_ev#/DC_EVParameters
$ref: '../types/iso15118_ev.yaml#/types/DC_EVParameters'
vars:
V2G_Session_Finished:
description: The v2g session between the charger and the car is finished
Expand Down
2 changes: 1 addition & 1 deletion interfaces/auth_token_provider.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ vars:
provided_token:
description: The provided token
type: object
$ref: /authorization#/ProvidedIdToken
$ref: '../types/authorization.yaml#/types/ProvidedIdToken'
4 changes: 2 additions & 2 deletions interfaces/auth_token_validator.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ cmds:
description: >-
Contains information about the authorization request
type: object
$ref: /authorization#/ProvidedIdToken
$ref: '../types/authorization.yaml#/types/ProvidedIdToken'
result:
description: >-
Result object containing validation result
type: object
$ref: /authorization#/ValidationResult
$ref: '../types/authorization.yaml#/types/ValidationResult'
6 changes: 3 additions & 3 deletions interfaces/board_support_AC.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ cmds:
result:
description: Hardware capability/limits
type: object
$ref: /board_support#/HardwareCapabilities
$ref: '../types/board_support.yaml#/types/HardwareCapabilities'
enable:
description: >-
Enables or disables the EVSE. Typically disabled results in control
Expand Down Expand Up @@ -86,7 +86,7 @@ vars:
event:
description: Event from ControlPilot signal/Relais/RCD
type: string
$ref: /board_support#/Event
$ref: '../types/board_support.yaml#/types/Event'
nr_of_phases_available:
description: Instantaneous phase count available to car
type: integer
Expand All @@ -95,4 +95,4 @@ vars:
telemetry:
description: Other telemetry
type: object
$ref: /board_support#/Telemetry
$ref: '../types/board_support.yaml#/types/Telemetry'
4 changes: 2 additions & 2 deletions interfaces/energy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ cmds:
value:
description: Limit object that will be routed through the tree.
type: object
$ref: /energy#/EnforcedLimits
$ref: '../types/energy.yaml#/types/EnforcedLimits'
vars:
energy_flow_request:
description: >-
Request energy flow to supply/limit energy import (direction from grid
to car) and/or consume/limit energy export (car to grid).
type: object
$ref: /energy#/EnergyFlowRequest
$ref: '../types/energy.yaml#/types/EnergyFlowRequest'
2 changes: 1 addition & 1 deletion interfaces/energy_price_information.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ vars:
Forecast JSON Object containing timestamps and the price forecast
for both import and export.
type: object
$ref: /energy_price_information#/EnergyPriceSchedule
$ref: '../types/energy_price_information.yaml#/types/EnergyPriceSchedule'
32 changes: 16 additions & 16 deletions interfaces/evse_manager.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cmds:
result:
description: Object that contains information of the EVSE including its connectors
type: object
$ref: /evse_manager#/Evse
$ref: '../types/evse_manager.yaml#/types/Evse'
enable:
description: Enables the evse. EVSE is available for charging after this operation
arguments:
Expand Down Expand Up @@ -41,11 +41,11 @@ cmds:
provided_token:
description: The token for which authorization was requested
type: object
$ref: /authorization#/ProvidedIdToken
$ref: '../types/authorization.yaml#/types/ProvidedIdToken'
validation_result:
description: The validation result
type: object
$ref: /authorization#/ValidationResult
$ref: '../types/authorization.yaml#/types/ValidationResult'
withdraw_authorization:
description: >-
Call to signals that EVSE is not further authorized to start a transaction
Expand Down Expand Up @@ -93,7 +93,7 @@ cmds:
request:
description: Request to stop the transaction.
type: object
$ref: /evse_manager#/StopTransactionRequest
$ref: '../types/evse_manager.yaml#/types/StopTransactionRequest'
result:
description: Returns true if successful
type: boolean
Expand All @@ -115,7 +115,7 @@ cmds:
value:
description: UUID of node that this limit applies to
type: object
$ref: /energy#/ExternalLimits
$ref: '../types/energy.yaml#/types/ExternalLimits'
switch_three_phases_while_charging:
description: Switch three phases while charging
arguments:
Expand All @@ -125,7 +125,7 @@ cmds:
result:
description: Returns success or error code
type: string
$ref: /evse_manager#/SwitchThreePhasesWhileChargingResult
$ref: '../types/evse_manager.yaml#/types/SwitchThreePhasesWhileChargingResult'
set_get_certificate_response:
description: >-
CertificateInstallationRes/CertificateUpdateRes - Set the new/updated Contract Certificate (including the certificate chain)
Expand All @@ -135,50 +135,50 @@ cmds:
certificate_reponse:
description: The response raw exi stream and the status from the CSMS system
type: object
$ref: /iso15118_charger#/Response_Exi_Stream_Status
$ref: '../types/iso15118_charger.yaml#/types/Response_Exi_Stream_Status'
vars:
session_event:
description: Emits all events related to sessions
type: object
$ref: /evse_manager#/SessionEvent
$ref: '../types/evse_manager.yaml#/types/SessionEvent'
limits:
description: Limits of this evse, published on change
type: object
$ref: /evse_manager#/Limits
$ref: '../types/evse_manager.yaml#/types/Limits'
ev_info:
description: More details about the EV if available
type: object
$ref: /evse_manager#/EVInfo
$ref: '../types/evse_manager.yaml#/types/EVInfo'
car_manufacturer:
description: Car manufacturer (if known)
type: string
$ref: /evse_manager#/CarManufacturer
$ref: '../types/evse_manager.yaml#/types/CarManufacturer'
telemetry:
description: Other telemetry
type: object
$ref: /board_support#/Telemetry
$ref: '../types/board_support.yaml#/types/Telemetry'
powermeter:
description: Measured dataset
type: object
$ref: /powermeter#/Powermeter
$ref: '../types/powermeter.yaml#/types/Powermeter'
evse_id:
description: EVSE ID including the connector number, e.g. DE*PNX*E123456*1
type: string
hw_capabilities:
description: "Hardware capability/limits"
type: object
$ref: /board_support#/HardwareCapabilities
$ref: '../types/board_support.yaml#/types/HardwareCapabilities'
iso15118_certificate_request:
description: >-
The vehicle requests the SECC to deliver the certificate that belong
to the currently valid contract of the vehicle.
Response will be reported async via set_get_certificate_response
type: object
$ref: /iso15118_charger#/Request_Exi_Stream_Schema
$ref: '../types/iso15118_charger.yaml#/types/Request_Exi_Stream_Schema'
enforced_limits:
description: Enforced limits for this node (coming from the EnergyManager)
type: object
$ref: /energy#/EnforcedLimits
$ref: '../types/energy.yaml#/types/EnforcedLimits'
ready:
description: Signals that the EVSE Manager is ready to start charging
type: boolean
Loading

0 comments on commit 8e114a0

Please sign in to comment.