Justin Jordan / ard2pmod

Dependencies:   ds3231 max14661

Dependents:   ard2pmod_demo

Fork of ard2pmod by Maxim Integrated

Embed: (wiki syntax)

« Back to documentation index

Ard2Pmod Class Reference

Ard2Pmod Class Reference

Ard2Pmod Class Used for establishing PMOD type, MAX14661 16:2 mux interface. More...

#include <ard2pmod.h>

Public Types

enum  PmodType
 

PmodType - enumerated PMOD types.

More...

Public Member Functions

 Ard2Pmod (PmodType pmod_type, PinName ow_pin=NC)
 Constructor for Ard2Pmod Class.

Detailed Description

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

Definition at line 79 of file ard2pmod.h.


Member Enumeration Documentation

enum PmodType

PmodType - enumerated PMOD types.

Definition at line 86 of file ard2pmod.h.


Constructor & Destructor Documentation

Ard2Pmod ( PmodType  pmod_type,
PinName  ow_pin = NC 
)

Constructor for Ard2Pmod Class.

Copyright (C) 2015 Maxim Integrated Products, Inc., All Rights Reserved.

On Entry:

Parameters:
[in]pmod_type- desired PMOD interface
[in]ow_pin- Used for 1-wire PMOD type only, GPIO for 1-wire Master

On Exit:

Returns:
none

Example:

 #include "ard2pmod.h"

 int main(void)
 {  
     Ard2Pmod ard2pmod(Ard2Pmod::PMOD_TYPE_1_GPIO);
     
     //main app.
     for(;;)
     {
     }
 }

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.

Definition at line 38 of file ard2pmod.cpp.