models

type Addressable struct {
	Created    int64         `bson:"created"`
	Modified   int64         `bson:"modified"`
	Origin     int64         `bson:"origin"`
	Id         bson.ObjectId `bson:"_id,omitempty"`
	Uuid       string        `bson:"uuid,omitempty"`
	Name       string        `bson:"name"`
	Protocol   string        `bson:"protocol"`  // Protocol for the address (HTTP/TCP)
	HTTPMethod string        `bson:"method"`    // Method for connecting (i.e. POST)
	Address    string        `bson:"address"`   // Address of the addressable
	Port       int           `bson:"port"`      // Port for the address
	Path       string        `bson:"path"`      // Path for callbacks
	Publisher  string        `bson:"publisher"` // For message bus protocols
	User       string        `bson:"user"`      // User id for authentication
	Password   string        `bson:"password"`  // Password of the user for authentication for the addressable
	Topic      string        `bson:"topic"`     // Topic for message bus addressables
}

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

type Command struct {
	Created  int64         `bson:"created"`
	Modified int64         `bson:"modified"`
	Origin   int64         `bson:"origin"`
	Id       bson.ObjectId `bson:"_id,omitempty"`
	Uuid     string        `bson:"uuid,omitempty"`
	Name     string        `bson:"name"`
	Get      Get           `bson:"get"`
	Put      Put           `bson:"put"`
}

type Device struct {
	Created        int64                   `bson:"created"`
	Modified       int64                   `bson:"modified"`
	Origin         int64                   `bson:"origin"`
	Description    string                  `bson:"description"`
	Id             bson.ObjectId           `bson:"_id,omitempty"`
	Uuid           string                  `bson:"uuid,omitempty"`
	Protocols      string                  `bson:"protocols,omitempty"`  //Contains a JSON representation of the supported protocols for the device
	AutoEvents     string                  `bson:"autoEvents,omitempty"` //Contains a JSON representation of the device's auto-generated events
	Name           string                  `bson:"name"`                 // Unique name for identifying a device
	AdminState     contract.AdminState     `bson:"adminState"`           // Admin state (locked/unlocked)
	OperatingState contract.OperatingState `bson:"operatingState"`       // Operating state (enabled/disabled)
	LastConnected  int64                   `bson:"lastConnected"`        // Time (milliseconds) that the device last provided any feedback or responded to any request
	LastReported   int64                   `bson:"lastReported"`         // Time (milliseconds) that the device reported data to the core microservice
	Labels         []string                `bson:"labels"`               // Other labels applied to the device to help with searching
	Location       interface{}             `bson:"location"`             // Device service specific location (interface{} is an empty interface so it can be anything)
	Service        mgo.DBRef               `bson:"service"`              // Associated Device Service - One per device
	Profile        mgo.DBRef               `bson:"profile"`              // Associated Device Profile - Describes the device
	ProfileName    string                  `bson:"profileName"`          // Associated Device Profile Name
}

type DeviceProfile struct {
	Created         int64             `bson:"created"`
	Modified        int64             `bson:"modified"`
	Origin          int64             `bson:"origin"`
	Description     string            `bson:"description"`
	Id              bson.ObjectId     `bson:"_id,omitempty"`
	Uuid            string            `bson:"uuid,omitempty"`
	Name            string            `bson:"name"`
	Manufacturer    string            `bson:"manufacturer"`
	Model           string            `bson:"model"`
	Labels          []string          `bson:"labels"`
	DeviceResources []DeviceResource  `bson:"deviceResources"`
	DeviceCommands  []ProfileResource `bson:"resources"`
	CoreCommands    []mgo.DBRef       `bson:"commands"`
}

type DeviceReport struct {
	Created  int64         `bson:"created"`
	Modified int64         `bson:"modified"`
	Origin   int64         `bson:"origin"`
	Id       bson.ObjectId `bson:"_id,omitempty"`
	Uuid     string        `bson:"uuid,omitempty"`
	Name     string        `bson:"name"`     // non-database identifier for a device report - must be unique
	Device   string        `bson:"device"`   // associated device name - should be a valid and unique device name
	Action   string        `bson:"action"`   // associated interval action name - should be a valid and unique interval action name
	Expected []string      `bson:"expected"` // array of value descriptor names describing the types of data captured in the report
}

type DeviceResource struct {
	Description string            `bson:"description"`
	Name        string            `bson:"name"`
	Tag         string            `bson:"tag"`
	Properties  ProfileProperty   `bson:"properties"`
	Attributes  map[string]string `bson:"attributes"`
}

