NotifyEventRequest

Documentation

Index

• type ComponentType
  • func (j *ComponentType) UnmarshalJSON(b []byte) error
• type CustomDataType
  • func (j *CustomDataType) UnmarshalJSON(b []byte) error
• type EVSEType
  • func (j *EVSEType) UnmarshalJSON(b []byte) error
• type EventDataType
  • func (j *EventDataType) UnmarshalJSON(b []byte) error
• type EventNotificationEnumType
  • func (j *EventNotificationEnumType) UnmarshalJSON(b []byte) error
• type EventNotificationEnumType_1
  • func (j *EventNotificationEnumType_1) UnmarshalJSON(b []byte) error
• type EventTriggerEnumType
  • func (j *EventTriggerEnumType) UnmarshalJSON(b []byte) error
• type EventTriggerEnumType_1
  • func (j *EventTriggerEnumType_1) UnmarshalJSON(b []byte) error
• type NotifyEventRequestJson
  • func (j *NotifyEventRequestJson) UnmarshalJSON(b []byte) error
• type VariableType
  • func (j *VariableType) UnmarshalJSON(b []byte) error

Types

type ComponentType

type ComponentType struct {
	// CustomData corresponds to the JSON schema field "customData".
	CustomData *CustomDataType `json:"customData,omitempty" yaml:"customData,omitempty"`

	// Evse corresponds to the JSON schema field "evse".
	Evse *EVSEType `json:"evse,omitempty" yaml:"evse,omitempty"`

	// Name of instance in case the component exists as multiple instances. Case
	// Insensitive. strongly advised to use Camel Case.
	//
	Instance *string `json:"instance,omitempty" yaml:"instance,omitempty"`

	// Name of the component. Name should be taken from the list of standardized
	// component names whenever possible. Case Insensitive. strongly advised to use
	// Camel Case.
	//
	Name string `json:"name" yaml:"name"`
}

A physical or logical component

func (*ComponentType) UnmarshalJSON

func (j *ComponentType) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type CustomDataType

type CustomDataType struct {
	// VendorId corresponds to the JSON schema field "vendorId".
	VendorId string `json:"vendorId" yaml:"vendorId"`
}

This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.

func (*CustomDataType) UnmarshalJSON

func (j *CustomDataType) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type EVSEType

type EVSEType struct {
	// An id to designate a specific connector (on an EVSE) by connector index number.
	//
	ConnectorId *int `json:"connectorId,omitempty" yaml:"connectorId,omitempty"`

	// CustomData corresponds to the JSON schema field "customData".
	CustomData *CustomDataType `json:"customData,omitempty" yaml:"customData,omitempty"`

	// Identified_ Object. MRID. Numeric_ Identifier
	// urn:x-enexis:ecdm:uid:1:569198
	// EVSE Identifier. This contains a number (> 0) designating an EVSE of the
	// Charging Station.
	//
	Id int `json:"id" yaml:"id"`
}

EVSE urn:x-oca:ocpp:uid:2:233123 Electric Vehicle Supply Equipment

func (*EVSEType) UnmarshalJSON

func (j *EVSEType) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type EventDataType

type EventDataType struct {
	// Actual value (_attributeType_ Actual) of the variable.
	//
	// The Configuration Variable
	// <<configkey-reporting-value-size,ReportingValueSize>> can be used
	// to limit GetVariableResult.attributeValue, VariableAttribute.value and
	// EventData.actualValue. The max size of these values will always remain equal.
	//
	//
	ActualValue string `json:"actualValue" yaml:"actualValue"`

	// Refers to the Id of an event that is considered to be the cause for this event.
	//
	//
	Cause *int `json:"cause,omitempty" yaml:"cause,omitempty"`

	// _Cleared_ is set to true to report the clearing of a monitored situation, i.e.
	// a 'return to normal'.
	//
	//
	Cleared *bool `json:"cleared,omitempty" yaml:"cleared,omitempty"`

	// Component corresponds to the JSON schema field "component".
	Component ComponentType `json:"component" yaml:"component"`

	// CustomData corresponds to the JSON schema field "customData".
	CustomData *CustomDataType `json:"customData,omitempty" yaml:"customData,omitempty"`

	// Identifies the event. This field can be referred to as a cause by other events.
	//
	//
	EventId int `json:"eventId" yaml:"eventId"`

	// EventNotificationType corresponds to the JSON schema field
	// "eventNotificationType".
	EventNotificationType EventNotificationEnumType `json:"eventNotificationType" yaml:"eventNotificationType"`

	// Technical (error) code as reported by component.
	//
	TechCode *string `json:"techCode,omitempty" yaml:"techCode,omitempty"`

	// Technical detail information as reported by component.
	//
	TechInfo *string `json:"techInfo,omitempty" yaml:"techInfo,omitempty"`

	// Timestamp of the moment the report was generated.
	//
	Timestamp string `json:"timestamp" yaml:"timestamp"`

	// If an event notification is linked to a specific transaction, this field can be
	// used to specify its transactionId.
	//
	TransactionId *string `json:"transactionId,omitempty" yaml:"transactionId,omitempty"`

	// Trigger corresponds to the JSON schema field "trigger".
	Trigger EventTriggerEnumType `json:"trigger" yaml:"trigger"`

	// Variable corresponds to the JSON schema field "variable".
	Variable VariableType `json:"variable" yaml:"variable"`

	// Identifies the VariableMonitoring which triggered the event.
	//
	VariableMonitoringId *int `json:"variableMonitoringId,omitempty" yaml:"variableMonitoringId,omitempty"`
}

