MAX6956.h

Go to the documentation of this file.

// I2Cdev library collection - MAX6956 I2C device class header file
// Based on Maxim MAX6956 datasheet 19-2414; Rev 4; 6/10
//
// 2013-12-15 by Tom Beighley <tomthegeek@gmail.com>
// I2C Device Library hosted at http://www.i2cdevlib.com
//
// Changelog:
//     2013-12-15 - initial release
//

/* ============================================
I2Cdev device library code is placed under the MIT license
Copyright (c) 2013 Tom Beighley

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
===============================================
*/

#ifndef _MAX6956_H_
#define _MAX6956_H_

#include "I2Cdev.h"

// -----------------------------------------------------------------------------
// Arduino-style "Serial.print" debug constant (uncomment to enable)
// -----------------------------------------------------------------------------
// #define MAX6956_SERIAL_DEBUG

#define MAX6956_ADDRESS                 0x40 // See table 3 
#define MAX6956_DEFAULT_ADDRESS         0x40 // AD0 and AD1 at ground.

//==========Registers==========

#define MAX6956_RA_NO_OP                0x00 


#define MAX6956_RA_GLOBAL_CURRENT       0x02

#define MAX6956_RA_CONFIGURATION        0x04

#define MAX6956_RA_TRANSITION_DETECT    0x06

#define MAX6956_RA_DISPLAY_TEST         0x07

#define MAX6956_RA_CONFIG_P7P6P5P4              0x09
#define MAX6956_RA_CONFIG_P11P10P9P8            0x0A
#define MAX6956_RA_CONFIG_P15P14P13P12          0x0B
#define MAX6956_RA_CONFIG_P19P18P17P16          0x0C
#define MAX6956_RA_CONFIG_P23P22P21P20          0x0D
#define MAX6956_RA_CONFIG_P27P26P25P24          0x0E
#define MAX6956_RA_CONFIG_P31P30P29P28          0x0F

#define MAX6956_RA_CURRENT_0xP5P4       0x12
#define MAX6956_RA_CURRENT_0xP7P6       0x13
#define MAX6956_RA_CURRENT_0xP9P8       0x14
#define MAX6956_RA_CURRENT_0xP11P10     0x15
#define MAX6956_RA_CURRENT_0xP13P12     0x16
#define MAX6956_RA_CURRENT_0xP15P14     0x17
#define MAX6956_RA_CURRENT_0xP17P16     0x18
#define MAX6956_RA_CURRENT_0xP19P18     0x19
#define MAX6956_RA_CURRENT_0xP21P20     0x1A
#define MAX6956_RA_CURRENT_0xP23P22     0x1B
#define MAX6956_RA_CURRENT_0xP25P24     0x1C
#define MAX6956_RA_CURRENT_0xP27P26     0x1D
#define MAX6956_RA_CURRENT_0xP29P28     0x1E
#define MAX6956_RA_CURRENT_0xP31P30     0x1F

#define MAX6956_RA_PORT0                0x20  
#define MAX6956_RA_PORT1                0x21  
#define MAX6956_RA_PORT2                0x22  
#define MAX6956_RA_PORT3                0x23  

#define MAX6956_RA_PORT4                0x24
#define MAX6956_RA_PORT5                0x25
#define MAX6956_RA_PORT6                0x26
#define MAX6956_RA_PORT7                0x27
#define MAX6956_RA_PORT8                0x28
#define MAX6956_RA_PORT9                0x29
#define MAX6956_RA_PORT10               0x2A
#define MAX6956_RA_PORT11               0x2B

#define MAX6956_RA_PORT12               0x2C
#define MAX6956_RA_PORT13               0x2D
#define MAX6956_RA_PORT14               0x2E
#define MAX6956_RA_PORT15               0x2F
#define MAX6956_RA_PORT16               0x30
#define MAX6956_RA_PORT17               0x31
#define MAX6956_RA_PORT18               0x32
#define MAX6956_RA_PORT19               0x33

#define MAX6956_RA_PORT20               0x34
#define MAX6956_RA_PORT21               0x35
#define MAX6956_RA_PORT22               0x36
#define MAX6956_RA_PORT23               0x37
#define MAX6956_RA_PORT24               0x38
#define MAX6956_RA_PORT25               0x39
#define MAX6956_RA_PORT26               0x3A
#define MAX6956_RA_PORT27               0x3B

#define MAX6956_RA_PORT28               0x3C
#define MAX6956_RA_PORT29               0x3D
#define MAX6956_RA_PORT30               0x3E
#define MAX6956_RA_PORT31               0x3F
/*
     Lower port groups
*/
#define MAX6956_RA_PORTS4_7             0x40 
#define MAX6956_RA_PORTS4_8             0x41 
#define MAX6956_RA_PORTS4_9             0x42 
#define MAX6956_RA_PORTS4_10            0x43 

/*
     8 port registers. Data bits D0-D7
*/
#define MAX6956_RA_PORTS4_11            0x44
#define MAX6956_RA_PORTS5_12            0x45
#define MAX6956_RA_PORTS6_13            0x46
#define MAX6956_RA_PORTS7_14            0x47
#define MAX6956_RA_PORTS8_15            0x48
#define MAX6956_RA_PORTS9_16            0x49
#define MAX6956_RA_PORTS10_17           0x4A
#define MAX6956_RA_PORTS11_18           0x4B
#define MAX6956_RA_PORTS12_19           0x4C
#define MAX6956_RA_PORTS13_20           0x4D
#define MAX6956_RA_PORTS14_21           0x4E
#define MAX6956_RA_PORTS15_22           0x4F
#define MAX6956_RA_PORTS16_23           0x50
#define MAX6956_RA_PORTS17_24           0x51
#define MAX6956_RA_PORTS18_25           0x52
#define MAX6956_RA_PORTS19_26           0x53
#define MAX6956_RA_PORTS20_27           0x54
#define MAX6956_RA_PORTS21_28           0x55
#define MAX6956_RA_PORTS22_29           0x56
#define MAX6956_RA_PORTS23_30           0x57
#define MAX6956_RA_PORTS24_31           0x58
/*
     Upper port  groups
*/
#define MAX6956_RA_PORTS25_31           0x59 
#define MAX6956_RA_PORTS26_31           0x5A 
#define MAX6956_RA_PORTS27_31           0x5B 
#define MAX6956_RA_PORTS28_31           0x5C 
#define MAX6956_RA_PORTS29_31           0x5D 
#define MAX6956_RA_PORTS30_31           0x5E 
#define MAX6956_RA_PORTS31_31           0x5F 

//=========Config bits=========

#define MAX6956_CONFIG_POWER_BIT            0  
#define MAX6956_CONFIG_GLOBAL_CURRENT_BIT   6  
#define MAX6956_CONFIG_TRANSITION_BIT       7  

#define MAX6956_GLOBAL_CURRENT_BIT          0  
#define MAX6956_GLOBAL_CURRENT_LENGTH       4  

#define MAX6956_PORT12_CURRENT_BIT          3  
#define MAX6956_PORT12_CURRENT_LENGTH       4  
#define MAX6956_PORT13_CURRENT_BIT          7  
#define MAX6956_PORT13_CURRENT_LENGTH       4  
#define MAX6956_PORT14_CURRENT_BIT          3  
#define MAX6956_PORT14_CURRENT_LENGTH       4  
#define MAX6956_PORT15_CURRENT_BIT          7  
#define MAX6956_PORT15_CURRENT_LENGTH       4  
#define MAX6956_PORT16_CURRENT_BIT          3  
#define MAX6956_PORT16_CURRENT_LENGTH       4  
#define MAX6956_PORT17_CURRENT_BIT          7  
#define MAX6956_PORT17_CURRENT_LENGTH       4  
#define MAX6956_PORT18_CURRENT_BIT          3  
#define MAX6956_PORT18_CURRENT_LENGTH       4  
#define MAX6956_PORT19_CURRENT_BIT          7  
#define MAX6956_PORT19_CURRENT_LENGTH       4  
#define MAX6956_PORT23_CURRENT_BIT          3  
#define MAX6956_PORT23_CURRENT_LENGTH       4  
#define MAX6956_PORT21_CURRENT_BIT          7  
#define MAX6956_PORT21_CURRENT_LENGTH       4  
#define MAX6956_PORT22_CURRENT_BIT          3  
#define MAX6956_PORT22_CURRENT_LENGTH       4  
#define MAX6956_PORT23_CURRENT_BIT          7  
#define MAX6956_PORT23_CURRENT_LENGTH       4  
#define MAX6956_PORT24_CURRENT_BIT          3  
#define MAX6956_PORT24_CURRENT_LENGTH       4  
#define MAX6956_PORT25_CURRENT_BIT          7  
#define MAX6956_PORT25_CURRENT_LENGTH       4  
#define MAX6956_PORT26_CURRENT_BIT          3  
#define MAX6956_PORT26_CURRENT_LENGTH       4  
#define MAX6956_PORT27_CURRENT_BIT          7  
#define MAX6956_PORT27_CURRENT_LENGTH       4  
#define MAX6956_PORT28_CURRENT_BIT          3  
#define MAX6956_PORT28_CURRENT_LENGTH       4  
#define MAX6956_PORT29_CURRENT_BIT          7  
#define MAX6956_PORT29_CURRENT_LENGTH       4  
#define MAX6956_PORT33_CURRENT_BIT          3  
#define MAX6956_PORT33_CURRENT_LENGTH       4  
#define MAX6956_PORT31_CURRENT_BIT          7  
#define MAX6956_PORT31_CURRENT_LENGTH       4  

#define MAX6956_DISPLAY_TEST_BIT            0  

#define MAX6956_TRANSITION_STATUS_BIT       7  
#define MAX6956_TRANSITION_MASK_BIT         0  
#define MAX6956_TRANSITION_MASK_LENGTH      7
#define MAX6956_TRANSITION_MASK_PORT30_BIT  6
#define MAX6956_TRANSITION_MASK_PORT29_BIT  5
#define MAX6956_TRANSITION_MASK_PORT28_BIT  4
#define MAX6956_TRANSITION_MASK_PORT27_BIT  3
#define MAX6956_TRANSITION_MASK_PORT26_BIT  2
#define MAX6956_TRANSITION_MASK_PORT25_BIT  1
#define MAX6956_TRANSITION_MASK_PORT24_BIT  0

//=========Values=========

#define MAX6956_OUTPUT_LED              0x00
#define MAX6956_OUTPUT_GPIO             0x01
#define MAX6956_INPUT_WO_PULL           0x02
#define MAX6956_INPUT_W_PULL            0x03

#define MAX6956_OFF                     0x00
#define MAX6956_ON                      0x01

#define MAX6956_CURRENT_0               0x00
#define MAX6956_CURRENT_1               0x01
#define MAX6956_CURRENT_2               0x02
#define MAX6956_CURRENT_3               0x03
#define MAX6956_CURRENT_4               0x04
#define MAX6956_CURRENT_5               0x05
#define MAX6956_CURRENT_6               0x06
#define MAX6956_CURRENT_7               0x07
#define MAX6956_CURRENT_8               0x08
#define MAX6956_CURRENT_9               0x09
#define MAX6956_CURRENT_10              0x0A
#define MAX6956_CURRENT_11              0x0B
#define MAX6956_CURRENT_12              0x0C
#define MAX6956_CURRENT_13              0x0D
#define MAX6956_CURRENT_14              0x0E
#define MAX6956_CURRENT_15              0x0F

class MAX6956 {
    public:
        MAX6956();
        MAX6956(uint8_t address);

        void initialize();
        bool testConnection();

        void reset();

        // Config register
        uint8_t getConfigReg();
        void setConfigReg(uint8_t config);

        bool getPower();
        void togglePower();
        void setPower(bool power);

        bool getEnableIndividualCurrent();
        void setEnableIndividualCurrent(bool global);

        bool getEnableTransitionDetection();
        void setEnableTransitionDetection(bool transition);

        // Global current
        uint8_t getGlobalCurrent();
        void setGlobalCurrent(uint8_t current);

        // Test mode
        bool getTestMode();
        void setTestMode(bool test);

        // Input mask 
        uint8_t getInputMask();
        void setInputMask(uint8_t mask);

        // Port config
        void configPort(uint8_t port, uint8_t portConfig);
        void configPorts(uint8_t lower, uint8_t upper, uint8_t portConfig);
        void configAllPorts(uint8_t portConfig);
        
        void setPortLevel(uint8_t port, uint8_t power); 
        void setPortCurrent(uint8_t port, uint8_t power); 
        void setAllPortsCurrent(uint8_t power); 
        void enableAllPorts();
        void disableAllPorts();
        
        uint8_t portsConfig[5];
        uint8_t portsStatus[3];

    private:
        uint8_t devAddr; 
        uint8_t buffer[1]; 
        uint8_t portConfig; 
        uint8_t portCurrentRA; 
        uint8_t portCurrentBit; 
        uint8_t psArrayIndex; 
        uint8_t psBitPosition; 
};

#endif /* _MAX6956_H_ */