2020-11-27 05:20:37 -05:00
|
|
|
#pragma once
|
2013-11-24 15:59:40 -05:00
|
|
|
//
|
|
|
|
// FILE: MCP4725.h
|
|
|
|
// AUTHOR: Rob Tillaart
|
2020-11-27 05:20:37 -05:00
|
|
|
// PURPOSE: Arduino library for 12 bit I2C DAC - MCP4725
|
2022-10-17 04:40:05 -04:00
|
|
|
// VERSION: 0.3.4
|
2020-11-27 05:20:37 -05:00
|
|
|
// URL: https://github.com/RobTillaart/MCP4725
|
2013-11-24 15:59:40 -05:00
|
|
|
//
|
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
|
2020-11-27 05:20:37 -05:00
|
|
|
#include "Wire.h"
|
2013-11-24 15:59:40 -05:00
|
|
|
#include "Arduino.h"
|
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
|
2022-10-17 04:40:05 -04:00
|
|
|
#define MCP4725_VERSION (F("0.3.4"))
|
2021-01-29 06:31:58 -05:00
|
|
|
|
2013-11-30 17:41:37 -05:00
|
|
|
|
2022-10-17 04:40:05 -04:00
|
|
|
// CONSTANTS
|
2013-11-24 15:59:40 -05:00
|
|
|
#define MCP4725_MAXVALUE 4095
|
2013-11-30 17:41:37 -05:00
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
|
2022-10-17 04:40:05 -04:00
|
|
|
// ERRORS
|
2021-01-29 06:31:58 -05:00
|
|
|
#define MCP4725_OK 0
|
2013-11-24 15:59:40 -05:00
|
|
|
#define MCP4725_VALUE_ERROR -999
|
2013-11-30 17:41:37 -05:00
|
|
|
#define MCP4725_REG_ERROR -998
|
2021-06-07 02:28:17 -04:00
|
|
|
#define MCP4725_NOT_CONNECTED -997
|
2021-01-29 06:31:58 -05:00
|
|
|
|
2013-11-24 15:59:40 -05:00
|
|
|
|
2022-10-17 04:40:05 -04:00
|
|
|
// powerDown Mode - TODO ENUM?
|
2013-12-01 13:33:59 -05:00
|
|
|
#define MCP4725_PDMODE_NORMAL 0x00
|
2013-12-01 16:09:02 -05:00
|
|
|
#define MCP4725_PDMODE_1K 0x01
|
|
|
|
#define MCP4725_PDMODE_100K 0x02
|
|
|
|
#define MCP4725_PDMODE_500K 0x03
|
2013-12-01 13:33:59 -05:00
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
|
2013-11-24 15:59:40 -05:00
|
|
|
class MCP4725
|
|
|
|
{
|
|
|
|
public:
|
2021-01-29 06:31:58 -05:00
|
|
|
explicit MCP4725(const uint8_t deviceAddress, TwoWire *wire = &Wire);
|
2013-11-24 15:59:40 -05:00
|
|
|
|
2019-10-14 07:16:57 -04:00
|
|
|
#if defined(ESP8266) || defined(ESP32)
|
2021-01-29 06:31:58 -05:00
|
|
|
bool begin(const uint8_t dataPin, const uint8_t clockPin);
|
2019-10-14 07:16:57 -04:00
|
|
|
#endif
|
2022-10-17 04:40:05 -04:00
|
|
|
|
|
|
|
#if defined (ARDUINO_ARCH_RP2040)
|
|
|
|
|
|
|
|
bool begin(int sda, int scl);
|
|
|
|
|
|
|
|
#endif
|
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
bool begin();
|
|
|
|
bool isConnected();
|
|
|
|
|
|
|
|
|
2022-10-17 04:40:05 -04:00
|
|
|
// uses writeFastMode
|
2021-01-29 06:31:58 -05:00
|
|
|
int setValue(const uint16_t value = 0);
|
2022-10-17 04:40:05 -04:00
|
|
|
// returns last value set - cached - much faster than readDAC();
|
2021-01-29 06:31:58 -05:00
|
|
|
uint16_t getValue();
|
|
|
|
|
|
|
|
|
2022-10-17 04:40:05 -04:00
|
|
|
// 0..100.0% - no input check.
|
2021-12-21 10:28:24 -05:00
|
|
|
int setPercentage(float percentage = 0);
|
2021-01-29 06:31:58 -05:00
|
|
|
float getPercentage() { return getValue() * (100.0 / MCP4725_MAXVALUE); };
|
|
|
|
|
|
|
|
|
|
|
|
int writeDAC(const uint16_t value, const bool EEPROM = false);
|
|
|
|
bool ready();
|
|
|
|
uint32_t getLastWriteEEPROM() { return _lastWriteEEPROM; };
|
|
|
|
uint16_t readDAC();
|
|
|
|
uint16_t readEEPROM();
|
|
|
|
|
|
|
|
|
2022-10-17 04:40:05 -04:00
|
|
|
// experimental
|
2021-01-29 06:31:58 -05:00
|
|
|
int writePowerDownMode(const uint8_t PDM, const bool EEPROM = false);
|
|
|
|
uint8_t readPowerDownModeEEPROM();
|
|
|
|
uint8_t readPowerDownModeDAC();
|
|
|
|
int powerOnReset();
|
|
|
|
int powerOnWakeUp();
|
|
|
|
|
2013-11-24 15:59:40 -05:00
|
|
|
|
|
|
|
private:
|
2021-01-29 06:31:58 -05:00
|
|
|
uint8_t _deviceAddress;
|
|
|
|
uint16_t _lastValue;
|
2022-10-17 04:40:05 -04:00
|
|
|
uint8_t _powerDownMode; // DATASHEET P15?
|
2021-01-29 06:31:58 -05:00
|
|
|
int _writeFastMode(const uint16_t value);
|
|
|
|
uint32_t _lastWriteEEPROM;
|
2013-12-01 13:33:59 -05:00
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
int _writeRegisterMode(const uint16_t value, uint8_t reg);
|
|
|
|
uint8_t _readRegister(uint8_t* buffer, const uint8_t length);
|
2013-12-01 16:09:02 -05:00
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
int _generalCall(const uint8_t gc);
|
2013-12-01 16:09:02 -05:00
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
TwoWire* _wire;
|
2013-11-24 15:59:40 -05:00
|
|
|
};
|
|
|
|
|
2021-12-21 10:28:24 -05:00
|
|
|
|
2020-11-27 05:20:37 -05:00
|
|
|
// -- END OF FILE --
|
2021-12-21 10:28:24 -05:00
|
|
|
|