models

Documentation

Index

• type BaseReading
• type BinaryReading
• type Event
• type Reading
• type SimpleReading

Types

type BaseReading

type BaseReading struct {
	Id         string
	Pushed     int64 // When the data was pushed out of EdgeX (0 - not pushed yet)
	Created    int64 // When the reading was created
	Origin     int64
	Modified   int64
	DeviceName string
	Name       string
	Labels     []string // Custom labels assigned to a reading, added in the APIv2 specification.
	// contains filtered or unexported fields
}

BaseReading contains data that was gathered from a device. Readings returned will all inherit from BaseReading but their concrete types will be either SimpleReading or BinaryReading, potentially interleaved in the APIv2 specification.

type BinaryReading

type BinaryReading struct {
	BaseReading `json:",inline"`
	BinaryValue []byte // Binary data payload
	MediaType   string // indicates what the content type of the binaryValue property is
}

An event reading for a binary data type BinaryReading object in the APIv2 specification.

type Event

type Event struct {
	CorrelationId string
	Checksum      string
	Id            string    // Id uniquely identifies an event, for example a UUID
	Pushed        int64     // Pushed is a timestamp indicating when the event was exported. If unexported, the value is zero.
	DeviceName    string    // DeviceName identifies the source of the event
	Created       int64     // Created is a timestamp indicating when the event was created.
	Modified      int64     // Modified is a timestamp indicating when the event was last modified.
	Origin        int64     // Origin is a timestamp that can communicate the time of the original reading, prior to event creation
	Readings      []Reading // Readings will contain zero to many entries for the associated readings of a given event.
	// contains filtered or unexported fields
}

Event represents a single measurable event read from a device

type Reading

type Reading interface {
	// contains filtered or unexported methods
}

a abstract interface to be implemented by BinaryReading/SimpleReading

type SimpleReading

type SimpleReading struct {
	BaseReading   `json:",inline"`
	Value         string // Device sensor data value
	ValueType     string // Indicates the datatype of the value property
	FloatEncoding string // Indicates how a float value is encoded
}

An event reading for a simple data type SimpleReading object in the APIv2 specification.