models

type Action struct {
	Path      string     `json:"path" yaml:"path,omitempty"`           // path used by service for action on a device or sensor
	Responses []Response `json:"responses" yaml:"responses,omitempty"` // responses from get or put requests to service
	URL       string     `json:"url,omitempty" yaml:"url,omitempty"`   // url for requests from command service
}

type ActionType string

type Addressable struct {
	BaseObject
	Id          string `json:"id"`
	Name        string `json:"name"`
	Protocol    string `json:"protocol"`    // Protocol for the address (HTTP/TCP)
	HTTPMethod  string `json:"method"`      // Method for connecting (i.e. POST)
	Address     string `json:"address"`     // Address of the addressable
	Port        int    `json:"port"`        // Port for the address
	Path        string `json:"path"`        // Path for callbacks
	Publisher   string `json:"publisher"`   // For message bus protocols
	User        string `json:"user"`        // User id for authentication
	Password    string `json:"password"`    // Password of the user for authentication for the addressable
	Topic       string `json:"topic"`       // Topic for message bus addressables
	Certificate string `json:"certificate"` // Certificate used for authentication
}

type AdminState string

type AutoEvent struct {
	// Frequency indicates how often the specific resource needs to be polled.
	// It represents as a duration string.
	// The format of this field is to be an unsigned integer followed by a unit which may be "ms", "s", "m" or "h"
	// representing milliseconds, seconds, minutes or hours. Eg, "100ms", "24h"
	Frequency string `json:"frequency,omitempty"`
	// OnChange indicates whether the device service will generate an event only,
	// if the reading value is different from the previous one.
	// If true, only generate events when readings change
	OnChange bool `json:"onChange,omitempty"`
	// Resource indicates the name of the resource in the device profile which describes the event to generate
	Resource string `json:"resource,omitempty"`
	// AverageValue selects if we are to calculate and send the average value for the frequency integration period from the selected resource
	AverageValue bool `json:"averageValue,omitempty"`
	// MinValue selects if we are to store and send the minimum value read for the frequency integration period from the selected resource
	MinValue bool `json:"minValue,omitempty"`
	// MaxValue selects if we are to store and send the maximum value read for the frequency integration period from the selected resource
	MaxValue bool `json:"maxValue,omitempty"`
	// Export indicates whether the auto-generated event should be exported automatically without an associated rule
	Export bool `json:"export,omitempty"`
}

type BaseObject struct {
	Created  int64 `json:"created,omitempty" yaml:"created,omitempty"`
	Modified int64 `json:"modified,omitempty" yaml:"modified,omitempty"`
	Origin   int64 `json:"origin,omitempty" yaml:"origin,omitempty"`
}

type CallbackAlert struct {
	ActionType ActionType `json:"type"`
	Id         string     `json:"id"`
}

type Channel struct {
	Type          ChannelType `json:"type,omitempty"`
	MailAddresses []string    `json:"mailAddresses,omitempty"`
	Url           string      `json:"url,omitempty"`
}

type ChannelType string

type Command struct {
	BaseObject `yaml:",inline"`
	Id         string `json:"id" yaml:"id,omitempty"`
	Name       string `json:"name" yaml:"name,omitempty"` // Command name (unique on the profile)
	Get        *Get   `json:"get" yaml:"get,omitempty"`   // Get Command
	Put        *Put   `json:"put" yaml:"put,omitempty"`   // Put Command
}

type CommandResponse struct {
	Id             string         `json:"id"`
	Name           string         `json:"name"`           // Unique name for identifying a device
	AdminState     AdminState     `json:"adminState"`     // Admin state (locked/unlocked)
	OperatingState OperatingState `json:"operatingState"` // Operating state (enabled/disabled)
	LastConnected  int64          `json:"lastConnected"`  // Time (milliseconds) that the device last provided any feedback or responded to any request
	LastReported   int64          `json:"lastReported"`   // Time (milliseconds) that the device reported data to the core microservice
	Labels         []string       `json:"labels"`         // Other labels applied to the device to help with searching
	Location       interface{}    `json:"location"`       // Device service specific location (interface{} is an empty interface so it can be anything)
	Commands       []Command      `json:"commands"`       // Associated Device Profile - Describes the device
}

type DescribedObject struct {
	BaseObject  `yaml:",inline"`
	Description string `json:"description" yaml:"description,omitempty"`
}

type Device struct {
	DescribedObject
	Id             string                        `json:"id"`
	Name           string                        `json:"name"`           // Unique name for identifying a device
	AdminState     AdminState                    `json:"adminState"`     // Admin state (locked/unlocked)
	OperatingState OperatingState                `json:"operatingState"` // Operating state (enabled/disabled)
	Protocols      map[string]ProtocolProperties `json:"protocols"`      // A map of supported protocols for the given device
	LastConnected  int64                         `json:"lastConnected"`  // Time (milliseconds) that the device last provided any feedback or responded to any request
	LastReported   int64                         `json:"lastReported"`   // Time (milliseconds) that the device reported data to the core microservice
	Labels         []string                      `json:"labels"`         // Other labels applied to the device to help with searching
	Location       interface{}                   `json:"location"`       // Device service specific location (interface{} is an empty interface so it can be anything)
	Service        DeviceService                 `json:"service"`        // Associated Device Service - One per device
	Profile        DeviceProfile                 `json:"profile"`        // Associated Device Profile - Describes the device
	AutoEvents     []AutoEvent                   `json:"autoEvents"`     // A list of auto-generated events coming from the device
}

type DeviceProfile struct {
	DescribedObject `yaml:",inline"`
	Id              string            `json:"id" yaml:"id,omitempty"`
	Name            string            `json:"name" yaml:"name,omitempty"`                 // Non-database identifier (must be unique)
	Manufacturer    string            `json:"manufacturer" yaml:"manufacturer,omitempty"` // Manufacturer of the device
	Model           string            `json:"model" yaml:"model,omitempty"`               // Model of the device
	IsOfficial      bool              `json:"isOfficial" yaml:"isOfficial,omitempty"`     // Whether the device profile is an official profile or a user defined profile
	Checksum        string            `json:"checksum" yaml:"checksum,omitempty"`         // Checksum of the device profile used to determine if the profile is official
	Labels          []string          `json:"labels" yaml:"labels,flow,omitempty"`        // Labels used to search for groups of profiles
	DeviceResources []DeviceResource  `json:"deviceResources" yaml:"deviceResources,omitempty"`
	Resources       []ProfileResource `json:"resources" yaml:"resources,omitempty"`
	Commands        []Command         `json:"commands" yaml:"commands,omitempty"` // List of commands to Get/Put information for devices associated with this profile
}

type DeviceResource struct {
	Description string                 `json:"description" yaml:"description,omitempty"`
	Name        string                 `json:"name" yaml:"name,omitempty"`
	Tag         string                 `json:"tag" yaml:"tag,omitempty"`
	Properties  ProfileProperty        `json:"properties" yaml:"properties"`
	Attributes  map[string]interface{} `json:"attributes" yaml:"attributes,omitempty"`
}

type DeviceService struct {
	Service
	AdminState AdminState `json:"adminState"` // Device Service Admin State
}

type EncryptionDetails struct {
	Algo       string `json:"encryptionAlgorithm,omitempty"`
	Key        string `json:"encryptionKey,omitempty"`
	InitVector string `json:"initializingVector,omitempty"`
}

type Event struct {
	ID         string    `json:"id" codec:"omitempty"`
	Pushed     int64     `json:"pushed" codec:"omitempty"`
	Device     string    `json:"device" codec:"omitempty"` // Device identifier (name or id)
	Created    int64     `json:"created" codec:"omitempty"`
	Modified   int64     `json:"modified" codec:"omitempty"`
	Origin     int64     `json:"origin" codec:"omitempty"`
	Restricted bool      `json:"restricted" codec:"omitempty"`
	Readings   []Reading `json:"readings" codec:"omitempty"` // List of readings
}

type Filter struct {
	DeviceIDs          []string `json:"deviceIdentifiers,omitempty"`
	ValueDescriptorIDs []string `json:"valueDescriptorIdentifiers,omitempty"`
}

type Get struct {
	Action `yaml:",inline"`
}

type Interval struct {
	ID        string `json:"id"`
	Created   int64  `json:"created"`
	Modified  int64  `json:"modified"`
	Origin    int64  `json:"origin"`    // not currently used reserved for interval origin source
	Name      string `json:"name"`      // non-database identifier for a shcedule (*must be quitue)
	Start     string `json:"start"`     // Start time i ISO 8601 format YYYYMMDD'T'HHmmss 	@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyymmdd'T'HHmmss")
	End       string `json:"end"`       // Start time i ISO 8601 format YYYYMMDD'T'HHmmss 	@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyymmdd'T'HHmmss")
	Frequency string `json:"frequency"` // how frequently should the event occur according ISO 8601
	Cron      string `json:"cron"`      // cron styled regular expression indicating how often the action under interval should occur.  Use either runOnce, frequency or cron and not all.
	RunOnce   bool   `json:"runOnce"`   // boolean indicating that this interval runs one time - at the time indicated by the start
}

type IntervalAction struct {
	ID         string `json:"id"`
	Created    int64  `json:"created"`
	Modified   int64  `json:"modified"`
	Origin     int64  `json:"origin"`
	Name       string `json:"name"`
	Interval   string `json:"interval"`
	Parameters string `json:"parameters"`
	Target     string `json:"target"`
	Protocol   string `json:"protocol"`
	HTTPMethod string `json:"httpMethod"`
	Address    string `json:"address"`
	Port       int    `json:"port"`
	Path       string `json:"path"`
	Publisher  string `json:"publisher"`
	User       string `json:"user"`
	Password   string `json:"password"`
	Topic      string `json:"topic"`
}

type LogEntry struct {
	Level         string        `bson:"logLevel" json:"logLevel"`
	Args          []interface{} `bson:"args" json:"args"`
	OriginService string        `bson:"originService" json:"originService"`
	Message       string        `bson:"message" json:"message"`
	Created       int64         `bson:"created" json:"created"`
}

type Notification struct {
	BaseObject
	ID          string                `json:"id,omitempty"`
	Slug        string                `json:"slug,omitempty"`
	Sender      string                `json:"sender,omitempty"`
	Category    NotificationsCategory `json:"category,omitempty"`
	Severity    NotificationsSeverity `json:"severity,omitempty"`
	Content     string                `json:"content,omitempty"`
	Description string                `json:"description,omitempty"`
	Status      NotificationsStatus   `json:"status,omitempty"`
	Labels      []string              `json:"labels,omitempty"`
	ContentType string                `json:"contenttype,omitempty"`
}

type NotificationsCategory string

type NotificationsSeverity string

type NotificationsStatus string

type NotifyUpdate struct {
	Name      string `json:"name"`
	Operation string `json:"operation"`
}

type OperatingState string

type Operation struct {
	Action   string   `bson:"action" json:"action,omitempty"`
	Services []string `bson:"services,omitempty" json:"services,omitempty"`
}

type ProfileProperty struct {
	Value     PropertyValue `json:"value"`
	Units     Units         `json:"units" yaml:"units,omitempty"`
	MediaType string        `json:"mediaType" yaml:"mediaType,omitempty"`
}

type ProfileResource struct {
	Name string              `json:"name" yaml:"name,omitempty"`
	Get  []ResourceOperation `json:"get" yaml:"get,omitempty"`
	Set  []ResourceOperation `json:"set" yaml:"set,omitempty"`
}

type PropertyValue struct {
	Type          string `json:"type" yaml:"type,omitempty"`                 // ValueDescriptor Type of property after transformations
	ReadWrite     string `json:"readWrite" yaml:"readWrite,omitempty"`       // Read/Write Permissions set for this property
	Minimum       string `json:"minimum" yaml:"minimum,omitempty"`           // Minimum value that can be get/set from this property
	Maximum       string `json:"maximum" yaml:"maximum,omitempty"`           // Maximum value that can be get/set from this property
	DefaultValue  string `json:"defaultValue" yaml:"defaultValue,omitempty"` // Default value set to this property if no argument is passed
	Size          string `json:"size" yaml:"size,omitempty"`                 // Size of this property in its type  (i.e. bytes for numeric types, characters for string types)
	Mask          string `json:"mask" yaml:"mask,omitempty"`                 // Mask to be applied prior to get/set of property
	Shift         string `json:"shift" yaml:"shift,omitempty"`               // Shift to be applied after masking, prior to get/set of property
	Scale         string `json:"scale" yaml:"scale,omitempty"`               // Multiplicative factor to be applied after shifting, prior to get/set of property
	Offset        string `json:"offset" yaml:"offset,omitempty"`             // Additive factor to be applied after multiplying, prior to get/set of property
	Base          string `json:"base" yaml:"base,omitempty"`                 // Base for property to be applied to, leave 0 for no power operation (i.e. base ^ property: 2 ^ 10)
	Assertion     string `json:"assertion" yaml:"assertion,omitempty"`       // Required value of the property, set for checking error state.  Failing an assertion condition will mark the device with an error state
	Precision     string `json:"precision" yaml:"precision,omitempty"`
	FloatEncoding string `json:"floatEncoding" yaml:"floatEncoding,omitempty"` // FloatEncoding indicates the representation of floating value of reading.  It should be 'Base64' or 'eNotation'
}

type ProtocolProperties map[string]string