type DeviceService struct {
	Created        int64                   `bson:"created"`
	Modified       int64                   `bson:"modified"`
	Origin         int64                   `bson:"origin"`
	Description    string                  `bson:"description"`
	Id             bson.ObjectId           `bson:"_id,omitempty"`
	Uuid           string                  `bson:"uuid,omitempty"`
	Name           string                  `bson:"name"`           // time in milliseconds that the device last provided any feedback or responded to any request
	LastConnected  int64                   `bson:"lastConnected"`  // time in milliseconds that the device last reported data to the core
	LastReported   int64                   `bson:"lastReported"`   // operational state - either enabled or disabled
	OperatingState contract.OperatingState `bson:"operatingState"` // operational state - ether enabled or disableddc
	Labels         []string                `bson:"labels"`         // tags or other labels applied to the device service for search or other identification needs
	Addressable    mgo.DBRef               `bson:"addressable"`    // address (MQTT topic, HTTP address, serial bus, etc.) for reaching the service
	AdminState     contract.AdminState     `bson:"adminState"`     // Device Service Admin State
}

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

type Event struct {
	Created  int64         `bson:"created"`
	Modified int64         `bson:"modified"`
	Origin   int64         `bson:"origin"`
	Id       bson.ObjectId `bson:"_id,omitempty"`
	Uuid     string        `bson:"uuid,omitempty"`
	Pushed   int64         `bson:"pushed"`
	Device   string        `bson:"device"`             // Device identifier (name or id)
	Readings []mgo.DBRef   `bson:"readings,omitempty"` // List of readings
	Checksum string        `bson:"checksum,omitempty"` // checksum used to identify events
}

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

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

type Interval struct {
	Created   int64         `bson:"created"`
	Modified  int64         `bson:"modified"`
	Origin    int64         `bson:"origin"`
	Id        bson.ObjectId `bson:"_id,omitempty"`
	Uuid      string        `bson:"uuid,omitempty"`
	Name      string        `bson:"name"`
	Start     string        `bson:"start"`
	End       string        `bson:"end"`
	Frequency string        `bson:"frequency"`
	Cron      string        `bson:"cron,omitempty"`
	RunOnce   bool          `bson:"runonce"`
}

type IntervalAction struct {
	Created    int64         `bson:"created"`
	Modified   int64         `bson:"modified"`
	Origin     int64         `bson:"origin"`
	Id         bson.ObjectId `bson:"_id,omitempty"`
	Uuid       string        `bson:"uuid,omitempty"`
	Name       string        `bson:"name"`
	Interval   string        `bson:"interval"`
	Parameters string        `bson:"parameters"`
	Target     string        `bson:"target"`
	Protocol   string        `bson:"protocol"`
	HTTPMethod string        `bson:"httpMethod"`
	Address    string        `bson:"address"`
	Port       int           `bson:"port"`
	Path       string        `bson:"path"`
	Publisher  string        `bson:"publisher"`
	User       string        `bson:"user"`
	Password   string        `bson:"password"`
	Topic      string        `bson:"topic"`
}

type Notification struct {
	Created     int64                          `bson:"created"`
	Modified    int64                          `bson:"modified"`
	Origin      int64                          `bson:"origin"`
	Id          bson.ObjectId                  `bson:"_id,omitempty"`
	Uuid        string                         `bson:"uuid,omitempty"`
	Slug        string                         `bson:"slug"`
	Sender      string                         `bson:"sender"`
	Category    contract.NotificationsCategory `bson:"category"`
	Severity    contract.NotificationsSeverity `bson:"severity"`
	Content     string                         `bson:"content"`
	Description string                         `bson:"description"`
	Status      contract.NotificationsStatus   `bson:"status"`
	Labels      []string                       `bson:"labels,omitempty"`
	ContentType string                         `bson:"contenttype"`
}

type ProfileProperty struct {
	Value PropertyValue `bson:"value"`
	Units Units         `bson:"units"`
}

type ProfileResource struct {
	Name string              `bson:"name"`
	Get  []ResourceOperation `bson:"get"`
	Set  []ResourceOperation `bson:"set"`
}

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

