relay

package

v0.0.0-...-a79553f Latest Latest Go to latest Published: Aug 8, 2023 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Device interface {
	Name() string
	On()
	Off()
	State() (bool, error)
	Number() int
	TypeInfo() DeviceTypeInfo
}

type DeviceCategory int

const (
	Fans DeviceCategory = iota
	Lights
)

func (d DeviceCategory) String() string

type DeviceOpt func(s *Service)

func WithDevice(device Device) DeviceOpt

type DeviceTypeInfo struct {
	Category DeviceCategory
}

type Normality uint8

const (
	NormallyOpen Normality = iota
	NormallyClosed
	Undefined Normality = 8
)

func (n Normality) String() string

type Relay struct {
	Normality  Normality
	DeviceName string
	DeviceTypeInfo
	// contains filtered or unexported fields
}

func NewRelay(deviceName string, pinNumber int, relayNumber int, normality Normality, category DeviceCategory) *Relay

func (r *Relay) Name() string

func (r *Relay) Number() int

func (r *Relay) Off()

func (r *Relay) On()

func (r *Relay) State() (bool, error)

func (r *Relay) TypeInfo() DeviceTypeInfo

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

func New(opts ...DeviceOpt) *Service

func (s *Service) DeviceByRelay(number int) (Device, error)

func (s *Service) Devices() map[string]Device

func (s *Service) Fans() Device

func (s *Service) Lights() Device

func (s *Service) SetAllTo(signal Signal)

type Signal uint8

const (
	Off Signal = iota
	On
)