extendedtriggermessage

package
v0.18.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 6, 2024 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

The diagnostics functional block contains OCPP 2.0 features than enable remote diagnostics of problems with a charging station.

Index

Constants

View Source
const (
	ExtendedTriggerMessageTypeBootNotification               ExtendedTriggerMessageType = "BootNotification"               // This contains the field definition of a diagnostics log file
	ExtendedTriggerMessageTypeLogStatusNotification          ExtendedTriggerMessageType = "LogStatusNotification"          // Sent by the CSMS to the Charging Station to request that the Charging Station uploads the security log
	ExtendedTriggerMessageTypeHeartbeat                      ExtendedTriggerMessageType = "Heartbeat"                      // Accepted this log upload. This does not mean the log file is uploaded is successfully, the Charging Station will now start the log file upload.
	ExtendedTriggerMessageTypeMeterValues                    ExtendedTriggerMessageType = "MeterValues"                    // Log update request rejected.
	ExtendedTriggerMessageTypeSignChargingStationCertificate ExtendedTriggerMessageType = "SignChargingStationCertificate" // Accepted this log upload, but in doing this has canceled an ongoing log file upload.
	ExtendedTriggerMessageTypeFirmwareStatusNotification     ExtendedTriggerMessageType = "FirmwareStatusNotification"     // Accepted this log upload, but in doing this has canceled an ongoing log file upload.
	ExtendedTriggerMessageTypeStatusNotification             ExtendedTriggerMessageType = "StatusNotification"             // Accepted this log upload, but in doing this has canceled an ongoing log file upload.

	ExtendedTriggerMessageStatusAccepted       ExtendedTriggerMessageStatus = "Accepted"
	ExtendedTriggerMessageStatusRejected       ExtendedTriggerMessageStatus = "Rejected"
	ExtendedTriggerMessageStatusNotImplemented ExtendedTriggerMessageStatus = "NotImplemented"
)
View Source
const ExtendedTriggerMessageFeatureName = "ExtendedTriggerMessage"
View Source
const ProfileName = "ExtendedTriggerMessage"

Variables

Functions

This section is empty.

Types

type ChargePointHandler

type ChargePointHandler interface {
	// OnExtendedTriggerMessage is called on a charging station whenever a ExtendedTriggerMessageRequest is received from the CSMS.
	OnExtendedTriggerMessage(request *ExtendedTriggerMessageRequest) (response *ExtendedTriggerMessageResponse, err error)
}

Needs to be implemented by Charging stations for handling messages part of the OCPP 1.6j security extension.

type ExtendedTriggerMessageFeature

type ExtendedTriggerMessageFeature struct{}

func (ExtendedTriggerMessageFeature) GetFeatureName

func (e ExtendedTriggerMessageFeature) GetFeatureName() string

func (ExtendedTriggerMessageFeature) GetRequestType

func (e ExtendedTriggerMessageFeature) GetRequestType() reflect.Type

func (ExtendedTriggerMessageFeature) GetResponseType

func (e ExtendedTriggerMessageFeature) GetResponseType() reflect.Type

type ExtendedTriggerMessageRequest

type ExtendedTriggerMessageRequest struct {
	RequestedMessage ExtendedTriggerMessageType `json:"requestedMessage" validate:"required,extendedTriggerMessageType"`
	ConnectorId      *int                       `json:"connectorId" validate:"gt=0,omitempty"`
}

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

func NewExtendedTriggerMessageRequest

func NewExtendedTriggerMessageRequest(requestedMessage ExtendedTriggerMessageType) *ExtendedTriggerMessageRequest

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

func (ExtendedTriggerMessageRequest) GetFeatureName

func (r ExtendedTriggerMessageRequest) GetFeatureName() string

type ExtendedTriggerMessageResponse

type ExtendedTriggerMessageResponse struct {
	Status ExtendedTriggerMessageStatus `json:"status" validate:"required,extendedTriggerMessageStatus"`
}

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

func NewExtendedTriggerMessageResponse

func NewExtendedTriggerMessageResponse(status ExtendedTriggerMessageStatus) *ExtendedTriggerMessageResponse

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

func (ExtendedTriggerMessageResponse) GetFeatureName

func (c ExtendedTriggerMessageResponse) GetFeatureName() string

type ExtendedTriggerMessageStatus

type ExtendedTriggerMessageStatus string

type ExtendedTriggerMessageType

type ExtendedTriggerMessageType string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL