devices

README

devices

Some sensor type devices written in Go

Documentation

Overview

Package device provides a framework for managing hardware devices with support for messaging, periodic operations, and state management. Devices can be controlled via MQTT messages and can publish their state and data periodically.

Index

• Constants
• Variables
• func IsMock() bool
• func SetMock(v bool)
• type Device
• type DeviceBase
  • func NewDeviceBase[T any](name string) *DeviceBase[T]
  • func (d *DeviceBase[T]) Close() error
  • func (d *DeviceBase[T]) Get() (T, error)
  • func (d *DeviceBase[T]) HandleMsg(msg *messanger.Msg) error
  • func (d *DeviceBase[T]) Name() string
  • func (d *DeviceBase[T]) Open() error
  • func (d *DeviceBase[T]) RegisterEventHandler(f func(evt *DeviceEvent))
  • func (d *DeviceBase[T]) Set(v T) error
  • func (d *DeviceBase[T]) StartTicker(period time.Duration, f *func(time.Time))
  • func (d *DeviceBase[T]) String() string
  • func (d *DeviceBase[T]) TickHandler() *func(time.Time)
  • func (d *DeviceBase[T]) Type() Type
• type DeviceEvent
• type DeviceState
• type TimerHandler
• type Type

Constants

const (
	DeviceEventInitialized = "initialized"
	DeviceEventError       = "error"
	DeviceEventDataReady   = "data"
	DeviceEventRisingEdge  = "rising"
	DeviceEventFallingEdge = "falling"
)

Variables

var (
	ErrNotImplemented     = errors.New("method is not implemented")
	ErrTypeNotImplemented = errors.New("type is not implemented")
)

Functions

func IsMock

func IsMock() bool

func SetMock

func SetMock(v bool)

Types

type Device

type Device[T any] interface {
	Name() string
	Type() Type
	Open() error
	Close() error

	Get() (T, error)
	Set(v T) error

	TickHandler() *func(time.Time)
	StartTicker(period time.Duration, f *func(time.Time))
	RegisterEventHandler(f func(evt *DeviceEvent))
	HandleMsg(msg *messanger.Msg) error

	String() string
}

Device is a type-safe device contract for a single value type T. Implementations may be read-only by returning an error from Set.

type DeviceBase

type DeviceBase[T any] struct {
	// contains filtered or unexported fields
}

func NewDeviceBase

func NewDeviceBase[T any](name string) *DeviceBase[T]

func (*DeviceBase[T]) Close

func (d *DeviceBase[T]) Close() error

func (*DeviceBase[T]) Get

func (d *DeviceBase[T]) Get() (T, error)

func (*DeviceBase[T]) HandleMsg

func (d *DeviceBase[T]) HandleMsg(msg *messanger.Msg) error

func (*DeviceBase[T]) Name

func (d *DeviceBase[T]) Name() string

func (*DeviceBase[T]) Open

func (d *DeviceBase[T]) Open() error

func (*DeviceBase[T]) RegisterEventHandler

func (d *DeviceBase[T]) RegisterEventHandler(f func(evt *DeviceEvent))

func (*DeviceBase[T]) Set

func (d *DeviceBase[T]) Set(v T) error

func (*DeviceBase[T]) StartTicker

func (d *DeviceBase[T]) StartTicker(period time.Duration, f *func(time.Time))

func (*DeviceBase[T]) String

func (d *DeviceBase[T]) String() string

func (*DeviceBase[T]) TickHandler

func (d *DeviceBase[T]) TickHandler() *func(time.Time)

func (*DeviceBase[T]) Type

func (d *DeviceBase[T]) Type() Type

type DeviceEvent

type DeviceEvent struct {
	Type    string
	Message string
	Time    time.Time
}

type DeviceState

type DeviceState uint8

const (
	StateUnknown DeviceState = iota
	StateInitializing
	StateRunning
	StateError
	StateStopped
)

type TimerHandler

type TimerHandler func(time.Time)

type Type

type Type uint8

const (
	TypeBool Type = iota
	TypeInt
	TypeFloat
	TypeString
	TypeBytes
	TypeJSON
	TypeAny
	TypeGPS
)