api

package

Go to main page

Versions in this module

v0

v0.5.8

Jul 13, 2023

v0.5.7

Jul 13, 2023

Changes in this version

type ZoneClimateReport

+ func (r *ZoneClimateReport) String() string

type ZoneReport

+ func (r *ZoneReport) String() string

v0.5.6

Jul 12, 2023

v0.5.5

Jul 11, 2023

Changes in this version

type AlarmLevel

+ const AlarmLevel_FAILURE

v0.5.4

Jul 7, 2023

v0.5.3

Jul 7, 2023

Changes in this version

+ const ErrorFullBuffer

+ const ErrorNoActiveConnection

+ const ErrorTaskEnded

+ var AlarmLevel_name = map[int32]string

+ var AlarmLevel_value = map[string]int32

+ var AlarmStatus_name = map[int32]string

+ var AlarmStatus_value = map[string]int32

+ var DefaultCallOptions []grpc.CallOption

+ var DefaultDialOptions []grpc.DialOption

+ var DefaultServerOptions []grpc.ServerOption

+ var File_olympus_service_proto protoreflect.FileDescriptor

+ var Olympus_ServiceDesc = grpc.ServiceDesc

+ func ConnectClimate(ctx context.Context, address string, declaration *ClimateDeclaration, ...) <-chan ConnectionResult[*ClimateUpStream, *ClimateDownStream]

+ func ConnectTracking(ctx context.Context, address string, declaration *TrackingDeclaration, ...) <-chan ConnectionResult[*TrackingUpStream, *TrackingDownStream]

+ func RegisterOlympusServer(s grpc.ServiceRegistrar, srv OlympusServer)

+ func ServerLoop(ctx context.Context, s ServerStream[Up, Down], handler HandleFunc[Up, Down]) error

+ func WithTelemetry(ctx context.Context, serviceName string) context.Context

+ type AlarmEvent struct

+ End *time.Time

+ Start time.Time

+ type AlarmLevel int32

+ const AlarmLevel_EMERGENCY

+ const AlarmLevel_WARNING

+ func (AlarmLevel) Descriptor() protoreflect.EnumDescriptor

+ func (AlarmLevel) EnumDescriptor() ([]byte, []int)

+ func (AlarmLevel) Type() protoreflect.EnumType

+ func (x AlarmLevel) Enum() *AlarmLevel

+ func (x AlarmLevel) Number() protoreflect.EnumNumber

+ func (x AlarmLevel) String() string

+ type AlarmReport struct

+ Description string

+ Events []AlarmEvent

+ Identification string

+ Level AlarmLevel

+ func (r *AlarmReport) On() bool

+ type AlarmStatus int32

+ const AlarmStatus_OFF

+ const AlarmStatus_ON

+ func (AlarmStatus) Descriptor() protoreflect.EnumDescriptor

+ func (AlarmStatus) EnumDescriptor() ([]byte, []int)

+ func (AlarmStatus) Type() protoreflect.EnumType

+ func (x AlarmStatus) Enum() *AlarmStatus

+ func (x AlarmStatus) Number() protoreflect.EnumNumber

+ func (x AlarmStatus) String() string

+ type AlarmUpdate struct

+ Description string

+ Identification string

+ Level AlarmLevel

+ Status AlarmStatus

+ Time *timestamp.Timestamp

+ func (*AlarmUpdate) Descriptor() ([]byte, []int)

+ func (*AlarmUpdate) ProtoMessage()

+ func (a *AlarmUpdate) Clone() *AlarmUpdate

+ func (x *AlarmUpdate) GetDescription() string

+ func (x *AlarmUpdate) GetIdentification() string

+ func (x *AlarmUpdate) GetLevel() AlarmLevel

+ func (x *AlarmUpdate) GetStatus() AlarmStatus

+ func (x *AlarmUpdate) GetTime() *timestamp.Timestamp

+ func (x *AlarmUpdate) ProtoReflect() protoreflect.Message

+ func (x *AlarmUpdate) Reset()

+ func (x *AlarmUpdate) String() string

+ type Bounds struct

+ Maximum *float32

+ Minimum *float32

+ type ClientTask struct

+ func NewClimateTask(ctx context.Context, address string, declaration *ClimateDeclaration, ...) *ClientTask[*ClimateUpStream, *ClimateDownStream]

+ func NewTrackingTask(ctx context.Context, address string, declaration *TrackingDeclaration, ...) *ClientTask[*TrackingUpStream, *TrackingDownStream]

+ func (c *ClientTask[Up, Down]) Confirmations() <-chan ConfirmationResult[Down]

