device

Documentation

Index

• type BlockwiseTransferConfig
  • func (c *BlockwiseTransferConfig) Validate() error
• type CoapConfig
  • func (c *CoapConfig) Validate() error
• type Config
  • func (c *Config) Validate() error
• type InactivityMonitor
  • func (c *InactivityMonitor) Validate() error
• type ManufacturerConfig
  • func (c *ManufacturerConfig) Validate() error
• type ManufacturerTLSConfig
  • func (c *ManufacturerTLSConfig) ToCertMangerConfig() client.Config
  • func (c *ManufacturerTLSConfig) Validate() error
• type OwnershipTransferConfig
  • func (c *OwnershipTransferConfig) Validate() error
• type OwnershipTransferMethod
• type Service
  • func New(ctx context.Context, serviceName string, config Config, logger log.Logger, ...) (*Service, error)
  • func (s *Service) Close()
  • func (s *Service) DialDTLS(ctx context.Context, addr string, _ *dtls.Config, opts ...coap.DialOptionFunc) (*coap.ClientCloseHandler, error)
  • func (s *Service) DialOwnership(ctx context.Context, addr string, dtlsCfg *dtls.Config, ...) (*coap.ClientCloseHandler, error)
  • func (s *Service) DialTCP(ctx context.Context, addr string, opts ...coap.DialOptionFunc) (*coap.ClientCloseHandler, error)
  • func (s *Service) DialTLS(ctx context.Context, addr string, tlsCfg *tls.Config, ...) (*coap.ClientCloseHandler, error)
  • func (s *Service) DialUDP(ctx context.Context, addr string, opts ...coap.DialOptionFunc) (*coap.ClientCloseHandler, error)
  • func (s *Service) ErrFunc(err error)
  • func (s *Service) GetDeviceConfiguration() core.DeviceConfiguration
  • func (s *Service) GetOwnOptions() []core.OwnOption
  • func (s *Service) GetOwnershipClients() []otm.Client
  • func (s *Service) Serve() error
• type TLSConfig
  • func (c *TLSConfig) Validate() error
• type UDPClientConn
  • func (c *UDPClientConn) Context() context.Context

Types

type BlockwiseTransferConfig

type BlockwiseTransferConfig struct {
	Enabled bool   `yaml:"enabled" json:"enabled"`
	SZX     string `yaml:"blockSize" json:"blockSize"`
	// contains filtered or unexported fields
}

func (*BlockwiseTransferConfig) Validate

func (c *BlockwiseTransferConfig) Validate() error

type CoapConfig

type CoapConfig struct {
	MaxMessageSize    uint32                  `yaml:"maxMessageSize" json:"maxMessageSize"`
	InactivityMonitor InactivityMonitor       `yaml:"inactivityMonitor" json:"inactivityMonitor"`
	BlockwiseTransfer BlockwiseTransferConfig `yaml:"blockwiseTransfer" json:"blockwiseTransfer"`
	OwnershipTransfer OwnershipTransferConfig `yaml:"ownershipTransfer" json:"ownershipTransfer"`
	TLS               TLSConfig               `yaml:"tls" json:"tls"`
}

func (*CoapConfig) Validate

func (c *CoapConfig) Validate() error

type Config

type Config struct {
	COAP CoapConfig `yaml:"coap" json:"coap"`
}

func (*Config) Validate

func (c *Config) Validate() error

type InactivityMonitor

type InactivityMonitor struct {
	Timeout time.Duration `yaml:"timeout" json:"timeout"`
}

func (*InactivityMonitor) Validate

func (c *InactivityMonitor) Validate() error

type ManufacturerConfig

type ManufacturerConfig struct {
	TLS ManufacturerTLSConfig `yaml:"tls" json:"tls"`
}

func (*ManufacturerConfig) Validate

func (c *ManufacturerConfig) Validate() error

type ManufacturerTLSConfig

type ManufacturerTLSConfig struct {
	CAPool   string `yaml:"caPool" json:"caPool" description:"file path to the root certificates in PEM format"`
	KeyFile  string `yaml:"keyFile" json:"keyFile" description:"file name of private key in PEM format"`
	CertFile string `yaml:"certFile" json:"certFile" description:"file name of certificate in PEM format"`
	// contains filtered or unexported fields
}

func (*ManufacturerTLSConfig) ToCertMangerConfig

func (c *ManufacturerTLSConfig) ToCertMangerConfig() client.Config

func (*ManufacturerTLSConfig) Validate

func (c *ManufacturerTLSConfig) Validate() error

type OwnershipTransferConfig

type OwnershipTransferConfig struct {
	Methods      []OwnershipTransferMethod `yaml:"methods" json:"methods"`
	Manufacturer ManufacturerConfig        `yaml:"manufacturerCertificate" json:"manufacturerCertificate"`
}

func (*OwnershipTransferConfig) Validate

func (c *OwnershipTransferConfig) Validate() error

type OwnershipTransferMethod

type OwnershipTransferMethod string

const (
	OwnershipTransferJustWorks               OwnershipTransferMethod = "justWorks"
	OwnershipTransferManufacturerCertificate OwnershipTransferMethod = "manufacturerCertificate"
)

type Service

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

func New

func New(ctx context.Context, serviceName string, config Config, logger log.Logger, tracerProvider trace.TracerProvider) (*Service, error)

New creates new GRPC service

func (*Service) Close

func (s *Service) Close()

Shutdown turn off server.

func (*Service) DialDTLS

func (s *Service) DialDTLS(ctx context.Context, addr string, _ *dtls.Config, opts ...coap.DialOptionFunc) (*coap.ClientCloseHandler, error)

func (*Service) DialOwnership

func (s *Service) DialOwnership(ctx context.Context, addr string, dtlsCfg *dtls.Config, opts ...coap.DialOptionFunc) (*coap.ClientCloseHandler, error)

func (*Service) DialTCP

func (s *Service) DialTCP(ctx context.Context, addr string, opts ...coap.DialOptionFunc) (*coap.ClientCloseHandler, error)

func (*Service) DialTLS

func (s *Service) DialTLS(ctx context.Context, addr string, tlsCfg *tls.Config, opts ...coap.DialOptionFunc) (*coap.ClientCloseHandler, error)

func (*Service) DialUDP

func (s *Service) DialUDP(ctx context.Context, addr string, opts ...coap.DialOptionFunc) (*coap.ClientCloseHandler, error)

func (*Service) ErrFunc

func (s *Service) ErrFunc(err error)

func (*Service) GetDeviceConfiguration

func (s *Service) GetDeviceConfiguration() core.DeviceConfiguration

func (*Service) GetOwnOptions

func (s *Service) GetOwnOptions() []core.OwnOption

func (*Service) GetOwnershipClients

func (s *Service) GetOwnershipClients() []otm.Client

func (*Service) Serve

func (s *Service) Serve() error

Serve starts a device provisioning service on the configured address in *Service.

type TLSConfig

type TLSConfig struct {
	SubjectUUID string `yaml:"subjectUuid" json:"subjectUuid"`

	PreSharedKeyUUID string `yaml:"preSharedKeyUuid" json:"preSharedKeyUuid"`
	// contains filtered or unexported fields
}

func (*TLSConfig) Validate

func (c *TLSConfig) Validate() error

type UDPClientConn

type UDPClientConn struct {
	*client.Client
}

func (*UDPClientConn) Context

func (c *UDPClientConn) Context() context.Context