devicerepository

Documentation

Overview

Package devicerepository integrates with the Device Repository.

Index

• type Config
  • func (c Config) Initialize(ctx context.Context, blobConf config.BlobConfig, overwrite bool) error
  • func (c Config) NewStore(ctx context.Context, blobConf config.BlobConfig) (store.Store, error)
• type DeviceRepository
  • func New(c *component.Component, conf *Config) (*DeviceRepository, error)
  • func (dr *DeviceRepository) Context() context.Context
  • func (dr *DeviceRepository) GetBrand(ctx context.Context, req *ttnpb.GetEndDeviceBrandRequest) (*ttnpb.EndDeviceBrand, error)
  • func (dr *DeviceRepository) GetDownlinkDecoder(ctx context.Context, req *ttnpb.GetPayloadFormatterRequest) (*ttnpb.MessagePayloadDecoder, error)
  • func (dr *DeviceRepository) GetDownlinkEncoder(ctx context.Context, req *ttnpb.GetPayloadFormatterRequest) (*ttnpb.MessagePayloadEncoder, error)
  • func (dr *DeviceRepository) GetModel(ctx context.Context, req *ttnpb.GetEndDeviceModelRequest) (*ttnpb.EndDeviceModel, error)
  • func (dr *DeviceRepository) GetTemplate(ctx context.Context, req *ttnpb.GetTemplateRequest) (*ttnpb.EndDeviceTemplate, error)
  • func (dr *DeviceRepository) GetUplinkDecoder(ctx context.Context, req *ttnpb.GetPayloadFormatterRequest) (*ttnpb.MessagePayloadDecoder, error)
  • func (dr *DeviceRepository) ListBrands(ctx context.Context, req *ttnpb.ListEndDeviceBrandsRequest) (*ttnpb.ListEndDeviceBrandsResponse, error)
  • func (dr *DeviceRepository) ListModels(ctx context.Context, req *ttnpb.ListEndDeviceModelsRequest) (*ttnpb.ListEndDeviceModelsResponse, error)
  • func (dr *DeviceRepository) RegisterHandlers(s *runtime.ServeMux, conn *grpc.ClientConn)
  • func (dr *DeviceRepository) RegisterServices(s *grpc.Server)
  • func (*DeviceRepository) Roles() []ttnpb.ClusterRole
• type StoreConfig

Types

type Config

type Config struct {
	Store StoreConfig `name:"store"`

	Source    string `name:"source" description:"Device Repository Source (directory)"`
	Directory string `name:"directory" description:"OS filesystem directory, which contains the Device Repository"`

	AssetsBaseURL string `name:"assets-base-url" description:"The base URL for Device Repository assets"`
}

Config represents the DeviceRepository configuration.

func (Config) Initialize

func (c Config) Initialize(ctx context.Context, blobConf config.BlobConfig, overwrite bool) error

Initialize sets up the Device Repository.

func (Config) NewStore

func (c Config) NewStore(ctx context.Context, blobConf config.BlobConfig) (store.Store, error)

NewStore creates a new Store for end devices.

type DeviceRepository

type DeviceRepository struct {
	ttnpb.UnimplementedDeviceRepositoryServer

	*component.Component
	// contains filtered or unexported fields
}

DeviceRepository implements the Device Repository component.

The Device Repository component exposes the DeviceRepository service.

func New

func New(c *component.Component, conf *Config) (*DeviceRepository, error)

New returns a new *DeviceRepository.

func (*DeviceRepository) Context

func (dr *DeviceRepository) Context() context.Context

Context returns the context of the Device Repository.

func (*DeviceRepository) GetBrand

func (dr *DeviceRepository) GetBrand(
	ctx context.Context,
	req *ttnpb.GetEndDeviceBrandRequest,
) (*ttnpb.EndDeviceBrand, error)

GetBrand implements the ttnpb.DeviceRepositoryServer interface.

func (*DeviceRepository) GetDownlinkDecoder

func (dr *DeviceRepository) GetDownlinkDecoder(
	ctx context.Context,
	req *ttnpb.GetPayloadFormatterRequest,
) (*ttnpb.MessagePayloadDecoder, error)

GetDownlinkDecoder implements the ttnpb.DeviceRepositoryServer interface.

func (*DeviceRepository) GetDownlinkEncoder

func (dr *DeviceRepository) GetDownlinkEncoder(
	ctx context.Context,
	req *ttnpb.GetPayloadFormatterRequest,
) (*ttnpb.MessagePayloadEncoder, error)

GetDownlinkEncoder implements the ttnpb.DeviceRepositoryServer interface.

func (*DeviceRepository) GetModel

func (dr *DeviceRepository) GetModel(
	ctx context.Context,
	req *ttnpb.GetEndDeviceModelRequest,
) (*ttnpb.EndDeviceModel, error)

GetModel implements the ttnpb.DeviceRepositoryServer interface.

func (*DeviceRepository) GetTemplate

func (dr *DeviceRepository) GetTemplate(
	ctx context.Context,
	req *ttnpb.GetTemplateRequest,
) (*ttnpb.EndDeviceTemplate, error)

GetTemplate implements the ttnpb.DeviceRepositoryServer interface.

func (*DeviceRepository) GetUplinkDecoder

func (dr *DeviceRepository) GetUplinkDecoder(
	ctx context.Context,
	req *ttnpb.GetPayloadFormatterRequest,
) (*ttnpb.MessagePayloadDecoder, error)

GetUplinkDecoder implements the ttnpb.DeviceRepositoryServer interface.

func (*DeviceRepository) ListBrands

func (dr *DeviceRepository) ListBrands(
	ctx context.Context,
	req *ttnpb.ListEndDeviceBrandsRequest,
) (*ttnpb.ListEndDeviceBrandsResponse, error)

ListBrands implements the ttnpb.DeviceRepositoryServer interface.

func (*DeviceRepository) ListModels

func (dr *DeviceRepository) ListModels(
	ctx context.Context,
	req *ttnpb.ListEndDeviceModelsRequest,
) (*ttnpb.ListEndDeviceModelsResponse, error)

ListModels implements the ttnpb.DeviceRepositoryServer interface.

func (*DeviceRepository) RegisterHandlers

func (dr *DeviceRepository) RegisterHandlers(s *runtime.ServeMux, conn *grpc.ClientConn)

RegisterHandlers registers gRPC handlers.

func (*DeviceRepository) RegisterServices

func (dr *DeviceRepository) RegisterServices(s *grpc.Server)

RegisterServices registers services provided by dr at s.

func (*DeviceRepository) Roles

func (*DeviceRepository) Roles() []ttnpb.ClusterRole

Roles returns the roles that the Device Repository fulfills.

type StoreConfig

type StoreConfig struct {
	Store store.Store `name:"-"`

	Bleve bleve.Config `name:"bleve"`
}

StoreConfig represents configuration for the Device Repository store.