api

Documentation

Index

• type DeviceAPI
  • func NewDeviceAPI(driver models.DriverEngine) DeviceAPI
• type PluginAPI
  • func NewPluginAPI(driver models.DriverEngine) PluginAPI
• type PluginStatus

Types

type DeviceAPI

type DeviceAPI interface {
	GetDeviceShadow(ctx *comctx.Context) (any, error)
	GetLatestDeviceProperty(ctx *comctx.Context) (any, error)
	PublishEvent(ctx *comctx.Context) (any, error)
	SetDeviceNumber(ctx *comctx.Context) (any, error)
}

func NewDeviceAPI

func NewDeviceAPI(driver models.DriverEngine) DeviceAPI

type PluginAPI

type PluginAPI interface {
	CreateAndActivatePlugin(ctx *comctx.Context) (any, error)
	ActivatePlugin(ctx *comctx.Context) (any, error)
	ClosePlugin(ctx *comctx.Context) (any, error)
	RestartPlugin(ctx *comctx.Context) (any, error)
	CheckPluginStatus(ctx *comctx.Context) (any, error)
	CheckAllPluginStatus(ctx *comctx.Context) (any, error)
	GetAllConfigs(ctx *comctx.Context) (any, error)
	UpdateNorthLink(c *comctx.Context) (any, error)
}

func NewPluginAPI

func NewPluginAPI(driver models.DriverEngine) PluginAPI

type PluginStatus

type PluginStatus struct {
	Name   string         `json:"name,omitempty"`
	Enable bool           `json:"enable,omitempty"`
	On     bool           `json:"on,omitempty"`
	Status map[string]int `json:"status,omitempty"`
}