OcppModel.V20.Behaviours.Charger behaviour (ocpp_model v0.2.1)
View Source
Behaviour of a Charger, allowing the module assuming the behaviour to be able to respond to messages send to it
Main entrypoint, based on the action parameter, this function will call one of the callback functions
Specs
Main entrypoint, based on the action parameter, this function will call one of the callback functions
Specs
cancel_reservation(
req :: %OcppModel.V20.Messages.CancelReservationRequest{reservationId: term()}
) ::
{:ok,
%OcppModel.V20.Messages.CancelReservationResponse{
status: term(),
statusInfo: term()
}}
| {:error, :cancel_reservation, String.t()}
Specs
certificate_signed(
req :: %OcppModel.V20.Messages.CertificateSignedRequest{
certificateChain: term(),
certificateType: term()
}
) ::
{:ok,
%OcppModel.V20.Messages.CertificateSignedResponse{
status: term(),
statusInfo: term()
}}
| {:error, :certificate_signed, String.t()}
Specs
change_availability(
req :: %OcppModel.V20.Messages.ChangeAvailabilityRequest{
evse: term(),
operationalStatus: term()
}
) ::
{:ok,
%OcppModel.V20.Messages.ChangeAvailabilityResponse{
status: term(),
statusInfo: term()
}}
| {:error, :change_availability, String.t()}
Specs
clear_cache(req :: %OcppModel.V20.Messages.ClearCacheRequest{}) ::
{:ok,
%OcppModel.V20.Messages.ClearCacheResponse{
status: term(),
statusInfo: term()
}}
| {:error, :clear_cache, String.t()}
Specs
clear_charging_profile(
req :: %OcppModel.V20.Messages.ClearChargingProfileRequest{
chargingProfileCriteria: term(),
chargingProfileId: term()
}
) ::
{:ok,
%OcppModel.V20.Messages.ClearChargingProfileResponse{
status: term(),
statusInfo: term()
}}
| {:error, :clear_charging_profile, String.t()}
Specs
clear_display_message(
req :: %OcppModel.V20.Messages.ClearDisplayMessageRequest{id: term()}
) ::
{:ok,
%OcppModel.V20.Messages.ClearDisplayMessageResponse{
status: term(),
statusInfo: term()
}}
| {:error, :clear_display_message, String.t()}
Specs
clear_variable_monitoring(
req :: %OcppModel.V20.Messages.ClearVariableMonitoringRequest{id: term()}
) ::
{:ok,
%OcppModel.V20.Messages.ClearVariableMonitoringResponse{
clearMonitoringResult: term()
}}
| {:error, :clear_variable_monitoring, String.t()}
Specs
cost_updated(
req :: %OcppModel.V20.Messages.CostUpdatedRequest{
totalCost: term(),
transactionId: term()
}
) ::
{:ok, %OcppModel.V20.Messages.CostUpdatedResponse{}}
| {:error, :cost_updated, String.t()}
Specs
data_transfer(
req :: %OcppModel.V20.Messages.DataTransferRequest{
data: term(),
messageId: term(),
vendorId: term()
}
) ::
{:ok,
%OcppModel.V20.Messages.DataTransferResponse{
data: term(),
status: term(),
statusInfo: term()
}}
| {:error, :data_transfer, String.t()}
Specs
delete_certificate(
req :: %OcppModel.V20.Messages.DeleteCertificateRequest{
certificateHashData: term()
}
) ::
{:ok,
%OcppModel.V20.Messages.DeleteCertificateResponse{
status: term(),
statusInfo: term()
}}
| {:error, :delete_certificate, String.t()}
Specs
get_charging_profiles(
req :: %OcppModel.V20.Messages.GetChargingProfilesRequest{
chargingProfile: term(),
evseId: term(),
requestId: term()
}
) ::
{:ok,
%OcppModel.V20.Messages.GetChargingProfilesResponse{
status: term(),
statusInfo: term()
}}
| {:error, :get_charging_profiles, String.t()}
Specs
get_local_list_version([
{:req, %OcppModel.V20.Messages.GetLocalListVersionRequest{}}
]) ::
{:ok,
%OcppModel.V20.Messages.GetLocalListVersionResponse{versionNumber: term()}}
| {:error, :get_local_list_version, String.t()}
Specs
get_transaction_status([
{:req,
%OcppModel.V20.Messages.GetTransactionStatusRequest{transactionId: term()}}
]) ::
{:ok,
%OcppModel.V20.Messages.GetTransactionStatusResponse{
messagesInQueue: term(),
ongoingIndicator: term()
}}
| {:error, :get_transaction_status, String.t()}
Specs
reset(req :: %OcppModel.V20.Messages.ResetRequest{evseId: term(), type: term()}) ::
{:ok,
%OcppModel.V20.Messages.ResetResponse{status: term(), statusInfo: term()}}
| {:error, :reset, String.t()}
Specs
unlock_connector(
req :: %OcppModel.V20.Messages.UnlockConnectorRequest{evseId: term()}
) ::
{:ok,
%OcppModel.V20.Messages.UnlockConnectorResponse{
status: term(),
statusInfo: term()
}}
| {:error, :unlock_connector, String.t()}