Class to report an event notification for a component-variable.

func (*EventDataType) UnmarshalJSON

func (j *EventDataType) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type EventNotificationEnumType

type EventNotificationEnumType string

const EventNotificationEnumTypeCustomMonitor EventNotificationEnumType = "CustomMonitor"

const EventNotificationEnumTypeHardWiredMonitor EventNotificationEnumType = "HardWiredMonitor"

const EventNotificationEnumTypeHardWiredNotification EventNotificationEnumType = "HardWiredNotification"

const EventNotificationEnumTypePreconfiguredMonitor EventNotificationEnumType = "PreconfiguredMonitor"

func (*EventNotificationEnumType) UnmarshalJSON

func (j *EventNotificationEnumType) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type EventNotificationEnumType_1

type EventNotificationEnumType_1 string

const EventNotificationEnumType_1_CustomMonitor EventNotificationEnumType_1 = "CustomMonitor"

const EventNotificationEnumType_1_HardWiredMonitor EventNotificationEnumType_1 = "HardWiredMonitor"

const EventNotificationEnumType_1_HardWiredNotification EventNotificationEnumType_1 = "HardWiredNotification"

const EventNotificationEnumType_1_PreconfiguredMonitor EventNotificationEnumType_1 = "PreconfiguredMonitor"

func (*EventNotificationEnumType_1) UnmarshalJSON

func (j *EventNotificationEnumType_1) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type EventTriggerEnumType

type EventTriggerEnumType string

const EventTriggerEnumTypeAlerting EventTriggerEnumType = "Alerting"

const EventTriggerEnumTypeDelta EventTriggerEnumType = "Delta"

const EventTriggerEnumTypePeriodic EventTriggerEnumType = "Periodic"

func (*EventTriggerEnumType) UnmarshalJSON

func (j *EventTriggerEnumType) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type EventTriggerEnumType_1

type EventTriggerEnumType_1 string

const EventTriggerEnumType_1_Alerting EventTriggerEnumType_1 = "Alerting"

const EventTriggerEnumType_1_Delta EventTriggerEnumType_1 = "Delta"

const EventTriggerEnumType_1_Periodic EventTriggerEnumType_1 = "Periodic"

func (*EventTriggerEnumType_1) UnmarshalJSON

func (j *EventTriggerEnumType_1) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type NotifyEventRequestJson

type NotifyEventRequestJson struct {
	// CustomData corresponds to the JSON schema field "customData".
	CustomData *CustomDataType `json:"customData,omitempty" yaml:"customData,omitempty"`

	// EventData corresponds to the JSON schema field "eventData".
	EventData []EventDataType `json:"eventData" yaml:"eventData"`

	// Timestamp of the moment this message was generated at the Charging Station.
	//
	GeneratedAt string `json:"generatedAt" yaml:"generatedAt"`

	// Sequence number of this message. First message starts at 0.
	//
	SeqNo int `json:"seqNo" yaml:"seqNo"`

	// “to be continued” indicator. Indicates whether another part of the report
	// follows in an upcoming notifyEventRequest message. Default value when omitted
	// is false.
	//
	Tbc bool `json:"tbc,omitempty" yaml:"tbc,omitempty"`
}

func (*NotifyEventRequestJson) UnmarshalJSON

func (j *NotifyEventRequestJson) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type VariableType

type VariableType struct {
	// CustomData corresponds to the JSON schema field "customData".
	CustomData *CustomDataType `json:"customData,omitempty" yaml:"customData,omitempty"`

	// Name of instance in case the variable exists as multiple instances. Case
	// Insensitive. strongly advised to use Camel Case.
	//
	Instance *string `json:"instance,omitempty" yaml:"instance,omitempty"`

	// Name of the variable. Name should be taken from the list of standardized
	// variable names whenever possible. Case Insensitive. strongly advised to use
	// Camel Case.
	//
	Name string `json:"name" yaml:"name"`
}

Reference key to a component-variable.

func (*VariableType) UnmarshalJSON

func (j *VariableType) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.