devicemodel

Documentation

Index

• Constants
• type Aspect
• type AspectNode
• type Attribute
• type Characteristic
• type Concept
• type Content
• type ContentVariable
• type Device
• type DeviceClass
• type DeviceGroup
  • func (this *DeviceGroup) SetShortCriteria()
• type DeviceGroupFilterCriteria
  • func (this DeviceGroupFilterCriteria) Short() string
• type DeviceType
• type DeviceTypeCriteria
• type DeviceTypeSelectable
• type FilterCriteria
  • func (this FilterCriteria) Short() string
• type Function
• type Hub
• type Interaction
• type Protocol
• type ProtocolSegment
• type Service
• type ServiceGroup
• type ServicePathOption
• type Type

Constants

const CONTROLLING_FUNCTION_PREFIX = "urn:infai:ses:controlling-function:"

const MEASURING_FUNCTION_PREFIX = "urn:infai:ses:measuring-function:"

const PREFIX_RDF = "PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>"

const PREFIX_SES = "PREFIX ses: <https://senergy.infai.org/ontology/> "

PREFIXES

const RDFS_COMMENT = "http://www.w3.org/2000/01/rdf-schema#comment"

const RDFS_LABEL = "http://www.w3.org/2000/01/rdf-schema#label"

const RDF_TYPE = "http://www.w3.org/1999/02/22-rdf-syntax-ns#type"

const SES_ONTOLOGY_ASPECT = "https://senergy.infai.org/ontology/Aspect"

const SES_ONTOLOGY_CHARACTERISTIC = "https://senergy.infai.org/ontology/Characteristic"

const SES_ONTOLOGY_CONCEPT = "https://senergy.infai.org/ontology/Concept"

const SES_ONTOLOGY_CONTROLLING_FUNCTION = "https://senergy.infai.org/ontology/ControllingFunction"

Classes

const SES_ONTOLOGY_COUNT = "https://senergy.infai.org/ontology/Count"

const SES_ONTOLOGY_DEVICE_CLASS = "https://senergy.infai.org/ontology/DeviceClass"

const SES_ONTOLOGY_DEVICE_TYPE = "https://senergy.infai.org/ontology/DeviceType"

const SES_ONTOLOGY_EXPOSES_FUNCTION = "https://senergy.infai.org/ontology/exposesFunction"

const SES_ONTOLOGY_HAS_BASE_CHARACTERISTIC = "https://senergy.infai.org/ontology/hasBaseCharacteristic"

const SES_ONTOLOGY_HAS_CHARACTERISTIC = "https://senergy.infai.org/ontology/hasCharacteristic"

const SES_ONTOLOGY_HAS_CONCEPT = "https://senergy.infai.org/ontology/hasConcept"

Properties

const SES_ONTOLOGY_HAS_DEVICE_CLASS = "https://senergy.infai.org/ontology/hasDeviceClass"

const SES_ONTOLOGY_HAS_IMAGE = "https://senergy.infai.org/ontology/hasImage"

const SES_ONTOLOGY_HAS_INTERACTION = "https://senergy.infai.org/ontology/interaction"

const SES_ONTOLOGY_HAS_MAX_VALUE = "https://senergy.infai.org/ontology/hasMaxValue"

const SES_ONTOLOGY_HAS_MIN_VALUE = "https://senergy.infai.org/ontology/hasMinValue"

const SES_ONTOLOGY_HAS_PROTOCOL = "https://senergy.infai.org/ontology/hasProtocol"

const SES_ONTOLOGY_HAS_SERVICE = "https://senergy.infai.org/ontology/hasService"

const SES_ONTOLOGY_HAS_SUB_CHARACTERISTIC = "https://senergy.infai.org/ontology/hasSubCharacteristic"

const SES_ONTOLOGY_HAS_VALUE = "https://senergy.infai.org/ontology/hasValue"

const SES_ONTOLOGY_HAS_VALUE_TYPE = "https://senergy.infai.org/ontology/hasValueType"