+ func (c *ClientTask[Up, Down]) Fatal(err error)

+ func (c *ClientTask[Up, Down]) MayRequest(m Up) <-chan RequestResult[Down]

+ func (c *ClientTask[Up, Down]) Request(m Up) <-chan RequestResult[Down]

+ func (c *ClientTask[Up, Down]) Run() (err error)

+ type ClimateDeclaration struct

+ Host string

+ MaxHumidity *float32

+ MaxTemperature *float32

+ MinHumidity *float32

+ MinTemperature *float32

+ Name string

+ Since *timestamp.Timestamp

+ func (*ClimateDeclaration) Descriptor() ([]byte, []int)

+ func (*ClimateDeclaration) ProtoMessage()

+ func (x *ClimateDeclaration) GetHost() string

+ func (x *ClimateDeclaration) GetMaxHumidity() float32

+ func (x *ClimateDeclaration) GetMaxTemperature() float32

+ func (x *ClimateDeclaration) GetMinHumidity() float32

+ func (x *ClimateDeclaration) GetMinTemperature() float32

+ func (x *ClimateDeclaration) GetName() string

+ func (x *ClimateDeclaration) GetSince() *timestamp.Timestamp

+ func (x *ClimateDeclaration) ProtoReflect() protoreflect.Message

+ func (x *ClimateDeclaration) Reset()

+ func (x *ClimateDeclaration) String() string

+ type ClimateDownStream struct

+ Metadata map[string]string

+ RegistrationConfirmation *ClimateRegistrationConfirmation

+ func (*ClimateDownStream) Descriptor() ([]byte, []int)

+ func (*ClimateDownStream) ProtoMessage()

+ func (x *ClimateDownStream) GetMetadata() map[string]string

+ func (x *ClimateDownStream) GetRegistrationConfirmation() *ClimateRegistrationConfirmation

+ func (x *ClimateDownStream) ProtoReflect() protoreflect.Message

+ func (x *ClimateDownStream) Reset()

+ func (x *ClimateDownStream) String() string

+ type ClimateRegistrationConfirmation struct

+ PageSize int32

+ SendBacklogs bool

+ func (*ClimateRegistrationConfirmation) Descriptor() ([]byte, []int)

+ func (*ClimateRegistrationConfirmation) ProtoMessage()

+ func (x *ClimateRegistrationConfirmation) GetPageSize() int32

+ func (x *ClimateRegistrationConfirmation) GetSendBacklogs() bool

+ func (x *ClimateRegistrationConfirmation) ProtoReflect() protoreflect.Message

+ func (x *ClimateRegistrationConfirmation) Reset()

+ func (x *ClimateRegistrationConfirmation) String() string

+ type ClimateReport struct

+ Humidity *float32

+ Temperatures []float32

+ Time *timestamp.Timestamp

+ func (*ClimateReport) Descriptor() ([]byte, []int)

+ func (*ClimateReport) ProtoMessage()

+ func (x *ClimateReport) GetHumidity() float32

+ func (x *ClimateReport) GetTemperatures() []float32

+ func (x *ClimateReport) GetTime() *timestamp.Timestamp

+ func (x *ClimateReport) ProtoReflect() protoreflect.Message

+ func (x *ClimateReport) Reset()

+ func (x *ClimateReport) String() string

+ type ClimateState struct

+ Humidity *float32

+ Name string

+ Temperature *float32

+ UvLight *float32

+ VisibleLight *float32

+ Wind *float32

+ func (*ClimateState) Descriptor() ([]byte, []int)

+ func (*ClimateState) ProtoMessage()

+ func (a *ClimateState) Clone() *ClimateState

+ func (x *ClimateState) GetHumidity() float32

+ func (x *ClimateState) GetName() string

+ func (x *ClimateState) GetTemperature() float32

+ func (x *ClimateState) GetUvLight() float32

+ func (x *ClimateState) GetVisibleLight() float32

+ func (x *ClimateState) GetWind() float32

+ func (x *ClimateState) ProtoReflect() protoreflect.Message

+ func (x *ClimateState) Reset()

+ func (x *ClimateState) String() string

+ type ClimateTarget struct

+ Current *ClimateState

+ CurrentEnd *ClimateState

+ Next *ClimateState

+ NextEnd *ClimateState

+ NextTime *timestamp.Timestamp

+ func (*ClimateTarget) Descriptor() ([]byte, []int)

+ func (*ClimateTarget) ProtoMessage()

+ func (x *ClimateTarget) GetCurrent() *ClimateState

+ func (x *ClimateTarget) GetCurrentEnd() *ClimateState

+ func (x *ClimateTarget) GetNext() *ClimateState

+ func (x *ClimateTarget) GetNextEnd() *ClimateState

+ func (x *ClimateTarget) GetNextTime() *timestamp.Timestamp

+ func (x *ClimateTarget) ProtoReflect() protoreflect.Message

+ func (x *ClimateTarget) Reset()

+ func (x *ClimateTarget) String() string

+ type ClimateTimeSeries struct

+ Humidity PointSeries

+ Reference time.Time

+ Temperature PointSeries

+ TemperatureAux []PointSeries

+ Units string

+ type ClimateUpStream struct

+ Alarms []*AlarmUpdate

+ Backlog bool

+ Declaration *ClimateDeclaration

+ Metadata map[string]string

+ Reports []*ClimateReport

+ Target *ClimateTarget

+ func (*ClimateUpStream) Descriptor() ([]byte, []int)

+ func (*ClimateUpStream) ProtoMessage()

+ func (x *ClimateUpStream) GetAlarms() []*AlarmUpdate

+ func (x *ClimateUpStream) GetBacklog() bool

+ func (x *ClimateUpStream) GetDeclaration() *ClimateDeclaration

+ func (x *ClimateUpStream) GetMetadata() map[string]string

+ func (x *ClimateUpStream) GetReports() []*ClimateReport

+ func (x *ClimateUpStream) GetTarget() *ClimateTarget

+ func (x *ClimateUpStream) ProtoReflect() protoreflect.Message

+ func (x *ClimateUpStream) Reset()

+ func (x *ClimateUpStream) String() string

+ type ConfirmationResult struct

+ Confirmation Down

+ Error error

+ type Connection struct

+ func (c *Connection[Up, Down]) Close() (err error)

+ func (c *Connection[Up, Down]) Confirmation() Down

+ func (c *Connection[Up, Down]) Established() bool

+ func (c *Connection[Up, Down]) Send(m Up) (res Down, err error)

+ type ConnectionOption interface

+ func WithDialOptions(opts ...grpc.DialOption) ConnectionOption

+ type ConnectionResult struct

+ Connection *Connection[Up, Down]

+ Error error

+ type DiskStatus struct

+ BytesPerSecond int64

+ FreeBytes int64

+ TotalBytes int64

+ func (*DiskStatus) Descriptor() ([]byte, []int)

+ func (*DiskStatus) ProtoMessage()

+ func (x *DiskStatus) GetBytesPerSecond() int64

+ func (x *DiskStatus) GetFreeBytes() int64

+ func (x *DiskStatus) GetTotalBytes() int64

+ func (x *DiskStatus) ProtoReflect() protoreflect.Message

+ func (x *DiskStatus) Reset()

+ func (x *DiskStatus) String() string

+ type Error string

+ func (e Error) Error() string

+ type HandleFunc func(context.Context, Up) (Down, error)

+ type NotificationSettings struct

+ NotifyNonGraceful bool

+ NotifyOnWarning bool

+ SubscribeToAll bool

+ Subscriptions []string

+ func (s NotificationSettings) SubscribedTo(zone string) bool

+ type NotificationSettingsUpdate struct

+ Endpoint string

+ Settings NotificationSettings

+ type OlympusClient interface

+ Climate func(ctx context.Context, opts ...grpc.CallOption) (Olympus_ClimateClient, error)

+ SendAlarm func(ctx context.Context, in *AlarmUpdate, opts ...grpc.CallOption) (*empty.Empty, error)

+ Tracking func(ctx context.Context, opts ...grpc.CallOption) (Olympus_TrackingClient, error)

+ func NewOlympusClient(cc grpc.ClientConnInterface) OlympusClient

+ type OlympusServer interface

+ Climate func(Olympus_ClimateServer) error

+ SendAlarm func(context.Context, *AlarmUpdate) (*empty.Empty, error)

+ Tracking func(Olympus_TrackingServer) error

+ type Olympus_ClimateClient interface

+ Recv func() (*ClimateDownStream, error)

+ Send func(*ClimateUpStream) error

+ type Olympus_ClimateServer interface

+ Recv func() (*ClimateUpStream, error)

+ Send func(*ClimateDownStream) error

+ type Olympus_TrackingClient interface

+ Recv func() (*TrackingDownStream, error)

+ Send func(*TrackingUpStream) error

+ type Olympus_TrackingServer interface

+ Recv func() (*TrackingUpStream, error)

+ Send func(*TrackingDownStream) error