type ProvisionWatcher struct {
	Created        int64                   `bson:"created"`
	Modified       int64                   `bson:"modified"`
	Origin         int64                   `bson:"origin"`
	Id             bson.ObjectId           `bson:"_id,omitempty"`
	Uuid           string                  `bson:"uuid,omitempty"`
	Name           string                  `bson:"name"`           // unique name and identifier of the addressable
	Identifiers    map[string]string       `bson:"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        mgo.DBRef               `bson:"profile"`        // device profile that should be applied to the devices available at the identifier addresses
	Service        mgo.DBRef               `bson:"service"`        // device service that owns the watcher
	OperatingState contract.OperatingState `bson:"operatingState"` // operational state - either enabled or disabled
}

type Put struct {
	Path           string     `bson:"path"`      // path used by service for action on a device or sensor
	Responses      []Response `bson:"responses"` // responses from get or put requests to service
	URL            string     // url for requests from command service
	ParameterNames []string   `bson:"parameterNames"`
}

type Reading struct {
	Created  int64         `bson:"created"`
	Modified int64         `bson:"modified"`
	Origin   int64         `bson:"origin"`
	Id       bson.ObjectId `bson:"_id,omitempty"`
	Uuid     string        `bson:"uuid"`
	Pushed   int64         `bson:"pushed"` // When the data was pushed out of EdgeX (0 - not pushed yet)
	Device   string        `bson:"device"`
	Name     string        `bson:"name"`
	Value    string        `bson:"value"` // Device sensor data value
}

type Registration struct {
	Created     int64         `bson:"created"`
	Modified    int64         `bson:"modified"`
	Origin      int64         `bson:"origin"`
	ID          bson.ObjectId `bson:"_id,omitempty"`
	Uuid        string        `bson:"uuid,omitempty"`
	Name        string
	Addressable Addressable
	Format      string
	Filter      Filter
	Encryption  EncryptionDetails
	Compression string
	Enable      bool
	Destination string
}

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

type Response struct {
	Code           string   `bson:"code"`
	Description    string   `bson:"description"`
	ExpectedValues []string `bson:"expectedValues"`
}

type Subscription struct {
	Created              int64                            `bson:"created"`
	Modified             int64                            `bson:"modified"`
	Origin               int64                            `bson:"origin"`
	Id                   bson.ObjectId                    `bson:"_id,omitempty"`
	Uuid                 string                           `bson:"uuid,omitempty"`
	Slug                 string                           `bson:"slug"`
	Receiver             string                           `bson:"receiver"`
	Description          string                           `bson:"description"`
	SubscribedCategories []contract.NotificationsCategory `bson:"subscribedCategories,omitempty"`
	SubscribedLabels     []string                         `bson:"subscribedLabels,omitempty"`
	Channels             []Channel                        `bson:"channels,omitempty"`
}

type Transmission struct {
	Created      int64                       `bson:"created"`
	Modified     int64                       `bson:"modified"`
	Origin       int64                       `bson:"origin"`
	Id           bson.ObjectId               `bson:"_id,omitempty"`
	Uuid         string                      `bson:"uuid,omitempty"`
	Notification Notification                `bson:"notification,omitempty"`
	Receiver     string                      `bson:"receiver"`
	Channel      Channel                     `bson:"channel,omitempty"`
	Status       contract.TransmissionStatus `bson:"status"`
	ResendCount  int                         `bson:"resendcount"`
	Records      []TransmissionRecord        `bson:"records,omitempty"`
}

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

type Units struct {
	Type         string `bson:"type"`
	ReadWrite    string `bson:"readWrite"`
	DefaultValue string `bson:"defaultValue"`
}

type ValueDescriptor struct {
	Id            bson.ObjectId `bson:"_id,omitempty"`
	Uuid          string        `bson:"uuid"`
	Created       int64         `bson:"created"`
	Description   string        `bson:"description,omitempty"`
	Modified      int64         `bson:"modified"`
	Origin        int64         `bson:"origin"`
	Name          string        `bson:"name"`
	Min           interface{}   `bson:"min,omitempty"`
	Max           interface{}   `bson:"max,omitempty"`
	DefaultValue  interface{}   `bson:"defaultValue,omitempty"`
	Type          string        `bson:"type,omitempty"`
	UomLabel      string        `bson:"uomLabel,omitempty"`
	Formatting    string        `bson:"formatting,omitempty"`
	Labels        []string      `bson:"labels,omitempty"`
	MediaType     string        `bson:"mediaType,omitempty"`
	FloatEncoding string        `bson:"floatEncoding,omitempty"`
}