i2c_adc_ads7828.h

/*

  i2c_adc_ads7828.h - Arduino library for TI ADS7828 I2C A/D converter

  Library:: i2c_adc_ads7828
  Author:: Doc Walker <4-20ma@wvfans.net>

  Copyright:: 2009-2016 Doc Walker

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

*/




#ifndef i2c_adc_ads7828_h
#define i2c_adc_ads7828_h

// _________________________________________________________ STANDARD INCLUDES
// include types & constants of Wiring core API
#include "Arduino.h"


// __________________________________________________________ PROJECT INCLUDES
// include twi/i2c library
#include <Wire.h>


// ____________________________________________________________ UTILITY MACROS


// _________________________________________________________________ CONSTANTS
static const uint8_t DIFFERENTIAL        = 0 << 7; // SD == 0


static const uint8_t SINGLE_ENDED         = 1 << 7; // SD == 1


static const uint8_t REFERENCE_OFF        = 0 << 3; // PD1 == 0


static const uint8_t REFERENCE_ON         = 1 << 3; // PD1 == 1


static const uint8_t ADC_OFF              = 0 << 2; // PD0 == 0


static const uint8_t ADC_ON               = 1 << 2; // PD0 == 1


static const uint8_t DEFAULT_CHANNEL_MASK  = 0xFF;


static const uint16_t DEFAULT_MIN_SCALE    = 0;


static const uint16_t DEFAULT_MAX_SCALE    = 0xFFF;


// _________________________________________________________ CLASS DEFINITIONS
class ADS7828;
class ADS7828Channel
{
  public:
    // ............................................... public member functions
    ADS7828Channel() {};
    ADS7828Channel(ADS7828* const, uint8_t, uint8_t, uint16_t, uint16_t);
    uint8_t commandByte();
    ADS7828* device();
    uint8_t id();
    uint8_t index();
    void newSample(uint16_t);
    void reset();
    uint16_t sample();
    uint8_t start();
    uint16_t total();
    uint8_t update();
    uint16_t value();

    // ........................................ static public member functions

    // ..................................................... public attributes
    uint16_t maxScale;

    uint16_t minScale;

    // .............................................. static public attributes

  private:
    // .............................................. private member functions

    // ....................................... static private member functions

    // .................................................... private attributes
    uint8_t commandByte_;

    ADS7828* device_;

    uint8_t index_;

    uint16_t samples_[1 << 4];

    uint16_t total_;

    // ............................................. static private attributes
    static const uint8_t MOVING_AVERAGE_BITS_ = 4;
};


class ADS7828
{
  public:
    // ............................................... public member functions
    ADS7828(uint8_t);
    ADS7828(uint8_t, uint8_t);
    ADS7828(uint8_t, uint8_t, uint8_t);
    ADS7828(uint8_t, uint8_t, uint8_t, uint16_t, uint16_t);
    uint8_t address();
    ADS7828Channel* channel(uint8_t);
    uint8_t commandByte();
    uint8_t start();
    uint8_t start(uint8_t);
    uint8_t update(); // single device, all unmasked channel
    uint8_t update(uint8_t); // single device, single channel

    // ........................................ static public member functions
    static void begin();
    static ADS7828* device(uint8_t);
    static uint8_t updateAll(); // all devices, all unmasked channels

    // ..................................................... public attributes
    uint8_t channelMask;                    // mask of active channels

    // .............................................. static public attributes

  private:
    // .............................................. private member functions
    void init(uint8_t, uint8_t, uint8_t, uint16_t, uint16_t);
    uint16_t read();

    // ....................................... static private member functions
    static uint16_t read(uint8_t);
    static uint8_t start(uint8_t, uint8_t);
    static uint8_t update(ADS7828*); // single device, all unmasked channels
    static uint8_t update(ADS7828*, uint8_t); // single device, single channel

    // .................................................... private attributes
    uint8_t address_;

    ADS7828Channel channels_[8];

    uint8_t commandByte_;

    // ............................................. static private attributes
    static ADS7828* devices_[4];

    static const uint8_t BASE_ADDRESS_ = 0x48;
};
#endif