db

Documentation

Overview

Package db implements a database for storing the history of the state of the CX34

Index

• type Database
  • func Open(dir string) (*Database, error)
  • func (db *Database) HistorianService() *Service
  • func (db *Database) ReadSnapshots(start, end time.Time) ([]*chiltrix.State, error)
  • func (db *Database) RestoreBackup(badgerBackupFilePath string) error
  • func (db *Database) WriteSnapshot(state *chiltrix.State) error
• type Service
  • func (s *Service) QueryStream(req *chiltrix.QueryStreamRequest, srv chiltrix.Historian_QueryStreamServer) error

Types

type Database

type Database struct {
	// contains filtered or unexported fields
}

Database stores historical values of the heat pump's state.

func Open

func Open(dir string) (*Database, error)

Open returns a databased stored in the given directory.

func (*Database) HistorianService

func (db *Database) HistorianService() *Service

HistorianService returns an implementation of chiltrix.Historian.

func (*Database) ReadSnapshots

func (db *Database) ReadSnapshots(start, end time.Time) ([]*chiltrix.State, error)

ReadSnapshots reads a set of snapshots from the database based on a time range.

func (*Database) RestoreBackup

func (db *Database) RestoreBackup(badgerBackupFilePath string) error

func (*Database) WriteSnapshot

func (db *Database) WriteSnapshot(state *chiltrix.State) error

WriteSnapshot writes a snaptshot of the heatpump state to the database.

type Service

type Service struct {
	chiltrix.UnimplementedHistorianServer
	// contains filtered or unexported fields
}

Service implements chiltrix.HistorianServer and is backed by a Database object.

func (*Service) QueryStream

func (s *Service) QueryStream(req *chiltrix.QueryStreamRequest, srv chiltrix.Historian_QueryStreamServer) error

QueryStream returns a stream of State values based on a query.