openadr

package module

Go to main page

Versions in this module

v0

v0.4.0

Oct 13, 2026

Changes in this version

+ var ErrClosed = errors.New("openadr: closed")

+ var ErrConfiguration = errors.New("openadr: invalid configuration")

+ var ErrInvalid = errors.New("openadr: invalid")

+ var ErrNotImplemented = errors.New("openadr: not implemented")

+ var ErrProtocol = errors.New("openadr: protocol error")

+ var ErrServer = errors.New("openadr: server error")

+ var ErrTimeout = errors.New("openadr: timeout")

+ var ErrTooManyRequests = errors.New("openadr: too many requests")

+ var ErrUnavailable = errors.New("openadr: unavailable")

type Error

+ RetryAfter time.Duration

type ValidationError

+ func (e *ValidationError) Is(target error) bool

v0.2.0

Oct 13, 2026

Changes in this version

+ type Mechanism string

+ const MechanismWebSocket

+ const MechanismWebhook

type Notification

+ ID string

type Notifiers

+ WebSocket bool

type ObjectOperation

+ Mechanism Mechanism

type ObjectType

+ const ObjectResourceGroup

+ type ResourceGroup struct

+ Attributes []ValuesMap

+ Children []ResourceGroupChild

+ Name string

+ Targets []string

+ func (g ResourceGroup) Validate() error

+ type ResourceGroupChild struct

+ ID string

+ Type ResourceGroupChildType

+ type ResourceGroupChildType string

+ const ChildResource

+ const ChildResourceGroup

v0.1.0

Oct 12, 2026

Changes in this version

+ const AggregatedReport

+ const MQTTAnonymous

+ const MQTTBearerToken

+ const MQTTCertificate

+ var ErrBadRequest = errors.New("openadr: bad request")

+ var ErrConflict = errors.New("openadr: conflict")

+ var ErrForbidden = errors.New("openadr: forbidden")

+ var ErrNotFound = errors.New("openadr: not found")

+ var ErrUnauthorized = errors.New("openadr: unauthorized")

+ var Infinite = Duration

+ func ValidID(id string) bool

+ type Duration struct

+ Days int64

+ Hours int64

+ Minutes int64

+ Months int64

+ Negative bool

+ Seconds float64

+ Weeks int64

+ Years int64

+ func DurationOf(td time.Duration) Duration

+ func ParseDuration(s string) (Duration, error)

+ func (d Duration) AddTo(t time.Time) time.Time

+ func (d Duration) IsInfinite() bool

+ func (d Duration) IsZero() bool

+ func (d Duration) String() string

+ func (d Duration) TimeDuration() (time.Duration, bool)

+ type Error struct

+ Method string

+ Path string

+ Problem Problem

+ StatusCode int

+ func (e *Error) Error() string

+ func (e *Error) Is(target error) bool

+ type Event struct

+ Duration *Duration

+ IntervalPeriod *IntervalPeriod

+ Intervals []Interval

+ Name string

+ PayloadDescriptors []EventPayloadDescriptor

+ Priority *int

+ ProgramID string

+ ReportDescriptors []ReportDescriptor

+ Targets []string

+ func (e Event) Validate() error

+ type EventPayloadDescriptor struct

+ Currency string

+ PayloadType string

+ Units string

+ type Interval struct

+ ID int32

+ IntervalPeriod *IntervalPeriod

+ Payloads []ValuesMap

+ type IntervalPeriod struct

+ Duration *Duration

+ RandomizeStart *Duration

+ Start *time.Time

+ type MQTTAuthentication struct

+ CACert string

+ ClientCert string

+ ClientKey string

+ Method string

+ Username string

+ type MQTTBinding struct

+ Authentication MQTTAuthentication

+ Serialization string

+ URIs []string

+ type Metadata struct

+ Created time.Time

+ ID string

+ Modified time.Time

+ type Notification struct

+ Object any

+ ObjectType ObjectType

+ Operation Operation

+ Targets []string

+ type Notifiers struct

+ MQTT *MQTTBinding

+ Webhook bool

+ type ObjectOperation struct

+ BearerToken string

+ CallbackURL string

+ Objects []ObjectType

+ Operations []Operation

+ type ObjectType string

+ const ObjectEvent

+ const ObjectProgram

+ const ObjectReport

+ const ObjectResource

+ const ObjectSubscription

+ const ObjectVEN

+ type Operation string

+ const OperationCreate

+ const OperationDelete

+ const OperationRead

+ const OperationUpdate

+ type PayloadDescriptor interface

+ type Point struct

+ X float64

+ Y float64

+ type Problem struct

+ Detail string

+ Instance string

+ Status int

+ Title string

+ Type string

+ type Program struct

+ Attributes []ValuesMap

+ Descriptions []ProgramDescription

+ IntervalPeriod *IntervalPeriod

+ Name string

+ PayloadDescriptors []PayloadDescriptor

+ Targets []string

+ func (p Program) Validate() error

+ type ProgramDescription struct

+ URL string

+ type Report struct

+ ClientID string

+ ClientName string

+ EventID string

+ Name string

+ PayloadDescriptors []ReportPayloadDescriptor

+ Resources []ReportResource

+ func (r Report) Validate() error

+ type ReportDescriptor struct

+ Aggregate bool

+ Frequency int32

+ Historical bool

+ NumIntervals int32

+ PayloadType string

+ ReadingType string

+ Repeat int32

+ ReportIntervals ReportIntervals

+ StartInterval int32

+ Targets []string

+ Units string

+ func NewReportDescriptor(payloadType string) ReportDescriptor

+ type ReportIntervals string

+ const ReportIntervalsIntervals

+ const ReportIntervalsOpen

+ const ReportIntervalsSubIntervals

+ type ReportPayloadDescriptor struct

+ Accuracy *float64

+ Confidence *int

+ PayloadType string

+ ReadingType string

+ Units string

+ type ReportResource struct

+ IntervalPeriod *IntervalPeriod

+ Intervals []Interval

+ ResourceName string

+ type Resource struct

+ Attributes []ValuesMap

+ ClientID string

+ Name string

+ Targets []string

+ VENID string

+ func (r Resource) Validate() error

+ type Subscription struct

+ ClientID string

+ ClientName string

+ ObjectOperations []ObjectOperation

+ ProgramID string

+ Targets []string

+ func (s Subscription) Validate() error

+ type Topics struct

+ All string

+ Create string

+ Delete string

+ Update string

+ type VEN struct

+ Attributes []ValuesMap

+ ClientID string

+ Name string

+ Targets []string

+ func (v VEN) Validate() error

+ type ValidationError struct

+ Field string

+ Reason string

+ func (e *ValidationError) Error() string

+ type Value struct

+ func Bool(b bool) Value

+ func Number(n float64) Value

+ func PointValue(x, y float64) Value

+ func String(s string) Value

+ func (v Value) Bool() (bool, bool)

+ func (v Value) Kind() ValueKind

+ func (v Value) Number() (float64, bool)

+ func (v Value) Point() (Point, bool)

+ func (v Value) String() string

+ func (v Value) Text() (string, bool)

+ type ValueKind uint8

+ const KindBool

+ const KindNumber

+ const KindPoint

+ const KindString

+ func (k ValueKind) String() string

+ type ValuesMap struct

+ Type string

+ Values []Value

+ type Version string

+ const Version310

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