type ProvisionWatcher struct {
	BaseObject
	Id             string            `json:"id"`
	Name           string            `json:"name"`           // unique name and identifier of the addressable
	Identifiers    map[string]string `json:"identifiers"`    // set of key value pairs that identify type of of address (MAC, HTTP,...) and address to watch for (00-05-1B-A1-99-99, 10.0.0.1,...)
	Profile        DeviceProfile     `json:"profile"`        // device profile that should be applied to the devices available at the identifier addresses
	Service        DeviceService     `json:"service"`        // device service that owns the watcher
	OperatingState OperatingState    `json:"operatingState"` // operational state - either enabled or disabled
}

type Put struct {
	Action         `yaml:",inline"`
	ParameterNames []string `json:"parameterNames" yaml:"parameterNames,omitempty"`
}

type Reading struct {
	Id          string `json:"id"`
	Pushed      int64  `json:"pushed"`  // When the data was pushed out of EdgeX (0 - not pushed yet)
	Created     int64  `json:"created"` // When the reading was created
	Origin      int64  `json:"origin"`
	Modified    int64  `json:"modified"`
	Device      string `json:"device"`
	Name        string `json:"name"`
	Value       string `json:"value"`       // Device sensor data value
	BinaryValue []byte `json:"binaryValue"` // Binary data payload
	AvgValue    string `json:"avgValue"`    // Device calculated average value
	MinValue    string `json:"minValue"`    // Device minimum sensor data value
	MaxValue    string `json:"maxValue"`    // Device maximum sensor data value
}

type Registration struct {
	ID          string            `json:"id"`
	Created     int64             `json:"created"`
	Modified    int64             `json:"modified"`
	Origin      int64             `json:"origin"`
	Name        string            `json:"name"`
	Addressable Addressable       `json:"addressable"`
	Format      string            `json:"format"`
	Filter      Filter            `json:"filter"`
	Encryption  EncryptionDetails `json:"encryption"`
	Compression string            `json:"compression"`
	Enable      bool              `json:"enable"`
	Destination string            `json:"destination"`
}

type ResourceOperation struct {
	Index     string            `json:"index" yaml:"index,omitempty"`
	Operation string            `json:"operation" yaml:"operation,omitempty"`
	Object    string            `json:"object" yaml:"object,omitempty"`
	Parameter string            `json:"parameter" yaml:"parameter,omitempty"`
	Resource  string            `json:"resource" yaml:"resource,omitempty"`
	Secondary []string          `json:"secondary" yaml:"secondary,omitempty"`
	Mappings  map[string]string `json:"mappings" yaml:"mappings,omitempty"`
}

type Response struct {
	Code           string   `json:"code" yaml:"code,omitempty"`
	Description    string   `json:"description" yaml:"description,omitempty"`
	ExpectedValues []string `json:"expectedValues" yaml:"expectedValues,omitempty"`
}

type Service struct {
	DescribedObject
	Id             string         `json:"id"`
	Name           string         `json:"name"`           // time in milliseconds that the device last provided any feedback or responded to any request
	LastConnected  int64          `json:"lastConnected"`  // time in milliseconds that the device last reported data to the core
	LastReported   int64          `json:"lastReported"`   // operational state - either enabled or disabled
	OperatingState OperatingState `json:"operatingState"` // operational state - ether enabled or disableddc
	Labels         []string       `json:"labels"`         // tags or other labels applied to the device service for search or other identification needs
	Addressable    Addressable    `json:"addressable"`    // address (MQTT topic, HTTP address, serial bus, etc.) for reaching the service
}

type Subscription struct {
	BaseObject
	ID                   string                  `json:"id"`
	Slug                 string                  `json:"slug,omitempty"`
	Receiver             string                  `json:"receiver,omitempty"`
	Description          string                  `json:"description,omitempty"`
	SubscribedCategories []NotificationsCategory `json:"subscribedCategories,omitempty"`
	SubscribedLabels     []string                `json:"subscribedLabels,omitempty"`
	Channels             []Channel               `json:"channels,omitempty"`
}

type Transmission struct {
	BaseObject
	ID           string               `json:"id"`
	Notification Notification         `json:"notification"`
	Receiver     string               `json:"receiver,omitempty"`
	Channel      Channel              `json:"channel,omitempty"`
	Status       TransmissionStatus   `json:"status,omitempty"`
	ResendCount  int                  `json:"resendcount"`
	Records      []TransmissionRecord `json:"records,omitempty"`
}

type TransmissionRecord struct {
	Status   TransmissionStatus `json:"status"`
	Response string             `json:"response"`
	Sent     int64              `json:"sent"`
}

type TransmissionStatus string

type Units struct {
	Type         string `json:"type" yaml:"type,omitempty"`
	ReadWrite    string `json:"readWrite" yaml:"readWrite,omitempty"`
	DefaultValue string `json:"defaultValue" yaml:"defaultValue,omitempty"`
}