const SES_ONTOLOGY_LOCATION = "https://senergy.infai.org/ontology/Location"

const SES_ONTOLOGY_MEASURING_FUNCTION = "https://senergy.infai.org/ontology/MeasuringFunction"

const SES_ONTOLOGY_REFERS_TO = "https://senergy.infai.org/ontology/refersTo"

const SES_ONTOLOGY_SERVICE = "https://senergy.infai.org/ontology/Service"

const SES_ONTOLOGY_TOTAL_COUNT = "https://senergy.infai.org/ontology/totalCount"

const URN_PREFIX = "urn:infai:ses:"

Types

type Aspect

type Aspect struct {
	Id      string `json:"id"`
	Name    string `json:"name"`
	RdfType string `json:"rdf_type"`
}

type AspectNode

type AspectNode struct {
	Id            string   `json:"id"`
	Name          string   `json:"name"`
	RootId        string   `json:"root_id"`
	ParentId      string   `json:"parent_id"`
	ChildIds      []string `json:"child_ids"`
	AncestorIds   []string `json:"ancestor_ids"`
	DescendentIds []string `json:"descendent_ids"`
}

type Attribute

type Attribute struct {
	Key    string `json:"key"`
	Value  string `json:"value"`
	Origin string `json:"origin"`
}

type Characteristic

type Characteristic struct {
	Id                 string           `json:"id"`
	Name               string           `json:"name"`
	Type               Type             `json:"type"`
	MinValue           interface{}      `json:"min_value,omitempty"`
	MaxValue           interface{}      `json:"max_value,omitempty"`
	Value              interface{}      `json:"value,omitempty"`
	SubCharacteristics []Characteristic `json:"sub_characteristics"`
	RdfType            string           `json:"rdf_type"`
}

type Concept

type Concept struct {
	Id                   string   `json:"id"`
	Name                 string   `json:"name"`
	CharacteristicIds    []string `json:"characteristic_ids"`
	BaseCharacteristicId string   `json:"base_characteristic_id"`
	RdfType              string   `json:"rdf_type"`
}

type Content

type Content struct {
	Id                string          `json:"id"`
	ContentVariable   ContentVariable `json:"content_variable"`
	Serialization     string          `json:"serialization"`
	ProtocolSegmentId string          `json:"protocol_segment_id"`
}

type ContentVariable

type ContentVariable struct {
	Id                   string            `json:"id"`
	Name                 string            `json:"name"`
	Type                 Type              `json:"type"`
	SubContentVariables  []ContentVariable `json:"sub_content_variables"`
	CharacteristicId     string            `json:"characteristic_id"`
	Value                interface{}       `json:"value"`
	SerializationOptions []string          `json:"serialization_options"`
	UnitReference        string            `json:"unit_reference,omitempty"`
	FunctionId           string            `json:"function_id,omitempty"`
	AspectId             string            `json:"aspect_id,omitempty"`
}

type Device

type Device struct {
	Id           string      `json:"id"`
	LocalId      string      `json:"local_id"`
	Name         string      `json:"name"`
	Attributes   []Attribute `json:"attributes"`
	DeviceTypeId string      `json:"device_type_id"`
}

type DeviceClass

type DeviceClass struct {
	Id      string `json:"id"`
	Name    string `json:"name"`
	Image   string `json:"image"`
	RdfType string `json:"rdf_type"`
}

type DeviceGroup

type DeviceGroup struct {
	Id            string                      `json:"id"`
	Name          string                      `json:"name"`
	Image         string                      `json:"image"`
	Criteria      []DeviceGroupFilterCriteria `json:"criteria"`
	DeviceIds     []string                    `json:"device_ids"`
	CriteriaShort []string                    `json:"criteria_short,omitempty"`
}

func (*DeviceGroup) SetShortCriteria

func (this *DeviceGroup) SetShortCriteria()

type DeviceGroupFilterCriteria

