Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of ard2pmod by
ard2pmod.h
- Committer:
- j3
- Date:
- 2016-04-25
- Revision:
- 18:6d82914432e2
- Parent:
- 17:294c52822d28
File content as of revision 18:6d82914432e2:
/******************************************************************//**
* Copyright (C) 2015 Maxim Integrated Products, Inc., All Rights Reserved.
*
* 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 MAXIM INTEGRATED 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.
*
* Except as contained in this notice, the name of Maxim Integrated
* Products, Inc. shall not be used except as stated in the Maxim Integrated
* Products, Inc. Branding Policy.
*
* The mere transfer of this software does not imply any licenses
* of trade secrets, proprietary technology, copyrights, patents,
* trademarks, maskwork rights, or any other form of intellectual
* property whatsoever. Maxim Integrated Products, Inc. retains all
* ownership rights.
**********************************************************************/
#ifndef ARD2PMOD_H
#define ARD2PMOD_H
#include "mbed.h"
#include "max14661.h"
#include "ds3231.h"
	
	
/******************************************************************//**
* Ard2Pmod Class
* Used for establishing PMOD type, MAX14661 16:2 mux interface
*
* Please See MAXREFDES72# pcb schematic for configuration
*
* PMOD_TYPE_I2C_A -
* Switches SWA9, SWA12 and SWB10, SWB11 closed.  All other switches 
* open
*
* PMOD_TYPE_I2C_B -
* Switches SWA9, SWA7 and SWB10, SWB8 closed.  All other switches 
* open
* 
* PMOD_TYPE_I2C_AB - 
* Switches SWA7, SWA9, SWA12 and SWB8, SWB10, SWB11 closed.  All other
* switches open
*
* PMOD_TYPE_1_GPIO - 
* Switches all open, mux not used
*
* PMOD_TYPE_2_SPI - 
* Switches all open, mux not used
*
* PMOD_TYPE_3_UART - 
* Switches SWA12, SWA1, SWB11, SWB2 closed.  All other switches open.
*
* PMOD_TYPE_4_UART - 
* Switches SWA13, SWA2, SWB12, SWB1 closed.  All other switches open.
*
* PMOD_TYPE_5_HBRIDGE - 
* Switches all open, mux not used
*
* PMOD_TYPE_6_HBRIDGE - 
* Switches all open, mux not used
**********************************************************************/
class Ard2Pmod 
{
    public:
        
        /**
		* PmodType - enumerated PMOD types
		*/
		enum PmodType
		{
			PMOD_TYPE_I2C_A,
			PMOD_TYPE_I2C_B,
			PMOD_TYPE_I2C_AB,
			PMOD_TYPE_1_GPIO,
			PMOD_TYPE_2_SPI,
			PMOD_TYPE_3_UART,
			PMOD_TYPE_4_UART,
			PMOD_TYPE_5_HBRIDGE,
			PMOD_TYPE_6_HBRIDGE,
			PMOD_TYPE_7_ONEWIRE_A,
			PMOD_TYPE_8_ONEWIRE_B,
			PMOD_TYPE_9_ONEWIRE_AB
		};
		
		
	    /**************************************************************//**
	    * Constructor for Ard2Pmod Class
	    *
	    * On Entry:
	    *     @param[in] pmod_type - desired PMOD interface
	    *     @param[in] ow_pin - Used for 1-wire PMOD type only, GPIO for 1-wire Master
	    *
	    * On Exit:
	    *
	    * @return none
	    *
	    * Example:
		* @code
		* #include "ard2pmod.h"
		*
		* int main(void)
		* {  
		*     Ard2Pmod ard2pmod(Ard2Pmod::PMOD_TYPE_1_GPIO);
		*     
		*     //main app.
		*     for(;;)
		*     {
		*     }
		* }
		* @endcode
		******************************************************************/
		Ard2Pmod(PmodType pmod_type, PinName ow_pin = NC); 
		
		private:
		
		Max14661 _mux;
};
#endif /* ARD2PMOD_H*/
            
    