Documentation
¶
Index ¶
- type AttributeEnumType
- type AttributeEnumType_1
- type ComponentType
- type CustomDataType
- type DataEnumType
- type DataEnumType_1
- type EVSEType
- type MutabilityEnumType
- type MutabilityEnumType_1
- type NotifyReportRequestJson
- type ReportDataType
- type VariableAttributeType
- type VariableCharacteristicsType
- type VariableType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AttributeEnumType ¶
type AttributeEnumType string
const AttributeEnumTypeActual AttributeEnumType = "Actual"
const AttributeEnumTypeMaxSet AttributeEnumType = "MaxSet"
const AttributeEnumTypeMinSet AttributeEnumType = "MinSet"
const AttributeEnumTypeTarget AttributeEnumType = "Target"
func (*AttributeEnumType) UnmarshalJSON ¶
func (j *AttributeEnumType) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler.
type AttributeEnumType_1 ¶
type AttributeEnumType_1 string
const AttributeEnumType_1_Actual AttributeEnumType_1 = "Actual"
const AttributeEnumType_1_MaxSet AttributeEnumType_1 = "MaxSet"
const AttributeEnumType_1_MinSet AttributeEnumType_1 = "MinSet"
const AttributeEnumType_1_Target AttributeEnumType_1 = "Target"
func (*AttributeEnumType_1) UnmarshalJSON ¶
func (j *AttributeEnumType_1) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler.
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 DataEnumType ¶
type DataEnumType string
const DataEnumTypeBoolean DataEnumType = "boolean"
const DataEnumTypeDateTime DataEnumType = "dateTime"
const DataEnumTypeDecimal DataEnumType = "decimal"
const DataEnumTypeInteger DataEnumType = "integer"
const DataEnumTypeMemberList DataEnumType = "MemberList"
const DataEnumTypeOptionList DataEnumType = "OptionList"
const DataEnumTypeSequenceList DataEnumType = "SequenceList"
const DataEnumTypeString DataEnumType = "string"
func (*DataEnumType) UnmarshalJSON ¶
func (j *DataEnumType) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler.
type DataEnumType_1 ¶
type DataEnumType_1 string
const DataEnumType_1_Boolean DataEnumType_1 = "boolean"
const DataEnumType_1_DateTime DataEnumType_1 = "dateTime"
const DataEnumType_1_Decimal DataEnumType_1 = "decimal"
const DataEnumType_1_Integer DataEnumType_1 = "integer"
const DataEnumType_1_MemberList DataEnumType_1 = "MemberList"
const DataEnumType_1_OptionList DataEnumType_1 = "OptionList"
const DataEnumType_1_SequenceList DataEnumType_1 = "SequenceList"
const DataEnumType_1_String DataEnumType_1 = "string"
func (*DataEnumType_1) UnmarshalJSON ¶
func (j *DataEnumType_1) 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 ¶
UnmarshalJSON implements json.Unmarshaler.
type MutabilityEnumType ¶
type MutabilityEnumType string
const MutabilityEnumTypeReadOnly MutabilityEnumType = "ReadOnly"
const MutabilityEnumTypeReadWrite MutabilityEnumType = "ReadWrite"
const MutabilityEnumTypeWriteOnly MutabilityEnumType = "WriteOnly"
func (*MutabilityEnumType) UnmarshalJSON ¶
func (j *MutabilityEnumType) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler.
type MutabilityEnumType_1 ¶
type MutabilityEnumType_1 string
const MutabilityEnumType_1_ReadOnly MutabilityEnumType_1 = "ReadOnly"
const MutabilityEnumType_1_ReadWrite MutabilityEnumType_1 = "ReadWrite"
const MutabilityEnumType_1_WriteOnly MutabilityEnumType_1 = "WriteOnly"
func (*MutabilityEnumType_1) UnmarshalJSON ¶
func (j *MutabilityEnumType_1) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler.
type NotifyReportRequestJson ¶
type NotifyReportRequestJson struct { // CustomData corresponds to the JSON schema field "customData". CustomData *CustomDataType `json:"customData,omitempty" yaml:"customData,omitempty"` // Timestamp of the moment this message was generated at the Charging Station. // GeneratedAt string `json:"generatedAt" yaml:"generatedAt"` // ReportData corresponds to the JSON schema field "reportData". ReportData []ReportDataType `json:"reportData,omitempty" yaml:"reportData,omitempty"` // The id of the GetReportRequest or GetBaseReportRequest that requested this // report // RequestId int `json:"requestId" yaml:"requestId"` // 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 notifyReportRequest message. Default value when omitted // is false. // // Tbc bool `json:"tbc,omitempty" yaml:"tbc,omitempty"` }
func (*NotifyReportRequestJson) UnmarshalJSON ¶
func (j *NotifyReportRequestJson) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler.
type ReportDataType ¶
type ReportDataType struct { // 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"` // Variable corresponds to the JSON schema field "variable". Variable VariableType `json:"variable" yaml:"variable"` // VariableAttribute corresponds to the JSON schema field "variableAttribute". VariableAttribute []VariableAttributeType `json:"variableAttribute" yaml:"variableAttribute"` // VariableCharacteristics corresponds to the JSON schema field // "variableCharacteristics". VariableCharacteristics *VariableCharacteristicsType `json:"variableCharacteristics,omitempty" yaml:"variableCharacteristics,omitempty"` }
Class to report components, variables and variable attributes and characteristics.
func (*ReportDataType) UnmarshalJSON ¶
func (j *ReportDataType) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler.
type VariableAttributeType ¶
type VariableAttributeType struct { // If true, value that will never be changed by the Charging Station at runtime. // Default when omitted is false. // Constant bool `json:"constant,omitempty" yaml:"constant,omitempty"` // CustomData corresponds to the JSON schema field "customData". CustomData *CustomDataType `json:"customData,omitempty" yaml:"customData,omitempty"` // Mutability corresponds to the JSON schema field "mutability". Mutability *MutabilityEnumType_1 `json:"mutability,omitempty" yaml:"mutability,omitempty"` // If true, value will be persistent across system reboots or power down. Default // when omitted is false. // Persistent bool `json:"persistent,omitempty" yaml:"persistent,omitempty"` // Type corresponds to the JSON schema field "type". Type *AttributeEnumType_1 `json:"type,omitempty" yaml:"type,omitempty"` // Value of the attribute. May only be omitted when mutability is set to // 'WriteOnly'. // // 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. // Value *string `json:"value,omitempty" yaml:"value,omitempty"` }
Attribute data of a variable.
func (*VariableAttributeType) UnmarshalJSON ¶
func (j *VariableAttributeType) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler.
type VariableCharacteristicsType ¶
type VariableCharacteristicsType struct { // CustomData corresponds to the JSON schema field "customData". CustomData *CustomDataType `json:"customData,omitempty" yaml:"customData,omitempty"` // DataType corresponds to the JSON schema field "dataType". DataType DataEnumType_1 `json:"dataType" yaml:"dataType"` // Maximum possible value of this variable. When the datatype of this Variable is // String, OptionList, SequenceList or MemberList, this field defines the maximum // length of the (CSV) string. // MaxLimit *float64 `json:"maxLimit,omitempty" yaml:"maxLimit,omitempty"` // Minimum possible value of this variable. // MinLimit *float64 `json:"minLimit,omitempty" yaml:"minLimit,omitempty"` // Flag indicating if this variable supports monitoring. // SupportsMonitoring bool `json:"supportsMonitoring" yaml:"supportsMonitoring"` // Unit of the variable. When the transmitted value has a unit, this field SHALL // be included. // Unit *string `json:"unit,omitempty" yaml:"unit,omitempty"` // Allowed values when variable is Option/Member/SequenceList. // // * OptionList: The (Actual) Variable value must be a single value from the // reported (CSV) enumeration list. // // * MemberList: The (Actual) Variable value may be an (unordered) (sub-)set of // the reported (CSV) valid values list. // // * SequenceList: The (Actual) Variable value may be an ordered (priority, etc) // (sub-)set of the reported (CSV) valid values. // // This is a comma separated list. // // The Configuration Variable // <<configkey-configuration-value-size,ConfigurationValueSize>> can // be used to limit SetVariableData.attributeValue and // VariableCharacteristics.valueList. The max size of these values will always // remain equal. // // ValuesList *string `json:"valuesList,omitempty" yaml:"valuesList,omitempty"` }
Fixed read-only parameters of a variable.
func (*VariableCharacteristicsType) UnmarshalJSON ¶
func (j *VariableCharacteristicsType) 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.