xml

Documentation

Overview

xml implements data structures and functions for parsing, working with and exporting SunSpec data in XML exchange format. The XML schema in use is described in the SunSpec Data Exchange Specification version 1.2, particularly on page 11. Note that the parser in this package is case-sensitive even though some examples in the specification use `sunSpecData` instead of `SunSpecData` as the top-level tag name (this package assumes the latter). http://sunspec.org/wp-content/uploads/2015/06/SunSpec-Model-Data-Exchange-12021.pdf

Index

• Variables
• func Open(e *DataElement) (sunspec.Array, error)
• func OpenDevice(dx *DeviceElement) (sunspec.Device, error)
• type DataElement
  • func CopyArray(a sunspec.Array) (sunspec.Array, *DataElement)
• type DeviceElement
  • func CopyDevice(d sunspec.Device) (sunspec.Device, *DeviceElement)
• type ModelElement
• type PointElement

Variables

var ErrEmptyValue = errors.New("empty value")

var ErrNoSuchElement = errors.New("no such element")

var ErrTooManyErrors = errors.New("too many errors")

Functions

func Open

func Open(e *DataElement) (sunspec.Array, error)

Open open a new sunspec.Array which is populated from the specified DataElement.

func OpenDevice

func OpenDevice(dx *DeviceElement) (sunspec.Device, error)

OpenDevice opens a new sunspec.Device which is populated from the specified DeviceElement.

Types

type DataElement

type DataElement struct {
	XMLName xml.Name         `xml:"SunSpecData"`
	Version string           `xml:"v,attr"`
	Devices []*DeviceElement `xml:"d"`
}

func CopyArray

func CopyArray(a sunspec.Array) (sunspec.Array, *DataElement)

CopyArray copies an existing SunSpec Array into a new SunSpec Array and an XML DataElement. Operations on the returned SunSpec Array edit the returned DataElement.

type DeviceElement

type DeviceElement struct {
	XMLName       xml.Name        `xml:"d"`
	CorrelationId uint32          `xml:"cid,attr,omitempty"`
	Id            string          `xml:"id,attr,omitempty"`
	Namespace     string          `xml:"ns,attr,omitempty"`
	LoggerId      string          `xml:"lid,attr,omitempty"`
	Manufacturer  string          `xml:"man,attr,omitempty"`
	Model         string          `xml:"mod,attr,omitempty"`
	Serial        string          `xml:"sn,attr,omitempty"`
	Timestamp     *time.Time      `xml:"t,attr,omitempty"`
	Models        []*ModelElement `xml:"m"`
}

func CopyDevice

func CopyDevice(d sunspec.Device) (sunspec.Device, *DeviceElement)

CopyDevice copies an existing SunSpec Device into a new SunSpec Device and an XML DeviceElement. Operations on the returned SunSpec Device edit the returned DeviceElement.

type ModelElement

type ModelElement struct {
	XMLName   xml.Name        `xml:"m"`
	Id        sunspec.ModelId `xml:"id,attr"`
	Namespace string          `xml:"ns,attr,omitempty"`
	Index     uint32          `xml:"x,attr,omitempty"`
	Points    []*PointElement `xml:"p"`
}

Note that we can use omitempty on Index because indices in SunSpec XML start at 1. Therefore an index of 0 (unused) will not be serialised.

type PointElement

type PointElement struct {
	XMLName     xml.Name   `xml:"p"`
	Description string     `xml:"d,attr,omitempty"`
	Id          string     `xml:"id,attr"`
	ScaleFactor int16      `xml:"sf,attr,omitempty"`
	Timestamp   *time.Time `xml:"t,attr,omitempty"`
	Unit        string     `xml:"u,attr,omitempty"`
	Index       uint32     `xml:"x,attr,omitempty"`
	Value       string     `xml:",chardata"`
}

Note that we can use omitempty on ScaleFactor because a scale factor of 0 means no scaling. Therefore an sf of 0 is meaningless anyway.