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

• Variables
• func IsMock() bool
• func SetMock(v bool)
• type Device
• type DeviceManager
  • func NewDeviceManager() *DeviceManager
  • func (m *DeviceManager) Add(d Device[any]) error
  • func (m *DeviceManager) Get(name string) (Device[any], error)
• type DeviceState
• type Type

Variables

var (
	ErrNotFound           = errors.New("device not found")
	ErrDeviceExists       = errors.New("device already exists")
	ErrTypeMismatch       = errors.New("device registered with different type")
	ErrTypeNotImplemented = errors.New("method not implemented")
)

var (
	ErrNotImplemented = errors.New("Method is not implemented")
)

Functions

func IsMock

func IsMock() bool

func SetMock

func SetMock(v bool)

Types

type Device

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

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

type DeviceManager

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

func NewDeviceManager

func NewDeviceManager() *DeviceManager

func (*DeviceManager) Add

func (m *DeviceManager) Add(d Device[any]) error

Register a typed device. Fails if name already used with a different T.

func (*DeviceManager) Get

func (m *DeviceManager) Get(name string) (Device[any], error)

type DeviceState

type DeviceState uint8

const (
	StateUnknown DeviceState = iota
	StateInitializing
	StateRunning
	StateError
	StateStopped
)

type Type

type Type uint8

const (
	TypeBool Type = iota
	TypeInt
	TypeFloat
	TypeAny
	TypeBME280
	TypeGPS
)