type DeviceGroupFilterCriteria struct {
	Interaction   Interaction `json:"interaction"`
	FunctionId    string      `json:"function_id"`
	AspectId      string      `json:"aspect_id"`
	DeviceClassId string      `json:"device_class_id"`
}

func (DeviceGroupFilterCriteria) Short

func (this DeviceGroupFilterCriteria) Short() string

type DeviceType

type DeviceType struct {
	Id            string         `json:"id"`
	Name          string         `json:"name"`
	Description   string         `json:"description"`
	ServiceGroups []ServiceGroup `json:"service_groups"`
	Services      []Service      `json:"services"`
	DeviceClassId string         `json:"device_class_id"`
	Attributes    []Attribute    `json:"attributes"`
}

type DeviceTypeCriteria

type DeviceTypeCriteria struct {
	DeviceTypeId          string `json:"device_type_id"`
	ServiceId             string `json:"service_id"`
	ContentVariableId     string `json:"content_variable_id"`
	ContentVariablePath   string `json:"content_variable_path"`
	FunctionId            string `json:"function_id"`
	Interaction           string `json:"interaction"`
	IsControllingFunction bool   `json:"controlling_function"`
	DeviceClassId         string `json:"device_class_id"`
	AspectId              string `json:"aspect_id"`
	CharacteristicId      string `json:"characteristic_id"`
}

type DeviceTypeSelectable

type DeviceTypeSelectable struct {
	DeviceTypeId       string                         `json:"device_type_id,omitempty"`
	Services           []Service                      `json:"services,omitempty"`
	ServicePathOptions map[string][]ServicePathOption `json:"service_path_options,omitempty"`
}

type FilterCriteria

type FilterCriteria struct {
	FunctionId    string `json:"function_id"`
	AspectId      string `json:"aspect_id"`
	DeviceClassId string `json:"device_class_id"`
}

func (FilterCriteria) Short

func (this FilterCriteria) Short() string

type Function

type Function struct {
	Id        string `json:"id"`
	Name      string `json:"name"`
	ConceptId string `json:"concept_id"`
	RdfType   string `json:"rdf_type"`
}

type Hub

type Hub struct {
	Id             string   `json:"id"`
	Name           string   `json:"name"`
	Hash           string   `json:"hash"`
	DeviceLocalIds []string `json:"device_local_ids"`
}

type Interaction

type Interaction string

const (
	EVENT             Interaction = "event"
	REQUEST           Interaction = "request"
	EVENT_AND_REQUEST Interaction = "event+request"
)

type Protocol

type Protocol struct {
	Id               string            `json:"id"`
	Name             string            `json:"name"`
	Handler          string            `json:"handler"`
	ProtocolSegments []ProtocolSegment `json:"protocol_segments"`
}

type ProtocolSegment

type ProtocolSegment struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

type Service

type Service struct {
	Id              string      `json:"id"`
	LocalId         string      `json:"local_id"`
	Name            string      `json:"name"`
	Description     string      `json:"description"`
	Interaction     Interaction `json:"interaction"`
	ProtocolId      string      `json:"protocol_id"`
	Inputs          []Content   `json:"inputs"`
	Outputs         []Content   `json:"outputs"`
	Attributes      []Attribute `json:"attributes"`
	ServiceGroupKey string      `json:"service_group_key"`
}

type ServiceGroup

type ServiceGroup struct {
	Key         string `json:"key"`
	Name        string `json:"name"`
	Description string `json:"description"`
}

type ServicePathOption

type ServicePathOption struct {
	ServiceId        string `json:"service_id"`
	Path             string `json:"path"`
	CharacteristicId string `json:"characteristic_id"`
	AspectNodeId     string `json:"aspect_node_id"`
	FunctionId       string `json:"function_id"`
}

type Type

type Type string

const (
	String  Type = "https://schema.org/Text"
	Integer Type = "https://schema.org/Integer"
	Float   Type = "https://schema.org/Float"
	Boolean Type = "https://schema.org/Boolean"

	List      Type = "https://schema.org/ItemList"
	Structure Type = "https://schema.org/StructuredValue"
)