dmcontext

Documentation

Index

• Constants
• Variables
• func ParseTopic(topic string) (string, error)
• func Run(handle func(Context) error)
• type Context
  • func NewContext(confFile string) Context
• type DeltaCallback
• type DeviceEvent
• type DeviceInfo
• type DevicePropConfigs
• type DeviceProperties
• type DeviceShadow
• type DmCtx
  • func (c *DmCtx) Close() error
  • func (c *DmCtx) GetAllDevices() []DeviceInfo
  • func (c *DmCtx) GetDevicePropConfigs() (map[string]DevicePropConfigs, error)
  • func (c *DmCtx) GetDeviceProperties(info *DeviceInfo) (*DeviceShadow, error)
  • func (c *DmCtx) GetDriverConfig() (string, error)
  • func (c *DmCtx) Offline(info *DeviceInfo) error
  • func (c *DmCtx) Online(info *DeviceInfo) error
  • func (c *DmCtx) RegisterDeltaCallback(info *DeviceInfo, cb DeltaCallback)
  • func (c *DmCtx) RegisterEventCallback(info *DeviceInfo, cb EventCallback)
  • func (c *DmCtx) ReportDeviceProperties(info *DeviceInfo, props *DeviceProperties) error
  • func (c *DmCtx) Start()
  • func (c *DmCtx) SystemConfigExt() *SystemConfig
• type EventCallback
• type SystemConfig
• type Topic

Constants

const (
	DefaultDriverConf = "/etc/baetyl/driver.yml"
	DefaultPropsConf  = "/etc/baetyl/props.yml"
	KeyDevice         = "device"
	KeyStatus         = "status"
	OnlineStatus      = "online"
	OfflineStatus     = "offline"
)

const (
	DeviceTopicRe = "\\$baetyl/device/(.+)/(.+)"
)

Variables

var (
	ErrCallbackNotRegister     = errors.New("callback not registered yet")
	ErrInvalidCallback         = errors.New("invalid device callback")
	ErrInvalidMessage          = errors.New("invalid device message")
	ErrInvalidChannel          = errors.New("invalid channel")
	ErrResponseChannelNotExist = errors.New("response channel not exist")
)

Functions

func ParseTopic

func ParseTopic(topic string) (string, error)

func Run

func Run(handle func(Context) error)

Run service

Types

type Context

type Context interface {
	context.Context
	SystemConfigExt() *SystemConfig
	GetAllDevices() []DeviceInfo
	ReportDeviceProperties(info *DeviceInfo, props *DeviceProperties) error
	GetDeviceProperties(info *DeviceInfo) (*DeviceShadow, error)
	RegisterDeltaCallback(info *DeviceInfo, cb DeltaCallback)
	RegisterEventCallback(info *DeviceInfo, cb EventCallback)
	Online(info *DeviceInfo) error
	Offline(info *DeviceInfo) error
	GetDriverConfig() (string, error)
	GetDevicePropConfigs() (map[string]DevicePropConfigs, error)
	Start()
	io.Closer
}

func NewContext

func NewContext(confFile string) Context

type DeltaCallback

type DeltaCallback func(*DeviceInfo, *DeviceProperties) error

type DeviceEvent

type DeviceEvent struct {
	Name  string      `json:"name,omitempty"`
	Event interface{} `json:"event,omitempty"`
}

type DeviceInfo

type DeviceInfo struct {
	Name  string `yaml:"name,omitempty" json:"name,omitempty"`
	Topic `yaml:",inline" json:",inline"`
}

type DevicePropConfigs

type DevicePropConfigs struct {
	Name        string            `yaml:"name,omitempty" json:"name,omitempty"`
	PropConfigs map[string]string `yaml:"propConfigs,omitempty" json:"propConfigs,omitempty"`
}

type DeviceProperties

type DeviceProperties struct {
	Name  string                 `json:"name,omitempty"`
	Props map[string]interface{} `json:"props,omitempty"`
}

type DeviceShadow

type DeviceShadow struct {
	Name   string    `json:"name,omitempty"`
	Report v1.Report `json:"report,omitempty"`
	Desire v1.Desire `json:"desire,omitempty"`
}

type DmCtx

type DmCtx struct {
	context.Context
	// contains filtered or unexported fields
}

func (*DmCtx) Close

func (c *DmCtx) Close() error

func (*DmCtx) GetAllDevices

func (c *DmCtx) GetAllDevices() []DeviceInfo

func (*DmCtx) GetDevicePropConfigs

func (c *DmCtx) GetDevicePropConfigs() (map[string]DevicePropConfigs, error)

func (*DmCtx) GetDeviceProperties

func (c *DmCtx) GetDeviceProperties(info *DeviceInfo) (*DeviceShadow, error)

func (*DmCtx) GetDriverConfig

func (c *DmCtx) GetDriverConfig() (string, error)

func (*DmCtx) Offline

func (c *DmCtx) Offline(info *DeviceInfo) error

func (*DmCtx) Online

func (c *DmCtx) Online(info *DeviceInfo) error

func (*DmCtx) RegisterDeltaCallback

func (c *DmCtx) RegisterDeltaCallback(info *DeviceInfo, cb DeltaCallback)

func (*DmCtx) RegisterEventCallback

func (c *DmCtx) RegisterEventCallback(info *DeviceInfo, cb EventCallback)

func (*DmCtx) ReportDeviceProperties

func (c *DmCtx) ReportDeviceProperties(info *DeviceInfo, props *DeviceProperties) error

func (*DmCtx) Start

func (c *DmCtx) Start()

func (*DmCtx) SystemConfigExt

func (c *DmCtx) SystemConfigExt() *SystemConfig

type EventCallback

type EventCallback func(*DeviceInfo, *DeviceEvent) error

type SystemConfig

type SystemConfig struct {
	context.SystemConfig `yaml:",inline" json:",inline"`
	Devices              []DeviceInfo `yaml:"devices,omitempty" json:"devices,omitempty"`
}

type Topic

type Topic struct {
	Delta       mqtt2.QOSTopic `yaml:"delta,omitempty" json:"delta,omitempty"`
	Report      mqtt2.QOSTopic `yaml:"report,omitempty" json:"report,omitempty"`
	Event       mqtt2.QOSTopic `yaml:"event,omitempty" json:"event,omitempty"`
	Get         mqtt2.QOSTopic `yaml:"get,omitempty" json:"get,omitempty"`
	GetResponse mqtt2.QOSTopic `yaml:"getResponse,omitempty" json:"getResponse,omitempty"`
}