i2c

README

i2c

some plain Go/Golang i2c sensor bindings to Waveshare Sense HAT for raspberry pi using https://periph.io

Supported hardware:

• Raspberry Zero W 1
• https://www.waveshare.com/wiki/Sense_HAT_(B)
  • Sensirion SHTC3 (https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/2_Humidity_Sensors/Datasheets/Sensirion_Humidity_Sensors_SHTC3_Datasheet.pdf)
• Adafruit SHT31
  • Sensirion SHT3x (https://sensirion.com/media/documents/213E6A3B/61641DC3/Sensirion_Humidity_Sensors_SHT3x_Datasheet_digital.pdf)

Documentation

Index

• type Dispatcher
  • func (d *Dispatcher) OnError(id ID, err error)
  • func (d *Dispatcher) OnHumidity(id ID, h RH)
  • func (d *Dispatcher) OnTemperature(id ID, t T)
  • func (d *Dispatcher) Register(observer interface{}) (hnd int)
  • func (d *Dispatcher) Time() time.Time
  • func (d *Dispatcher) Unregister(hnd int)
• type ErrorObserver
• type HumidityObserver
• type ID
• type Observer
• type Polling
  • func NewPolling(interval time.Duration) *Polling
  • func (p *Polling) Close() error
  • func (p *Polling) Dispatcher() *Dispatcher
• type PrintObserver
  • func (p PrintObserver) OnError(id ID, err error)
  • func (p PrintObserver) OnHumidity(id ID, h RH)
  • func (p PrintObserver) OnTemperature(id ID, t T)
• type RH
  • func (v RH) Humidity() float64
  • func (v RH) String() string
• type Sensor
• type T
  • func (t T) Celsius() float64
  • func (t T) String() string
• type TemperatureObserver

Types

type Dispatcher

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

func (*Dispatcher) OnError

func (d *Dispatcher) OnError(id ID, err error)

OnError dispatches a new error event.

func (*Dispatcher) OnHumidity

func (d *Dispatcher) OnHumidity(id ID, h RH)

OnHumidity dispatches a new humidity event.

func (*Dispatcher) OnTemperature

func (d *Dispatcher) OnTemperature(id ID, t T)

OnTemperature dispatches a new temperature event.

func (*Dispatcher) Register

func (d *Dispatcher) Register(observer interface{}) (hnd int)

func (*Dispatcher) Time

func (d *Dispatcher) Time() time.Time

func (*Dispatcher) Unregister

func (d *Dispatcher) Unregister(hnd int)

type ErrorObserver

type ErrorObserver interface {
	OnError(id ID, err error)
}

type HumidityObserver

type HumidityObserver interface {
	OnHumidity(id ID, h RH)
}

type ID

type ID int32

ID is just some sensor identifier.

type Observer

type Observer interface {
	TemperatureObserver
	HumidityObserver
	ErrorObserver
}

type Polling

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

func NewPolling

func NewPolling(interval time.Duration) *Polling

NewPolling tries to identify the correct i2c bus and the connected devices and immediately starts polling. It does never fail, and instead just returns an instance which has no sensors.

func (*Polling) Close

func (p *Polling) Close() error

func (*Polling) Dispatcher

func (p *Polling) Dispatcher() *Dispatcher

type PrintObserver

type PrintObserver struct {
}

func (PrintObserver) OnError

func (p PrintObserver) OnError(id ID, err error)

func (PrintObserver) OnHumidity

func (p PrintObserver) OnHumidity(id ID, h RH)

func (PrintObserver) OnTemperature

func (p PrintObserver) OnTemperature(id ID, t T)

type RH

type RH int32

RH is the relative humidity in milli-RH (1% = 1000RH)

func (RH) Humidity

func (v RH) Humidity() float64

Humidity returns the value in relative percent.

func (RH) String

func (v RH) String() string

type Sensor

type Sensor interface {
	Poll(*Dispatcher)
}

type T

type T int32

T is the temperature in milli-Celsius (1°C = 1000T)

func (T) Celsius

func (t T) Celsius() float64

Celsius returns just the degree value.

func (T) String

func (t T) String() string

type TemperatureObserver

type TemperatureObserver interface {
	OnTemperature(id ID, t T)
}