adxl345

Documentation

Overview

Package adxl345 implements the MovementSensor interface for the ADXL345 accelerometer.

Index

• Constants
• func NewAdxl345(ctx context.Context, deps resource.Dependencies, conf resource.Config, ...) (movementsensor.MovementSensor, error)
• type Config
  • func (cfg *Config) Validate(path string) ([]string, error)
• type FreeFallConfig
  • func (freefallCfg *FreeFallConfig) ValidateFreeFallConfigs(path string) error
• type InterruptID
• type TapConfig
  • func (tapCfg *TapConfig) ValidateTapConfigs(path string) error

Constants

const (
	// an unsigned time value representing the maximum time that an event must be above the
	// THRESH_TAP threshold to qualify as a tap event [625 µs/LSB].
	DurAddr byte = 0x21
	// info on which interrupts have been enabled.
	IntEnableAddr byte = 0x2E
	// info on which interrupt pin to send each interrupt.
	IntMapAddr byte = 0x2F
	// info on which interrupt has gone off since the last time this address has been read from.
	IntSourceAddr byte = 0x30
	// an unsigned time value representing the wait time from the detection of a tap event to the
	// start of the time window [1.25 ms/LSB].
	LatentAddr byte = 0x22
	// info on which axes have been turned on for taps (X, Y, Z are bits 2, 1, 0 respectively).
	TapAxesAddr byte = 0x2A
	// an unsigned threshold value for tap interrupts [62.5 mg/LSB ].
	ThreshTapAddr byte = 0x1D
	// che threshold value, in unsigned format, for free-fall detection.
	ThreshFfAddr byte = 0x28
	// the  minimum time that the value of all axes must be less than THRESH_FF to generate a free-fall interrupt.
	TimeFfAddr byte = 0x29
)

addresses relevant to interrupts.

const (
	// ThreshTapScaleFactor is the scale factor for THRESH_TAP register.
	ThreshTapScaleFactor float32 = 62.5
	// DurScaleFactor is the scale factor for DUR register.
	DurScaleFactor float32 = 625
	// TimeFfScaleFactor is the scale factor for TIME_FF register.
	TimeFfScaleFactor float32 = .5
	// ThreshFfScaleFactor is the scale factor for THRESH_FF register.
	ThreshFfScaleFactor float32 = 62.5
)

Functions

func NewAdxl345

func NewAdxl345(
	ctx context.Context,
	deps resource.Dependencies,
	conf resource.Config,
	logger golog.Logger,
) (movementsensor.MovementSensor, error)

NewAdxl345 is a constructor to create a new object representing an ADXL345 accelerometer.

Types

type Config

type Config struct {
	BoardName              string          `json:"board"`
	I2cBus                 string          `json:"i2c_bus"`
	UseAlternateI2CAddress bool            `json:"use_alternate_i2c_address,omitempty"`
	SingleTap              *TapConfig      `json:"tap,omitempty"`
	FreeFall               *FreeFallConfig `json:"free_fall,omitempty"`
}

Config is a description of how to find an ADXL345 accelerometer on the robot.

func (*Config) Validate

func (cfg *Config) Validate(path string) ([]string, error)

Validate ensures all parts of the config are valid, and then returns the list of things we depend on.

type FreeFallConfig

type FreeFallConfig struct {
	AccelerometerPin int     `json:"accelerometer_pin"`
	InterruptPin     string  `json:"interrupt_pin"`
	Threshold        float32 `json:"threshold,omitempty"`
	Time             float32 `json:"time_ms,omitempty"`
}

FreeFallConfig is a description of the configs for free fall registers.

func (*FreeFallConfig) ValidateFreeFallConfigs

func (freefallCfg *FreeFallConfig) ValidateFreeFallConfigs(path string) error

ValidateFreeFallConfigs validates the freefall piece of the config.

type InterruptID

type InterruptID = uint8

InterruptID is a type of interrupts available on ADXL345.

const (
	// SingleTap is a key value used to find various needs associated with this interrupt.
	SingleTap InterruptID = iota
	// FreeFall is a key value used to find various needs associated with this interrupt.
	FreeFall InterruptID = iota
)

type TapConfig

type TapConfig struct {
	AccelerometerPin int     `json:"accelerometer_pin"`
	InterruptPin     string  `json:"interrupt_pin"`
	ExcludeX         bool    `json:"exclude_x,omitempty"`
	ExcludeY         bool    `json:"exclude_y,omitempty"`
	ExcludeZ         bool    `json:"exclude_z,omitempty"`
	Threshold        float32 `json:"threshold,omitempty"`
	Dur              float32 `json:"dur_us,omitempty"`
}

TapConfig is a description of the configs for tap registers.

func (*TapConfig) ValidateTapConfigs

func (tapCfg *TapConfig) ValidateTapConfigs(path string) error

ValidateTapConfigs validates the tap piece of the config.