alex/GY-63_MS5611
1
0
Fork 0
mirror of https://github.com/RobTillaart/Arduino.git synced 2024-10-03 18:09:02 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
39d928a98a
GY-63_MS5611/libraries/AD520X
History
rob tillaart f27f754fbb add license to library,json
2021-05-28 14:16:25 +02:00
..
.github/workflows add arduino-lint 2021-05-28 13:17:38 +02:00
examples/AD5204_demo 2021-01-29 2021-01-29 12:31:58 +01:00
test 2021-01-29 2021-01-29 12:31:58 +01:00
.arduino-ci.yml 2021-01-29 2021-01-29 12:31:58 +01:00
AD520X.cpp 2021-01-29 2021-01-29 12:31:58 +01:00
AD520X.h 2021-01-29 2021-01-29 12:31:58 +01:00
keywords.txt 2021-01-29 2021-01-29 12:31:58 +01:00
library.json add license to library,json 2021-05-28 14:16:25 +02:00
library.properties 2021-01-29 2021-01-29 12:31:58 +01:00
LICENSE 2021-01-29 2021-01-29 12:31:58 +01:00
README.md 2021-01-29 2021-01-29 12:31:58 +01:00

README.md

Arduino CI License: MIT GitHub release

AD520X

Arduino library for SPI AD5204 and AD5206 digital potentiometers

Description

The library is still experimental as not all functionality is tested (enough).

The AD5204 (4 pm) and AD5206 (6 pm) are SPI based digital potentiometers. This library consists of a base class AD520X that does the work.

The interface is straightforward, one can set a value per pm between 0..255.

Although not tested this library should work for the older AD8400 (1 pm), the AD8402 (2 pm) and AD8403 (4 pm) as the interface is very similar (datasheet comparison). If you can confirm it works, please let me know.

Interface

Constructors

  • AD520X(select, reset, shutdown, dataOut = 255, clock = 255) constructor
    Base class, not to be used directly. If dataOut and clock are set to 255 (default) it uses hardware SPI. If dataOut and clock are set to another (valid) value) it uses software SPI. reset and shutdown may be set to 255 too, which effectively disables them.
    Note: hardware SPI is 10+ times faster on an UNO.
  • AD5204(select, reset, shutdown, dataOut = 255, clock = 255) uses 4 pm.
  • AD5206(select, reset, shutdown, dataOut = 255, clock = 255) uses 6 pm.
  • AD8400(select, reset, shutdown, dataOut = 255, clock = 255) uses 1 pm.
  • AD8402(select, reset, shutdown, dataOut = 255, clock = 255) uses 2 pm.
  • AD8403(select, reset, shutdown, dataOut = 255, clock = 255) uses 4 pm.

Base

  • begin(value = 128) value is the initial value of all potentiometer.
  • setValue(pm, value) set a potentiometer to a value
  • setAll(value) set all potentiometers to the same value e.g. 0 or max or mid
  • getValue(pm) returns the last set value of a specific potmeter
  • reset(value = 128) resets all potentiometers to value, default 128.

Misc

  • pmCount() returns the number of internal potmeters.
  • powerOn() switches the module on
  • powerOff() switches the module off
  • powerDown() use powerOFf() instead
  • isPowerOn() returns true if on (default) or

Future

  • setInvert(pm) invert flag per potmeter

    • 0..255 -> 255..0
    • 1 uint8_t can hold 8 flags

  • getInvert(pm)

  • follow(pm_B, pm_A, percentage = 100)

    • makes pm_B follow pm_A unless pm_B is addressed explicitly
    • array cascade = 0xFF or pm_A.
    • It will follow pm_A for certain percentage default 100.

  • setPercentage(pm, float value) 0..100%

  • getPercentage(pm)

  • logarithmic effect? setGamma(pm, value); easier with setPercentage()

Operations

See examples.