iotmodel

Documentation

Index

• type Aspect
• 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 Function
• type Hub
• type Interaction
• type Location
• type Protocol
• type ProtocolSegment
• type Service
• type Type

Types

type Aspect

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

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"`
}

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"`
	Services      []Service   `json:"services"`
	DeviceClassId string      `json:"device_class_id"`
	Attributes    []Attribute `json:"attributes"`
	RdfType       string      `json:"rdf_type"`
}

type Function

type Function struct {
	Id          string `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description"`
	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 Location

type Location struct {
	Id             string   `json:"id"`
	Name           string   `json:"name"`
	Description    string   `json:"description"`
	Image          string   `json:"image"`
	DeviceIds      []string `json:"device_ids"`
	DeviceGroupIds []string `json:"device_group_ids"`
	RdfType        string   `json:"rdf_type"`
}

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"`
	AspectIds   []string    `json:"aspect_ids"`
	ProtocolId  string      `json:"protocol_id"`
	Inputs      []Content   `json:"inputs"`
	Outputs     []Content   `json:"outputs"`
	FunctionIds []string    `json:"function_ids"`
	Attributes  []Attribute `json:"attributes"`
	RdfType     string      `json:"rdf_type"`
}

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"
)