plugin

package

Go to main page

Versions in this module

v1

v1.9.1

Mar 9, 2022

Changes in this version

+ func ConcatPluginPath(pluginID string, paths ...string) string

+ func DeviceLogoURL(req *http.Request, d entity.Device) string

+ func OTA(areaID uint64, pluginID, identity, firmwareURL string) (err error)

type Client

+ OTA func(d entity.Device, firmwareURL string) error

+ type Config struct

+ Info string

+ Name string

+ SupportDevices []DeviceConfig

+ Version string

+ func (p Config) ID() string

+ func (p Config) Validate() error

type DeviceConfig

+ Control string

+ Logo string

+ Model string

+ Name string

+ Provisioning string

+ Type DeviceType

type DeviceInfo

+ Identity string

+ Manufacturer string

+ Version string

+ type DeviceInstances struct

+ Identity string

+ Instances []Instance

+ OTASupport bool

+ func (das DeviceInstances) GetInfo() (d DeviceInfo, err error)

type DeviceType

+ const TypeBedSideLamp

+ const TypeBulb

+ const TypeCamera

+ const TypeCeilingLamp

+ const TypeConverter

+ const TypeCurtain

+ const TypeDWirelessSwitch

+ const TypeDoorLock

+ const TypeDownLight

+ const TypeDynamicAndStaticSensor

+ const TypeFanLamp

+ const TypeGasSensor

+ const TypeGateway

+ const TypeHumanSensors

+ const TypeIlluminanceSensor

+ const TypeLamp

+ const TypeLifeElectric

+ const TypeLightStrip

+ const TypeMagneticRailLamp

+ const TypeNightLight

+ const TypeOneKeySwitch

+ const TypePeepholeDoorbell

+ const TypePendantLight

+ const TypePowerStrip

+ const TypeRouter

+ const TypeSensor

+ const TypeSmokeSensor

+ const TypeTemperatureAndHumiditySensor

+ const TypeThreeKeySwitch

+ const TypeTwoKeySwitch

+ const TypeWallPlug

+ const TypeWaterLeakSensor

+ const TypeWifiRepeater

+ const TypeWindowDoorSensor

type DiscoverResponse

+ LogoURL string

type Plugin

+ func (p Plugin) StopAndRemovePluginImage() (err error)

v1.5.0

Nov 23, 2021

Changes in this version

+ func DisconnectDevice(identity, pluginID string, authParams map[string]string) error

+ func GetInfoFromDeviceAttrs(pluginID string, das DeviceAttributes) (d entity.Device, err error)

+ func PluginBasePath(path string) (plgPath string)

+ func RunPlugin(plg Plugin) (containerID string, err error)

type Client

+ Connect func(identity, pluginID string, authParams map[string]string) (DeviceAttributes, error)

+ DeviceConfig func(entity.Device) DeviceConfig

+ DeviceConfigs func() []DeviceConfig

type DeviceAttributes

+ func ConnectDevice(identity, pluginID string, authParams map[string]string) (das DeviceAttributes, err error)

+ type DeviceConfig struct

+ PluginID string

+ type DeviceInfo struct

+ Control string

+ Logo string

+ Model string

+ Name string

+ Provisioning string

type DiscoverResponse

+ AuthRequired bool

type Manager

+ GetPlugin func(id string) (*Plugin, error)

+ LoadPlugins func() (map[string]*Plugin, error)

type Plugin

+ Name string

+ func GetPluginConfig(addr, pluginID string) (config Plugin, err error)

+ func NewFromEntity(p entity.PluginInfo) Plugin

+ func (p Plugin) UpdateOrInstall() (err error)

+ type PluginConfig struct

+ Info string

+ Name string

+ SupportDevices []DeviceInfo

+ Version string

+ func LoadPluginConfig(path string) (plg PluginConfig, err error)

+ func (p PluginConfig) ID() string

+ func (p PluginConfig) Validate() error

v1.4.0

Oct 19, 2021

Changes in this version

+ var NotExistErr = errors.New("plugin not exist")

+ func AddDevice(d *entity.Device, tx *gorm.DB) (err error)

+ func ArchiveURL(pluginID string, req *http.Request) string

+ func BuildFromDir(path, tag string) (imageID string, err error)

+ func BuildFromTar(tarPath string) (imageID string, err error)

+ func DefaultOnDeviceStateChange(d entity.Device, attr entity.Attribute) error

+ func EndPointsManager() (manager endpoints.Manager, err error)

+ func GetControlAttributeByID(d entity.Device, instanceID int, attr string) (attribute entity.Attribute, err error)

+ func GetControlAttributes(d entity.Device) (attributes []entity.Attribute, err error)

+ func GetInstanceControlAttributes(instance Instance) (attributes []entity.Attribute)

+ func LogoURL(req *http.Request, d entity.Device) string

+ func NewClient(callbacks ...OnDeviceStateChange) *client

+ func NewDiscovery(cli *client) *discovery

+ func NewManager() *manager

+ func PluginURL(d entity.Device, req *http.Request, token string) string

+ func RelativeControlPath(d entity.Device, token string) string

+ func RemoveDevice(deviceID int) (err error)

+ func SetAttributes(areaID uint64, pluginID, identity string, data json.RawMessage) (err error)

+ func SetGlobalClient(c Client)

+ func SetGlobalManager(m Manager)

+ func StaticURL(pluginID, relativePath string, req *http.Request) string

+ func UpdateShadowReported(d entity.Device, attr entity.Attribute) (err error)

+ type Attribute struct

+ CanControl bool

+ type Client interface

+ DeviceInfo func(entity.Device) Info

+ DevicesDiscover func(ctx context.Context) <-chan DiscoverResponse

+ Disconnect func(entity.Device) error

+ GetAttributes func(device entity.Device) (DeviceAttributes, error)

+ HealthCheck func(entity.Device) error

+ IsOnline func(entity.Device) bool

+ SetAttributes func(device entity.Device, data json.RawMessage) (result []byte, err error)

+ func GetGlobalClient() Client

+ type Device struct

+ Control string

+ Logo string

+ Model string

+ Name string

+ Provisioning string

+ Type DeviceType

+ type DeviceAttributes struct

+ Identity string

+ Instances []Instance

+ Online bool

+ func GetUserDeviceAttributes(areaID uint64, userID int, pluginID, identity string) (das DeviceAttributes, err error)

+ type DeviceType string

+ const TypeLight

+ const TypeOutlet

+ const TypeRoutingGateway

+ const TypeSecurity

+ const TypeSwitch

+ type DiscoverResponse struct

+ Identity string

+ Manufacturer string

+ Model string

+ Name string

+ PluginID string

+ type Info struct

+ Compress string

+ Control string

+ Logo string

+ Provisioning string

+ type Instance struct

+ Attributes []Attribute

+ InstanceId int

+ Type string

+ type Manager interface

+ Get func(id string) (*Plugin, error)

+ Load func() (map[string]*Plugin, error)

+ func GetGlobalManager() Manager

+ type OnDeviceStateChange func(d entity.Device, attr entity.Attribute) error

+ type Plugin struct

+ AreaID uint64

+ Brand string

+ DownloadURL string

+ ID string

+ Image docker.Image

+ Info string

+ LogoURL string

+ Source string

+ SupportDevices []*Device

+ Version string

+ func LoadPluginFromZip(path string, areaID uint64) (plg Plugin, err error)

+ func LoadPluginInfo(path string) (plg Plugin, err error)

+ func (p Plugin) BrandLogoURL(req *http.Request) string

+ func (p Plugin) Install() (err error)

+ func (p Plugin) IsAdded() bool

+ func (p Plugin) IsDevelopment() bool

+ func (p Plugin) IsNewest() bool

+ func (p Plugin) IsRunning() bool

+ func (p Plugin) Remove() (err error)

+ func (p Plugin) Up() (err error)

+ func (p Plugin) Update() (err error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL