types

package
v1.0.0-beta.48 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 8, 2024 License: MIT Imports: 7 Imported by: 35

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ChangeType_name = map[int32]string{
		0: "CHANGE_TYPE_UNSPECIFIED",
		1: "ADD",
		2: "UPDATE",
		3: "REMOVE",
		4: "REPLACE",
	}
	ChangeType_value = map[string]int32{
		"CHANGE_TYPE_UNSPECIFIED": 0,
		"ADD":                     1,
		"UPDATE":                  2,
		"REMOVE":                  3,
		"REPLACE":                 4,
	}
)

Enum value maps for ChangeType.

View Source 
var (
	Connectivity_name = map[int32]string{
		0: "CONNECTIVITY_UNSPECIFIED",
		1: "NOT_APPLICABLE",
		2: "DISCONNECTED",
		3: "CONNECTED",
	}
	Connectivity_value = map[string]int32{
		"CONNECTIVITY_UNSPECIFIED": 0,
		"NOT_APPLICABLE":           1,
		"DISCONNECTED":             2,
		"CONNECTED":                3,
	}
)

Enum value maps for Connectivity.

View Source 
var (
	CommStatus_name = map[int32]string{
		0: "COMM_STATUS_UNSPECIFIED",
		1: "COMM_SUCCESS",
		2: "COMM_FAILURE",
	}
	CommStatus_value = map[string]int32{
		"COMM_STATUS_UNSPECIFIED": 0,
		"COMM_SUCCESS":            1,
		"COMM_FAILURE":            2,
	}
)

Enum value maps for CommStatus.

View Source 
var (
	Image_Source_Purpose_name = map[int32]string{
		0: "PURPOSE_UNSPECIFIED",
		1: "ANY",
		2: "MASKABLE",
	}
	Image_Source_Purpose_value = map[string]int32{
		"PURPOSE_UNSPECIFIED": 0,
		"ANY":                 1,
		"MASKABLE":            2,
	}
)

Enum value maps for Image_Source_Purpose.

View Source 
var (
	PullSupport_name = map[int32]string{
		0: "PULL_SUPPORT_UNSPECIFIED",
		1: "PULL_SUPPORT_NATIVE",
		2: "PULL_SUPPORT_EMULATED",
	}
	PullSupport_value = map[string]int32{
		"PULL_SUPPORT_UNSPECIFIED": 0,
		"PULL_SUPPORT_NATIVE":      1,
		"PULL_SUPPORT_EMULATED":    2,
	}
)

Enum value maps for PullSupport.

View Source 
var (
	InvalidNumberBehaviour_name = map[int32]string{
		0: "INVALID_NUMBER_BEHAVIOUR_UNSPECIFIED",
		1: "RESTRICT",
		2: "ERROR",
		3: "ALLOW",
	}
	InvalidNumberBehaviour_value = map[string]int32{
		"INVALID_NUMBER_BEHAVIOUR_UNSPECIFIED": 0,
		"RESTRICT":                             1,
		"ERROR":                                2,
		"ALLOW":                                3,
	}
)

Enum value maps for InvalidNumberBehaviour.

View Source 
var (
	TweenSupport_name = map[int32]string{
		0: "TWEEN_SUPPORT_UNSPECIFIED",
		1: "NO_SUPPORT",
		2: "NATIVE",
		3: "EMULATED",
		4: "FIXED",
	}
	TweenSupport_value = map[string]int32{
		"TWEEN_SUPPORT_UNSPECIFIED": 0,
		"NO_SUPPORT":                1,
		"NATIVE":                    2,
		"EMULATED":                  3,
		"FIXED":                     4,
	}
)

Enum value maps for TweenSupport.

View Source 
var (
	TemperatureUnit_name = map[int32]string{
		0: "TEMPERATURE_UNIT_UNSPECIFIED",
		1: "CELSIUS",
		2: "FAHRENHEIT",
		3: "KELVIN",
	}
	TemperatureUnit_value = map[string]int32{
		"TEMPERATURE_UNIT_UNSPECIFIED": 0,
		"CELSIUS":                      1,
		"FAHRENHEIT":                   2,
		"KELVIN":                       3,
	}
)

Enum value maps for TemperatureUnit.

View Source 
var (
	MuteSupport_name = map[int32]string{
		0: "MUTE_SUPPORT_UNSPECIFIED",
		1: "MUTE_NATIVE",
		2: "MUTE_EMULATED",
	}
	MuteSupport_value = map[string]int32{
		"MUTE_SUPPORT_UNSPECIFIED": 0,
		"MUTE_NATIVE":              1,
		"MUTE_EMULATED":            2,
	}
)

Enum value maps for MuteSupport.

View Source 
var File_types_change_proto protoreflect.FileDescriptor
View Source 
var File_types_connection_proto protoreflect.FileDescriptor
View Source 
var File_types_image_proto protoreflect.FileDescriptor
View Source 
var File_types_info_proto protoreflect.FileDescriptor
View Source 
var File_types_number_proto protoreflect.FileDescriptor
View Source 
var File_types_page_token_proto protoreflect.FileDescriptor
View Source 
var File_types_tween_proto protoreflect.FileDescriptor
View Source 
var File_types_unit_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AudioLevel 

type AudioLevel struct {

	// The current gain, typically as a percentage unless documented in the AudioLevel usage.
	Gain float32 `protobuf:"fixed32,1,opt,name=gain,proto3" json:"gain,omitempty"`
	// How the gain changes or should change over time. On write only duration should be set.
	GainTween *Tween `protobuf:"bytes,2,opt,name=gain_tween,json=gainTween,proto3" json:"gain_tween,omitempty"`
	// Read-only, the target value for the gain during a transition
	TargetGain float32 `protobuf:"fixed32,3,opt,name=target_gain,json=targetGain,proto3" json:"target_gain,omitempty"`
	// If the audio level muted.
	Muted bool `protobuf:"varint,4,opt,name=muted,proto3" json:"muted,omitempty"`
	// contains filtered or unexported fields
}

Represents an audio signal level for either input or output devices. Typically if fine grained control of either gain or muted is required then a FieldMask should describe this.

func (*AudioLevel) Descriptor deprecated 

func (*AudioLevel) Descriptor() ([]byte, []int)

Deprecated: Use AudioLevel.ProtoReflect.Descriptor instead.

func (*AudioLevel) GetGain 

func (x *AudioLevel) GetGain() float32

func (*AudioLevel) GetGainTween 

func (x *AudioLevel) GetGainTween() *Tween

func (*AudioLevel) GetMuted 

func (x *AudioLevel) GetMuted() bool

func (*AudioLevel) GetTargetGain 

func (x *AudioLevel) GetTargetGain() float32

func (*AudioLevel) ProtoMessage 

func (*AudioLevel) ProtoMessage()

func (*AudioLevel) ProtoReflect 

func (x *AudioLevel) ProtoReflect() protoreflect.Message

func (*AudioLevel) Reset 

func (x *AudioLevel) Reset()

func (*AudioLevel) String 

func (x *AudioLevel) String() string

type AudioLevelChange 

type AudioLevelChange struct {

	// The name of the device that is the source of the change
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// When the change was applied
	ChangeTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=change_time,json=changeTime,proto3" json:"change_time,omitempty"`
	// The new state for the change
	Level *AudioLevel `protobuf:"bytes,3,opt,name=level,proto3" json:"level,omitempty"`
	// contains filtered or unexported fields
}

A change to the audio level

func (*AudioLevelChange) Descriptor deprecated 

func (*AudioLevelChange) Descriptor() ([]byte, []int)

Deprecated: Use AudioLevelChange.ProtoReflect.Descriptor instead.

func (*AudioLevelChange) GetChangeTime 

func (x *AudioLevelChange) GetChangeTime() *timestamppb.Timestamp

func (*AudioLevelChange) GetLevel 

func (x *AudioLevelChange) GetLevel() *AudioLevel

func (*AudioLevelChange) GetName 

func (x *AudioLevelChange) GetName() string

func (*AudioLevelChange) ProtoMessage 

func (*AudioLevelChange) ProtoMessage()

func (*AudioLevelChange) ProtoReflect 

func (x *AudioLevelChange) ProtoReflect() protoreflect.Message

func (*AudioLevelChange) Reset 

func (x *AudioLevelChange) Reset()

func (*AudioLevelChange) String 

func (x *AudioLevelChange) String() string

type ChangeType 

type ChangeType int32

Type of change 

const (
	// Nothing has changed but existing items have been requested. The new_value property should be set
	ChangeType_CHANGE_TYPE_UNSPECIFIED ChangeType = 0
	// An item has been added. The new_value property of the change should be set
	ChangeType_ADD ChangeType = 1
	// An item has been updated. The new_value and old_value properties of the change should be set
	ChangeType_UPDATE ChangeType = 2
	// A item has been removed. The old_value property of the change should be set
	ChangeType_REMOVE ChangeType = 3
	// All existing items should be replaced by this set of items.
	ChangeType_REPLACE ChangeType = 4
)

func (ChangeType) Descriptor 

func (ChangeType) Descriptor() protoreflect.EnumDescriptor

func (ChangeType) Enum 

func (x ChangeType) Enum() *ChangeType

func (ChangeType) EnumDescriptor deprecated 

func (ChangeType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ChangeType.Descriptor instead.

func (ChangeType) Number 

func (x ChangeType) Number() protoreflect.EnumNumber

func (ChangeType) String 

func (x ChangeType) String() string

func (ChangeType) Type 

func (ChangeType) Type() protoreflect.EnumType

type CommStatus 

type CommStatus int32

Describes the state of communication between two entities. the CommStatus typically represents the application layer rather than any transport layer. For example TCP messages may be sent and ACKs received for them but if the application protocol response are never received then the CommStatus should not be COMM_SUCCESS. 

const (
	// the status of the line is unknown or unknowable
	CommStatus_COMM_STATUS_UNSPECIFIED CommStatus = 0
	// The last time we attempted communication across it was successful.
	CommStatus_COMM_SUCCESS CommStatus = 1
	// Communication with the device is failing
	CommStatus_COMM_FAILURE CommStatus = 2
)

func (CommStatus) Descriptor 

func (CommStatus) Descriptor() protoreflect.EnumDescriptor

func (CommStatus) Enum 

func (x CommStatus) Enum() *CommStatus

func (CommStatus) EnumDescriptor deprecated 

func (CommStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use CommStatus.Descriptor instead.

func (CommStatus) Number 

func (x CommStatus) Number() protoreflect.EnumNumber

func (CommStatus) String 

func (x CommStatus) String() string

func (CommStatus) Type 

func (CommStatus) Type() protoreflect.EnumType

type Connectivity 

type Connectivity int32

Defines the connection state between two entities. This could be a TCP network connection or a HDMI connection. In cases where a connection is possible but the state of the connection can never be determined directly use NOT_APPLICABLE, for example a simple io connection has no concept of 'alive'.

The state of DISCONNECTED is not automatically an indication if issues in a system. A device may decide to disconnect to save resources. 

const (
	// The connection state has not been provided.
	Connectivity_CONNECTIVITY_UNSPECIFIED Connectivity = 0
	// The concept of a connection makes no sense for this device
	Connectivity_NOT_APPLICABLE Connectivity = 1
	// There is no active connection
	Connectivity_DISCONNECTED Connectivity = 2
	// There is an open connection to the device
	Connectivity_CONNECTED Connectivity = 3
)

func (Connectivity) Descriptor 

func (Connectivity) Descriptor() protoreflect.EnumDescriptor

func (Connectivity) Enum 

func (x Connectivity) Enum() *Connectivity

func (Connectivity) EnumDescriptor deprecated 

func (Connectivity) EnumDescriptor() ([]byte, []int)

Deprecated: Use Connectivity.Descriptor instead.

func (Connectivity) Number 

func (x Connectivity) Number() protoreflect.EnumNumber

func (Connectivity) String 

func (x Connectivity) String() string

func (Connectivity) Type 

func (Connectivity) Type() protoreflect.EnumType

type FloatAttributes 

type FloatAttributes struct {
	Bounds *FloatBounds `protobuf:"bytes,1,opt,name=bounds,proto3" json:"bounds,omitempty"`
	// The stepping interval, how little the value can change in one go. A default value of 0 is equivalent to a
	// continuous step, i.e. all possible float values are supported
	Step float32 `protobuf:"fixed32,3,opt,name=step,proto3" json:"step,omitempty"`
	// Indicate whether the device supports delta adjustments when changing the value
	SupportsDelta bool `protobuf:"varint,4,opt,name=supports_delta,json=supportsDelta,proto3" json:"supports_delta,omitempty"`
	// Indicate the level of ramp support the device has
	RampSupport TweenSupport `` /* 129-byte string literal not displayed */
	// Provide information on how invalid values will be handled
	DefaultCapping *NumberCapping `protobuf:"bytes,6,opt,name=default_capping,json=defaultCapping,proto3" json:"default_capping,omitempty"`
	// contains filtered or unexported fields
}

Describes features and restrictions applied to a number that is typically used as part of an apis value

func (*FloatAttributes) Descriptor deprecated 

func (*FloatAttributes) Descriptor() ([]byte, []int)

Deprecated: Use FloatAttributes.ProtoReflect.Descriptor instead.

func (*FloatAttributes) GetBounds 

func (x *FloatAttributes) GetBounds() *FloatBounds

func (*FloatAttributes) GetDefaultCapping 

func (x *FloatAttributes) GetDefaultCapping() *NumberCapping

func (*FloatAttributes) GetRampSupport 

func (x *FloatAttributes) GetRampSupport() TweenSupport

func (*FloatAttributes) GetStep 

func (x *FloatAttributes) GetStep() float32

func (*FloatAttributes) GetSupportsDelta 

func (x *FloatAttributes) GetSupportsDelta() bool

func (*FloatAttributes) ProtoMessage 

func (*FloatAttributes) ProtoMessage()

func (*FloatAttributes) ProtoReflect 

func (x *FloatAttributes) ProtoReflect() protoreflect.Message

func (*FloatAttributes) Reset 

func (x *FloatAttributes) Reset()

func (*FloatAttributes) String 

func (x *FloatAttributes) String() string

type FloatBounds 

type FloatBounds struct {

	// the minimum value (inclusive). If absent then there is no minimum, though this is typically Float.Min
	Min *float32 `protobuf:"fixed32,1,opt,name=min,proto3,oneof" json:"min,omitempty"`
	// the maximum value (inclusive). If absent then there is no maximum, though this is typically Float.Max
	Max *float32 `protobuf:"fixed32,2,opt,name=max,proto3,oneof" json:"max,omitempty"`
	// contains filtered or unexported fields
}

Defines the bounds for a number. Either of the min or max values can be absent which means those aspects are unbounded. It makes no sense for both to be unset, if so then this is no longer a bounds but that isn't disallowed.

Contrary to most programming practices both min and max are inclusive and denote the max allowed value, just like htmls input type=range.

func (*FloatBounds) Descriptor deprecated 

func (*FloatBounds) Descriptor() ([]byte, []int)

Deprecated: Use FloatBounds.ProtoReflect.Descriptor instead.

func (*FloatBounds) GetMax 

func (x *FloatBounds) GetMax() float32

func (*FloatBounds) GetMin 

func (x *FloatBounds) GetMin() float32

func (*FloatBounds) ProtoMessage 

func (*FloatBounds) ProtoMessage()

func (*FloatBounds) ProtoReflect 

func (x *FloatBounds) ProtoReflect() protoreflect.Message

func (*FloatBounds) Reset 

func (x *FloatBounds) Reset()

func (*FloatBounds) String 

func (x *FloatBounds) String() string

type Image 

type Image struct {

	// Possible sources of image data.
	// Each source encodes a possible representation of the image, typically to solve art direction or resolution
	// variation. For example there might be a square source and a portrait source, there might be a source sized 128x128
	// and one sized 32x32.
	// All sources should represent the same subject.
	//
	// The renderer should choose the source that best destination criteria, preferring to select a larger image if no
	// exact match is found, selecting lower indexes to break ties.
	Sources []*Image_Source `protobuf:"bytes,1,rep,name=sources,proto3" json:"sources,omitempty"`
	// A description of the image, typically used when the image cannot be displayed or consumed by the observer, i.e. when using a screen reader.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Image describes a resolution, context, aspect ratio, and source independent image. When selecting an image to display the renderer inspects the properties of each image source to find the combination that best matches the intended output destination.

An image is a visual representation of some subject, for example "A dog chasing it's tail, on grass". The subject does not change when you double the resolution, crop in landscape or square, encode using jpeg or webp, or serve via a url or filesystem path. The choice for each of these properties can only be determined at image display time, i.e. the renderer knows that it doesn't support webp, and the destination area is 480px wide at 1.5x pixel density.

func (*Image) Descriptor deprecated 

func (*Image) Descriptor() ([]byte, []int)

Deprecated: Use Image.ProtoReflect.Descriptor instead.

func (*Image) GetDescription 

func (x *Image) GetDescription() string

func (*Image) GetSources 

func (x *Image) GetSources() []*Image_Source

func (*Image) ProtoMessage 

func (*Image) ProtoMessage()

func (*Image) ProtoReflect 

func (x *Image) ProtoReflect() protoreflect.Message

func (*Image) Reset 

func (x *Image) Reset()

func (*Image) String 

func (x *Image) String() string

type Image_Content 

type Image_Content struct {

	// A media type for the image, e.g. "image/jpeg".
	// See https://www.iana.org/assignments/media-types/media-types.xhtml#image
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Content describes the possible choices for where the image bytes come from.
	//
	// Types that are assignable to Content:
	//
	//	*Image_Content_Body
	//	*Image_Content_Url
	//	*Image_Content_Ref
	//	*Image_Content_Path
	Content isImage_Content_Content `protobuf_oneof:"content"`
	// contains filtered or unexported fields
}

Content describes the location of the image data.

func (*Image_Content) Descriptor deprecated 

func (*Image_Content) Descriptor() ([]byte, []int)

Deprecated: Use Image_Content.ProtoReflect.Descriptor instead.

func (*Image_Content) GetBody 

func (x *Image_Content) GetBody() []byte

func (*Image_Content) GetContent 

func (m *Image_Content) GetContent() isImage_Content_Content

func (*Image_Content) GetPath 

func (x *Image_Content) GetPath() string

func (*Image_Content) GetRef 

func (x *Image_Content) GetRef() string

func (*Image_Content) GetType 

func (x *Image_Content) GetType() string

func (*Image_Content) GetUrl 

func (x *Image_Content) GetUrl() string

func (*Image_Content) ProtoMessage 

func (*Image_Content) ProtoMessage()

func (*Image_Content) ProtoReflect 

func (x *Image_Content) ProtoReflect() protoreflect.Message

func (*Image_Content) Reset 

func (x *Image_Content) Reset()

func (*Image_Content) String 

func (x *Image_Content) String() string

type Image_Content_Body 

type Image_Content_Body struct {
	// The binary content of the image.
	//
	// Prefer other content options instead of embedding the body, especially if the image has multiple sources and/or
	// content types, providing the byte content for each variation can get large and cause performance issues.
	Body []byte `protobuf:"bytes,2,opt,name=body,proto3,oneof"`
}

type Image_Content_Path 

type Image_Content_Path struct {
	// A path on the local file system where the image content is located.
	Path string `protobuf:"bytes,5,opt,name=path,proto3,oneof"`
}

type Image_Content_Ref 

type Image_Content_Ref struct {
	// The image is resolved in a catalog of known images using this identifier.
	// For example in an icon set.
	Ref string `protobuf:"bytes,4,opt,name=ref,proto3,oneof"`
}

type Image_Content_Url 

type Image_Content_Url struct {
	// A url that resolves to the image content.
	Url string `protobuf:"bytes,3,opt,name=url,proto3,oneof"`
}

type Image_Source 

type Image_Source struct {

	// Where to get the image bytes from in preference order.
	// When displaying the image the renderer will go through each src until it finds one of a type it supports.
	Src []*Image_Content `protobuf:"bytes,1,rep,name=src,proto3" json:"src,omitempty"`
	// The intrinsic width of the image.
	Width int32 `protobuf:"varint,2,opt,name=width,proto3" json:"width,omitempty"`
	// The intrinsic height of the image.
	Height int32 `protobuf:"varint,3,opt,name=height,proto3" json:"height,omitempty"`
	// The intended purpose for the image.
	// The purpose informs the user of the image which intended contexts the image has been designed for.
	//
	// Purpose is inspired by https://w3c.github.io/manifest/#purpose-member
	Purpose Image_Source_Purpose `protobuf:"varint,4,opt,name=purpose,proto3,enum=smartcore.types.Image_Source_Purpose" json:"purpose,omitempty"`
	// contains filtered or unexported fields
}

Source represents a variation on the display of an image. Sources may exist for shape variations, or resolution variations. Sources should not change the core subject of an image.

func (*Image_Source) Descriptor deprecated 

func (*Image_Source) Descriptor() ([]byte, []int)

Deprecated: Use Image_Source.ProtoReflect.Descriptor instead.

func (*Image_Source) GetHeight 

func (x *Image_Source) GetHeight() int32

func (*Image_Source) GetPurpose 

func (x *Image_Source) GetPurpose() Image_Source_Purpose

func (*Image_Source) GetSrc 

func (x *Image_Source) GetSrc() []*Image_Content

func (*Image_Source) GetWidth 

func (x *Image_Source) GetWidth() int32

func (*Image_Source) ProtoMessage 

func (*Image_Source) ProtoMessage()

func (*Image_Source) ProtoReflect 

func (x *Image_Source) ProtoReflect() protoreflect.Message

func (*Image_Source) Reset 

func (x *Image_Source) Reset()

func (*Image_Source) String 

func (x *Image_Source) String() string

type Image_Source_Purpose 

type Image_Source_Purpose int32

Purpose defines the possible intended context for an image. 

const (
	// The purpose is unspecified.
	// Renderers may treat this as ANY.
	Image_Source_PURPOSE_UNSPECIFIED Image_Source_Purpose = 0
	// The renderer is free to use the image in any context.
	Image_Source_ANY Image_Source_Purpose = 1
	// The image has been designed with masks and safe zones in mind.
	// As such any part of the image outside the safe zone may be ignored/hidden/masked by the renderer.
	//
	// See https://w3c.github.io/manifest/#dfn-safe-zone
	Image_Source_MASKABLE Image_Source_Purpose = 2
)

func (Image_Source_Purpose) Descriptor 

func (Image_Source_Purpose) Descriptor() protoreflect.EnumDescriptor

func (Image_Source_Purpose) Enum 

func (x Image_Source_Purpose) Enum() *Image_Source_Purpose

func (Image_Source_Purpose) EnumDescriptor deprecated 

func (Image_Source_Purpose) EnumDescriptor() ([]byte, []int)

Deprecated: Use Image_Source_Purpose.Descriptor instead.

func (Image_Source_Purpose) Number 

func (x Image_Source_Purpose) Number() protoreflect.EnumNumber

func (Image_Source_Purpose) String 

func (x Image_Source_Purpose) String() string

func (Image_Source_Purpose) Type 

func (Image_Source_Purpose) Type() protoreflect.EnumType

type Int32Attributes 

type Int32Attributes struct {
	Bounds *Int32Bounds `protobuf:"bytes,1,opt,name=bounds,proto3" json:"bounds,omitempty"`
	// The stepping interval, how little the value can change in one go. A default value of 0 is equivalent to a
	// continuous step, i.e. step=1
	Step int32 `protobuf:"varint,3,opt,name=step,proto3" json:"step,omitempty"`
	// Indicate whether the device supports delta adjustments when changing the value
	SupportsDelta bool `protobuf:"varint,4,opt,name=supports_delta,json=supportsDelta,proto3" json:"supports_delta,omitempty"`
	// Indicate the level of ramp support the device has
	RampSupport TweenSupport `` /* 129-byte string literal not displayed */
	// Provide information on how invalid values will be handled
	DefaultCapping *NumberCapping `protobuf:"bytes,6,opt,name=default_capping,json=defaultCapping,proto3" json:"default_capping,omitempty"`
	// contains filtered or unexported fields
}

Describes features and restrictions applied to a number that is typically used as part of an apis value

func (*Int32Attributes) Descriptor deprecated 

func (*Int32Attributes) Descriptor() ([]byte, []int)

Deprecated: Use Int32Attributes.ProtoReflect.Descriptor instead.

func (*Int32Attributes) GetBounds 

func (x *Int32Attributes) GetBounds() *Int32Bounds

func (*Int32Attributes) GetDefaultCapping 

func (x *Int32Attributes) GetDefaultCapping() *NumberCapping

func (*Int32Attributes) GetRampSupport 

func (x *Int32Attributes) GetRampSupport() TweenSupport

func (*Int32Attributes) GetStep 

func (x *Int32Attributes) GetStep() int32

func (*Int32Attributes) GetSupportsDelta 

func (x *Int32Attributes) GetSupportsDelta() bool

func (*Int32Attributes) ProtoMessage 

func (*Int32Attributes) ProtoMessage()

func (*Int32Attributes) ProtoReflect 

func (x *Int32Attributes) ProtoReflect() protoreflect.Message

func (*Int32Attributes) Reset 

func (x *Int32Attributes) Reset()

func (*Int32Attributes) String 

func (x *Int32Attributes) String() string

type Int32Bounds 

type Int32Bounds struct {

	// the minimum value (inclusive). If absent then there is no minimum, though this is typically Int32.Min
	Min *int32 `protobuf:"varint,1,opt,name=min,proto3,oneof" json:"min,omitempty"`
	// the maximum value (inclusive). If absent then there is no maximum, though this is typically Int32.Max
	Max *int32 `protobuf:"varint,2,opt,name=max,proto3,oneof" json:"max,omitempty"`
	// contains filtered or unexported fields
}

Defines the bounds for a number. Either of the min or max values can be absent which means those aspects are unbounded. It makes no sense for both to be unset, if so then this is no longer a bounds but that isn't disallowed.

Contrary to most programming practices both min and max are inclusive and denote the max allowed value, just like htmls input type=range.

func (*Int32Bounds) Descriptor deprecated 

func (*Int32Bounds) Descriptor() ([]byte, []int)

Deprecated: Use Int32Bounds.ProtoReflect.Descriptor instead.

func (*Int32Bounds) GetMax 

func (x *Int32Bounds) GetMax() int32

func (*Int32Bounds) GetMin 

func (x *Int32Bounds) GetMin() int32

func (*Int32Bounds) ProtoMessage 

func (*Int32Bounds) ProtoMessage()

func (*Int32Bounds) ProtoReflect 

func (x *Int32Bounds) ProtoReflect() protoreflect.Message

func (*Int32Bounds) Reset 

func (x *Int32Bounds) Reset()

func (*Int32Bounds) String 

func (x *Int32Bounds) String() string

type InvalidNumberBehaviour 

type InvalidNumberBehaviour int32

Possible behaviours for values that are not allowed by the number 

const (
	// A default behaviour will be applied, typically RESTRICT
	InvalidNumberBehaviour_INVALID_NUMBER_BEHAVIOUR_UNSPECIFIED InvalidNumberBehaviour = 0
	// The value will be restricted to the most appropriate value, typically the closest
	InvalidNumberBehaviour_RESTRICT InvalidNumberBehaviour = 1
	// An error will be raised to alert to the invalid value
	InvalidNumberBehaviour_ERROR InvalidNumberBehaviour = 2
	// Ignore the bounds and apply the value anyway
	InvalidNumberBehaviour_ALLOW InvalidNumberBehaviour = 3
)

func (InvalidNumberBehaviour) Descriptor 

func (InvalidNumberBehaviour) Descriptor() protoreflect.EnumDescriptor

func (InvalidNumberBehaviour) Enum 

func (x InvalidNumberBehaviour) Enum() *InvalidNumberBehaviour

func (InvalidNumberBehaviour) EnumDescriptor deprecated 

func (InvalidNumberBehaviour) EnumDescriptor() ([]byte, []int)

Deprecated: Use InvalidNumberBehaviour.Descriptor instead.

func (InvalidNumberBehaviour) Number 

func (x InvalidNumberBehaviour) Number() protoreflect.EnumNumber

func (InvalidNumberBehaviour) String 

func (x InvalidNumberBehaviour) String() string

func (InvalidNumberBehaviour) Type 

func (InvalidNumberBehaviour) Type() protoreflect.EnumType

type MuteSupport 

type MuteSupport int32

What is the level of mute support that the speaker provides 

const (
	MuteSupport_MUTE_SUPPORT_UNSPECIFIED MuteSupport = 0
	// The speaker natively supports mute
	MuteSupport_MUTE_NATIVE MuteSupport = 1
	// Muting is emulated, typically by setting the gain to 0
	MuteSupport_MUTE_EMULATED MuteSupport = 2
)

func (MuteSupport) Descriptor 

func (MuteSupport) Descriptor() protoreflect.EnumDescriptor

func (MuteSupport) Enum 

func (x MuteSupport) Enum() *MuteSupport

func (MuteSupport) EnumDescriptor deprecated 

func (MuteSupport) EnumDescriptor() ([]byte, []int)

Deprecated: Use MuteSupport.Descriptor instead.

func (MuteSupport) Number 

func (x MuteSupport) Number() protoreflect.EnumNumber

func (MuteSupport) String 

func (x MuteSupport) String() string

func (MuteSupport) Type 

func (MuteSupport) Type() protoreflect.EnumType

type NumberCapping 

type NumberCapping struct {

	// If the value is less than the minimum, behave this way. Should default to RESTRICT
	Min InvalidNumberBehaviour `protobuf:"varint,1,opt,name=min,proto3,enum=smartcore.types.InvalidNumberBehaviour" json:"min,omitempty"`
	// If the value does not lie on a step value, behave this way. Should default to ALLOW
	Step InvalidNumberBehaviour `protobuf:"varint,2,opt,name=step,proto3,enum=smartcore.types.InvalidNumberBehaviour" json:"step,omitempty"`
	// If the value is greater than the maximum, behave this way. Should default to RESTRICT
	Max InvalidNumberBehaviour `protobuf:"varint,3,opt,name=max,proto3,enum=smartcore.types.InvalidNumberBehaviour" json:"max,omitempty"`
	// contains filtered or unexported fields
}

Options for how invalid number values will be handled

func (*NumberCapping) Descriptor deprecated 

func (*NumberCapping) Descriptor() ([]byte, []int)

Deprecated: Use NumberCapping.ProtoReflect.Descriptor instead.

func (*NumberCapping) GetMax 

func (x *NumberCapping) GetMax() InvalidNumberBehaviour

func (*NumberCapping) GetMin 

func (x *NumberCapping) GetMin() InvalidNumberBehaviour

func (*NumberCapping) GetStep 

func (x *NumberCapping) GetStep() InvalidNumberBehaviour

func (*NumberCapping) ProtoMessage 

func (*NumberCapping) ProtoMessage()

func (*NumberCapping) ProtoReflect 

func (x *NumberCapping) ProtoReflect() protoreflect.Message

func (*NumberCapping) Reset 

func (x *NumberCapping) Reset()

func (*NumberCapping) String 

func (x *NumberCapping) String() string

type PageToken 

type PageToken struct {

	// there can be only one indicator of the start of the next page
	//
	// Types that are assignable to PageStart:
	//
	//	*PageToken_LastOffset
	//	*PageToken_LastResourceName
	PageStart isPageToken_PageStart `protobuf_oneof:"page_start"`
	// contains filtered or unexported fields
}

Represents a specialist token used for fetching subsequent pages of a List request. Typically encoded as base64 or something similar.

@see https://cloud.google.com/apis/design/design_patterns#list_pagination

func (*PageToken) Descriptor deprecated 

func (*PageToken) Descriptor() ([]byte, []int)

Deprecated: Use PageToken.ProtoReflect.Descriptor instead.

func (*PageToken) GetLastOffset 

func (x *PageToken) GetLastOffset() int32

func (*PageToken) GetLastResourceName 

func (x *PageToken) GetLastResourceName() string

func (*PageToken) GetPageStart 

func (m *PageToken) GetPageStart() isPageToken_PageStart

func (*PageToken) ProtoMessage 

func (*PageToken) ProtoMessage()

func (*PageToken) ProtoReflect 

func (x *PageToken) ProtoReflect() protoreflect.Message

func (*PageToken) Reset 

func (x *PageToken) Reset()

func (*PageToken) String 

func (x *PageToken) String() string

type PageToken_LastOffset 

type PageToken_LastOffset struct {
	// The offset representing the tail resource returned in the last page
	LastOffset int32 `protobuf:"varint,1,opt,name=last_offset,json=lastOffset,proto3,oneof"`
}

type PageToken_LastResourceName 

type PageToken_LastResourceName struct {
	// The name of the tail resource returned in the last page response
	LastResourceName string `protobuf:"bytes,2,opt,name=last_resource_name,json=lastResourceName,proto3,oneof"`
}

type PullSupport 

type PullSupport int32

PullSupport describes how Pull methods are implemented by the server 

const (
	// How subscriptions are implemented is not known.
	PullSupport_PULL_SUPPORT_UNSPECIFIED PullSupport = 0
	// Subscribing is supported natively by the underlying system.
	PullSupport_PULL_SUPPORT_NATIVE PullSupport = 1
	// Subscribing is supported in the driver, rather than natively.
	// Usually the driver will poll the system for data.
	PullSupport_PULL_SUPPORT_EMULATED PullSupport = 2
)

func (PullSupport) Descriptor 

func (PullSupport) Descriptor() protoreflect.EnumDescriptor

func (PullSupport) Enum 

func (x PullSupport) Enum() *PullSupport

func (PullSupport) EnumDescriptor deprecated 

func (PullSupport) EnumDescriptor() ([]byte, []int)

Deprecated: Use PullSupport.Descriptor instead.

func (PullSupport) Number 

func (x PullSupport) Number() protoreflect.EnumNumber

func (PullSupport) String 

func (x PullSupport) String() string

func (PullSupport) Type 

func (PullSupport) Type() protoreflect.EnumType

type ResourceSupport 

type ResourceSupport struct {

	// Whether the device supports querying, i.e. get apis
	Readable bool `protobuf:"varint,1,opt,name=readable,proto3" json:"readable,omitempty"`
	// Whether the device supports writable actions, i.e. update or action apis
	Writable bool `protobuf:"varint,2,opt,name=writable,proto3" json:"writable,omitempty"`
	// Whether the device supports subscriptions, i.e. pull apis
	Observable bool `protobuf:"varint,3,opt,name=observable,proto3" json:"observable,omitempty"`
	// Which fields can be written to.
	// Relative to the resource type, not the message (FooRequest) type.
	// If this field is absent, the list of updatable fields is unknown, assume all.
	// Check the response to your Update request for the values that were updated.
	// An attempt to explicitly (via update_mask) write to a non-writable field will error.
	WritableFields *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=writable_fields,json=writableFields,proto3" json:"writable_fields,omitempty"`
	// How Pull is implemented by the server
	PullSupport PullSupport `` /* 128-byte string literal not displayed */
	// If Pull is emulated, how often updates can be expected.
	// This is not strict, updates may be less or more frequent.
	PullPoll *durationpb.Duration `protobuf:"bytes,6,opt,name=pull_poll,json=pullPoll,proto3" json:"pull_poll,omitempty"`
	// contains filtered or unexported fields
}

ResourceSupport describes how a trait resource supports read/write/subscribe apis.

For sensor traits any write oriented properties should be and will be ignored.

func (*ResourceSupport) Descriptor deprecated 

func (*ResourceSupport) Descriptor() ([]byte, []int)

Deprecated: Use ResourceSupport.ProtoReflect.Descriptor instead.

func (*ResourceSupport) GetObservable 

func (x *ResourceSupport) GetObservable() bool

func (*ResourceSupport) GetPullPoll 

func (x *ResourceSupport) GetPullPoll() *durationpb.Duration

func (*ResourceSupport) GetPullSupport 

func (x *ResourceSupport) GetPullSupport() PullSupport

func (*ResourceSupport) GetReadable 

func (x *ResourceSupport) GetReadable() bool

func (*ResourceSupport) GetWritable 

func (x *ResourceSupport) GetWritable() bool

func (*ResourceSupport) GetWritableFields 

func (x *ResourceSupport) GetWritableFields() *fieldmaskpb.FieldMask

func (*ResourceSupport) ProtoMessage 

func (*ResourceSupport) ProtoMessage()

func (*ResourceSupport) ProtoReflect 

func (x *ResourceSupport) ProtoReflect() protoreflect.Message

func (*ResourceSupport) Reset 

func (x *ResourceSupport) Reset()

func (*ResourceSupport) String 

func (x *ResourceSupport) String() string

type Temperature 

type Temperature struct {

	// The value in celsius, always! Use device attributes if the device 'thinks' in a different unit but always
	// communicate in celsius.
	ValueCelsius float64 `protobuf:"fixed64,1,opt,name=value_celsius,json=valueCelsius,proto3" json:"value_celsius,omitempty"`
	// contains filtered or unexported fields
}

A temperature value

func (*Temperature) Descriptor deprecated 

func (*Temperature) Descriptor() ([]byte, []int)

Deprecated: Use Temperature.ProtoReflect.Descriptor instead.

func (*Temperature) GetValueCelsius 

func (x *Temperature) GetValueCelsius() float64

func (*Temperature) ProtoMessage 

func (*Temperature) ProtoMessage()

func (*Temperature) ProtoReflect 

func (x *Temperature) ProtoReflect() protoreflect.Message

func (*Temperature) Reset 

func (x *Temperature) Reset()

func (*Temperature) String 

func (x *Temperature) String() string

type TemperatureUnit 

type TemperatureUnit int32

Possible temperature units for physical bodies. 

const (
	TemperatureUnit_TEMPERATURE_UNIT_UNSPECIFIED TemperatureUnit = 0
	TemperatureUnit_CELSIUS                      TemperatureUnit = 1
	TemperatureUnit_FAHRENHEIT                   TemperatureUnit = 2
	TemperatureUnit_KELVIN                       TemperatureUnit = 3
)

func (TemperatureUnit) Descriptor 

func (TemperatureUnit) Descriptor() protoreflect.EnumDescriptor

func (TemperatureUnit) Enum 

func (x TemperatureUnit) Enum() *TemperatureUnit

func (TemperatureUnit) EnumDescriptor deprecated 

func (TemperatureUnit) EnumDescriptor() ([]byte, []int)

Deprecated: Use TemperatureUnit.Descriptor instead.

func (TemperatureUnit) Number 

func (x TemperatureUnit) Number() protoreflect.EnumNumber

func (TemperatureUnit) String 

func (x TemperatureUnit) String() string

func (TemperatureUnit) Type 

func (TemperatureUnit) Type() protoreflect.EnumType

type Tween 

type Tween struct {

	// Read-only [0-100], how far along the transition (in time) are we.
	Progress float32 `protobuf:"fixed32,1,opt,name=progress,proto3" json:"progress,omitempty"`
	// how long the transition will last in total
	TotalDuration *durationpb.Duration `protobuf:"bytes,2,opt,name=total_duration,json=totalDuration,proto3" json:"total_duration,omitempty"`
	// contains filtered or unexported fields
}

An in-progress transition between two values. The values themselves should be defined in an enclosing message.

Typically an enclosing message will define three properties, the value, the tween, and the target value.

Example definition 

message WaterHeight {
  // The current or expected height of water, in meters
  float height = 1;
  // Describe how the height changes or should change over time
  Tween height_tween = 2;
  // Read-only, the target height at the end of a transition
  float target_height = 3;
}

func (*Tween) Descriptor deprecated 

func (*Tween) Descriptor() ([]byte, []int)

Deprecated: Use Tween.ProtoReflect.Descriptor instead.

func (*Tween) GetProgress 

func (x *Tween) GetProgress() float32

func (*Tween) GetTotalDuration 

func (x *Tween) GetTotalDuration() *durationpb.Duration

func (*Tween) ProtoMessage 

func (*Tween) ProtoMessage()

func (*Tween) ProtoReflect 

func (x *Tween) ProtoReflect() protoreflect.Message

func (*Tween) Reset 

func (x *Tween) Reset()

func (*Tween) String 

func (x *Tween) String() string

type TweenSupport 

type TweenSupport int32

Denote different types of tween support. Clients may use this to control performance sensitive areas by enabling or disabling tweening when support is not native, for example 

const (
	// Tween support is not specified.
	TweenSupport_TWEEN_SUPPORT_UNSPECIFIED TweenSupport = 0
	// The device does not support tweening
	TweenSupport_NO_SUPPORT TweenSupport = 1
	// The device natively supports tweening. Natively typically means with minimal performance impact (i.e. no network)
	TweenSupport_NATIVE TweenSupport = 2
	// The device supports tweening via emulation. Typically tweening is implemented by the Smart Core driver or a
	// supervisor node and not the device itself.
	TweenSupport_EMULATED TweenSupport = 3
	// The device tweens values, but the duration or rate is fixed and cannot be adjusted. For example a motor might only
	// have one speed when operating an adjustable desk
	TweenSupport_FIXED TweenSupport = 4
)

func (TweenSupport) Descriptor 

func (TweenSupport) Descriptor() protoreflect.EnumDescriptor

func (TweenSupport) Enum 

func (x TweenSupport) Enum() *TweenSupport

func (TweenSupport) EnumDescriptor deprecated 

func (TweenSupport) EnumDescriptor() ([]byte, []int)

Deprecated: Use TweenSupport.Descriptor instead.

func (TweenSupport) Number 

func (x TweenSupport) Number() protoreflect.EnumNumber

func (TweenSupport) String 

func (x TweenSupport) String() string

func (TweenSupport) Type 

func (TweenSupport) Type() protoreflect.EnumType

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.