localauth

Documentation

Overview

The Local authorization list functional block contains OCPP 2.0 features for synchronizing local authorization lists between CSMS and charging station. Local lists are used for offline and generally optimized authorization.

Index

• Constants
• Variables
• type CSMSHandler
• type ChargingStationHandler
• type GetLocalListVersionFeature
  • func (f GetLocalListVersionFeature) GetFeatureName() string
  • func (f GetLocalListVersionFeature) GetRequestType() reflect.Type
  • func (f GetLocalListVersionFeature) GetResponseType() reflect.Type
• type GetLocalListVersionRequest
  • func NewGetLocalListVersionRequest() *GetLocalListVersionRequest
  • func (r GetLocalListVersionRequest) GetFeatureName() string
• type GetLocalListVersionResponse
  • func NewGetLocalListVersionResponse(version int) *GetLocalListVersionResponse
  • func (c GetLocalListVersionResponse) GetFeatureName() string

Constants

const GetLocalListVersionFeatureName = "GetLocalListVersion"

const ProfileName = "localAuthList"

Variables

var Profile = ocpp.NewProfile(
	ProfileName,
	GetLocalListVersionFeature{},
)

Types

type CSMSHandler

type CSMSHandler interface {
}

Needs to be implemented by a CSMS for handling messages part of the OCPP 2.0 Local Authorization List profile.

type ChargingStationHandler

type ChargingStationHandler interface {
	// OnGetLocalListVersion is called on a charging station whenever a GetLocalListVersionRequest is received from the CSMS.
	OnGetLocalListVersion(request *GetLocalListVersionRequest) (confirmation *GetLocalListVersionResponse, err error)
}

Needs to be implemented by Charging stations for handling messages part of the OCPP 2.0 Local Authorization List profile.

type GetLocalListVersionFeature

type GetLocalListVersionFeature struct{}

The CSMS can request a Charging Station for the version number of the Local Authorization List by sending a GetLocalListVersionRequest. Upon receipt of the GetLocalListVersionRequest Charging Station responds with a GetLocalListVersionResponse containing the version number of its Local Authorization List. The Charging Station SHALL use a version number of 0 (zero) to indicate that the Local Authorization List is empty.

func (GetLocalListVersionFeature) GetFeatureName

func (f GetLocalListVersionFeature) GetFeatureName() string

func (GetLocalListVersionFeature) GetRequestType

func (f GetLocalListVersionFeature) GetRequestType() reflect.Type

func (GetLocalListVersionFeature) GetResponseType

func (f GetLocalListVersionFeature) GetResponseType() reflect.Type

type GetLocalListVersionRequest

type GetLocalListVersionRequest struct {
}

The field definition of the GetLocalListVersion request payload sent by the CSMS to the Charging Station.

func NewGetLocalListVersionRequest

func NewGetLocalListVersionRequest() *GetLocalListVersionRequest

Creates a new GetLocalListVersionRequest, which doesn't contain any required or optional fields.

func (GetLocalListVersionRequest) GetFeatureName

func (r GetLocalListVersionRequest) GetFeatureName() string

type GetLocalListVersionResponse

type GetLocalListVersionResponse struct {
	VersionNumber int `json:"versionNumber" validate:"gte=0"`
}

This field definition of the GetLocalListVersion response payload, sent by the Charging Station to the CSMS in response to a GetLocalListVersionRequest. In case the request was invalid, or couldn't be processed, an error will be sent instead.

func NewGetLocalListVersionResponse

func NewGetLocalListVersionResponse(version int) *GetLocalListVersionResponse

Creates a new GetLocalListVersionResponse, containing all required fields. There are no optional fields for this message.

func (GetLocalListVersionResponse) GetFeatureName

func (c GetLocalListVersionResponse) GetFeatureName() string