iio

type ActivityID ¶

type ActivityID int

ActivityID is the ID of the activity which is reported by the EC.

const (
	// SigMotionID is the ID of the activity, significant motion.
	SigMotionID ActivityID = 1
	// DoubleTapID is the ID of the activity, double tap.
	DoubleTapID ActivityID = 2
	// OrientationID is the ID of the activity, orientation.
	OrientationID ActivityID = 3
	// OnBodyDetectionID is the ID of the activity, on-body detection.
	OnBodyDetectionID ActivityID = 4
)

type Buffer ¶

type Buffer struct {
	Channels []*ChannelSpec
	// contains filtered or unexported fields
}

Buffer provides a means to read continuous data captured from a sensor. See https://01.org/linuxgraphics/gfx-docs/drm/driver-api/iio/buffers.html#buffers.

func (b *Buffer) Close() error

func (b *Buffer) Open() (<-chan BufferData, error)

func (b *Buffer) SetLength(len int) error

type BufferData ¶

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

BufferData is a single reading of data from a sensor's buffer.

func (d *BufferData) GetRaw(ix int) ([]byte, error)

func (d *BufferData) Int16(ix int) (int16, error)

func (d *BufferData) Int32(ix int) (int32, error)

func (d *BufferData) Int64(ix int) (int64, error)

func (d *BufferData) Int8(ix int) (int8, error)

func (d *BufferData) Uint16(ix int) (uint16, error)

func (d *BufferData) Uint32(ix int) (uint32, error)

func (d *BufferData) Uint64(ix int) (uint64, error)

func (d *BufferData) Uint8(ix int) (uint8, error)

type ChannelSpec ¶

type ChannelSpec struct {
	Index       int
	Name        string
	Signed      bool
	RealBits    uint
	StorageBits uint
	Shift       uint
	Endianness  Endianness
	// contains filtered or unexported fields
}

ChannelSpec describes one piece of data that is read from an iio buffer.

type CrosRing ¶

type CrosRing struct {
	// Sensors is a list of all of the cros ec sensors that will produce data
	// on the cros-ec-ring. The cros ec ring itself will not be present in this
	// list.
	Sensors map[uint]ringSensor
	// contains filtered or unexported fields
}

CrosRing is an instance of a cros-ec-ring iio device. The buffer for this device is used to receive sensor data for all cros-ec-* sensors on a DUT.

Each datum read from the cros-ec-ring buffer contains a sensor ID field which coresponds to ID of the cros ec sensor which produced the data.

func NewRing(sensors []*Sensor) (*CrosRing, error)

func (cr *CrosRing) Close() error

func (cr *CrosRing) Open(ctx context.Context) (<-chan *SensorReading, error)

type Device ¶

type Device struct {
	Path string
}

Device is a object we can read and write attributes from.

func (d *Device) ReadAttr(attr string) (string, error)

func (d *Device) ReadIntegerAttr(attr string) (int, error)

func (d *Device) WriteAttr(attr, value string) error

type Endianness ¶

type Endianness int

Endianness defines the endianness of a Buffer channel.

const (
	// BE specifies that channel data is big endian.
	BE Endianness = iota
	// LE specifies that channel data is little endian.
	LE
)

type Sensor ¶

type Sensor struct {
	Device
	Name          SensorName
	Location      SensorLocation
	IioID         uint
	ID            uint
	Scale         float64
	MinFrequency  int
	MaxFrequency  int
	OldSysfsStyle bool
}

Sensor represents one sensor on the DUT.

func GetSensors(ctx context.Context) ([]*Sensor, error)

func (s *Sensor) NewBuffer() (*Buffer, error)

func (s *Sensor) Read() (*SensorReading, error)

type SensorLocation ¶

type SensorLocation string

SensorLocation is the location of the sensor in the DUT which is reported by the EC and exposed by the kernel in /sys/bus/iio/devices/iio:device*/location.

const (
	// Base means that the sensor is located in the base of the DUT.
	Base SensorLocation = "base"
	// Lid means that the sensor is located in the lid of the DUT.
	Lid SensorLocation = "lid"
	// Camera means that the sensor is located near the camera.
	Camera SensorLocation = "camera"
	// None means that the sensor location is not known or not applicable.
	None SensorLocation = "none"
)

type SensorName ¶

type SensorName string

SensorName is the kind of sensor which is reported by the EC and exposed by the kernel in /sys/bus/iio/devices/iio:device*/name. The name is in the form cros-ec-*.

const (
	// Accel is an accelerometer sensor.
	Accel SensorName = "cros-ec-accel"
	// Gyro is a gyroscope sensor.
	Gyro SensorName = "cros-ec-gyro"
	// Mag is a magnetometer sensor.
	Mag SensorName = "cros-ec-mag"
	// Light is a light or proximity sensor.
	Light SensorName = "cros-ec-light"
	// Baro is a barometer.
	Baro SensorName = "cros-ec-baro"
	// Ring is a special sensor for ChromeOS that produces a stream of data from
	// all sensors on the DUT.
	Ring SensorName = "cros-ec-ring"
	// Activity is a special sensor for ChromeOS that produces several kind of
	// activity events by the data of other sensors.
	Activity SensorName = "cros-ec-activity"
)

type SensorReading ¶

type SensorReading struct {
	// Data contains all values read from the sensor.
	// Its length depends on the type of sensor being used.
	Data  []float64
	ID    uint
	Flags uint8
	// Timestamp is the duration from the boot time of the DUT to the time the
	// reading was taken
	Timestamp time.Duration
}

SensorReading is one reading from a sensor.

type Trigger ¶

type Trigger struct {
	Type TriggerType
	Name string
}

Trigger : device that can be used to trigger events.

func GetTriggers() ([]*Trigger, error)

type TriggerType ¶

type TriggerType string

TriggerType defines the trigger supported by chromeos. sysfs trigger, and ring trigger for <= 3.18 kernels.

const (
	SysfsTrigger TriggerType = "sysfs"
	RingTrigger  TriggerType = "cros-ec-ring-"
)