+ type Point lttb.Point[float32]

+ func (p Point) MarshalJSON() ([]byte, error)

+ type PointSeries []lttb.Point[float32]

+ func (series PointSeries) MarshalJSON() ([]byte, error)

+ type RequestResult struct

+ Error error

+ Message Down

+ type ServerStream interface

+ Context func() context.Context

+ Recv func() (Up, error)

+ Send func(Down) error

+ type ServiceEvent struct

+ End *time.Time

+ Graceful bool

+ Start time.Time

+ type ServiceLog struct

+ Events []*ServiceEvent

+ Zone string

+ func (l *ServiceLog) Clone() *ServiceLog

+ func (l *ServiceLog) On() bool

+ func (l *ServiceLog) SetOff(t time.Time, graceful bool)

+ func (l *ServiceLog) SetOn(time time.Time)

+ type StreamInfo struct

+ ExperimentName string

+ StreamURL string

+ ThumbnailURL string

+ type TrackingDeclaration struct

+ ExperimentName string

+ Hostname string

+ Since *timestamp.Timestamp

+ StreamServer string

+ func (*TrackingDeclaration) Descriptor() ([]byte, []int)

+ func (*TrackingDeclaration) ProtoMessage()

+ func (x *TrackingDeclaration) GetExperimentName() string

+ func (x *TrackingDeclaration) GetHostname() string

+ func (x *TrackingDeclaration) GetSince() *timestamp.Timestamp

+ func (x *TrackingDeclaration) GetStreamServer() string

+ func (x *TrackingDeclaration) ProtoReflect() protoreflect.Message

+ func (x *TrackingDeclaration) Reset()

+ func (x *TrackingDeclaration) String() string

+ type TrackingDownStream struct

+ Metadata map[string]string

+ func (*TrackingDownStream) Descriptor() ([]byte, []int)

+ func (*TrackingDownStream) ProtoMessage()

+ func (x *TrackingDownStream) GetMetadata() map[string]string

+ func (x *TrackingDownStream) ProtoReflect() protoreflect.Message

+ func (x *TrackingDownStream) Reset()

+ func (x *TrackingDownStream) String() string

+ type TrackingInfo struct

+ BytesPerSecond int64

+ FreeBytes int64

+ Since time.Time

+ Stream *StreamInfo

+ TotalBytes int64

+ func (i *TrackingInfo) Clone() *TrackingInfo

+ type TrackingUpStream struct

+ Alarms []*AlarmUpdate

+ Declaration *TrackingDeclaration

+ DiskStatus *DiskStatus

+ Metadata map[string]string

+ func (*TrackingUpStream) Descriptor() ([]byte, []int)

+ func (*TrackingUpStream) ProtoMessage()

+ func (x *TrackingUpStream) GetAlarms() []*AlarmUpdate

+ func (x *TrackingUpStream) GetDeclaration() *TrackingDeclaration

+ func (x *TrackingUpStream) GetDiskStatus() *DiskStatus

+ func (x *TrackingUpStream) GetMetadata() map[string]string

+ func (x *TrackingUpStream) ProtoReflect() protoreflect.Message

+ func (x *TrackingUpStream) Reset()

+ func (x *TrackingUpStream) String() string

+ type UnimplementedOlympusServer struct

+ func (UnimplementedOlympusServer) Climate(Olympus_ClimateServer) error

+ func (UnimplementedOlympusServer) SendAlarm(context.Context, *AlarmUpdate) (*empty.Empty, error)

+ func (UnimplementedOlympusServer) Tracking(Olympus_TrackingServer) error

+ type UnsafeOlympusServer interface

+ type ZoneClimateReport struct

+ Current *ClimateState

+ CurrentEnd *ClimateState

+ Humidity *float32

+ HumidityBounds Bounds

+ Next *ClimateState

+ NextEnd *ClimateState

+ NextTime *time.Time

+ Since time.Time

+ Temperature *float32

+ TemperatureBounds Bounds

+ func (r *ZoneClimateReport) Clone() *ZoneClimateReport

+ type ZoneReport struct

+ Alarms []AlarmReport

+ Climate *ZoneClimateReport

+ Host string

+ Name string

+ Tracking *TrackingInfo

+ type ZoneReportSummary struct

+ ActiveEmergencies int

+ ActiveWarnings int

+ Climate *ZoneClimateReport

+ Host string

+ Name string

+ Tracking *TrackingInfo

v0.5.2

Jul 6, 2023

v0.5.1

Jul 6, 2023

v0.5.0

Jul 6, 2023

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL