device

Documentation

Index

• func RegisterCreator(kind config.DeviceKind, creator Creator)
• type Config
• type Creator
  • func CreateRandomDeviceFactory(registers dataflow.Registers) Creator
• type Device
  • func RunDevice(cfg Config, target dataflow.Fillable) (device Device, err error)
• type DevicePool
  • func RunPool() (pool *DevicePool)
  • func (p *DevicePool) AddDevice(device Device)
  • func (p *DevicePool) GetDevice(deviceName string) Device
  • func (p *DevicePool) GetDevices() map[string]Device
  • func (p *DevicePool) RemoveDevice(device Device)
  • func (p *DevicePool) Shutdown()
• type DeviceStruct
  • func (c *DeviceStruct) Config() Config
  • func (c *DeviceStruct) GetClosedChan() chan struct{}
  • func (c *DeviceStruct) GetLastUpdated() time.Time
  • func (c *DeviceStruct) GetModel() string
  • func (c *DeviceStruct) GetRegisters() dataflow.Registers
  • func (c *DeviceStruct) GetShutdownChan() chan struct{}
  • func (c *DeviceStruct) SetLastUpdatedNow()
  • func (c *DeviceStruct) SetModel(model string)
  • func (c *DeviceStruct) SetRegisters(registers dataflow.Registers)
  • func (c *DeviceStruct) Shutdown()

Functions

func RegisterCreator

func RegisterCreator(kind config.DeviceKind, creator Creator)

Types

type Config

type Config interface {
	Name() string
	Kind() config.DeviceKind
	Device() string
	SkipFields() []string
	SkipCategories() []string
	LogDebug() bool
	LogComDebug() bool
}

type Creator

type Creator func(deviceStruct DeviceStruct, output chan dataflow.Value) (device Device, err error)

func CreateRandomDeviceFactory

func CreateRandomDeviceFactory(registers dataflow.Registers) Creator

type Device

type Device interface {
	Config() Config
	GetRegisters() dataflow.Registers
	SetRegisters(registers dataflow.Registers)
	SetLastUpdatedNow()
	GetLastUpdated() time.Time
	SetModel(model string)
	GetModel() string
	Shutdown()
}

func RunDevice

func RunDevice(cfg Config, target dataflow.Fillable) (device Device, err error)

type DevicePool

type DevicePool struct {
	Devices      map[string]Device
	DevicesMutex sync.RWMutex
}

func RunPool

func RunPool() (pool *DevicePool)

func (*DevicePool) AddDevice

func (p *DevicePool) AddDevice(device Device)

func (*DevicePool) GetDevice

func (p *DevicePool) GetDevice(deviceName string) Device

func (*DevicePool) GetDevices

func (p *DevicePool) GetDevices() map[string]Device

func (*DevicePool) RemoveDevice

func (p *DevicePool) RemoveDevice(device Device)

func (*DevicePool) Shutdown

func (p *DevicePool) Shutdown()

type DeviceStruct

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

func (*DeviceStruct) Config

func (c *DeviceStruct) Config() Config

func (*DeviceStruct) GetClosedChan

func (c *DeviceStruct) GetClosedChan() chan struct{}

func (*DeviceStruct) GetLastUpdated

func (c *DeviceStruct) GetLastUpdated() time.Time

func (*DeviceStruct) GetModel

func (c *DeviceStruct) GetModel() string

func (*DeviceStruct) GetRegisters

func (c *DeviceStruct) GetRegisters() dataflow.Registers

func (*DeviceStruct) GetShutdownChan

func (c *DeviceStruct) GetShutdownChan() chan struct{}

func (*DeviceStruct) SetLastUpdatedNow

func (c *DeviceStruct) SetLastUpdatedNow()

func (*DeviceStruct) SetModel

func (c *DeviceStruct) SetModel(model string)

func (*DeviceStruct) SetRegisters

func (c *DeviceStruct) SetRegisters(registers dataflow.Registers)

func (*DeviceStruct) Shutdown

func (c *DeviceStruct) Shutdown()