adxl345

Documentation

Overview

Package adxl345 provides a driver for the ADXL345 digital accelerometer.

Datasheet EN: http://www.analog.com/media/en/technical-documentation/data-sheets/ADXL345.pdf

Datasheet JP: http://www.analog.com/media/jp/technical-documentation/data-sheets/ADXL345_jp.pdf

Index

• Constants
• type Device
  • func New(bus machine.I2C) Device
  • func (d *Device) Configure()
  • func (d *Device) Halt()
  • func (d *Device) ReadAcceleration() (x int32, y int32, z int32, err error)
  • func (d *Device) ReadRawAcceleration() (x int32, y int32, z int32)
  • func (d *Device) Restart()
  • func (d *Device) SetRange(sensorRange Range) bool
  • func (d *Device) SetRate(rate Rate) bool
  • func (d *Device) UseLowPower(power bool)
• type Range
• type Rate

Constants

const (
	// Data rate
	RATE_3200HZ Rate = 0x0F // 3200 Hz
	RATE_1600HZ Rate = 0x0E // 1600 Hz
	RATE_800HZ  Rate = 0x0D // 800 Hz
	RATE_400HZ  Rate = 0x0C // 400 Hz
	RATE_200HZ  Rate = 0x0B // 200 Hz
	RATE_100HZ  Rate = 0x0A // 100 Hz
	RATE_50HZ   Rate = 0x09 // 50 Hz
	RATE_25HZ   Rate = 0x08 // 25 Hz
	RATE_12_5HZ Rate = 0x07 // 12.5 Hz
	RATE_6_25HZ Rate = 0x06 // 6.25 Hz
	RATE_3_13HZ Rate = 0x05 // 3.13 Hz
	RATE_1_56HZ Rate = 0x04 // 1.56 Hz
	RATE_0_78HZ Rate = 0x03 // 0.78 Hz
	RATE_0_39HZ Rate = 0x02 // 0.39 Hz
	RATE_0_20HZ Rate = 0x01 // 0.20 Hz
	RATE_0_10HZ Rate = 0x00 // 0.10 Hz

	// Data range
	RANGE_2G  Range = 0x00 // +-2 g
	RANGE_4G  Range = 0x01 // +-4 g
	RANGE_8G  Range = 0x02 // +-8 g
	RANGE_16G Range = 0x03 // +-16 g)

	REG_DEVID          = 0x00 // R,     11100101,   Device ID
	REG_THRESH_TAP     = 0x1D // R/W,   00000000,   Tap threshold
	REG_OFSX           = 0x1E // R/W,   00000000,   X-axis offset
	REG_OFSY           = 0x1F // R/W,   00000000,   Y-axis offset
	REG_OFSZ           = 0x20 // R/W,   00000000,   Z-axis offset
	REG_DUR            = 0x21 // R/W,   00000000,   Tap duration
	REG_LATENT         = 0x22 // R/W,   00000000,   Tap latency
	REG_WINDOW         = 0x23 // R/W,   00000000,   Tap window
	REG_THRESH_ACT     = 0x24 // R/W,   00000000,   Activity threshold
	REG_THRESH_INACT   = 0x25 // R/W,   00000000,   Inactivity threshold
	REG_TIME_INACT     = 0x26 // R/W,   00000000,   Inactivity time
	REG_ACT_INACT_CTL  = 0x27 // R/W,   00000000,   Axis enable control for activity and inactiv ity detection
	REG_THRESH_FF      = 0x28 // R/W,   00000000,   Free-fall threshold
	REG_TIME_FF        = 0x29 // R/W,   00000000,   Free-fall time
	REG_TAP_AXES       = 0x2A // R/W,   00000000,   Axis control for single tap/double tap
	REG_ACT_TAP_STATUS = 0x2B // R,     00000000,   Source of single tap/double tap
	REG_BW_RATE        = 0x2C // R/W,   00001010,   Data rate and power mode control
	REG_POWER_CTL      = 0x2D // R/W,   00000000,   Power-saving features control
	REG_INT_ENABLE     = 0x2E // R/W,   00000000,   Interrupt enable control
	REG_INT_MAP        = 0x2F // R/W,   00000000,   Interrupt mapping control
	REG_INT_SOUCE      = 0x30 // R,     00000010,   Source of interrupts
	REG_DATA_FORMAT    = 0x31 // R/W,   00000000,   Data format control
	REG_DATAX0         = 0x32 // R,     00000000,   X-Axis Data 0
	REG_DATAX1         = 0x33 // R,     00000000,   X-Axis Data 1
	REG_DATAY0         = 0x34 // R,     00000000,   Y-Axis Data 0
	REG_DATAY1         = 0x35 // R,     00000000,   Y-Axis Data 1
	REG_DATAZ0         = 0x36 // R,     00000000,   Z-Axis Data 0
	REG_DATAZ1         = 0x37 // R,     00000000,   Z-Axis Data 1
	REG_FIFO_CTL       = 0x38 // R/W,   00000000,   FIFO control
	REG_FIFO_STATUS    = 0x39 // R,     00000000,   FIFO status
)

const AddressHigh = 0x1D

const AddressLow = 0x53

Types

type Device

type Device struct {
	Address uint16
	// contains filtered or unexported fields
}

Device wraps an I2C connection to a ADXL345 device.

func New

func New(bus machine.I2C) Device

New creates a new ADXL345 connection. The I2C bus must already be configured.

This function only creates the Device object, it does not init the device. To do that you must call the Configure() method on the Device before using it.

func (*Device) Configure

func (d *Device) Configure()

Configure sets up the device for communication

func (*Device) Halt

func (d *Device) Halt()

Halt stops the sensor, values will not updated

func (*Device) ReadAcceleration

func (d *Device) ReadAcceleration() (x int32, y int32, z int32, err error)

ReadAcceleration reads the current acceleration from the device and returns it in µg (micro-gravity). When one of the axes is pointing straight to Earth and the sensor is not moving the returned value will be around 1000000 or -1000000.

func (*Device) ReadRawAcceleration

func (d *Device) ReadRawAcceleration() (x int32, y int32, z int32)

ReadRawAcceleration reads the sensor values and returns the raw x, y and z axis from the adxl345.

func (*Device) Restart

func (d *Device) Restart()

Restart makes reading the sensor working again after a halt

func (*Device) SetRange

func (d *Device) SetRange(sensorRange Range) bool

SetRange change the current range of the sensor

func (*Device) SetRate

func (d *Device) SetRate(rate Rate) bool

SetRate change the current rate of the sensor

func (*Device) UseLowPower

func (d *Device) UseLowPower(power bool)

UseLowPower sets the ADXL345 to use the low power mode.

type Range

type Range uint8

type Rate

type Rate uint8