MAX11410 - MAX11410 high speed 24-bit Delta-Sigma ADC

Maxim Integrated » Code » MAX11410

MAX11410 high speed 24-bit Delta-Sigma ADC

Dependents: MAX11410BOB_24bit_ADC MAX11410BOB_Serial_Tester

MAX11410.cpp@15:d5781c8fc002, 2020-03-10 (annotated)

Committer:: whismanoid
Date:: Tue Mar 10 16:18:14 2020 -0700
Revision:: 15:d5781c8fc002
Parent:: 14:b49eecf7e4d8
Child:: 16:00aa1e5a6843

timing delay after enable RTD bias current

Who changed what in which revision?

User	Revision	Line number	New contents of line
whismanoid	0:68e64068330f	1	// /*******************************************************************************
whismanoid	4:c169ba85d673	2	// * Copyright (C) 2020 Maxim Integrated Products, Inc., All Rights Reserved.
whismanoid	0:68e64068330f	3	// *
whismanoid	0:68e64068330f	4	// * Permission is hereby granted, free of charge, to any person obtaining a
whismanoid	0:68e64068330f	5	// * copy of this software and associated documentation files (the "Software"),
whismanoid	0:68e64068330f	6	// * to deal in the Software without restriction, including without limitation
whismanoid	0:68e64068330f	7	// * the rights to use, copy, modify, merge, publish, distribute, sublicense,
whismanoid	0:68e64068330f	8	// * and/or sell copies of the Software, and to permit persons to whom the
whismanoid	0:68e64068330f	9	// * Software is furnished to do so, subject to the following conditions:
whismanoid	0:68e64068330f	10	// *
whismanoid	0:68e64068330f	11	// * The above copyright notice and this permission notice shall be included
whismanoid	0:68e64068330f	12	// * in all copies or substantial portions of the Software.
whismanoid	0:68e64068330f	13	// *
whismanoid	0:68e64068330f	14	// * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
whismanoid	0:68e64068330f	15	// * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
whismanoid	0:68e64068330f	16	// * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
whismanoid	0:68e64068330f	17	// * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
whismanoid	0:68e64068330f	18	// * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
whismanoid	0:68e64068330f	19	// * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
whismanoid	0:68e64068330f	20	// * OTHER DEALINGS IN THE SOFTWARE.
whismanoid	0:68e64068330f	21	// *
whismanoid	0:68e64068330f	22	// * Except as contained in this notice, the name of Maxim Integrated
whismanoid	0:68e64068330f	23	// * Products, Inc. shall not be used except as stated in the Maxim Integrated
whismanoid	0:68e64068330f	24	// * Products, Inc. Branding Policy.
whismanoid	0:68e64068330f	25	// *
whismanoid	0:68e64068330f	26	// * The mere transfer of this software does not imply any licenses
whismanoid	0:68e64068330f	27	// * of trade secrets, proprietary technology, copyrights, patents,
whismanoid	0:68e64068330f	28	// * trademarks, maskwork rights, or any other form of intellectual
whismanoid	0:68e64068330f	29	// * property whatsoever. Maxim Integrated Products, Inc. retains all
whismanoid	0:68e64068330f	30	// * ownership rights.
whismanoid	0:68e64068330f	31	// *******************************************************************************
whismanoid	0:68e64068330f	32	// */
whismanoid	0:68e64068330f	33	// *********************************************************************
whismanoid	0:68e64068330f	34	// @file MAX11410.cpp
whismanoid	0:68e64068330f	35	// *********************************************************************
whismanoid	0:68e64068330f	36	// Device Driver file
whismanoid	0:68e64068330f	37	// DO NOT EDIT; except areas designated "CUSTOMIZE". Automatically generated file.
whismanoid	0:68e64068330f	38	// generated by XMLSystemOfDevicesToMBED.py
whismanoid	0:68e64068330f	39	// System Name = ExampleSystem
whismanoid	0:68e64068330f	40	// System Description = Device driver example
whismanoid	0:68e64068330f	41
whismanoid	0:68e64068330f	42	#include "MAX11410.h"
whismanoid	0:68e64068330f	43
whismanoid	0:68e64068330f	44	// Device Name = MAX11410
whismanoid	0:68e64068330f	45	// Device Description = 1.9ksps, Low-Power, Serial SPI 24-Bit, 10-Channel, Differential/Single-Ended Input, SAR ADC
whismanoid	0:68e64068330f	46	// Device DeviceBriefDescription = 24-bit 1.9ksps Delta-Sigma ADC
whismanoid	0:68e64068330f	47	// Device Manufacturer = Maxim Integrated
whismanoid	0:68e64068330f	48	// Device PartNumber = MAX11410ATI+
whismanoid	0:68e64068330f	49	// Device RegValue_Width = DataWidth16bit_HL
whismanoid	0:68e64068330f	50	//
whismanoid	0:68e64068330f	51	// ADC MaxOutputDataRate = 1.9ksps
whismanoid	0:68e64068330f	52	// ADC NumChannels = 10
whismanoid	0:68e64068330f	53	// ADC ResolutionBits = 24
whismanoid	0:68e64068330f	54	//
whismanoid	0:68e64068330f	55	// SPI CS = ActiveLow
whismanoid	0:68e64068330f	56	// SPI FrameStart = CS
whismanoid	0:68e64068330f	57	// SPI CPOL = 0
whismanoid	0:68e64068330f	58	// SPI CPHA = 0
whismanoid	0:68e64068330f	59	// SPI MOSI and MISO Data are both stable on Rising edge of SCLK
whismanoid	0:68e64068330f	60	// SPI SCLK Idle Low
whismanoid	0:68e64068330f	61	// SPI SCLKMaxMHz = 8
whismanoid	0:68e64068330f	62	// SPI SCLKMinMHz = 0
whismanoid	0:68e64068330f	63	//
whismanoid	0:68e64068330f	64
whismanoid	0:68e64068330f	65	// CODE GENERATOR: class constructor definition
whismanoid	0:68e64068330f	66	MAX11410::MAX11410(SPI &spi, DigitalOut &cs_pin, // SPI interface
whismanoid	0:68e64068330f	67	// CODE GENERATOR: class constructor definition gpio InputPin pins
whismanoid	0:68e64068330f	68	// CODE GENERATOR: class constructor definition gpio OutputPin pins
whismanoid	0:68e64068330f	69	// CODE GENERATOR: class constructor definition ic_variant
whismanoid	0:68e64068330f	70	MAX11410_ic_t ic_variant)
whismanoid	0:68e64068330f	71	// CODE GENERATOR: class constructor initializer list
whismanoid	0:68e64068330f	72	: m_spi(spi), m_cs_pin(cs_pin), // SPI interface
whismanoid	0:68e64068330f	73	// CODE GENERATOR: class constructor initializer list gpio InputPin pins
whismanoid	0:68e64068330f	74	// CODE GENERATOR: class constructor initializer list gpio OutputPin pins
whismanoid	0:68e64068330f	75	// CODE GENERATOR: class constructor initializer list ic_variant
whismanoid	0:68e64068330f	76	m_ic_variant(ic_variant)
whismanoid	0:68e64068330f	77	{
whismanoid	0:68e64068330f	78	// CODE GENERATOR: class constructor definition SPI interface initialization
whismanoid	0:68e64068330f	79	//
whismanoid	0:68e64068330f	80	// SPI CS = ActiveLow
whismanoid	0:68e64068330f	81	// SPI FrameStart = CS
whismanoid	0:68e64068330f	82	m_SPI_cs_state = 1;
whismanoid	13:df96a784cda6	83	if (m_cs_pin.is_connected()) { // avoid mbed runtime error if pin is NC not connected
whismanoid	13:df96a784cda6	84	m_cs_pin = m_SPI_cs_state;
whismanoid	13:df96a784cda6	85	}
whismanoid	0:68e64068330f	86
whismanoid	0:68e64068330f	87	// SPI CPOL = 0
whismanoid	0:68e64068330f	88	// SPI CPHA = 0
whismanoid	0:68e64068330f	89	// SPI MOSI and MISO Data are both stable on Rising edge of SCLK
whismanoid	0:68e64068330f	90	// SPI SCLK Idle Low
whismanoid	0:68e64068330f	91	m_SPI_dataMode = 0; //SPI_MODE0; // CPOL=0,CPHA=0: Rising Edge stable; SCLK idle Low
whismanoid	0:68e64068330f	92	m_spi.format(8,m_SPI_dataMode); // int bits_must_be_8, int mode=0_3 CPOL=0,CPHA=0
whismanoid	0:68e64068330f	93
whismanoid	0:68e64068330f	94	// SPI SCLKMaxMHz = 8
whismanoid	0:68e64068330f	95	// SPI SCLKMinMHz = 0
whismanoid	0:68e64068330f	96	//#define SPI_SCLK_Hz 48000000 // 48MHz
whismanoid	0:68e64068330f	97	//#define SPI_SCLK_Hz 24000000 // 24MHz
whismanoid	0:68e64068330f	98	//#define SPI_SCLK_Hz 12000000 // 12MHz
whismanoid	0:68e64068330f	99	//#define SPI_SCLK_Hz 6000000 // 6MHz
whismanoid	0:68e64068330f	100	//#define SPI_SCLK_Hz 4000000 // 4MHz
whismanoid	0:68e64068330f	101	//#define SPI_SCLK_Hz 2000000 // 2MHz
whismanoid	0:68e64068330f	102	//#define SPI_SCLK_Hz 1000000 // 1MHz
whismanoid	0:68e64068330f	103	m_SPI_SCLK_Hz = 8000000; // 8MHz; MAX11410 limit is 8MHz
whismanoid	0:68e64068330f	104	m_spi.frequency(m_SPI_SCLK_Hz);
whismanoid	0:68e64068330f	105
whismanoid	0:68e64068330f	106	}
whismanoid	0:68e64068330f	107
whismanoid	0:68e64068330f	108	// CODE GENERATOR: class destructor definition
whismanoid	0:68e64068330f	109	MAX11410::~MAX11410()
whismanoid	0:68e64068330f	110	{
whismanoid	0:68e64068330f	111	// do nothing
whismanoid	0:68e64068330f	112	}
whismanoid	0:68e64068330f	113
whismanoid	0:68e64068330f	114	// CODE GENERATOR: spi_frequency setter definition
whismanoid	0:68e64068330f	115	/// set SPI SCLK frequency
whismanoid	0:68e64068330f	116	void MAX11410::spi_frequency(int spi_sclk_Hz)
whismanoid	0:68e64068330f	117	{
whismanoid	0:68e64068330f	118	m_SPI_SCLK_Hz = spi_sclk_Hz;
whismanoid	0:68e64068330f	119	m_spi.frequency(m_SPI_SCLK_Hz);
whismanoid	0:68e64068330f	120	}
whismanoid	0:68e64068330f	121
whismanoid	0:68e64068330f	122	// CODE GENERATOR: omit global g_MAX11410_device
whismanoid	0:68e64068330f	123	// CODE GENERATOR: extern function declarations
whismanoid	0:68e64068330f	124	// CODE GENERATOR: extern function requirement MAX11410::SPIoutputCS
whismanoid	0:68e64068330f	125	// Assert SPI Chip Select
whismanoid	0:68e64068330f	126	// SPI chip-select for MAX11410
whismanoid	0:68e64068330f	127	//
whismanoid	12:daecd93dd33a	128	inline void MAX11410::SPIoutputCS(int isLogicHigh)
whismanoid	0:68e64068330f	129	{
whismanoid	0:68e64068330f	130	// CODE GENERATOR: extern function definition for function SPIoutputCS
whismanoid	0:68e64068330f	131	// CODE GENERATOR: extern function definition for standard SPI interface function SPIoutputCS(int isLogicHigh)
whismanoid	0:68e64068330f	132	m_SPI_cs_state = isLogicHigh;
whismanoid	13:df96a784cda6	133	if (m_cs_pin.is_connected()) { // avoid mbed runtime error if pin is NC not connected
whismanoid	13:df96a784cda6	134	m_cs_pin = m_SPI_cs_state;
whismanoid	13:df96a784cda6	135	}
whismanoid	0:68e64068330f	136	}
whismanoid	0:68e64068330f	137
whismanoid	0:68e64068330f	138	// CODE GENERATOR: extern function requirement MAX11410::SPIwrite16bits
whismanoid	0:68e64068330f	139	// SPI write 16 bits
whismanoid	0:68e64068330f	140	// SPI interface to MAX11410 shift 16 bits mosiData into MAX11410 DIN
whismanoid	0:68e64068330f	141	//
whismanoid	0:68e64068330f	142	void MAX11410::SPIwrite16bits(int16_t mosiData16)
whismanoid	0:68e64068330f	143	{
whismanoid	0:68e64068330f	144	// CODE GENERATOR: extern function definition for function SPIwrite16bits
whismanoid	0:68e64068330f	145	// TODO1: CODE GENERATOR: extern function definition for standard SPI interface function SPIwrite16bits(int16_t mosiData16)
whismanoid	0:68e64068330f	146	size_t byteCount = 2;
whismanoid	0:68e64068330f	147	static char mosiData[2];
whismanoid	0:68e64068330f	148	static char misoData[2];
whismanoid	0:68e64068330f	149	mosiData[0] = (char)((mosiData16 >> 8) & 0xFF); // MSByte
whismanoid	0:68e64068330f	150	mosiData[1] = (char)((mosiData16 >> 0) & 0xFF); // LSByte
whismanoid	0:68e64068330f	151	//
whismanoid	0:68e64068330f	152	// Arduino: begin critical section: noInterrupts() masks all interrupt sources; end critical section with interrupts()
whismanoid	0:68e64068330f	153	//~ noInterrupts();
whismanoid	0:68e64068330f	154	//
whismanoid	0:68e64068330f	155	//~ digitalWrite(Scope_Trigger_Pin, LOW); // diagnostic Scope_Trigger_Pin
whismanoid	0:68e64068330f	156	//
whismanoid	0:68e64068330f	157	unsigned int numBytesTransferred = m_spi.write(mosiData, byteCount, misoData, byteCount);
whismanoid	0:68e64068330f	158	//~ m_spi.transfer(mosiData8_FF0000);
whismanoid	0:68e64068330f	159	//~ m_spi.transfer(mosiData16_00FF00);
whismanoid	0:68e64068330f	160	//~ m_spi.transfer(mosiData16_0000FF);
whismanoid	0:68e64068330f	161	//
whismanoid	0:68e64068330f	162	//~ digitalWrite(Scope_Trigger_Pin, HIGH); // diagnostic Scope_Trigger_Pin
whismanoid	0:68e64068330f	163	//
whismanoid	0:68e64068330f	164	// Arduino: begin critical section: noInterrupts() masks all interrupt sources; end critical section with interrupts()
whismanoid	0:68e64068330f	165	//~ interrupts();
whismanoid	0:68e64068330f	166	// Optional Diagnostic function to print SPI transactions
whismanoid	0:68e64068330f	167	if (onSPIprint)
whismanoid	0:68e64068330f	168	{
whismanoid	0:68e64068330f	169	onSPIprint(byteCount, (uint8_t)mosiData, (uint8_t)misoData);
whismanoid	0:68e64068330f	170	}
whismanoid	0:68e64068330f	171	//
whismanoid	0:68e64068330f	172	// VERIFY: SPIwrite24bits print diagnostic information
whismanoid	0:68e64068330f	173	//cmdLine.serial().printf(" MOSI->"));
whismanoid	0:68e64068330f	174	//cmdLine.serial().printf(" 0x"));
whismanoid	0:68e64068330f	175	//Serial.print( (mosiData8_FF0000 & 0xFF), HEX);
whismanoid	0:68e64068330f	176	//cmdLine.serial().printf(" 0x"));
whismanoid	0:68e64068330f	177	//Serial.print( (mosiData16_00FF00 & 0xFF), HEX);
whismanoid	0:68e64068330f	178	//cmdLine.serial().printf(" 0x"));
whismanoid	0:68e64068330f	179	//Serial.print( (mosiData16_0000FF & 0xFF), HEX);
whismanoid	0:68e64068330f	180	// hex dump mosiData[0..byteCount-1]
whismanoid	0:68e64068330f	181	#if 0 // HAS_MICROUSBSERIAL
whismanoid	0:68e64068330f	182	cmdLine_microUSBserial.serial().printf("\r\nSPI");
whismanoid	0:68e64068330f	183	if (byteCount > 7) {
whismanoid	0:68e64068330f	184	cmdLine_microUSBserial.serial().printf(" byteCount:%d", byteCount);
whismanoid	0:68e64068330f	185	}
whismanoid	0:68e64068330f	186	cmdLine_microUSBserial.serial().printf(" MOSI->");
whismanoid	0:68e64068330f	187	for (unsigned int byteIndex = 0; byteIndex < byteCount; byteIndex++)
whismanoid	0:68e64068330f	188	{
whismanoid	0:68e64068330f	189	cmdLine_microUSBserial.serial().printf(" 0x%2.2X", mosiData[byteIndex]);
whismanoid	0:68e64068330f	190	}
whismanoid	0:68e64068330f	191	// hex dump misoData[0..byteCount-1]
whismanoid	0:68e64068330f	192	cmdLine_microUSBserial.serial().printf(" MISO<-");
whismanoid	0:68e64068330f	193	for (unsigned int byteIndex = 0; byteIndex < numBytesTransferred; byteIndex++)
whismanoid	0:68e64068330f	194	{
whismanoid	0:68e64068330f	195	cmdLine_microUSBserial.serial().printf(" 0x%2.2X", misoData[byteIndex]);
whismanoid	0:68e64068330f	196	}
whismanoid	0:68e64068330f	197	cmdLine_microUSBserial.serial().printf(" ");
whismanoid	0:68e64068330f	198	#endif
whismanoid	0:68e64068330f	199	#if 0 // HAS_DAPLINK_SERIAL
whismanoid	0:68e64068330f	200	cmdLine_DAPLINKserial.serial().printf("\r\nSPI");
whismanoid	0:68e64068330f	201	if (byteCount > 7) {
whismanoid	0:68e64068330f	202	cmdLine_DAPLINKserial.serial().printf(" byteCount:%d", byteCount);
whismanoid	0:68e64068330f	203	}
whismanoid	0:68e64068330f	204	cmdLine_DAPLINKserial.serial().printf(" MOSI->");
whismanoid	0:68e64068330f	205	for (unsigned int byteIndex = 0; byteIndex < byteCount; byteIndex++)
whismanoid	0:68e64068330f	206	{
whismanoid	0:68e64068330f	207	cmdLine_DAPLINKserial.serial().printf(" 0x%2.2X", mosiData[byteIndex]);
whismanoid	0:68e64068330f	208	}
whismanoid	0:68e64068330f	209	// hex dump misoData[0..byteCount-1]
whismanoid	0:68e64068330f	210	cmdLine_DAPLINKserial.serial().printf(" MISO<-");
whismanoid	0:68e64068330f	211	for (unsigned int byteIndex = 0; byteIndex < numBytesTransferred; byteIndex++)
whismanoid	0:68e64068330f	212	{
whismanoid	0:68e64068330f	213	cmdLine_DAPLINKserial.serial().printf(" 0x%2.2X", misoData[byteIndex]);
whismanoid	0:68e64068330f	214	}
whismanoid	0:68e64068330f	215	cmdLine_DAPLINKserial.serial().printf(" ");
whismanoid	0:68e64068330f	216	#endif
whismanoid	0:68e64068330f	217	// VERIFY: DIAGNOSTIC: print MAX5715 device register write
whismanoid	0:68e64068330f	218	// TODO: MAX5715_print_register_verbose(mosiData8_FF0000, mosiData16_00FFFF);
whismanoid	0:68e64068330f	219	// TODO: print_verbose_SPI_diagnostic(mosiData16_FF00, mosiData16_00FF, misoData16_FF00, misoData16_00FF);
whismanoid	0:68e64068330f	220	//
whismanoid	0:68e64068330f	221	// int misoData16 = (misoData16_FF00 << 8) \| misoData16_00FF;
whismanoid	0:68e64068330f	222	// return misoData16;
whismanoid	0:68e64068330f	223	}
whismanoid	0:68e64068330f	224
whismanoid	0:68e64068330f	225	// CODE GENERATOR: extern function requirement MAX11410::SPIreadWrite16bits
whismanoid	0:68e64068330f	226	// SPI read and write 16 bits
whismanoid	0:68e64068330f	227	// SPI interface to MAX11410 shift 16 bits mosiData16 into MAX11410 DIN
whismanoid	0:68e64068330f	228	// while simultaneously capturing 16 bits miso data from MAX11410 DOUT
whismanoid	0:68e64068330f	229	//
whismanoid	0:68e64068330f	230	int16_t MAX11410::SPIreadWrite16bits(int16_t mosiData16)
whismanoid	0:68e64068330f	231	{
whismanoid	0:68e64068330f	232	// CODE GENERATOR: extern function definition for function SPIreadWrite16bits
whismanoid	0:68e64068330f	233	// TODO1: CODE GENERATOR: extern function definition for standard SPI interface function SPIreadWrite16bits(int16_t mosiData16)
whismanoid	0:68e64068330f	234	size_t byteCount = 2;
whismanoid	0:68e64068330f	235	static char mosiData[2];
whismanoid	0:68e64068330f	236	static char misoData[2];
whismanoid	0:68e64068330f	237	mosiData[0] = (char)((mosiData16 >> 8) & 0xFF); // MSByte
whismanoid	0:68e64068330f	238	mosiData[1] = (char)((mosiData16 >> 0) & 0xFF); // LSByte
whismanoid	0:68e64068330f	239	//
whismanoid	0:68e64068330f	240	// Arduino: begin critical section: noInterrupts() masks all interrupt sources; end critical section with interrupts()
whismanoid	0:68e64068330f	241	//~ noInterrupts();
whismanoid	0:68e64068330f	242	//
whismanoid	0:68e64068330f	243	//~ digitalWrite(Scope_Trigger_Pin, LOW); // diagnostic Scope_Trigger_Pin
whismanoid	0:68e64068330f	244	//
whismanoid	0:68e64068330f	245	unsigned int numBytesTransferred = m_spi.write(mosiData, byteCount, misoData, byteCount);
whismanoid	0:68e64068330f	246	//~ m_spi.transfer(mosiData8_FF0000);
whismanoid	0:68e64068330f	247	//~ m_spi.transfer(mosiData16_00FF00);
whismanoid	0:68e64068330f	248	//~ m_spi.transfer(mosiData16_0000FF);
whismanoid	0:68e64068330f	249	//
whismanoid	0:68e64068330f	250	//~ digitalWrite(Scope_Trigger_Pin, HIGH); // diagnostic Scope_Trigger_Pin
whismanoid	0:68e64068330f	251	//
whismanoid	0:68e64068330f	252	// Arduino: begin critical section: noInterrupts() masks all interrupt sources; end critical section with interrupts()
whismanoid	0:68e64068330f	253	//~ interrupts();
whismanoid	0:68e64068330f	254	// Optional Diagnostic function to print SPI transactions
whismanoid	0:68e64068330f	255	if (onSPIprint)
whismanoid	0:68e64068330f	256	{
whismanoid	0:68e64068330f	257	onSPIprint(byteCount, (uint8_t)mosiData, (uint8_t)misoData);
whismanoid	0:68e64068330f	258	}
whismanoid	0:68e64068330f	259	//
whismanoid	0:68e64068330f	260	// VERIFY: SPIwrite24bits print diagnostic information
whismanoid	0:68e64068330f	261	//cmdLine.serial().printf(" MOSI->"));
whismanoid	0:68e64068330f	262	//cmdLine.serial().printf(" 0x"));
whismanoid	0:68e64068330f	263	//Serial.print( (mosiData8_FF0000 & 0xFF), HEX);
whismanoid	0:68e64068330f	264	//cmdLine.serial().printf(" 0x"));
whismanoid	0:68e64068330f	265	//Serial.print( (mosiData16_00FF00 & 0xFF), HEX);
whismanoid	0:68e64068330f	266	//cmdLine.serial().printf(" 0x"));
whismanoid	0:68e64068330f	267	//Serial.print( (mosiData16_0000FF & 0xFF), HEX);
whismanoid	0:68e64068330f	268	// hex dump mosiData[0..byteCount-1]
whismanoid	0:68e64068330f	269	#if 0 // HAS_MICROUSBSERIAL
whismanoid	0:68e64068330f	270	cmdLine_microUSBserial.serial().printf("\r\nSPI");
whismanoid	0:68e64068330f	271	if (byteCount > 7) {
whismanoid	0:68e64068330f	272	cmdLine_microUSBserial.serial().printf(" byteCount:%d", byteCount);
whismanoid	0:68e64068330f	273	}
whismanoid	0:68e64068330f	274	cmdLine_microUSBserial.serial().printf(" MOSI->");
whismanoid	0:68e64068330f	275	for (unsigned int byteIndex = 0; byteIndex < byteCount; byteIndex++)
whismanoid	0:68e64068330f	276	{
whismanoid	0:68e64068330f	277	cmdLine_microUSBserial.serial().printf(" 0x%2.2X", mosiData[byteIndex]);
whismanoid	0:68e64068330f	278	}
whismanoid	0:68e64068330f	279	// hex dump misoData[0..byteCount-1]
whismanoid	0:68e64068330f	280	cmdLine_microUSBserial.serial().printf(" MISO<-");
whismanoid	0:68e64068330f	281	for (unsigned int byteIndex = 0; byteIndex < numBytesTransferred; byteIndex++)
whismanoid	0:68e64068330f	282	{
whismanoid	0:68e64068330f	283	cmdLine_microUSBserial.serial().printf(" 0x%2.2X", misoData[byteIndex]);
whismanoid	0:68e64068330f	284	}
whismanoid	0:68e64068330f	285	cmdLine_microUSBserial.serial().printf(" ");
whismanoid	0:68e64068330f	286	#endif
whismanoid	0:68e64068330f	287	#if 0 // HAS_DAPLINK_SERIAL
whismanoid	0:68e64068330f	288	cmdLine_DAPLINKserial.serial().printf("\r\nSPI");
whismanoid	0:68e64068330f	289	if (byteCount > 7) {
whismanoid	0:68e64068330f	290	cmdLine_DAPLINKserial.serial().printf(" byteCount:%d", byteCount);
whismanoid	0:68e64068330f	291	}
whismanoid	0:68e64068330f	292	cmdLine_DAPLINKserial.serial().printf(" MOSI->");
whismanoid	0:68e64068330f	293	for (unsigned int byteIndex = 0; byteIndex < byteCount; byteIndex++)
whismanoid	0:68e64068330f	294	{
whismanoid	0:68e64068330f	295	cmdLine_DAPLINKserial.serial().printf(" 0x%2.2X", mosiData[byteIndex]);
whismanoid	0:68e64068330f	296	}
whismanoid	0:68e64068330f	297	// hex dump misoData[0..byteCount-1]
whismanoid	0:68e64068330f	298	cmdLine_DAPLINKserial.serial().printf(" MISO<-");
whismanoid	0:68e64068330f	299	for (unsigned int byteIndex = 0; byteIndex < numBytesTransferred; byteIndex++)
whismanoid	0:68e64068330f	300	{
whismanoid	0:68e64068330f	301	cmdLine_DAPLINKserial.serial().printf(" 0x%2.2X", misoData[byteIndex]);
whismanoid	0:68e64068330f	302	}
whismanoid	0:68e64068330f	303	cmdLine_DAPLINKserial.serial().printf(" ");
whismanoid	0:68e64068330f	304	#endif
whismanoid	0:68e64068330f	305	// VERIFY: DIAGNOSTIC: print MAX5715 device register write
whismanoid	0:68e64068330f	306	// TODO: MAX5715_print_register_verbose(mosiData8_FF0000, mosiData16_00FFFF);
whismanoid	0:68e64068330f	307	// TODO: print_verbose_SPI_diagnostic(mosiData16_FF00, mosiData16_00FF, misoData16_FF00, misoData16_00FF);
whismanoid	0:68e64068330f	308	//
whismanoid	0:68e64068330f	309	//int misoData16 = (misoData16_FF00 << 8) \| misoData16_00FF;
whismanoid	0:68e64068330f	310	int misoData16 = (misoData[0] << 8) \| misoData[1];
whismanoid	0:68e64068330f	311	return misoData16;
whismanoid	0:68e64068330f	312	}
whismanoid	0:68e64068330f	313
whismanoid	0:68e64068330f	314	// CODE GENERATOR: extern function requirement MAX11410::SPIreadWrite32bits
whismanoid	0:68e64068330f	315	// SPI read and write 32 bits
whismanoid	0:68e64068330f	316	// SPI interface to MAX11410 shift 32 bits mosiData into MAX11410 DIN
whismanoid	0:68e64068330f	317	// while simultaneously capturing 32 bits miso data from MAX11410 DOUT
whismanoid	0:68e64068330f	318	//
whismanoid	0:68e64068330f	319	int32_t MAX11410::SPIreadWrite32bits(int32_t mosiData32)
whismanoid	0:68e64068330f	320	{
whismanoid	0:68e64068330f	321	// CODE GENERATOR: extern function definition for function SPIreadWrite32bits
whismanoid	0:68e64068330f	322	// TODO1: CODE GENERATOR: extern function definition for standard SPI interface function SPIreadWrite32bits(int32_t mosiData32)
whismanoid	0:68e64068330f	323	size_t byteCount = 4;
whismanoid	0:68e64068330f	324	static char mosiData[4];
whismanoid	0:68e64068330f	325	static char misoData[4];
whismanoid	0:68e64068330f	326	mosiData[0] = (char)((mosiData32 >> 24) & 0xFF); // MSByte
whismanoid	0:68e64068330f	327	mosiData[1] = (char)((mosiData32 >> 16) & 0xFF);
whismanoid	0:68e64068330f	328	mosiData[2] = (char)((mosiData32 >> 8) & 0xFF);
whismanoid	0:68e64068330f	329	mosiData[3] = (char)((mosiData32 >> 0) & 0xFF); // LSByte
whismanoid	0:68e64068330f	330	//
whismanoid	0:68e64068330f	331	// Arduino: begin critical section: noInterrupts() masks all interrupt sources; end critical section with interrupts()
whismanoid	0:68e64068330f	332	//~ noInterrupts();
whismanoid	0:68e64068330f	333	//
whismanoid	0:68e64068330f	334	//~ digitalWrite(Scope_Trigger_Pin, LOW); // diagnostic Scope_Trigger_Pin
whismanoid	0:68e64068330f	335	//
whismanoid	0:68e64068330f	336	unsigned int numBytesTransferred = m_spi.write(mosiData, byteCount, misoData, byteCount);
whismanoid	0:68e64068330f	337	//~ m_spi.transfer(mosiData8_FF0000);
whismanoid	0:68e64068330f	338	//~ m_spi.transfer(mosiData16_00FF00);
whismanoid	0:68e64068330f	339	//~ m_spi.transfer(mosiData16_0000FF);
whismanoid	0:68e64068330f	340	//
whismanoid	0:68e64068330f	341	//~ digitalWrite(Scope_Trigger_Pin, HIGH); // diagnostic Scope_Trigger_Pin
whismanoid	0:68e64068330f	342	//
whismanoid	0:68e64068330f	343	// Arduino: begin critical section: noInterrupts() masks all interrupt sources; end critical section with interrupts()
whismanoid	0:68e64068330f	344	//~ interrupts();
whismanoid	0:68e64068330f	345	// Optional Diagnostic function to print SPI transactions
whismanoid	0:68e64068330f	346	if (onSPIprint)
whismanoid	0:68e64068330f	347	{
whismanoid	0:68e64068330f	348	onSPIprint(byteCount, (uint8_t)mosiData, (uint8_t)misoData);
whismanoid	0:68e64068330f	349	}
whismanoid	0:68e64068330f	350	//
whismanoid	0:68e64068330f	351	// VERIFY: SPIwrite24bits print diagnostic information
whismanoid	0:68e64068330f	352	//cmdLine.serial().printf(" MOSI->"));
whismanoid	0:68e64068330f	353	//cmdLine.serial().printf(" 0x"));
whismanoid	0:68e64068330f	354	//Serial.print( (mosiData8_FF0000 & 0xFF), HEX);
whismanoid	0:68e64068330f	355	//cmdLine.serial().printf(" 0x"));
whismanoid	0:68e64068330f	356	//Serial.print( (mosiData16_00FF00 & 0xFF), HEX);
whismanoid	0:68e64068330f	357	//cmdLine.serial().printf(" 0x"));
whismanoid	0:68e64068330f	358	//Serial.print( (mosiData16_0000FF & 0xFF), HEX);
whismanoid	0:68e64068330f	359	// hex dump mosiData[0..byteCount-1]
whismanoid	0:68e64068330f	360	#if 0 // HAS_MICROUSBSERIAL
whismanoid	0:68e64068330f	361	cmdLine_microUSBserial.serial().printf("\r\nSPI");
whismanoid	0:68e64068330f	362	if (byteCount > 7) {
whismanoid	0:68e64068330f	363	cmdLine_microUSBserial.serial().printf(" byteCount:%d", byteCount);
whismanoid	0:68e64068330f	364	}
whismanoid	0:68e64068330f	365	cmdLine_microUSBserial.serial().printf(" MOSI->");
whismanoid	0:68e64068330f	366	for (unsigned int byteIndex = 0; byteIndex < byteCount; byteIndex++)
whismanoid	0:68e64068330f	367	{
whismanoid	0:68e64068330f	368	cmdLine_microUSBserial.serial().printf(" 0x%2.2X", mosiData[byteIndex]);
whismanoid	0:68e64068330f	369	}
whismanoid	0:68e64068330f	370	// hex dump misoData[0..byteCount-1]
whismanoid	0:68e64068330f	371	cmdLine_microUSBserial.serial().printf(" MISO<-");
whismanoid	0:68e64068330f	372	for (unsigned int byteIndex = 0; byteIndex < numBytesTransferred; byteIndex++)
whismanoid	0:68e64068330f	373	{
whismanoid	0:68e64068330f	374	cmdLine_microUSBserial.serial().printf(" 0x%2.2X", misoData[byteIndex]);
whismanoid	0:68e64068330f	375	}
whismanoid	0:68e64068330f	376	cmdLine_microUSBserial.serial().printf(" ");
whismanoid	0:68e64068330f	377	#endif
whismanoid	0:68e64068330f	378	#if 0 // HAS_DAPLINK_SERIAL
whismanoid	0:68e64068330f	379	cmdLine_DAPLINKserial.serial().printf("\r\nSPI");
whismanoid	0:68e64068330f	380	if (byteCount > 7) {
whismanoid	0:68e64068330f	381	cmdLine_DAPLINKserial.serial().printf(" byteCount:%d", byteCount);
whismanoid	0:68e64068330f	382	}
whismanoid	0:68e64068330f	383	cmdLine_DAPLINKserial.serial().printf(" MOSI->");
whismanoid	0:68e64068330f	384	for (unsigned int byteIndex = 0; byteIndex < byteCount; byteIndex++)
whismanoid	0:68e64068330f	385	{
whismanoid	0:68e64068330f	386	cmdLine_DAPLINKserial.serial().printf(" 0x%2.2X", mosiData[byteIndex]);
whismanoid	0:68e64068330f	387	}
whismanoid	0:68e64068330f	388	// hex dump misoData[0..byteCount-1]
whismanoid	0:68e64068330f	389	cmdLine_DAPLINKserial.serial().printf(" MISO<-");
whismanoid	0:68e64068330f	390	for (unsigned int byteIndex = 0; byteIndex < numBytesTransferred; byteIndex++)
whismanoid	0:68e64068330f	391	{
whismanoid	0:68e64068330f	392	cmdLine_DAPLINKserial.serial().printf(" 0x%2.2X", misoData[byteIndex]);
whismanoid	0:68e64068330f	393	}
whismanoid	0:68e64068330f	394	cmdLine_DAPLINKserial.serial().printf(" ");
whismanoid	0:68e64068330f	395	#endif
whismanoid	0:68e64068330f	396	// VERIFY: DIAGNOSTIC: print MAX5715 device register write
whismanoid	0:68e64068330f	397	// TODO: MAX5715_print_register_verbose(mosiData8_FF0000, mosiData16_00FFFF);
whismanoid	0:68e64068330f	398	// TODO: print_verbose_SPI_diagnostic(mosiData16_FF00, mosiData16_00FF, misoData16_FF00, misoData16_00FF);
whismanoid	0:68e64068330f	399	//
whismanoid	0:68e64068330f	400	//int misoData32 = (misoData32_FF000000 << 24) \| (misoData32_FF0000 << 16) \| (misoData32_0000FF00 << 8) \| misoData32_000000FF;
whismanoid	0:68e64068330f	401	int misoData32 = (misoData[0] << 24) \| (misoData[1] << 16) \| (misoData[2] << 8) \| misoData[3];
whismanoid	0:68e64068330f	402	return misoData32;
whismanoid	0:68e64068330f	403	}
whismanoid	0:68e64068330f	404
whismanoid	0:68e64068330f	405	// CODE GENERATOR: class member function definitions
whismanoid	0:68e64068330f	406	//----------------------------------------
whismanoid	0:68e64068330f	407	// Menu item '!'
whismanoid	0:68e64068330f	408	// Initialize device
whismanoid	0:68e64068330f	409	// @return 1 on success; 0 on failure
whismanoid	0:68e64068330f	410	uint8_t MAX11410::Init(void)
whismanoid	0:68e64068330f	411	{
whismanoid	0:68e64068330f	412
whismanoid	0:68e64068330f	413	//----------------------------------------
whismanoid	1:d57c1a2cb83c	414	// AIN0-AIN1 reference voltage, in Volts
whismanoid	1:d57c1a2cb83c	415	VRef_REF0 = 2.500;
whismanoid	1:d57c1a2cb83c	416
whismanoid	1:d57c1a2cb83c	417	//----------------------------------------
whismanoid	1:d57c1a2cb83c	418	// REF1P-REF1N reference resistance, in Ohms
whismanoid	1:d57c1a2cb83c	419	VRef_REF1 = 4999;
whismanoid	1:d57c1a2cb83c	420
whismanoid	1:d57c1a2cb83c	421	//----------------------------------------
whismanoid	1:d57c1a2cb83c	422	// REF2P-REF2N reference voltage, in Volts
whismanoid	1:d57c1a2cb83c	423	VRef_REF2 = 2.500;
whismanoid	1:d57c1a2cb83c	424
whismanoid	1:d57c1a2cb83c	425	//----------------------------------------
whismanoid	1:d57c1a2cb83c	426	// AVDD-AGND supply voltage, in Volts
whismanoid	1:d57c1a2cb83c	427	VRef_AVDD = 3.300;
whismanoid	1:d57c1a2cb83c	428
whismanoid	1:d57c1a2cb83c	429	//----------------------------------------
whismanoid	5:a2e74357cfc0	430	// RTD Resistance measurement; Thermocouple Cold Junction, in Ohms
whismanoid	5:a2e74357cfc0	431	rtd_resistance = 1000.0;
whismanoid	5:a2e74357cfc0	432
whismanoid	5:a2e74357cfc0	433	//----------------------------------------
whismanoid	3:658a93dfb2d8	434	// Temperature calculated from RTD Resistance; Thermocouple Cold Junction, in degrees C
whismanoid	3:658a93dfb2d8	435	RTD_Temperature = 25.0;
whismanoid	3:658a93dfb2d8	436
whismanoid	3:658a93dfb2d8	437	//----------------------------------------
whismanoid	1:d57c1a2cb83c	438	// shadow of register ctrl CMD_r000_1001_dddd_dddd_CTRL
whismanoid	1:d57c1a2cb83c	439	ctrl = 0x01;
whismanoid	1:d57c1a2cb83c	440
whismanoid	1:d57c1a2cb83c	441	//----------------------------------------
whismanoid	9:06ca88952f1c	442	// set by Configure_PGA gain index register pga CMD_r000_1110_xxdd_xddd_PGA
whismanoid	9:06ca88952f1c	443	pgaGain = 1;
whismanoid	9:06ca88952f1c	444
whismanoid	9:06ca88952f1c	445	//----------------------------------------
whismanoid	9:06ca88952f1c	446	// Device ID Validation
whismanoid	9:06ca88952f1c	447	#warning "Not Implemented Yet: MAX11410::Init Device ID Validation..."
whismanoid	9:06ca88952f1c	448	const uint32_t part_id_expect = 0x000F02;
whismanoid	9:06ca88952f1c	449	uint32_t part_id_readback;
whismanoid	9:06ca88952f1c	450	RegRead(CMD_r001_0001_xxxx_xxxx_xxxx_xxxx_xxxx_xddd_PART_ID, &part_id_readback);
whismanoid	9:06ca88952f1c	451	if (part_id_readback != part_id_expect) return 0;
whismanoid	9:06ca88952f1c	452
whismanoid	9:06ca88952f1c	453	//----------------------------------------
whismanoid	1:d57c1a2cb83c	454	// write8 0x00 PD = 0x03 (Reset Registers; enter Standby mode)
whismanoid	1:d57c1a2cb83c	455	RegWrite(CMD_r000_0000_xxxx_xxdd_PD, PD_11_Reset);
whismanoid	1:d57c1a2cb83c	456
whismanoid	1:d57c1a2cb83c	457	//----------------------------------------
whismanoid	1:d57c1a2cb83c	458	// write8 0x00 PD = 0x00 (NOP)
whismanoid	1:d57c1a2cb83c	459	RegWrite(CMD_r000_0000_xxxx_xxdd_PD, PD_00_Normal);
whismanoid	0:68e64068330f	460
whismanoid	0:68e64068330f	461	//----------------------------------------
whismanoid	0:68e64068330f	462	// success
whismanoid	0:68e64068330f	463	return 1;
whismanoid	0:68e64068330f	464	}
whismanoid	0:68e64068330f	465
whismanoid	0:68e64068330f	466	//----------------------------------------
whismanoid	1:d57c1a2cb83c	467	// Return the physical voltage corresponding to conversion result,
whismanoid	1:d57c1a2cb83c	468	// for unipolar mode.
whismanoid	0:68e64068330f	469	// Does not perform any offset or gain correction.
whismanoid	0:68e64068330f	470	//
whismanoid	1:d57c1a2cb83c	471	// @pre CTRL::U_BN = 1 -- Unipolar mode
whismanoid	1:d57c1a2cb83c	472	// @pre CTRL::FORMAT = x
whismanoid	0:68e64068330f	473	// @pre VRef = Voltage of REF input, in Volts
whismanoid	0:68e64068330f	474	// @param[in] value_u24: raw 24-bit MAX11410 code (right justified).
whismanoid	0:68e64068330f	475	// @return physical voltage corresponding to MAX11410 code.
whismanoid	14:b49eecf7e4d8	476	//
whismanoid	14:b49eecf7e4d8	477	// @test Configure_CTRL_REF(2) expect 1 These tests require REF2 = 2.500V
whismanoid	4:c169ba85d673	478	// @test group UNIPOLAR VoltageOfCode_Unipolar(0xFFFFFF) expect 2.500 within 0.030 Full Scale
whismanoid	4:c169ba85d673	479	// @test group UNIPOLAR VoltageOfCode_Unipolar(0xFFFFFE) expect 2.500 Full Scale
whismanoid	4:c169ba85d673	480	// @test group UNIPOLAR VoltageOfCode_Unipolar(0xCCCCCC) expect 2.000 Two Volts
whismanoid	4:c169ba85d673	481	// @test group UNIPOLAR VoltageOfCode_Unipolar(0xC00000) expect 1.875 75% Scale
whismanoid	4:c169ba85d673	482	// @test group UNIPOLAR VoltageOfCode_Unipolar(0x800000) expect 1.250 Mid Scale
whismanoid	4:c169ba85d673	483	// @test group UNIPOLAR VoltageOfCode_Unipolar(0x666666) expect 1.000 One Volt
whismanoid	4:c169ba85d673	484	// @test group UNIPOLAR VoltageOfCode_Unipolar(0x400000) expect 0.625 25% Scale
whismanoid	4:c169ba85d673	485	// @test group UNIPOLAR VoltageOfCode_Unipolar(0x0A3D70) expect 0.100 100mV
whismanoid	4:c169ba85d673	486	// @test group UNIPOLAR VoltageOfCode_Unipolar(0x000064) expect 0.000014901162 100 LSB
whismanoid	4:c169ba85d673	487	// @test group UNIPOLAR VoltageOfCode_Unipolar(0x00000A) expect 0.0000014901162 Ten LSB
whismanoid	4:c169ba85d673	488	// @test group UNIPOLAR VoltageOfCode_Unipolar(0x000003) expect 0.00000044703483 Three LSB
whismanoid	4:c169ba85d673	489	// @test group UNIPOLAR VoltageOfCode_Unipolar(0x000002) expect 0.00000029802326 Two LSB
whismanoid	4:c169ba85d673	490	// @test group UNIPOLAR VoltageOfCode_Unipolar(0x000001) expect 0.00000014901162 One LSB
whismanoid	4:c169ba85d673	491	// @test group UNIPOLAR VoltageOfCode_Unipolar(0x000000) expect 0.0 Zero Scale
whismanoid	1:d57c1a2cb83c	492	//
whismanoid	1:d57c1a2cb83c	493	double MAX11410::VoltageOfCode_Unipolar(uint32_t value_u24)
whismanoid	0:68e64068330f	494	{
whismanoid	0:68e64068330f	495
whismanoid	0:68e64068330f	496	//----------------------------------------
whismanoid	0:68e64068330f	497	// Linear map min and max endpoints
whismanoid	1:d57c1a2cb83c	498	double VRef = VRef_REF2;
whismanoid	1:d57c1a2cb83c	499	uint8_t ref_sel = (ctrl & 0x03); // MAX11410_REF_SEL_enum_t
whismanoid	1:d57c1a2cb83c	500	switch(ref_sel)
whismanoid	1:d57c1a2cb83c	501	{
whismanoid	1:d57c1a2cb83c	502	case REF_SEL_000_AIN0_AIN1: VRef = VRef_REF0; break;
whismanoid	1:d57c1a2cb83c	503	case REF_SEL_001_REF1P_REF1N: VRef = VRef_REF1; break;
whismanoid	1:d57c1a2cb83c	504	case REF_SEL_010_REF2P_REF2N: VRef = VRef_REF2; break;
whismanoid	1:d57c1a2cb83c	505	case REF_SEL_011_AVDD_AGND: VRef = VRef_AVDD; break;
whismanoid	1:d57c1a2cb83c	506	case REF_SEL_100_AIN0_AGND: VRef = VRef_REF0; break;
whismanoid	1:d57c1a2cb83c	507	case REF_SEL_101_REF1P_AGND: VRef = VRef_REF1; break;
whismanoid	1:d57c1a2cb83c	508	case REF_SEL_110_REF2P_AGND: VRef = VRef_REF2; break;
whismanoid	1:d57c1a2cb83c	509	case REF_SEL_111_AVDD_AGND: VRef = VRef_AVDD; break;
whismanoid	1:d57c1a2cb83c	510	}
whismanoid	0:68e64068330f	511	double MaxScaleVoltage = VRef; // voltage of maximum code 0xffffff
whismanoid	0:68e64068330f	512	double MinScaleVoltage = 0.0; // voltage of minimum code 0x000
whismanoid	0:68e64068330f	513	const uint32_t FULL_SCALE_CODE_24BIT = 0xffffff;
whismanoid	0:68e64068330f	514	const uint32_t MaxCode = FULL_SCALE_CODE_24BIT;
whismanoid	0:68e64068330f	515	const uint32_t MinCode = 0x000;
whismanoid	0:68e64068330f	516	double codeFraction = ((double)value_u24 - MinCode) / (MaxCode - MinCode + 1);
whismanoid	1:d57c1a2cb83c	517	return (MinScaleVoltage + ((MaxScaleVoltage - MinScaleVoltage) * codeFraction)) / pgaGain;
whismanoid	1:d57c1a2cb83c	518	}
whismanoid	1:d57c1a2cb83c	519
whismanoid	1:d57c1a2cb83c	520	//----------------------------------------
whismanoid	1:d57c1a2cb83c	521	// Return the physical voltage corresponding to conversion result,
whismanoid	1:d57c1a2cb83c	522	// when conversion format is Bipolar mode, offset binary.
whismanoid	1:d57c1a2cb83c	523	// Does not perform any offset or gain correction.
whismanoid	1:d57c1a2cb83c	524	//
whismanoid	1:d57c1a2cb83c	525	// @pre CTRL::U_BN = 0 -- Bipolar mode
whismanoid	1:d57c1a2cb83c	526	// @pre CTRL::FORMAT = 1 -- offset binary
whismanoid	1:d57c1a2cb83c	527	// @pre VRef = Voltage of REF input, in Volts
whismanoid	1:d57c1a2cb83c	528	// @param[in] value_u24: raw 24-bit MAX11410 code (right justified).
whismanoid	1:d57c1a2cb83c	529	// @return physical voltage corresponding to MAX11410 code.
whismanoid	14:b49eecf7e4d8	530	//
whismanoid	14:b49eecf7e4d8	531	// @test Configure_CTRL_REF(2) expect 1 These tests require REF2 = 2.500V
whismanoid	4:c169ba85d673	532	// @test group BIPOB VoltageOfCode_Bipolar_OffsetBinary(0xFFFFFF) expect 2.5 within 0.030 Full Scale
whismanoid	4:c169ba85d673	533	// @test group BIPOB VoltageOfCode_Bipolar_OffsetBinary(0xFFFFFE) expect 2.5 Full Scale
whismanoid	4:c169ba85d673	534	// @test group BIPOB VoltageOfCode_Bipolar_OffsetBinary(0xC00000) expect 1.25 Mid Scale
whismanoid	4:c169ba85d673	535	// @test group BIPOB VoltageOfCode_Bipolar_OffsetBinary(0x800003) expect 0.00000894069671 Three LSB
whismanoid	4:c169ba85d673	536	// @test group BIPOB VoltageOfCode_Bipolar_OffsetBinary(0x800002) expect 0.00000596046447 Two LSB
whismanoid	4:c169ba85d673	537	// @test group BIPOB VoltageOfCode_Bipolar_OffsetBinary(0x800001) expect 0.0000029802326 One LSB
whismanoid	4:c169ba85d673	538	// @test group BIPOB VoltageOfCode_Bipolar_OffsetBinary(0x800000) expect 0.0 Zero Scale
whismanoid	4:c169ba85d673	539	// @test group BIPOB VoltageOfCode_Bipolar_OffsetBinary(0x7FFFFF) expect -0.0000029802326 Negative One LSB
whismanoid	4:c169ba85d673	540	// @test group BIPOB VoltageOfCode_Bipolar_OffsetBinary(0x7FFFFE) expect -0.0000059604644 Negative Two LSB
whismanoid	4:c169ba85d673	541	// @test group BIPOB VoltageOfCode_Bipolar_OffsetBinary(0x7FFFFD) expect -0.0000089406967 Negative Three LSB
whismanoid	4:c169ba85d673	542	// @test group BIPOB VoltageOfCode_Bipolar_OffsetBinary(0x400000) expect -1.25 Negative Mid Scale
whismanoid	4:c169ba85d673	543	// @test group BIPOB VoltageOfCode_Bipolar_OffsetBinary(0x000001) expect -2.5 Negative Full Scale
whismanoid	4:c169ba85d673	544	// @test group BIPOB VoltageOfCode_Bipolar_OffsetBinary(0x000000) expect -2.5 Negative Full Scale
whismanoid	1:d57c1a2cb83c	545	//
whismanoid	1:d57c1a2cb83c	546	double MAX11410::VoltageOfCode_Bipolar_OffsetBinary(uint32_t value_u24)
whismanoid	1:d57c1a2cb83c	547	{
whismanoid	1:d57c1a2cb83c	548
whismanoid	1:d57c1a2cb83c	549	//----------------------------------------
whismanoid	1:d57c1a2cb83c	550	// Linear map min and max endpoints
whismanoid	1:d57c1a2cb83c	551	double VRef = VRef_REF2;
whismanoid	1:d57c1a2cb83c	552	uint8_t ref_sel = (ctrl & 0x03); // MAX11410_REF_SEL_enum_t
whismanoid	1:d57c1a2cb83c	553	switch(ref_sel)
whismanoid	1:d57c1a2cb83c	554	{
whismanoid	1:d57c1a2cb83c	555	case REF_SEL_000_AIN0_AIN1: VRef = VRef_REF0; break;
whismanoid	1:d57c1a2cb83c	556	case REF_SEL_001_REF1P_REF1N: VRef = VRef_REF1; break;
whismanoid	1:d57c1a2cb83c	557	case REF_SEL_010_REF2P_REF2N: VRef = VRef_REF2; break;
whismanoid	1:d57c1a2cb83c	558	case REF_SEL_011_AVDD_AGND: VRef = VRef_AVDD; break;
whismanoid	1:d57c1a2cb83c	559	case REF_SEL_100_AIN0_AGND: VRef = VRef_REF0; break;
whismanoid	1:d57c1a2cb83c	560	case REF_SEL_101_REF1P_AGND: VRef = VRef_REF1; break;
whismanoid	1:d57c1a2cb83c	561	case REF_SEL_110_REF2P_AGND: VRef = VRef_REF2; break;
whismanoid	1:d57c1a2cb83c	562	case REF_SEL_111_AVDD_AGND: VRef = VRef_AVDD; break;
whismanoid	1:d57c1a2cb83c	563	}
whismanoid	1:d57c1a2cb83c	564	double MaxScaleVoltage = 2*VRef; // voltage of maximum code 0x7fffff
whismanoid	1:d57c1a2cb83c	565	double MinScaleVoltage = 0; // voltage of minimum code 0x800000;
whismanoid	1:d57c1a2cb83c	566	const uint32_t FULL_SCALE_CODE_24BIT = 0x7fffff;
whismanoid	1:d57c1a2cb83c	567	const uint32_t MaxCode = FULL_SCALE_CODE_24BIT;
whismanoid	1:d57c1a2cb83c	568	const int32_t CodeSpan = 0x1000000;
whismanoid	1:d57c1a2cb83c	569	const uint32_t MinCode = 0x800000;
whismanoid	1:d57c1a2cb83c	570	double codeFraction = ((double)value_u24 - MinCode) / CodeSpan;
whismanoid	1:d57c1a2cb83c	571	return (MinScaleVoltage + ((MaxScaleVoltage - MinScaleVoltage) * codeFraction)) / pgaGain;
whismanoid	1:d57c1a2cb83c	572	}
whismanoid	1:d57c1a2cb83c	573
whismanoid	1:d57c1a2cb83c	574	//----------------------------------------
whismanoid	1:d57c1a2cb83c	575	// Return the physical voltage corresponding to conversion result,
whismanoid	1:d57c1a2cb83c	576	// when conversion format is Bipolar mode, 2's complement.
whismanoid	1:d57c1a2cb83c	577	// Does not perform any offset or gain correction.
whismanoid	1:d57c1a2cb83c	578	//
whismanoid	1:d57c1a2cb83c	579	// @pre CTRL::U_BN = 0 -- Bipolar mode
whismanoid	1:d57c1a2cb83c	580	// @pre CTRL::FORMAT = 0 -- 2's complement
whismanoid	1:d57c1a2cb83c	581	// @pre VRef = Voltage of REF input, in Volts
whismanoid	1:d57c1a2cb83c	582	// @param[in] value_u24: raw 24-bit MAX11410 code (right justified).
whismanoid	1:d57c1a2cb83c	583	// @return physical voltage corresponding to MAX11410 code.
whismanoid	14:b49eecf7e4d8	584	//
whismanoid	14:b49eecf7e4d8	585	// @test Configure_CTRL_REF(2) expect 1 These tests require REF2 = 2.500V
whismanoid	4:c169ba85d673	586	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x7FFFFF) expect 2.500 within 0.030 Full Scale
whismanoid	4:c169ba85d673	587	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x7FFFFE) expect 2.500 Full Scale
whismanoid	4:c169ba85d673	588	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x666666) expect 2.000 Two Volts
whismanoid	4:c169ba85d673	589	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x600000) expect 1.875 75% Scale
whismanoid	4:c169ba85d673	590	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x400000) expect 1.250 Mid Scale
whismanoid	4:c169ba85d673	591	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x333333) expect 1.000 One Volt
whismanoid	4:c169ba85d673	592	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x200000) expect 0.625 25% Scale
whismanoid	4:c169ba85d673	593	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x051eb8) expect 0.100 100mV
whismanoid	4:c169ba85d673	594	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x000003) expect 0.00000894069671 Three LSB
whismanoid	4:c169ba85d673	595	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x000002) expect 0.00000596046447 Two LSB
whismanoid	4:c169ba85d673	596	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x000001) expect 0.0000029802326 One LSB
whismanoid	4:c169ba85d673	597	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x000000) expect 0.0 Zero Scale
whismanoid	4:c169ba85d673	598	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0xFFFFFF) expect -0.0000029802326 Negative One LSB
whismanoid	4:c169ba85d673	599	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0xFFFFFE) expect -0.0000059604644 Negative Two LSB
whismanoid	4:c169ba85d673	600	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0xFFFFFD) expect -0.0000089406967 Negative Three LSB
whismanoid	4:c169ba85d673	601	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0xFAE148) expect -0.100 Negative 100mV
whismanoid	4:c169ba85d673	602	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0xE00000) expect -0.625 Negative 25% Scale
whismanoid	4:c169ba85d673	603	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0xCCCCCD) expect -1.000 Negative One Volt
whismanoid	4:c169ba85d673	604	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0xC00000) expect -1.250 Negative Mid Scale
whismanoid	4:c169ba85d673	605	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0xA00000) expect -1.875 Negative 75% Scale
whismanoid	4:c169ba85d673	606	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x99999A) expect -2.000 Negative Two Volts
whismanoid	4:c169ba85d673	607	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x800001) expect -2.500 Negative Full Scale
whismanoid	4:c169ba85d673	608	// @test group BIP2C VoltageOfCode_Bipolar_2sComplement(0x800000) expect -2.500 Negative Full Scale
whismanoid	1:d57c1a2cb83c	609	//
whismanoid	1:d57c1a2cb83c	610	double MAX11410::VoltageOfCode_Bipolar_2sComplement(uint32_t value_u24)
whismanoid	1:d57c1a2cb83c	611	{
whismanoid	1:d57c1a2cb83c	612
whismanoid	1:d57c1a2cb83c	613	//----------------------------------------
whismanoid	1:d57c1a2cb83c	614	// Linear map min and max endpoints
whismanoid	1:d57c1a2cb83c	615	double VRef = VRef_REF2;
whismanoid	1:d57c1a2cb83c	616	uint8_t ref_sel = (ctrl & 0x03); // MAX11410_REF_SEL_enum_t
whismanoid	1:d57c1a2cb83c	617	switch(ref_sel)
whismanoid	1:d57c1a2cb83c	618	{
whismanoid	1:d57c1a2cb83c	619	case REF_SEL_000_AIN0_AIN1: VRef = VRef_REF0; break;
whismanoid	1:d57c1a2cb83c	620	case REF_SEL_001_REF1P_REF1N: VRef = VRef_REF1; break;
whismanoid	1:d57c1a2cb83c	621	case REF_SEL_010_REF2P_REF2N: VRef = VRef_REF2; break;
whismanoid	1:d57c1a2cb83c	622	case REF_SEL_011_AVDD_AGND: VRef = VRef_AVDD; break;
whismanoid	1:d57c1a2cb83c	623	case REF_SEL_100_AIN0_AGND: VRef = VRef_REF0; break;
whismanoid	1:d57c1a2cb83c	624	case REF_SEL_101_REF1P_AGND: VRef = VRef_REF1; break;
whismanoid	1:d57c1a2cb83c	625	case REF_SEL_110_REF2P_AGND: VRef = VRef_REF2; break;
whismanoid	1:d57c1a2cb83c	626	case REF_SEL_111_AVDD_AGND: VRef = VRef_AVDD; break;
whismanoid	1:d57c1a2cb83c	627	}
whismanoid	1:d57c1a2cb83c	628	double MaxScaleVoltage = 2 * VRef; // voltage of maximum code 0x7fffff
whismanoid	1:d57c1a2cb83c	629	double MinScaleVoltage = 0; // voltage of minimum code 0x800000
whismanoid	1:d57c1a2cb83c	630	const int32_t FULL_SCALE_CODE_24BIT_2S_COMPLEMENT = 0x7fffff;
whismanoid	1:d57c1a2cb83c	631	const int32_t SIGN_BIT_24BIT_2S_COMPLEMENT = 0x800000;
whismanoid	1:d57c1a2cb83c	632	if (value_u24 >= SIGN_BIT_24BIT_2S_COMPLEMENT) { value_u24 = value_u24 - (2 * SIGN_BIT_24BIT_2S_COMPLEMENT); }
whismanoid	1:d57c1a2cb83c	633	const int32_t MaxCode = FULL_SCALE_CODE_24BIT_2S_COMPLEMENT;
whismanoid	1:d57c1a2cb83c	634	const int32_t CodeSpan = 0x1000000;
whismanoid	1:d57c1a2cb83c	635	const int32_t MinCode = 0;
whismanoid	1:d57c1a2cb83c	636	double codeFraction = ((double)((int32_t)value_u24) - MinCode) / CodeSpan;
whismanoid	1:d57c1a2cb83c	637	return (MinScaleVoltage + ((MaxScaleVoltage - MinScaleVoltage) * codeFraction)) / pgaGain;
whismanoid	1:d57c1a2cb83c	638	}
whismanoid	1:d57c1a2cb83c	639
whismanoid	1:d57c1a2cb83c	640	//----------------------------------------
whismanoid	1:d57c1a2cb83c	641	// Return the physical voltage corresponding to conversion result,
whismanoid	1:d57c1a2cb83c	642	// when conversion format is determined by the CTRL register.
whismanoid	1:d57c1a2cb83c	643	// Does not perform any offset or gain correction.
whismanoid	1:d57c1a2cb83c	644	//
whismanoid	1:d57c1a2cb83c	645	// @pre CTRL::U_BN and CTRL::FORMAT = 0 select offset binary, 2's complement, or straight binary
whismanoid	1:d57c1a2cb83c	646	// @pre VRef = Voltage of REF input, in Volts
whismanoid	1:d57c1a2cb83c	647	// @param[in] value_u24: raw 24-bit MAX11410 code (right justified).
whismanoid	1:d57c1a2cb83c	648	// @return physical voltage corresponding to MAX11410 code.
whismanoid	1:d57c1a2cb83c	649	double MAX11410::VoltageOfCode(uint32_t value_u24)
whismanoid	1:d57c1a2cb83c	650	{
whismanoid	1:d57c1a2cb83c	651
whismanoid	1:d57c1a2cb83c	652	//----------------------------------------
whismanoid	1:d57c1a2cb83c	653	// warning -- WIP work in progress
whismanoid	1:d57c1a2cb83c	654	#warning "Not Tested Yet: MAX11410::VoltageOfCode..."
whismanoid	1:d57c1a2cb83c	655
whismanoid	1:d57c1a2cb83c	656	//----------------------------------------
whismanoid	1:d57c1a2cb83c	657	// Determine format from CTRL register U_BN and FORMAT
whismanoid	1:d57c1a2cb83c	658	uint8_t u_bn_bitmask = (1 << 6);
whismanoid	1:d57c1a2cb83c	659	uint8_t format_bitmask = (1 << 5);
whismanoid	1:d57c1a2cb83c	660	if ((ctrl & u_bn_bitmask) != 0)
whismanoid	1:d57c1a2cb83c	661	{
whismanoid	1:d57c1a2cb83c	662	return VoltageOfCode_Unipolar(value_u24);
whismanoid	1:d57c1a2cb83c	663	}
whismanoid	1:d57c1a2cb83c	664	if ((ctrl & format_bitmask) != 0)
whismanoid	1:d57c1a2cb83c	665	{
whismanoid	1:d57c1a2cb83c	666	return VoltageOfCode_Bipolar_OffsetBinary(value_u24);
whismanoid	1:d57c1a2cb83c	667	}
whismanoid	1:d57c1a2cb83c	668	return VoltageOfCode_Bipolar_2sComplement(value_u24);
whismanoid	0:68e64068330f	669	}
whismanoid	0:68e64068330f	670
whismanoid	0:68e64068330f	671	//----------------------------------------
whismanoid	0:68e64068330f	672	// Write a MAX11410 register.
whismanoid	0:68e64068330f	673	//
whismanoid	11:abde565b8497	674	// CMDOP_1aaa_aaaa_ReadRegister bit is cleared 0 indicating a write operation.
whismanoid	0:68e64068330f	675	//
whismanoid	0:68e64068330f	676	// MAX11410 register length can be determined by function RegSize.
whismanoid	0:68e64068330f	677	//
whismanoid	0:68e64068330f	678	// For 8-bit register size:
whismanoid	0:68e64068330f	679	//
whismanoid	0:68e64068330f	680	// SPI 16-bit transfer
whismanoid	0:68e64068330f	681	//
whismanoid	0:68e64068330f	682	// SPI MOSI = 0aaa_aaaa_dddd_dddd
whismanoid	0:68e64068330f	683	//
whismanoid	0:68e64068330f	684	// SPI MISO = xxxx_xxxx_xxxx_xxxx
whismanoid	0:68e64068330f	685	//
whismanoid	0:68e64068330f	686	// For 16-bit register size:
whismanoid	0:68e64068330f	687	//
whismanoid	0:68e64068330f	688	// SPI 24-bit or 32-bit transfer
whismanoid	0:68e64068330f	689	//
whismanoid	0:68e64068330f	690	// SPI MOSI = 0aaa_aaaa_dddd_dddd_dddd_dddd
whismanoid	0:68e64068330f	691	//
whismanoid	0:68e64068330f	692	// SPI MISO = xxxx_xxxx_xxxx_xxxx_xxxx_xxxx
whismanoid	0:68e64068330f	693	//
whismanoid	0:68e64068330f	694	// For 24-bit register size:
whismanoid	0:68e64068330f	695	//
whismanoid	0:68e64068330f	696	// SPI 32-bit transfer
whismanoid	0:68e64068330f	697	//
whismanoid	0:68e64068330f	698	// SPI MOSI = 0aaa_aaaa_dddd_dddd_dddd_dddd_dddd_dddd
whismanoid	0:68e64068330f	699	//
whismanoid	0:68e64068330f	700	// SPI MISO = xxxx_xxxx_xxxx_xxxx_xxxx_xxxx_xxxx_xxxx
whismanoid	0:68e64068330f	701	//
whismanoid	0:68e64068330f	702	// @return 1 on success; 0 on failure
whismanoid	10:7adee48a7f82	703	uint8_t MAX11410::RegWrite(MAX11410_CMD_enum_t commandByte, uint32_t regData)
whismanoid	0:68e64068330f	704	{
whismanoid	0:68e64068330f	705
whismanoid	0:68e64068330f	706	//----------------------------------------
whismanoid	10:7adee48a7f82	707	// switch based on register address szie RegSize(commandByte)
whismanoid	11:abde565b8497	708	commandByte = (MAX11410_CMD_enum_t)((commandByte &~ CMDOP_1aaa_aaaa_ReadRegister) & 0xFF);
whismanoid	10:7adee48a7f82	709	switch(RegSize(commandByte))
whismanoid	0:68e64068330f	710	{
whismanoid	0:68e64068330f	711	case 8: // 8-bit register size
whismanoid	0:68e64068330f	712	{
whismanoid	0:68e64068330f	713	// SPI 16-bit transfer
whismanoid	0:68e64068330f	714	// SPI MOSI = 0aaa_aaaa_dddd_dddd
whismanoid	0:68e64068330f	715	// SPI MISO = xxxx_xxxx_xxxx_xxxx
whismanoid	10:7adee48a7f82	716	int16_t mosiData16 = ((int16_t)commandByte << 8) \| ((int16_t)regData & 0xFF);
whismanoid	0:68e64068330f	717	SPIoutputCS(0);
whismanoid	0:68e64068330f	718	SPIwrite16bits(mosiData16);
whismanoid	0:68e64068330f	719	SPIoutputCS(1);
whismanoid	0:68e64068330f	720	}
whismanoid	0:68e64068330f	721	break;
whismanoid	0:68e64068330f	722	case 16: // 16-bit register size
whismanoid	0:68e64068330f	723	#warning "Not Verified Yet: MAX11410::RegWrite 16-bit SPIreadWrite32bits"
whismanoid	0:68e64068330f	724	{
whismanoid	0:68e64068330f	725	// SPI 24-bit or 32-bit transfer
whismanoid	0:68e64068330f	726	// SPI MOSI = 0aaa_aaaa_dddd_dddd_dddd_dddd
whismanoid	0:68e64068330f	727	// SPI MISO = xxxx_xxxx_xxxx_xxxx_xxxx_xxxx
whismanoid	0:68e64068330f	728	// SPI MOSI = 0aaa_aaaa_dddd_dddd_dddd_dddd_0000_0000
whismanoid	0:68e64068330f	729	// SPI MISO = xxxx_xxxx_xxxx_xxxx_xxxx_xxxx_xxxx_xxxx
whismanoid	10:7adee48a7f82	730	int32_t mosiData32 = ((int32_t)commandByte << 24) \| (((int32_t)regData & 0xFFFF) << 8);
whismanoid	0:68e64068330f	731	SPIoutputCS(0);
whismanoid	0:68e64068330f	732	SPIreadWrite32bits(mosiData32);
whismanoid	0:68e64068330f	733	SPIoutputCS(1);
whismanoid	0:68e64068330f	734	}
whismanoid	0:68e64068330f	735	break;
whismanoid	0:68e64068330f	736	case 24: // 24-bit register size
whismanoid	0:68e64068330f	737	{
whismanoid	0:68e64068330f	738	// SPI 32-bit transfer
whismanoid	0:68e64068330f	739	// SPI MOSI = 0aaa_aaaa_dddd_dddd_dddd_dddd_dddd_dddd
whismanoid	0:68e64068330f	740	// SPI MISO = xxxx_xxxx_xxxx_xxxx_xxxx_xxxx_xxxx_xxxx
whismanoid	10:7adee48a7f82	741	int32_t mosiData32 = ((int32_t)commandByte << 24) \| ((int32_t)regData & 0x00FFFFFF);
whismanoid	0:68e64068330f	742	SPIoutputCS(0);
whismanoid	0:68e64068330f	743	SPIreadWrite32bits(mosiData32);
whismanoid	0:68e64068330f	744	SPIoutputCS(1);
whismanoid	0:68e64068330f	745	}
whismanoid	0:68e64068330f	746	break;
whismanoid	0:68e64068330f	747	}
whismanoid	0:68e64068330f	748
whismanoid	0:68e64068330f	749	//----------------------------------------
whismanoid	0:68e64068330f	750	// success
whismanoid	0:68e64068330f	751	return 1;
whismanoid	0:68e64068330f	752	}
whismanoid	0:68e64068330f	753
whismanoid	0:68e64068330f	754	//----------------------------------------
whismanoid	0:68e64068330f	755	// Read an 8-bit MAX11410 register
whismanoid	0:68e64068330f	756	//
whismanoid	11:abde565b8497	757	// CMDOP_1aaa_aaaa_ReadRegister bit is set 1 indicating a read operation.
whismanoid	0:68e64068330f	758	//
whismanoid	0:68e64068330f	759	// MAX11410 register length can be determined by function RegSize.
whismanoid	0:68e64068330f	760	//
whismanoid	0:68e64068330f	761	// For 8-bit register size:
whismanoid	0:68e64068330f	762	//
whismanoid	0:68e64068330f	763	// SPI 16-bit transfer
whismanoid	0:68e64068330f	764	//
whismanoid	0:68e64068330f	765	// SPI MOSI = 1aaa_aaaa_0000_0000
whismanoid	0:68e64068330f	766	//
whismanoid	0:68e64068330f	767	// SPI MISO = xxxx_xxxx_dddd_dddd
whismanoid	0:68e64068330f	768	//
whismanoid	0:68e64068330f	769	// For 16-bit register size:
whismanoid	0:68e64068330f	770	//
whismanoid	0:68e64068330f	771	// SPI 24-bit or 32-bit transfer
whismanoid	0:68e64068330f	772	//
whismanoid	0:68e64068330f	773	// SPI MOSI = 1aaa_aaaa_0000_0000_0000_0000
whismanoid	0:68e64068330f	774	//
whismanoid	0:68e64068330f	775	// SPI MISO = xxxx_xxxx_dddd_dddd_dddd_dddd
whismanoid	0:68e64068330f	776	//
whismanoid	0:68e64068330f	777	// For 24-bit register size:
whismanoid	0:68e64068330f	778	//
whismanoid	0:68e64068330f	779	// SPI 32-bit transfer
whismanoid	0:68e64068330f	780	//
whismanoid	0:68e64068330f	781	// SPI MOSI = 1aaa_aaaa_0000_0000_0000_0000_0000_0000
whismanoid	0:68e64068330f	782	//
whismanoid	0:68e64068330f	783	// SPI MISO = xxxx_xxxx_dddd_dddd_dddd_dddd_dddd_dddd
whismanoid	0:68e64068330f	784	//
whismanoid	0:68e64068330f	785	//
whismanoid	0:68e64068330f	786	// @return 1 on success; 0 on failure
whismanoid	10:7adee48a7f82	787	uint8_t MAX11410::RegRead(MAX11410_CMD_enum_t commandByte, uint32_t* ptrRegData)
whismanoid	0:68e64068330f	788	{
whismanoid	0:68e64068330f	789
whismanoid	0:68e64068330f	790	//----------------------------------------
whismanoid	0:68e64068330f	791	// switch based on register address szie RegSize(regAddress)
whismanoid	11:abde565b8497	792	commandByte = (MAX11410_CMD_enum_t)((commandByte &~ CMDOP_1aaa_aaaa_ReadRegister) & 0xFF);
whismanoid	10:7adee48a7f82	793	switch(RegSize(commandByte))
whismanoid	0:68e64068330f	794	{
whismanoid	0:68e64068330f	795	case 8: // 8-bit register size
whismanoid	0:68e64068330f	796	{
whismanoid	0:68e64068330f	797	// SPI 16-bit transfer
whismanoid	0:68e64068330f	798	// SPI MOSI = 1aaa_aaaa_0000_0000
whismanoid	0:68e64068330f	799	// SPI MISO = xxxx_xxxx_dddd_dddd
whismanoid	11:abde565b8497	800	int16_t mosiData16 = ((CMDOP_1aaa_aaaa_ReadRegister \| (int16_t)commandByte) << 8) \| ((int16_t)0);
whismanoid	0:68e64068330f	801	SPIoutputCS(0);
whismanoid	0:68e64068330f	802	int16_t misoData16 = SPIreadWrite16bits(mosiData16);
whismanoid	0:68e64068330f	803	SPIoutputCS(1);
whismanoid	0:68e64068330f	804	(*ptrRegData) = (misoData16 & 0x00FF);
whismanoid	0:68e64068330f	805	}
whismanoid	0:68e64068330f	806	break;
whismanoid	0:68e64068330f	807	case 16: // 16-bit register size
whismanoid	0:68e64068330f	808	#warning "Not Verified Yet: MAX11410::RegRead 16-bit SPIreadWrite32bits"
whismanoid	0:68e64068330f	809	{
whismanoid	0:68e64068330f	810	// SPI 24-bit or 32-bit transfer
whismanoid	0:68e64068330f	811	// SPI MOSI = 1aaa_aaaa_0000_0000_0000_0000
whismanoid	0:68e64068330f	812	// SPI MISO = xxxx_xxxx_dddd_dddd_dddd_dddd
whismanoid	0:68e64068330f	813	// SPI MOSI = 1aaa_aaaa_0000_0000_0000_0000_0000_0000
whismanoid	0:68e64068330f	814	// SPI MISO = xxxx_xxxx_dddd_dddd_dddd_dddd_xxxx_xxxx
whismanoid	11:abde565b8497	815	int32_t mosiData32 = ((CMDOP_1aaa_aaaa_ReadRegister \| (int32_t)commandByte) << 24);
whismanoid	0:68e64068330f	816	SPIoutputCS(0);
whismanoid	0:68e64068330f	817	int32_t misoData32 = SPIreadWrite32bits(mosiData32);
whismanoid	0:68e64068330f	818	SPIoutputCS(1);
whismanoid	0:68e64068330f	819	(*ptrRegData) = ((misoData32 >> 8) & 0x00FFFF);
whismanoid	0:68e64068330f	820	}
whismanoid	0:68e64068330f	821	break;
whismanoid	0:68e64068330f	822	case 24: // 24-bit register size
whismanoid	0:68e64068330f	823	{
whismanoid	0:68e64068330f	824	// SPI 32-bit transfer
whismanoid	0:68e64068330f	825	// SPI MOSI = 1aaa_aaaa_0000_0000_0000_0000_0000_0000
whismanoid	0:68e64068330f	826	// SPI MISO = xxxx_xxxx_dddd_dddd_dddd_dddd_dddd_dddd
whismanoid	11:abde565b8497	827	int32_t mosiData32 = ((CMDOP_1aaa_aaaa_ReadRegister \| (int32_t)commandByte) << 24);
whismanoid	0:68e64068330f	828	SPIoutputCS(0);
whismanoid	0:68e64068330f	829	int32_t misoData32 = SPIreadWrite32bits(mosiData32);
whismanoid	0:68e64068330f	830	SPIoutputCS(1);
whismanoid	0:68e64068330f	831	(*ptrRegData) = (misoData32 & 0x00FFFFFF);
whismanoid	0:68e64068330f	832	}
whismanoid	0:68e64068330f	833	break;
whismanoid	0:68e64068330f	834	}
whismanoid	0:68e64068330f	835
whismanoid	0:68e64068330f	836	//----------------------------------------
whismanoid	0:68e64068330f	837	// success
whismanoid	0:68e64068330f	838	return 1;
whismanoid	0:68e64068330f	839	}
whismanoid	0:68e64068330f	840
whismanoid	0:68e64068330f	841	//----------------------------------------
whismanoid	0:68e64068330f	842	// Return the size of a MAX11410 register
whismanoid	0:68e64068330f	843	//
whismanoid	0:68e64068330f	844	// @return 8 for 8-bit, 16 for 16-bit, 24 for 24-bit, else 0 for undefined register size
whismanoid	10:7adee48a7f82	845	uint8_t MAX11410::RegSize(MAX11410_CMD_enum_t commandByte)
whismanoid	0:68e64068330f	846	{
whismanoid	0:68e64068330f	847
whismanoid	0:68e64068330f	848	//----------------------------------------
whismanoid	0:68e64068330f	849	// switch based on register address value regAddress
whismanoid	11:abde565b8497	850	commandByte = (MAX11410_CMD_enum_t)((commandByte &~ CMDOP_1aaa_aaaa_ReadRegister) & 0xFF);
whismanoid	10:7adee48a7f82	851	switch(commandByte)
whismanoid	0:68e64068330f	852	{
whismanoid	0:68e64068330f	853	default:
whismanoid	0:68e64068330f	854	return 0; // undefined register size
whismanoid	0:68e64068330f	855	case CMD_r000_0000_xxxx_xxdd_PD:
whismanoid	0:68e64068330f	856	case CMD_r000_0001_xddd_xxdd_CONV_START:
whismanoid	0:68e64068330f	857	case CMD_r000_0010_xddd_dddd_SEQ_START:
whismanoid	0:68e64068330f	858	case CMD_r000_0011_xxxx_xddd_CAL_START:
whismanoid	0:68e64068330f	859	case CMD_r000_0100_dddd_xddd_GP0_CTRL:
whismanoid	0:68e64068330f	860	case CMD_r000_0101_dddd_xddd_GP1_CTRL:
whismanoid	0:68e64068330f	861	case CMD_r000_0110_xddd_xxdd_GP_CONV:
whismanoid	0:68e64068330f	862	case CMD_r000_0111_xddd_dddd_GP_SEQ_ADDR:
whismanoid	0:68e64068330f	863	case CMD_r000_1000_x0dd_dddd_FILTER:
whismanoid	0:68e64068330f	864	case CMD_r000_1001_dddd_dddd_CTRL:
whismanoid	0:68e64068330f	865	case CMD_r000_1010_dddd_dddd_SOURCE:
whismanoid	0:68e64068330f	866	case CMD_r000_1011_dddd_dddd_MUX_CTRL0:
whismanoid	0:68e64068330f	867	case CMD_r000_1100_dddd_dddd_MUX_CTRL1:
whismanoid	0:68e64068330f	868	case CMD_r000_1101_dddd_dddd_MUX_CTRL2:
whismanoid	0:68e64068330f	869	case CMD_r000_1110_xxdd_xddd_PGA:
whismanoid	0:68e64068330f	870	case CMD_r000_1111_dddd_dddd_WAIT_EXT:
whismanoid	0:68e64068330f	871	case CMD_r001_0000_xxxx_xxxx_WAIT_START:
whismanoid	0:68e64068330f	872	return 8; // 8-bit register size
whismanoid	0:68e64068330f	873	case CMD_r001_0001_xxxx_xxxx_xxxx_xxxx_xxxx_xddd_PART_ID:
whismanoid	0:68e64068330f	874	case CMD_r001_0010_xxxx_xxxx_dddd_xxdd_dddd_dddd_SYSC_SEL:
whismanoid	0:68e64068330f	875	case CMD_r001_0011_dddd_dddd_dddd_dddd_dddd_dddd_SYS_OFF_A:
whismanoid	0:68e64068330f	876	case CMD_r001_0100_dddd_dddd_dddd_dddd_dddd_dddd_SYS_OFF_B:
whismanoid	0:68e64068330f	877	case CMD_r001_0101_dddd_dddd_dddd_dddd_dddd_dddd_SYS_GAIN_A:
whismanoid	0:68e64068330f	878	case CMD_r001_0110_dddd_dddd_dddd_dddd_dddd_dddd_SYS_GAIN_B:
whismanoid	0:68e64068330f	879	case CMD_r001_0111_dddd_dddd_dddd_dddd_dddd_dddd_SELF_OFF:
whismanoid	0:68e64068330f	880	case CMD_r001_1000_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_1:
whismanoid	0:68e64068330f	881	case CMD_r001_1001_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_2:
whismanoid	0:68e64068330f	882	case CMD_r001_1010_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_4:
whismanoid	0:68e64068330f	883	case CMD_r001_1011_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_8:
whismanoid	0:68e64068330f	884	case CMD_r001_1100_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_16:
whismanoid	0:68e64068330f	885	case CMD_r001_1101_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_32:
whismanoid	0:68e64068330f	886	case CMD_r001_1110_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_64:
whismanoid	0:68e64068330f	887	case CMD_r001_1111_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_128:
whismanoid	0:68e64068330f	888	case CMD_r010_0000_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH0:
whismanoid	0:68e64068330f	889	case CMD_r010_0001_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH1:
whismanoid	0:68e64068330f	890	case CMD_r010_0010_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH2:
whismanoid	0:68e64068330f	891	case CMD_r010_0011_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH3:
whismanoid	0:68e64068330f	892	case CMD_r010_0100_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH4:
whismanoid	0:68e64068330f	893	case CMD_r010_0101_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH5:
whismanoid	0:68e64068330f	894	case CMD_r010_0110_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH6:
whismanoid	0:68e64068330f	895	case CMD_r010_0111_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH7:
whismanoid	0:68e64068330f	896	case CMD_r010_1000_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH0:
whismanoid	0:68e64068330f	897	case CMD_r010_1001_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH1:
whismanoid	0:68e64068330f	898	case CMD_r010_1010_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH2:
whismanoid	0:68e64068330f	899	case CMD_r010_1011_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH3:
whismanoid	0:68e64068330f	900	case CMD_r010_1100_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH4:
whismanoid	0:68e64068330f	901	case CMD_r010_1101_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH5:
whismanoid	0:68e64068330f	902	case CMD_r010_1110_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH6:
whismanoid	0:68e64068330f	903	case CMD_r010_1111_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH7:
whismanoid	0:68e64068330f	904	case CMD_r011_0000_dddd_dddd_dddd_dddd_dddd_dddd_DATA0:
whismanoid	0:68e64068330f	905	case CMD_r011_0001_dddd_dddd_dddd_dddd_dddd_dddd_DATA1:
whismanoid	0:68e64068330f	906	case CMD_r011_0010_dddd_dddd_dddd_dddd_dddd_dddd_DATA2:
whismanoid	0:68e64068330f	907	case CMD_r011_0011_dddd_dddd_dddd_dddd_dddd_dddd_DATA3:
whismanoid	0:68e64068330f	908	case CMD_r011_0100_dddd_dddd_dddd_dddd_dddd_dddd_DATA4:
whismanoid	0:68e64068330f	909	case CMD_r011_0101_dddd_dddd_dddd_dddd_dddd_dddd_DATA5:
whismanoid	0:68e64068330f	910	case CMD_r011_0110_dddd_dddd_dddd_dddd_dddd_dddd_DATA6:
whismanoid	0:68e64068330f	911	case CMD_r011_0111_dddd_dddd_dddd_dddd_dddd_dddd_DATA7:
whismanoid	0:68e64068330f	912	case CMD_r011_1000_dddd_dddd_dddd_dddd_dxxx_dddd_STATUS:
whismanoid	0:68e64068330f	913	case CMD_r011_1001_dddd_dddd_dddd_dddd_dxxd_dddd_STATUS_IE:
whismanoid	0:68e64068330f	914	return 24; // 24-bit register size
whismanoid	0:68e64068330f	915	case CMD_r011_1010_xaaa_aaaa_dddd_dddd_UC_0:
whismanoid	0:68e64068330f	916	case CMD_r011_1011_xaaa_aaaa_dddd_dddd_UC_1:
whismanoid	0:68e64068330f	917	case CMD_r011_1100_xaaa_aaaa_dddd_dddd_UC_2:
whismanoid	0:68e64068330f	918	case CMD_r011_1101_xaaa_aaaa_dddd_dddd_UC_3:
whismanoid	0:68e64068330f	919	case CMD_r011_1110_xaaa_aaaa_dddd_dddd_UC_4:
whismanoid	0:68e64068330f	920	case CMD_r011_1111_xaaa_aaaa_dddd_dddd_UC_5:
whismanoid	0:68e64068330f	921	case CMD_r100_0000_xaaa_aaaa_dddd_dddd_UC_6:
whismanoid	0:68e64068330f	922	case CMD_r100_0001_xaaa_aaaa_dddd_dddd_UC_7:
whismanoid	0:68e64068330f	923	case CMD_r100_0010_xaaa_aaaa_dddd_dddd_UC_8:
whismanoid	0:68e64068330f	924	case CMD_r100_0011_xaaa_aaaa_dddd_dddd_UC_9:
whismanoid	0:68e64068330f	925	case CMD_r100_0100_xaaa_aaaa_dddd_dddd_UC_10:
whismanoid	0:68e64068330f	926	case CMD_r100_0101_xaaa_aaaa_dddd_dddd_UC_11:
whismanoid	0:68e64068330f	927	case CMD_r100_0110_xaaa_aaaa_dddd_dddd_UC_12:
whismanoid	0:68e64068330f	928	case CMD_r100_0111_xaaa_aaaa_dddd_dddd_UC_13:
whismanoid	0:68e64068330f	929	case CMD_r100_1000_xaaa_aaaa_dddd_dddd_UC_14:
whismanoid	0:68e64068330f	930	case CMD_r100_1001_xaaa_aaaa_dddd_dddd_UC_15:
whismanoid	0:68e64068330f	931	case CMD_r100_1010_xaaa_aaaa_dddd_dddd_UC_16:
whismanoid	0:68e64068330f	932	case CMD_r100_1011_xaaa_aaaa_dddd_dddd_UC_17:
whismanoid	0:68e64068330f	933	case CMD_r100_1100_xaaa_aaaa_dddd_dddd_UC_18:
whismanoid	0:68e64068330f	934	case CMD_r100_1101_xaaa_aaaa_dddd_dddd_UC_19:
whismanoid	0:68e64068330f	935	case CMD_r100_1110_xaaa_aaaa_dddd_dddd_UC_20:
whismanoid	0:68e64068330f	936	case CMD_r100_1111_xaaa_aaaa_dddd_dddd_UC_21:
whismanoid	0:68e64068330f	937	case CMD_r101_0000_xaaa_aaaa_dddd_dddd_UC_22:
whismanoid	0:68e64068330f	938	case CMD_r101_0001_xaaa_aaaa_dddd_dddd_UC_23:
whismanoid	0:68e64068330f	939	case CMD_r101_0010_xaaa_aaaa_dddd_dddd_UC_24:
whismanoid	0:68e64068330f	940	case CMD_r101_0011_xaaa_aaaa_dddd_dddd_UC_25:
whismanoid	0:68e64068330f	941	case CMD_r101_0100_xaaa_aaaa_dddd_dddd_UC_26:
whismanoid	0:68e64068330f	942	case CMD_r101_0101_xaaa_aaaa_dddd_dddd_UC_27:
whismanoid	0:68e64068330f	943	case CMD_r101_0110_xaaa_aaaa_dddd_dddd_UC_28:
whismanoid	0:68e64068330f	944	case CMD_r101_0111_xaaa_aaaa_dddd_dddd_UC_29:
whismanoid	0:68e64068330f	945	case CMD_r101_1000_xaaa_aaaa_dddd_dddd_UC_30:
whismanoid	0:68e64068330f	946	case CMD_r101_1001_xaaa_aaaa_dddd_dddd_UC_31:
whismanoid	0:68e64068330f	947	case CMD_r101_1010_xaaa_aaaa_dddd_dddd_UC_32:
whismanoid	0:68e64068330f	948	case CMD_r101_1011_xaaa_aaaa_dddd_dddd_UC_33:
whismanoid	0:68e64068330f	949	case CMD_r101_1100_xaaa_aaaa_dddd_dddd_UC_34:
whismanoid	0:68e64068330f	950	case CMD_r101_1101_xaaa_aaaa_dddd_dddd_UC_35:
whismanoid	0:68e64068330f	951	case CMD_r101_1110_xaaa_aaaa_dddd_dddd_UC_36:
whismanoid	0:68e64068330f	952	case CMD_r101_1111_xaaa_aaaa_dddd_dddd_UC_37:
whismanoid	0:68e64068330f	953	case CMD_r110_0000_xaaa_aaaa_dddd_dddd_UC_38:
whismanoid	0:68e64068330f	954	case CMD_r110_0001_xaaa_aaaa_dddd_dddd_UC_39:
whismanoid	0:68e64068330f	955	case CMD_r110_0010_xaaa_aaaa_dddd_dddd_UC_40:
whismanoid	0:68e64068330f	956	case CMD_r110_0011_xaaa_aaaa_dddd_dddd_UC_41:
whismanoid	0:68e64068330f	957	case CMD_r110_0100_xaaa_aaaa_dddd_dddd_UC_42:
whismanoid	0:68e64068330f	958	case CMD_r110_0101_xaaa_aaaa_dddd_dddd_UC_43:
whismanoid	0:68e64068330f	959	case CMD_r110_0110_xaaa_aaaa_dddd_dddd_UC_44:
whismanoid	0:68e64068330f	960	case CMD_r110_0111_xaaa_aaaa_dddd_dddd_UC_45:
whismanoid	0:68e64068330f	961	case CMD_r110_1000_xaaa_aaaa_dddd_dddd_UC_46:
whismanoid	0:68e64068330f	962	case CMD_r110_1001_xaaa_aaaa_dddd_dddd_UC_47:
whismanoid	0:68e64068330f	963	case CMD_r110_1010_xaaa_aaaa_dddd_dddd_UC_48:
whismanoid	0:68e64068330f	964	case CMD_r110_1011_xaaa_aaaa_dddd_dddd_UC_49:
whismanoid	0:68e64068330f	965	case CMD_r110_1100_xaaa_aaaa_dddd_dddd_UC_50:
whismanoid	0:68e64068330f	966	case CMD_r110_1101_xaaa_aaaa_dddd_dddd_UC_51:
whismanoid	0:68e64068330f	967	case CMD_r110_1110_xaaa_aaaa_dddd_dddd_UC_52:
whismanoid	0:68e64068330f	968	case CMD_r110_1111_xxxx_xxxx_xaaa_aaaa_UCADDR:
whismanoid	0:68e64068330f	969	return 16; // 16-bit register size
whismanoid	0:68e64068330f	970	}
whismanoid	0:68e64068330f	971	}
whismanoid	0:68e64068330f	972
whismanoid	0:68e64068330f	973	//----------------------------------------
whismanoid	11:abde565b8497	974	// Decode operation from commandByte
whismanoid	11:abde565b8497	975	//
whismanoid	11:abde565b8497	976	// @return operation such as idle, read register, write register, etc.
whismanoid	11:abde565b8497	977	MAX11410::MAX11410_CMDOP_enum_t MAX11410::DecodeCommand(MAX11410_CMD_enum_t commandByte)
whismanoid	11:abde565b8497	978	{
whismanoid	11:abde565b8497	979
whismanoid	11:abde565b8497	980	//----------------------------------------
whismanoid	11:abde565b8497	981	// decode operation from command byte
whismanoid	11:abde565b8497	982	switch (commandByte & 0x80)
whismanoid	11:abde565b8497	983	{
whismanoid	11:abde565b8497	984	default:
whismanoid	11:abde565b8497	985	case CMDOP_0aaa_aaaa_WriteRegister:
whismanoid	11:abde565b8497	986	return CMDOP_0aaa_aaaa_WriteRegister;
whismanoid	11:abde565b8497	987	case CMDOP_1aaa_aaaa_ReadRegister:
whismanoid	11:abde565b8497	988	return CMDOP_1aaa_aaaa_ReadRegister;
whismanoid	11:abde565b8497	989	}
whismanoid	11:abde565b8497	990	}
whismanoid	11:abde565b8497	991
whismanoid	11:abde565b8497	992	//----------------------------------------
whismanoid	10:7adee48a7f82	993	// Return the address field of a MAX11410 register
whismanoid	10:7adee48a7f82	994	//
whismanoid	10:7adee48a7f82	995	// @return register address field as given in datasheet
whismanoid	10:7adee48a7f82	996	uint8_t MAX11410::RegAddrOfCommand(MAX11410_CMD_enum_t commandByte)
whismanoid	10:7adee48a7f82	997	{
whismanoid	10:7adee48a7f82	998
whismanoid	10:7adee48a7f82	999	//----------------------------------------
whismanoid	10:7adee48a7f82	1000	// extract register address value from command byte
whismanoid	11:abde565b8497	1001	return (uint8_t)((commandByte &~ CMDOP_1aaa_aaaa_ReadRegister) & 0xFF);
whismanoid	10:7adee48a7f82	1002	}
whismanoid	10:7adee48a7f82	1003
whismanoid	10:7adee48a7f82	1004	//----------------------------------------
whismanoid	10:7adee48a7f82	1005	// Test whether a command byte is a register read command
whismanoid	10:7adee48a7f82	1006	//
whismanoid	10:7adee48a7f82	1007	// @return true if command byte is a register read command
whismanoid	10:7adee48a7f82	1008	uint8_t MAX11410::IsRegReadCommand(MAX11410_CMD_enum_t commandByte)
whismanoid	10:7adee48a7f82	1009	{
whismanoid	10:7adee48a7f82	1010
whismanoid	10:7adee48a7f82	1011	//----------------------------------------
whismanoid	10:7adee48a7f82	1012	// Test whether a command byte is a register read command
whismanoid	11:abde565b8497	1013	return (commandByte & CMDOP_1aaa_aaaa_ReadRegister) ? 1 : 0;
whismanoid	10:7adee48a7f82	1014	}
whismanoid	10:7adee48a7f82	1015
whismanoid	10:7adee48a7f82	1016	//----------------------------------------
whismanoid	0:68e64068330f	1017	// Return the name of a MAX11410 register
whismanoid	0:68e64068330f	1018	//
whismanoid	0:68e64068330f	1019	// @return null-terminated constant C string containing register name or empty string
whismanoid	10:7adee48a7f82	1020	const char* MAX11410::RegName(MAX11410_CMD_enum_t commandByte)
whismanoid	0:68e64068330f	1021	{
whismanoid	0:68e64068330f	1022
whismanoid	0:68e64068330f	1023	//----------------------------------------
whismanoid	0:68e64068330f	1024	// switch based on register address value regAddress
whismanoid	11:abde565b8497	1025	commandByte = (MAX11410_CMD_enum_t)((commandByte &~ CMDOP_1aaa_aaaa_ReadRegister) & 0xFF);
whismanoid	10:7adee48a7f82	1026	switch(commandByte)
whismanoid	0:68e64068330f	1027	{
whismanoid	0:68e64068330f	1028	default:
whismanoid	0:68e64068330f	1029	return ""; // undefined register
whismanoid	0:68e64068330f	1030	case CMD_r000_0000_xxxx_xxdd_PD: return "PD";
whismanoid	0:68e64068330f	1031	case CMD_r000_0001_xddd_xxdd_CONV_START: return "CONV_START";
whismanoid	0:68e64068330f	1032	case CMD_r000_0010_xddd_dddd_SEQ_START: return "SEQ_START";
whismanoid	0:68e64068330f	1033	case CMD_r000_0011_xxxx_xddd_CAL_START: return "CAL_START";
whismanoid	0:68e64068330f	1034	case CMD_r000_0100_dddd_xddd_GP0_CTRL: return "GP0_CTRL";
whismanoid	0:68e64068330f	1035	case CMD_r000_0101_dddd_xddd_GP1_CTRL: return "GP1_CTRL";
whismanoid	0:68e64068330f	1036	case CMD_r000_0110_xddd_xxdd_GP_CONV: return "GP_CONV";
whismanoid	0:68e64068330f	1037	case CMD_r000_0111_xddd_dddd_GP_SEQ_ADDR: return "GP_SEQ_ADDR";
whismanoid	0:68e64068330f	1038	case CMD_r000_1000_x0dd_dddd_FILTER: return "FILTER";
whismanoid	0:68e64068330f	1039	case CMD_r000_1001_dddd_dddd_CTRL: return "CTRL";
whismanoid	0:68e64068330f	1040	case CMD_r000_1010_dddd_dddd_SOURCE: return "SOURCE";
whismanoid	0:68e64068330f	1041	case CMD_r000_1011_dddd_dddd_MUX_CTRL0: return "MUX_CTRL0";
whismanoid	0:68e64068330f	1042	case CMD_r000_1100_dddd_dddd_MUX_CTRL1: return "MUX_CTRL1";
whismanoid	0:68e64068330f	1043	case CMD_r000_1101_dddd_dddd_MUX_CTRL2: return "MUX_CTRL2";
whismanoid	0:68e64068330f	1044	case CMD_r000_1110_xxdd_xddd_PGA: return "PGA";
whismanoid	0:68e64068330f	1045	case CMD_r000_1111_dddd_dddd_WAIT_EXT: return "WAIT_EXT";
whismanoid	0:68e64068330f	1046	case CMD_r001_0000_xxxx_xxxx_WAIT_START: return "WAIT_START";
whismanoid	0:68e64068330f	1047	case CMD_r001_0001_xxxx_xxxx_xxxx_xxxx_xxxx_xddd_PART_ID: return "PART_ID";
whismanoid	0:68e64068330f	1048	case CMD_r001_0010_xxxx_xxxx_dddd_xxdd_dddd_dddd_SYSC_SEL: return "SYSC_SEL";
whismanoid	0:68e64068330f	1049	case CMD_r001_0011_dddd_dddd_dddd_dddd_dddd_dddd_SYS_OFF_A: return "SYS_OFF_A";
whismanoid	0:68e64068330f	1050	case CMD_r001_0100_dddd_dddd_dddd_dddd_dddd_dddd_SYS_OFF_B: return "SYS_OFF_B";
whismanoid	0:68e64068330f	1051	case CMD_r001_0101_dddd_dddd_dddd_dddd_dddd_dddd_SYS_GAIN_A: return "SYS_GAIN_A";
whismanoid	0:68e64068330f	1052	case CMD_r001_0110_dddd_dddd_dddd_dddd_dddd_dddd_SYS_GAIN_B: return "SYS_GAIN_B";
whismanoid	0:68e64068330f	1053	case CMD_r001_0111_dddd_dddd_dddd_dddd_dddd_dddd_SELF_OFF: return "SELF_OFF";
whismanoid	0:68e64068330f	1054	case CMD_r001_1000_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_1: return "SELF_GAIN_1";
whismanoid	0:68e64068330f	1055	case CMD_r001_1001_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_2: return "SELF_GAIN_2";
whismanoid	0:68e64068330f	1056	case CMD_r001_1010_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_4: return "SELF_GAIN_4";
whismanoid	0:68e64068330f	1057	case CMD_r001_1011_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_8: return "SELF_GAIN_8";
whismanoid	0:68e64068330f	1058	case CMD_r001_1100_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_16: return "SELF_GAIN_16";
whismanoid	0:68e64068330f	1059	case CMD_r001_1101_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_32: return "SELF_GAIN_32";
whismanoid	0:68e64068330f	1060	case CMD_r001_1110_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_64: return "SELF_GAIN_64";
whismanoid	0:68e64068330f	1061	case CMD_r001_1111_dddd_dddd_dddd_dddd_dddd_dddd_SELF_GAIN_128: return "SELF_GAIN_128";
whismanoid	0:68e64068330f	1062	case CMD_r010_0000_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH0: return "LTHRESH0";
whismanoid	0:68e64068330f	1063	case CMD_r010_0001_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH1: return "LTHRESH1";
whismanoid	0:68e64068330f	1064	case CMD_r010_0010_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH2: return "LTHRESH2";
whismanoid	0:68e64068330f	1065	case CMD_r010_0011_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH3: return "LTHRESH3";
whismanoid	0:68e64068330f	1066	case CMD_r010_0100_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH4: return "LTHRESH4";
whismanoid	0:68e64068330f	1067	case CMD_r010_0101_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH5: return "LTHRESH5";
whismanoid	0:68e64068330f	1068	case CMD_r010_0110_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH6: return "LTHRESH6";
whismanoid	0:68e64068330f	1069	case CMD_r010_0111_dddd_dddd_dddd_dddd_dddd_dddd_LTHRESH7: return "LTHRESH7";
whismanoid	0:68e64068330f	1070	case CMD_r010_1000_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH0: return "UTHRESH0";
whismanoid	0:68e64068330f	1071	case CMD_r010_1001_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH1: return "UTHRESH1";
whismanoid	0:68e64068330f	1072	case CMD_r010_1010_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH2: return "UTHRESH2";
whismanoid	0:68e64068330f	1073	case CMD_r010_1011_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH3: return "UTHRESH3";
whismanoid	0:68e64068330f	1074	case CMD_r010_1100_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH4: return "UTHRESH4";
whismanoid	0:68e64068330f	1075	case CMD_r010_1101_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH5: return "UTHRESH5";
whismanoid	0:68e64068330f	1076	case CMD_r010_1110_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH6: return "UTHRESH6";
whismanoid	0:68e64068330f	1077	case CMD_r010_1111_dddd_dddd_dddd_dddd_dddd_dddd_UTHRESH7: return "UTHRESH7";
whismanoid	0:68e64068330f	1078	case CMD_r011_0000_dddd_dddd_dddd_dddd_dddd_dddd_DATA0: return "DATA0";
whismanoid	0:68e64068330f	1079	case CMD_r011_0001_dddd_dddd_dddd_dddd_dddd_dddd_DATA1: return "DATA1";
whismanoid	0:68e64068330f	1080	case CMD_r011_0010_dddd_dddd_dddd_dddd_dddd_dddd_DATA2: return "DATA2";
whismanoid	0:68e64068330f	1081	case CMD_r011_0011_dddd_dddd_dddd_dddd_dddd_dddd_DATA3: return "DATA3";
whismanoid	0:68e64068330f	1082	case CMD_r011_0100_dddd_dddd_dddd_dddd_dddd_dddd_DATA4: return "DATA4";
whismanoid	0:68e64068330f	1083	case CMD_r011_0101_dddd_dddd_dddd_dddd_dddd_dddd_DATA5: return "DATA5";
whismanoid	0:68e64068330f	1084	case CMD_r011_0110_dddd_dddd_dddd_dddd_dddd_dddd_DATA6: return "DATA6";
whismanoid	0:68e64068330f	1085	case CMD_r011_0111_dddd_dddd_dddd_dddd_dddd_dddd_DATA7: return "DATA7";
whismanoid	0:68e64068330f	1086	case CMD_r011_1000_dddd_dddd_dddd_dddd_dxxx_dddd_STATUS: return "STATUS";
whismanoid	0:68e64068330f	1087	case CMD_r011_1001_dddd_dddd_dddd_dddd_dxxd_dddd_STATUS_IE: return "STATUS_IE";
whismanoid	0:68e64068330f	1088	case CMD_r011_1010_xaaa_aaaa_dddd_dddd_UC_0: return "UC_0";
whismanoid	0:68e64068330f	1089	case CMD_r011_1011_xaaa_aaaa_dddd_dddd_UC_1: return "UC_1";
whismanoid	0:68e64068330f	1090	case CMD_r011_1100_xaaa_aaaa_dddd_dddd_UC_2: return "UC_2";
whismanoid	0:68e64068330f	1091	case CMD_r011_1101_xaaa_aaaa_dddd_dddd_UC_3: return "UC_3";
whismanoid	0:68e64068330f	1092	case CMD_r011_1110_xaaa_aaaa_dddd_dddd_UC_4: return "UC_4";
whismanoid	0:68e64068330f	1093	case CMD_r011_1111_xaaa_aaaa_dddd_dddd_UC_5: return "UC_5";
whismanoid	0:68e64068330f	1094	case CMD_r100_0000_xaaa_aaaa_dddd_dddd_UC_6: return "UC_6";
whismanoid	0:68e64068330f	1095	case CMD_r100_0001_xaaa_aaaa_dddd_dddd_UC_7: return "UC_7";
whismanoid	0:68e64068330f	1096	case CMD_r100_0010_xaaa_aaaa_dddd_dddd_UC_8: return "UC_8";
whismanoid	0:68e64068330f	1097	case CMD_r100_0011_xaaa_aaaa_dddd_dddd_UC_9: return "UC_9";
whismanoid	0:68e64068330f	1098	case CMD_r100_0100_xaaa_aaaa_dddd_dddd_UC_10: return "UC_10";
whismanoid	0:68e64068330f	1099	case CMD_r100_0101_xaaa_aaaa_dddd_dddd_UC_11: return "UC_11";
whismanoid	0:68e64068330f	1100	case CMD_r100_0110_xaaa_aaaa_dddd_dddd_UC_12: return "UC_12";
whismanoid	0:68e64068330f	1101	case CMD_r100_0111_xaaa_aaaa_dddd_dddd_UC_13: return "UC_13";
whismanoid	0:68e64068330f	1102	case CMD_r100_1000_xaaa_aaaa_dddd_dddd_UC_14: return "UC_14";
whismanoid	0:68e64068330f	1103	case CMD_r100_1001_xaaa_aaaa_dddd_dddd_UC_15: return "UC_15";
whismanoid	0:68e64068330f	1104	case CMD_r100_1010_xaaa_aaaa_dddd_dddd_UC_16: return "UC_16";
whismanoid	0:68e64068330f	1105	case CMD_r100_1011_xaaa_aaaa_dddd_dddd_UC_17: return "UC_17";
whismanoid	0:68e64068330f	1106	case CMD_r100_1100_xaaa_aaaa_dddd_dddd_UC_18: return "UC_18";
whismanoid	0:68e64068330f	1107	case CMD_r100_1101_xaaa_aaaa_dddd_dddd_UC_19: return "UC_19";
whismanoid	0:68e64068330f	1108	case CMD_r100_1110_xaaa_aaaa_dddd_dddd_UC_20: return "UC_20";
whismanoid	0:68e64068330f	1109	case CMD_r100_1111_xaaa_aaaa_dddd_dddd_UC_21: return "UC_21";
whismanoid	0:68e64068330f	1110	case CMD_r101_0000_xaaa_aaaa_dddd_dddd_UC_22: return "UC_22";
whismanoid	0:68e64068330f	1111	case CMD_r101_0001_xaaa_aaaa_dddd_dddd_UC_23: return "UC_23";
whismanoid	0:68e64068330f	1112	case CMD_r101_0010_xaaa_aaaa_dddd_dddd_UC_24: return "UC_24";
whismanoid	0:68e64068330f	1113	case CMD_r101_0011_xaaa_aaaa_dddd_dddd_UC_25: return "UC_25";
whismanoid	0:68e64068330f	1114	case CMD_r101_0100_xaaa_aaaa_dddd_dddd_UC_26: return "UC_26";
whismanoid	0:68e64068330f	1115	case CMD_r101_0101_xaaa_aaaa_dddd_dddd_UC_27: return "UC_27";
whismanoid	0:68e64068330f	1116	case CMD_r101_0110_xaaa_aaaa_dddd_dddd_UC_28: return "UC_28";
whismanoid	0:68e64068330f	1117	case CMD_r101_0111_xaaa_aaaa_dddd_dddd_UC_29: return "UC_29";
whismanoid	0:68e64068330f	1118	case CMD_r101_1000_xaaa_aaaa_dddd_dddd_UC_30: return "UC_30";
whismanoid	0:68e64068330f	1119	case CMD_r101_1001_xaaa_aaaa_dddd_dddd_UC_31: return "UC_31";
whismanoid	0:68e64068330f	1120	case CMD_r101_1010_xaaa_aaaa_dddd_dddd_UC_32: return "UC_32";
whismanoid	0:68e64068330f	1121	case CMD_r101_1011_xaaa_aaaa_dddd_dddd_UC_33: return "UC_33";
whismanoid	0:68e64068330f	1122	case CMD_r101_1100_xaaa_aaaa_dddd_dddd_UC_34: return "UC_34";
whismanoid	0:68e64068330f	1123	case CMD_r101_1101_xaaa_aaaa_dddd_dddd_UC_35: return "UC_35";
whismanoid	0:68e64068330f	1124	case CMD_r101_1110_xaaa_aaaa_dddd_dddd_UC_36: return "UC_36";
whismanoid	0:68e64068330f	1125	case CMD_r101_1111_xaaa_aaaa_dddd_dddd_UC_37: return "UC_37";
whismanoid	0:68e64068330f	1126	case CMD_r110_0000_xaaa_aaaa_dddd_dddd_UC_38: return "UC_38";
whismanoid	0:68e64068330f	1127	case CMD_r110_0001_xaaa_aaaa_dddd_dddd_UC_39: return "UC_39";
whismanoid	0:68e64068330f	1128	case CMD_r110_0010_xaaa_aaaa_dddd_dddd_UC_40: return "UC_40";
whismanoid	0:68e64068330f	1129	case CMD_r110_0011_xaaa_aaaa_dddd_dddd_UC_41: return "UC_41";
whismanoid	0:68e64068330f	1130	case CMD_r110_0100_xaaa_aaaa_dddd_dddd_UC_42: return "UC_42";
whismanoid	0:68e64068330f	1131	case CMD_r110_0101_xaaa_aaaa_dddd_dddd_UC_43: return "UC_43";
whismanoid	0:68e64068330f	1132	case CMD_r110_0110_xaaa_aaaa_dddd_dddd_UC_44: return "UC_44";
whismanoid	0:68e64068330f	1133	case CMD_r110_0111_xaaa_aaaa_dddd_dddd_UC_45: return "UC_45";
whismanoid	0:68e64068330f	1134	case CMD_r110_1000_xaaa_aaaa_dddd_dddd_UC_46: return "UC_46";
whismanoid	0:68e64068330f	1135	case CMD_r110_1001_xaaa_aaaa_dddd_dddd_UC_47: return "UC_47";
whismanoid	0:68e64068330f	1136	case CMD_r110_1010_xaaa_aaaa_dddd_dddd_UC_48: return "UC_48";
whismanoid	0:68e64068330f	1137	case CMD_r110_1011_xaaa_aaaa_dddd_dddd_UC_49: return "UC_49";
whismanoid	0:68e64068330f	1138	case CMD_r110_1100_xaaa_aaaa_dddd_dddd_UC_50: return "UC_50";
whismanoid	0:68e64068330f	1139	case CMD_r110_1101_xaaa_aaaa_dddd_dddd_UC_51: return "UC_51";
whismanoid	0:68e64068330f	1140	case CMD_r110_1110_xaaa_aaaa_dddd_dddd_UC_52: return "UC_52";
whismanoid	0:68e64068330f	1141	case CMD_r110_1111_xxxx_xxxx_xaaa_aaaa_UCADDR: return "UCADDR";
whismanoid	0:68e64068330f	1142	}
whismanoid	0:68e64068330f	1143	}
whismanoid	0:68e64068330f	1144
whismanoid	0:68e64068330f	1145	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1146	// Menu item 'XF'
whismanoid	1:d57c1a2cb83c	1147	//
whismanoid	1:d57c1a2cb83c	1148	// FILTER Select Filter and Rate.
whismanoid	1:d57c1a2cb83c	1149	// Sets conversion rate based on RATE, LINEF, and CONV_TYPE value. See Table 9a through Table 9d for details.
whismanoid	1:d57c1a2cb83c	1150	// For CONV_TYPE_01_Continuous, linef=LINEF_11_SINC4, rate=RATE_0100 selects output data rate 60SPS.
whismanoid	1:d57c1a2cb83c	1151	//
whismanoid	1:d57c1a2cb83c	1152	// @param[in] linef = filter type, default=MAX11410::LINEF_enum_t::LINEF_11_SINC4
whismanoid	1:d57c1a2cb83c	1153	// @param[in] rate = output data rate selection, default=MAX11410::RATE_enum_t::RATE_0100
whismanoid	1:d57c1a2cb83c	1154	//
whismanoid	1:d57c1a2cb83c	1155	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1156	uint8_t MAX11410::Configure_FILTER(uint8_t linef, uint8_t rate)
whismanoid	1:d57c1a2cb83c	1157	{
whismanoid	1:d57c1a2cb83c	1158
whismanoid	1:d57c1a2cb83c	1159	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1160	// write8 0x08 FILTER
whismanoid	1:d57c1a2cb83c	1161	RegWrite(CMD_r000_1000_x0dd_dddd_FILTER, (uint8_t)(0
whismanoid	1:d57c1a2cb83c	1162	\| (((uint8_t)linef & 3) << 4)
whismanoid	1:d57c1a2cb83c	1163	\| (((uint8_t)rate & 15) << 0)
whismanoid	1:d57c1a2cb83c	1164	));
whismanoid	1:d57c1a2cb83c	1165
whismanoid	1:d57c1a2cb83c	1166	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1167	// success
whismanoid	1:d57c1a2cb83c	1168	return 1;
whismanoid	1:d57c1a2cb83c	1169	}
whismanoid	1:d57c1a2cb83c	1170
whismanoid	1:d57c1a2cb83c	1171	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1172	// Menu item 'XP'
whismanoid	1:d57c1a2cb83c	1173	//
whismanoid	1:d57c1a2cb83c	1174	// PGA Select Gain and Signal Path.
whismanoid	1:d57c1a2cb83c	1175	//
whismanoid	1:d57c1a2cb83c	1176	// @param[in] sigpath = signal path, default=MAX11410::SIG_PATH_enum_t::SIG_PATH_00_BUFFERED
whismanoid	1:d57c1a2cb83c	1177	// @param[in] gain = gain selection, default=MAX11410::GAIN_enum_t::GAIN_000_1
whismanoid	1:d57c1a2cb83c	1178	//
whismanoid	1:d57c1a2cb83c	1179	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1180	uint8_t MAX11410::Configure_PGA(uint8_t sigpath, uint8_t gain)
whismanoid	1:d57c1a2cb83c	1181	{
whismanoid	1:d57c1a2cb83c	1182
whismanoid	1:d57c1a2cb83c	1183	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1184	// pga gain 1, 2, 4, 8, 16, 32, 64, or 128 based on gain index in register pga CMD_r000_1110_xxdd_xddd_PGA
whismanoid	1:d57c1a2cb83c	1185	static uint8_t pgaGainTable[8] = {1, 2, 4, 8, 16, 32, 64, 128};
whismanoid	1:d57c1a2cb83c	1186	pgaGain = (sigpath == SIG_PATH_10_PGA) ? pgaGainTable[(uint8_t)gain] : 1;
whismanoid	1:d57c1a2cb83c	1187
whismanoid	1:d57c1a2cb83c	1188	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1189	// write8 0x0E PGA
whismanoid	1:d57c1a2cb83c	1190	RegWrite(CMD_r000_1110_xxdd_xddd_PGA, (uint8_t)(0
whismanoid	1:d57c1a2cb83c	1191	\| (((uint8_t)sigpath & 2) << 4)
whismanoid	1:d57c1a2cb83c	1192	\| (((uint8_t)gain & 7) << 0)
whismanoid	1:d57c1a2cb83c	1193	));
whismanoid	1:d57c1a2cb83c	1194
whismanoid	1:d57c1a2cb83c	1195	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1196	// success
whismanoid	1:d57c1a2cb83c	1197	return 1;
whismanoid	1:d57c1a2cb83c	1198	}
whismanoid	1:d57c1a2cb83c	1199
whismanoid	1:d57c1a2cb83c	1200	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1201	// Menu item 'XC'
whismanoid	1:d57c1a2cb83c	1202	//
whismanoid	1:d57c1a2cb83c	1203	// CTRL Select clock, format, and reference.
whismanoid	1:d57c1a2cb83c	1204	//
whismanoid	1:d57c1a2cb83c	1205	// @param[in] extclk = external clock enable, default=0
whismanoid	1:d57c1a2cb83c	1206	// @param[in] u_bn = unipolar input range enable, default=0
whismanoid	1:d57c1a2cb83c	1207	// @param[in] format = offset binary format enable, default=0
whismanoid	1:d57c1a2cb83c	1208	// @param[in] refbufp_en = REFP reference buffer enable, default=0
whismanoid	1:d57c1a2cb83c	1209	// @param[in] refbufn_en = REFN reference buffer enable, default=0
whismanoid	1:d57c1a2cb83c	1210	// @param[in] ref_sel = reference selection, default=MAX11410::REF_SEL_enum_t::REF_SEL_001_REF1P_REF1N
whismanoid	1:d57c1a2cb83c	1211	//
whismanoid	1:d57c1a2cb83c	1212	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1213	uint8_t MAX11410::Configure_CTRL(uint8_t extclk, uint8_t u_bn, uint8_t format, uint8_t refbufp_en, uint8_t refbufn_en, uint8_t ref_sel)
whismanoid	1:d57c1a2cb83c	1214	{
whismanoid	1:d57c1a2cb83c	1215
whismanoid	1:d57c1a2cb83c	1216	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1217	// shadow of register CMD_r000_1001_dddd_dddd_CTRL
whismanoid	1:d57c1a2cb83c	1218	ctrl = (uint8_t)(0
whismanoid	1:d57c1a2cb83c	1219	\| (((uint8_t)extclk & 1) << 7)
whismanoid	1:d57c1a2cb83c	1220	\| (((uint8_t)u_bn & 1) << 6)
whismanoid	1:d57c1a2cb83c	1221	\| (((uint8_t)format & 1) << 5)
whismanoid	1:d57c1a2cb83c	1222	\| (((uint8_t)refbufp_en & 1) << 4)
whismanoid	1:d57c1a2cb83c	1223	\| (((uint8_t)refbufn_en & 1) << 3)
whismanoid	1:d57c1a2cb83c	1224	\| (((uint8_t)ref_sel & 7) << 0)
whismanoid	1:d57c1a2cb83c	1225	);
whismanoid	1:d57c1a2cb83c	1226
whismanoid	1:d57c1a2cb83c	1227	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1228	// write8 0x09 CTRL
whismanoid	1:d57c1a2cb83c	1229	RegWrite(CMD_r000_1001_dddd_dddd_CTRL, ctrl);
whismanoid	1:d57c1a2cb83c	1230
whismanoid	1:d57c1a2cb83c	1231	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1232	// success
whismanoid	1:d57c1a2cb83c	1233	return 1;
whismanoid	1:d57c1a2cb83c	1234	}
whismanoid	1:d57c1a2cb83c	1235
whismanoid	1:d57c1a2cb83c	1236	//----------------------------------------
whismanoid	14:b49eecf7e4d8	1237	// Menu item 'XR'
whismanoid	14:b49eecf7e4d8	1238	//
whismanoid	14:b49eecf7e4d8	1239	// CTRL select reference, without changing the other fields.
whismanoid	14:b49eecf7e4d8	1240	//
whismanoid	14:b49eecf7e4d8	1241	// @pre ctrl = shadow of CTRL register
whismanoid	14:b49eecf7e4d8	1242	// @param[in] ref_sel = reference selection, default=MAX11410::REF_SEL_enum_t::REF_SEL_001_REF1P_REF1N
whismanoid	14:b49eecf7e4d8	1243	//
whismanoid	14:b49eecf7e4d8	1244	// @return 1 on success; 0 on failure
whismanoid	14:b49eecf7e4d8	1245	uint8_t MAX11410::Configure_CTRL_REF(uint8_t ref_sel)
whismanoid	14:b49eecf7e4d8	1246	{
whismanoid	14:b49eecf7e4d8	1247
whismanoid	14:b49eecf7e4d8	1248	//----------------------------------------
whismanoid	14:b49eecf7e4d8	1249	// shadow of register CMD_r000_1001_dddd_dddd_CTRL
whismanoid	14:b49eecf7e4d8	1250	ctrl = (ctrl & ((~ 7) << 0))
whismanoid	14:b49eecf7e4d8	1251	\| (((uint8_t)ref_sel & 7) << 0);
whismanoid	14:b49eecf7e4d8	1252
whismanoid	14:b49eecf7e4d8	1253	//----------------------------------------
whismanoid	14:b49eecf7e4d8	1254	// write8 0x09 CTRL
whismanoid	14:b49eecf7e4d8	1255	RegWrite(CMD_r000_1001_dddd_dddd_CTRL, ctrl);
whismanoid	14:b49eecf7e4d8	1256
whismanoid	14:b49eecf7e4d8	1257	//----------------------------------------
whismanoid	14:b49eecf7e4d8	1258	// success
whismanoid	14:b49eecf7e4d8	1259	return 1;
whismanoid	14:b49eecf7e4d8	1260	}
whismanoid	14:b49eecf7e4d8	1261
whismanoid	14:b49eecf7e4d8	1262	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1263	// Menu item 'XS'
whismanoid	1:d57c1a2cb83c	1264	//
whismanoid	1:d57c1a2cb83c	1265	// SOURCE Configure voltage bias source, current source, burnout mode
whismanoid	1:d57c1a2cb83c	1266	//
whismanoid	1:d57c1a2cb83c	1267	// @param[in] vbias_mode = _______, default=MAX11410::VBIAS_MODE_enum_t::VBIAS_MODE_00_Active
whismanoid	1:d57c1a2cb83c	1268	// @param[in] brn_mode = _______, default=MAX11410::BRN_MODE_enum_t::BRN_MODE_00_disabled
whismanoid	1:d57c1a2cb83c	1269	// @param[in] idac_mode = _______, default=MAX11410::IDAC_MODE_enum_t::IDAC_MODE_0000_10uA
whismanoid	1:d57c1a2cb83c	1270	//
whismanoid	1:d57c1a2cb83c	1271	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1272	uint8_t MAX11410::Configure_SOURCE(uint8_t vbias_mode, uint8_t brn_mode, uint8_t idac_mode)
whismanoid	1:d57c1a2cb83c	1273	{
whismanoid	1:d57c1a2cb83c	1274
whismanoid	1:d57c1a2cb83c	1275	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1276	// warning -- WIP work in progress
whismanoid	1:d57c1a2cb83c	1277	#warning "Not Tested Yet: MAX11410::Configure_SOURCE..."
whismanoid	1:d57c1a2cb83c	1278
whismanoid	1:d57c1a2cb83c	1279	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1280	// write8 0x0A SOURCE
whismanoid	1:d57c1a2cb83c	1281	RegWrite(CMD_r000_1010_dddd_dddd_SOURCE, (uint8_t)(0
whismanoid	1:d57c1a2cb83c	1282	\| (((uint8_t)vbias_mode & 3) << 6)
whismanoid	1:d57c1a2cb83c	1283	\| (((uint8_t)brn_mode & 3) << 4)
whismanoid	1:d57c1a2cb83c	1284	\| (((uint8_t)idac_mode & 15) << 0)
whismanoid	1:d57c1a2cb83c	1285	));
whismanoid	1:d57c1a2cb83c	1286
whismanoid	1:d57c1a2cb83c	1287	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1288	// success
whismanoid	1:d57c1a2cb83c	1289	return 1;
whismanoid	1:d57c1a2cb83c	1290	}
whismanoid	1:d57c1a2cb83c	1291
whismanoid	1:d57c1a2cb83c	1292	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1293	// Menu item 'XM'
whismanoid	1:d57c1a2cb83c	1294	//
whismanoid	1:d57c1a2cb83c	1295	// MUX_CTRL0 Select pins for analog input AINP and AINN
whismanoid	1:d57c1a2cb83c	1296	//
whismanoid	1:d57c1a2cb83c	1297	// @param[in] ainp = channel high side, default=MAX11410::AINP_SEL_enum_t::AINP_SEL_0000_AIN0
whismanoid	1:d57c1a2cb83c	1298	// @param[in] ainn = channel low side, default=MAX11410::AINN_SEL_enum_t::AINN_SEL_1010_GND
whismanoid	1:d57c1a2cb83c	1299	//
whismanoid	1:d57c1a2cb83c	1300	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1301	uint8_t MAX11410::Configure_MUX_CTRL0(uint8_t ainp, uint8_t ainn)
whismanoid	1:d57c1a2cb83c	1302	{
whismanoid	1:d57c1a2cb83c	1303
whismanoid	1:d57c1a2cb83c	1304	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1305	// warning -- WIP work in progress
whismanoid	1:d57c1a2cb83c	1306	#warning "Not Tested Yet: MAX11410::Configure_MUX_CTRL0..."
whismanoid	1:d57c1a2cb83c	1307
whismanoid	1:d57c1a2cb83c	1308	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1309	// write8 0x0B MUX_CTRL0
whismanoid	1:d57c1a2cb83c	1310	RegWrite(CMD_r000_1011_dddd_dddd_MUX_CTRL0, (uint8_t)(0
whismanoid	1:d57c1a2cb83c	1311	\| (((uint8_t)ainp & 15) << 4)
whismanoid	1:d57c1a2cb83c	1312	\| (((uint8_t)ainn & 15) << 0)
whismanoid	1:d57c1a2cb83c	1313	));
whismanoid	1:d57c1a2cb83c	1314
whismanoid	1:d57c1a2cb83c	1315	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1316	// success
whismanoid	1:d57c1a2cb83c	1317	return 1;
whismanoid	1:d57c1a2cb83c	1318	}
whismanoid	1:d57c1a2cb83c	1319
whismanoid	1:d57c1a2cb83c	1320	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1321	// Menu item 'XI'
whismanoid	1:d57c1a2cb83c	1322	//
whismanoid	1:d57c1a2cb83c	1323	// MUX_CTRL1 Select pins for current source
whismanoid	1:d57c1a2cb83c	1324	//
whismanoid	1:d57c1a2cb83c	1325	// @param[in] idac1_sel = channel high side, default=MAX11410::IDAC1_SEL_enum_t::IDAC1_SEL_1111_unconnected
whismanoid	1:d57c1a2cb83c	1326	// @param[in] idac0_sel = channel low side, default=MAX11410::IDAC0_SEL_enum_t::IDAC0_SEL_1111_unconnected
whismanoid	1:d57c1a2cb83c	1327	//
whismanoid	1:d57c1a2cb83c	1328	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1329	uint8_t MAX11410::Configure_MUX_CTRL1(uint8_t idac1_sel, uint8_t idac0_sel)
whismanoid	1:d57c1a2cb83c	1330	{
whismanoid	1:d57c1a2cb83c	1331
whismanoid	1:d57c1a2cb83c	1332	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1333	// warning -- WIP work in progress
whismanoid	1:d57c1a2cb83c	1334	#warning "Not Tested Yet: MAX11410::Configure_MUX_CTRL1..."
whismanoid	1:d57c1a2cb83c	1335
whismanoid	1:d57c1a2cb83c	1336	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1337	// write8 0x0C MUX_CTRL1
whismanoid	1:d57c1a2cb83c	1338	RegWrite(CMD_r000_1100_dddd_dddd_MUX_CTRL1, (uint8_t)(0
whismanoid	1:d57c1a2cb83c	1339	\| (((uint8_t)idac1_sel & 15) << 4)
whismanoid	1:d57c1a2cb83c	1340	\| (((uint8_t)idac0_sel & 15) << 0)
whismanoid	1:d57c1a2cb83c	1341	));
whismanoid	1:d57c1a2cb83c	1342
whismanoid	1:d57c1a2cb83c	1343	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1344	// success
whismanoid	1:d57c1a2cb83c	1345	return 1;
whismanoid	1:d57c1a2cb83c	1346	}
whismanoid	1:d57c1a2cb83c	1347
whismanoid	1:d57c1a2cb83c	1348	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1349	// Menu item 'XV'
whismanoid	1:d57c1a2cb83c	1350	//
whismanoid	1:d57c1a2cb83c	1351	// MUX_CTRL2 Select pins for voltage bias source
whismanoid	1:d57c1a2cb83c	1352	//
whismanoid	1:d57c1a2cb83c	1353	// @param[in] vbias_ain7_ain0_bitmap = bit map of AIN7..AIN0 enables for voltage bias, default=0
whismanoid	1:d57c1a2cb83c	1354	//
whismanoid	1:d57c1a2cb83c	1355	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1356	uint8_t MAX11410::Configure_MUX_CTRL2(uint8_t vbias_ain7_ain0_bitmap)
whismanoid	1:d57c1a2cb83c	1357	{
whismanoid	1:d57c1a2cb83c	1358
whismanoid	1:d57c1a2cb83c	1359	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1360	// warning -- WIP work in progress
whismanoid	1:d57c1a2cb83c	1361	#warning "Not Tested Yet: MAX11410::Configure_MUX_CTRL2..."
whismanoid	1:d57c1a2cb83c	1362
whismanoid	1:d57c1a2cb83c	1363	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1364	// write8 0x0D MUX_CTRL2
whismanoid	1:d57c1a2cb83c	1365	RegWrite(CMD_r000_1101_dddd_dddd_MUX_CTRL2, vbias_ain7_ain0_bitmap);
whismanoid	1:d57c1a2cb83c	1366
whismanoid	1:d57c1a2cb83c	1367	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1368	// success
whismanoid	1:d57c1a2cb83c	1369	return 1;
whismanoid	1:d57c1a2cb83c	1370	}
whismanoid	1:d57c1a2cb83c	1371
whismanoid	1:d57c1a2cb83c	1372	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1373	// Menu item 'X0'
whismanoid	1:d57c1a2cb83c	1374	//
whismanoid	1:d57c1a2cb83c	1375	// CAL_START Calibrate Self Offset and Gain.
whismanoid	1:d57c1a2cb83c	1376	//
whismanoid	1:d57c1a2cb83c	1377	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1378	uint8_t MAX11410::Calibrate_Self_Offset_Gain(void)
whismanoid	1:d57c1a2cb83c	1379	{
whismanoid	1:d57c1a2cb83c	1380
whismanoid	1:d57c1a2cb83c	1381	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1382	// warning -- WIP work in progress
whismanoid	1:d57c1a2cb83c	1383	#warning "Not Tested Yet: MAX11410::Calibrate_Self_Offset_Gain..."
whismanoid	1:d57c1a2cb83c	1384
whismanoid	1:d57c1a2cb83c	1385	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1386	// write8 0x03 CAL_START
whismanoid	1:d57c1a2cb83c	1387	RegWrite(CMD_r000_0011_xxxx_xddd_CAL_START, (uint8_t)CAL_TYPE_000_SELF_CAL);
whismanoid	1:d57c1a2cb83c	1388
whismanoid	1:d57c1a2cb83c	1389	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1390	// success
whismanoid	1:d57c1a2cb83c	1391	return 1;
whismanoid	1:d57c1a2cb83c	1392	}
whismanoid	1:d57c1a2cb83c	1393
whismanoid	1:d57c1a2cb83c	1394	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1395	// Menu item 'X1'
whismanoid	1:d57c1a2cb83c	1396	//
whismanoid	1:d57c1a2cb83c	1397	// CAL_START Calibrate Selected PGA.
whismanoid	1:d57c1a2cb83c	1398	//
whismanoid	1:d57c1a2cb83c	1399	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1400	uint8_t MAX11410::Calibrate_PGA_Gain(void)
whismanoid	1:d57c1a2cb83c	1401	{
whismanoid	1:d57c1a2cb83c	1402
whismanoid	1:d57c1a2cb83c	1403	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1404	// warning -- WIP work in progress
whismanoid	1:d57c1a2cb83c	1405	#warning "Not Tested Yet: MAX11410::Calibrate_PGA_Gain..."
whismanoid	1:d57c1a2cb83c	1406
whismanoid	1:d57c1a2cb83c	1407	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1408	// write8 0x03 CAL_START
whismanoid	1:d57c1a2cb83c	1409	RegWrite(CMD_r000_0011_xxxx_xddd_CAL_START, (uint8_t)CAL_TYPE_001_PGA_GAIN);
whismanoid	1:d57c1a2cb83c	1410
whismanoid	1:d57c1a2cb83c	1411	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1412	// success
whismanoid	1:d57c1a2cb83c	1413	return 1;
whismanoid	1:d57c1a2cb83c	1414	}
whismanoid	1:d57c1a2cb83c	1415
whismanoid	1:d57c1a2cb83c	1416	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1417	// Menu item 'X4'
whismanoid	1:d57c1a2cb83c	1418	//
whismanoid	1:d57c1a2cb83c	1419	// CAL_START Calibrate System Offset A.
whismanoid	1:d57c1a2cb83c	1420	//
whismanoid	1:d57c1a2cb83c	1421	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1422	uint8_t MAX11410::Calibrate_System_Offset_A(void)
whismanoid	1:d57c1a2cb83c	1423	{
whismanoid	1:d57c1a2cb83c	1424
whismanoid	1:d57c1a2cb83c	1425	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1426	// warning -- WIP work in progress
whismanoid	1:d57c1a2cb83c	1427	#warning "Not Tested Yet: MAX11410::Calibrate_System_Offset_A..."
whismanoid	1:d57c1a2cb83c	1428
whismanoid	1:d57c1a2cb83c	1429	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1430	// write8 0x03 CAL_START
whismanoid	1:d57c1a2cb83c	1431	RegWrite(CMD_r000_0011_xxxx_xddd_CAL_START, (uint8_t)CAL_TYPE_100_SYS_OFF_A);
whismanoid	1:d57c1a2cb83c	1432
whismanoid	1:d57c1a2cb83c	1433	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1434	// success
whismanoid	1:d57c1a2cb83c	1435	return 1;
whismanoid	1:d57c1a2cb83c	1436	}
whismanoid	1:d57c1a2cb83c	1437
whismanoid	1:d57c1a2cb83c	1438	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1439	// Menu item 'X5'
whismanoid	1:d57c1a2cb83c	1440	//
whismanoid	1:d57c1a2cb83c	1441	// X6 0x03 CAL_START 0x06 Calibrate System Offset B
whismanoid	1:d57c1a2cb83c	1442	// X7 0x03 CAL_START 0x07 Calibrate System Gain B
whismanoid	1:d57c1a2cb83c	1443	// CAL_START Calibrate System Gain A.
whismanoid	1:d57c1a2cb83c	1444	//
whismanoid	1:d57c1a2cb83c	1445	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1446	uint8_t MAX11410::Calibrate_System_Gain_A(void)
whismanoid	1:d57c1a2cb83c	1447	{
whismanoid	1:d57c1a2cb83c	1448
whismanoid	1:d57c1a2cb83c	1449	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1450	// warning -- WIP work in progress
whismanoid	1:d57c1a2cb83c	1451	#warning "Not Tested Yet: MAX11410::Calibrate_System_Gain_A..."
whismanoid	1:d57c1a2cb83c	1452
whismanoid	1:d57c1a2cb83c	1453	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1454	// write8 0x03 CAL_START
whismanoid	1:d57c1a2cb83c	1455	RegWrite(CMD_r000_0011_xxxx_xddd_CAL_START, (uint8_t)CAL_TYPE_101_SYS_GAIN_A);
whismanoid	1:d57c1a2cb83c	1456
whismanoid	1:d57c1a2cb83c	1457	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1458	// success
whismanoid	1:d57c1a2cb83c	1459	return 1;
whismanoid	1:d57c1a2cb83c	1460	}
whismanoid	1:d57c1a2cb83c	1461
whismanoid	1:d57c1a2cb83c	1462	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1463	// Menu item 'X6'
whismanoid	1:d57c1a2cb83c	1464	//
whismanoid	1:d57c1a2cb83c	1465	// CAL_START Calibrate System Offset B.
whismanoid	1:d57c1a2cb83c	1466	//
whismanoid	1:d57c1a2cb83c	1467	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1468	uint8_t MAX11410::Calibrate_System_Offset_B(void)
whismanoid	1:d57c1a2cb83c	1469	{
whismanoid	1:d57c1a2cb83c	1470
whismanoid	1:d57c1a2cb83c	1471	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1472	// warning -- WIP work in progress
whismanoid	1:d57c1a2cb83c	1473	#warning "Not Tested Yet: MAX11410::Calibrate_System_Offset_B..."
whismanoid	1:d57c1a2cb83c	1474
whismanoid	1:d57c1a2cb83c	1475	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1476	// write8 0x03 CAL_START
whismanoid	1:d57c1a2cb83c	1477	RegWrite(CMD_r000_0011_xxxx_xddd_CAL_START, (uint8_t)CAL_TYPE_110_SYS_OFF_B);
whismanoid	1:d57c1a2cb83c	1478
whismanoid	1:d57c1a2cb83c	1479	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1480	// success
whismanoid	1:d57c1a2cb83c	1481	return 1;
whismanoid	1:d57c1a2cb83c	1482	}
whismanoid	1:d57c1a2cb83c	1483
whismanoid	1:d57c1a2cb83c	1484	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1485	// Menu item 'X7'
whismanoid	1:d57c1a2cb83c	1486	//
whismanoid	1:d57c1a2cb83c	1487	// CAL_START Calibrate System Gain B.
whismanoid	1:d57c1a2cb83c	1488	//
whismanoid	1:d57c1a2cb83c	1489	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1490	uint8_t MAX11410::Calibrate_System_Gain_B(void)
whismanoid	1:d57c1a2cb83c	1491	{
whismanoid	1:d57c1a2cb83c	1492
whismanoid	1:d57c1a2cb83c	1493	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1494	// warning -- WIP work in progress
whismanoid	1:d57c1a2cb83c	1495	#warning "Not Tested Yet: MAX11410::Calibrate_System_Gain_B..."
whismanoid	1:d57c1a2cb83c	1496
whismanoid	1:d57c1a2cb83c	1497	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1498	// write8 0x03 CAL_START
whismanoid	1:d57c1a2cb83c	1499	RegWrite(CMD_r000_0011_xxxx_xddd_CAL_START, (uint8_t)CAL_TYPE_111_SYS_GAIN_B);
whismanoid	1:d57c1a2cb83c	1500
whismanoid	1:d57c1a2cb83c	1501	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1502	// success
whismanoid	1:d57c1a2cb83c	1503	return 1;
whismanoid	1:d57c1a2cb83c	1504	}
whismanoid	1:d57c1a2cb83c	1505
whismanoid	1:d57c1a2cb83c	1506	//----------------------------------------
whismanoid	0:68e64068330f	1507	// Configure Measurement for voltage input.
whismanoid	0:68e64068330f	1508	//
whismanoid	0:68e64068330f	1509	// Example code for typical voltage measurement.
whismanoid	0:68e64068330f	1510	//
whismanoid	0:68e64068330f	1511	// SPI register write sequence test AIN0-AGND voltage input using REF2=2.5V
whismanoid	0:68e64068330f	1512	// write8 0x00 PD = 0x03 (Reset Registers; enter Standby mode)
whismanoid	0:68e64068330f	1513	// write8 0x00 PD = 0x00 (NOP)
whismanoid	0:68e64068330f	1514	// write8 0x08 FILTER = 0x34 to select RATE_0100, LINEF_11_SINC4 60SPS (given CONV_TYPE_01_Continuous )
whismanoid	0:68e64068330f	1515	// write8 0x0B MUX_CTRL0 = 0x0A to select AINP=AIN0 and AINN=GND
whismanoid	0:68e64068330f	1516	// write8 0x09 CTRL = 0x02 to select reference REF2P/REF2N; or CTRL = 0x1A to select reference REF2P/REF2N with reference input buffers enabled; Data Format = Bipolar 2's Complement
whismanoid	0:68e64068330f	1517	// write8 0x0E PGA = 0x00 to select input path = Buffers, digital gain = 1V/V
whismanoid	0:68e64068330f	1518	// write8 0x01 CONV_START = 0x01 to set Conversion Mode = Continuous
whismanoid	0:68e64068330f	1519	// read24 0x80\|0x38 STATUS (%SW 0xB8 0 0 0)
whismanoid	0:68e64068330f	1520	// read24 0x80\|0x30 DATA0 (%SW 0xB0 0 0 0)
whismanoid	0:68e64068330f	1521	//
whismanoid	1:d57c1a2cb83c	1522	// @param[in] ainp = channel high side, default=AINP_SEL_enum_t::AINP_SEL_0000_AIN0
whismanoid	1:d57c1a2cb83c	1523	// @param[in] ainn = channel low side, default=AINN_SEL_enum_t::AINN_SEL_1010_GND
whismanoid	0:68e64068330f	1524	//
whismanoid	0:68e64068330f	1525	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1526	uint8_t MAX11410::Configure_Voltage(MAX11410_AINP_SEL_enum_t ainp, MAX11410_AINN_SEL_enum_t ainn)
whismanoid	0:68e64068330f	1527	{
whismanoid	0:68e64068330f	1528
whismanoid	0:68e64068330f	1529	//----------------------------------------
whismanoid	0:68e64068330f	1530	// warning -- WIP work in progress
whismanoid	0:68e64068330f	1531	#warning "Not Tested Yet: MAX11410::Configure_Voltage..."
whismanoid	0:68e64068330f	1532
whismanoid	0:68e64068330f	1533	//----------------------------------------
whismanoid	0:68e64068330f	1534	// write8 0x00 PD = 0x03 (Reset Registers; enter Standby mode)
whismanoid	0:68e64068330f	1535	RegWrite(CMD_r000_0000_xxxx_xxdd_PD, PD_11_Reset);
whismanoid	0:68e64068330f	1536
whismanoid	0:68e64068330f	1537	//----------------------------------------
whismanoid	0:68e64068330f	1538	// write8 0x00 PD = 0x00 (NOP)
whismanoid	0:68e64068330f	1539	RegWrite(CMD_r000_0000_xxxx_xxdd_PD, PD_00_Normal);
whismanoid	0:68e64068330f	1540
whismanoid	0:68e64068330f	1541	//----------------------------------------
whismanoid	0:68e64068330f	1542	// write8 0x08 FILTER = 0x34 to select RATE_0100, LINEF_11_SINC4 60SPS (given CONV_TYPE_01_Continuous)
whismanoid	2:eac67184cc0c	1543	Configure_FILTER((uint8_t) /* MAX11410::MAX11410_LINEF_enum_t:: */ LINEF_11_SINC4,
whismanoid	2:eac67184cc0c	1544	(uint8_t) /* MAX11410::MAX11410_RATE_enum_t:: */ RATE_0100);
whismanoid	0:68e64068330f	1545
whismanoid	0:68e64068330f	1546	//----------------------------------------
whismanoid	0:68e64068330f	1547	// write8 0x0B MUX_CTRL0 = 0x0A to select AINP=AIN0 and AINN=GND
whismanoid	1:d57c1a2cb83c	1548	Configure_MUX_CTRL0((uint8_t)AINP_SEL_0000_AIN0, (uint8_t)AINN_SEL_1010_GND);
whismanoid	0:68e64068330f	1549
whismanoid	0:68e64068330f	1550	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1551	// write8 0x09 CTRL to select reference REF2P/REF2N; Data Format = Bipolar 2's Complement
whismanoid	1:d57c1a2cb83c	1552	Configure_CTRL(/extclk/ 0, /u_bn/ 0, /format/ 0,
whismanoid	1:d57c1a2cb83c	1553	/refbufp_en/ 0, /refbufn_en/ 0,
whismanoid	1:d57c1a2cb83c	1554	/ref_sel/ (uint8_t)REF_SEL_010_REF2P_REF2N);
whismanoid	0:68e64068330f	1555
whismanoid	0:68e64068330f	1556	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1557	// write8 0x0E PGA
whismanoid	2:eac67184cc0c	1558	Configure_PGA((uint8_t) /* MAX11410_SIG_PATH_enum_t:: */ SIG_PATH_00_BUFFERED,
whismanoid	2:eac67184cc0c	1559	(uint8_t) /* MAX11410_GAIN_enum_t:: */ GAIN_000_1);
whismanoid	0:68e64068330f	1560
whismanoid	0:68e64068330f	1561	//----------------------------------------
whismanoid	0:68e64068330f	1562	// write8 0x01 CONV_START = 0x01 to set Conversion Mode = Continuous
whismanoid	0:68e64068330f	1563	RegWrite(CMD_r000_0001_xddd_xxdd_CONV_START, 0x01);
whismanoid	0:68e64068330f	1564
whismanoid	0:68e64068330f	1565	//----------------------------------------
whismanoid	0:68e64068330f	1566	// read24 0x80\|0x38 STATUS (%SW 0xB8 0 0 0)
whismanoid	0:68e64068330f	1567	RegRead(CMD_r011_1000_dddd_dddd_dddd_dddd_dxxx_dddd_STATUS, &status);
whismanoid	0:68e64068330f	1568
whismanoid	0:68e64068330f	1569	//----------------------------------------
whismanoid	0:68e64068330f	1570	// read24 0x80\|0x30 DATA0 (%SW 0xB0 0 0 0)
whismanoid	0:68e64068330f	1571	RegRead(CMD_r011_0000_dddd_dddd_dddd_dddd_dddd_dddd_DATA0, &data0);
whismanoid	0:68e64068330f	1572
whismanoid	0:68e64068330f	1573	//----------------------------------------
whismanoid	0:68e64068330f	1574	// success
whismanoid	0:68e64068330f	1575	return 1;
whismanoid	0:68e64068330f	1576	}
whismanoid	0:68e64068330f	1577
whismanoid	0:68e64068330f	1578	//----------------------------------------
whismanoid	13:df96a784cda6	1579	// Menu item '$' -> AINcode[0], AINcode[1], AINcode[2], AINcode[3], AINcode[4], AINcode[5], AINcode[6], AINcode[7], AINcode[8], AINcode[9], AINcode[10]
whismanoid	1:d57c1a2cb83c	1580	// Measure all ADC channels in sequence.
whismanoid	8:3a9dfa2e8234	1581	// @post AINcode[0..10]: measurement result LSB code
whismanoid	0:68e64068330f	1582	//
whismanoid	0:68e64068330f	1583	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1584	uint8_t MAX11410::Read_All_Voltages(void)
whismanoid	0:68e64068330f	1585	{
whismanoid	0:68e64068330f	1586
whismanoid	0:68e64068330f	1587	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1588	// scan AIN0..AIN9
whismanoid	1:d57c1a2cb83c	1589	const MAX11410_AINN_SEL_enum_t ainn = AINN_SEL_1010_GND;
whismanoid	2:eac67184cc0c	1590	for(uint8_t ainp = /* MAX11410_AINP_SEL_enum_t:: / AINP_SEL_0000_AIN0; ainp <= / MAX11410_AINP_SEL_enum_t:: */ AINP_SEL_1010_AVDD; ainp++)
whismanoid	1:d57c1a2cb83c	1591	{
whismanoid	1:d57c1a2cb83c	1592	Measure_Voltage((MAX11410_AINP_SEL_enum_t)ainp, ainn);
whismanoid	1:d57c1a2cb83c	1593	}
whismanoid	0:68e64068330f	1594
whismanoid	0:68e64068330f	1595	//----------------------------------------
whismanoid	0:68e64068330f	1596	// success
whismanoid	0:68e64068330f	1597	return 1;
whismanoid	0:68e64068330f	1598	}
whismanoid	0:68e64068330f	1599
whismanoid	0:68e64068330f	1600	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1601	// Menu item 'V'
whismanoid	0:68e64068330f	1602	// Trigger Measurement for voltage input.
whismanoid	0:68e64068330f	1603	//
whismanoid	0:68e64068330f	1604	// Example code for typical voltage measurement.
whismanoid	0:68e64068330f	1605	//
whismanoid	1:d57c1a2cb83c	1606	// @pre external connection REF2P-REF2N is a reference voltage
whismanoid	1:d57c1a2cb83c	1607	// @pre VRef = Voltage of REF input, in Volts
whismanoid	1:d57c1a2cb83c	1608	// @param[in] ainp = channel high side, default=AINP_SEL_0000_AIN0
whismanoid	1:d57c1a2cb83c	1609	// @param[in] ainn = channel low side, default=AINN_SEL_1010_GND
whismanoid	1:d57c1a2cb83c	1610	// @post AINcode[ainp]: measurement result LSB code
whismanoid	0:68e64068330f	1611	//
whismanoid	1:d57c1a2cb83c	1612	// @return ideal voltage calculated from raw LSB code and reference voltage
whismanoid	1:d57c1a2cb83c	1613	double MAX11410::Measure_Voltage(MAX11410_AINP_SEL_enum_t ainp, MAX11410_AINN_SEL_enum_t ainn)
whismanoid	0:68e64068330f	1614	{
whismanoid	0:68e64068330f	1615
whismanoid	0:68e64068330f	1616	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1617	// restrict channel selection to valid index range
whismanoid	8:3a9dfa2e8234	1618	if ((uint8_t)ainp > /* MAX11410_AINP_SEL_enum_t:: */ AINP_SEL_1010_AVDD)
whismanoid	8:3a9dfa2e8234	1619	{
whismanoid	8:3a9dfa2e8234	1620	ainp = /* MAX11410_AINP_SEL_enum_t:: */ AINP_SEL_1010_AVDD;
whismanoid	8:3a9dfa2e8234	1621	}
whismanoid	8:3a9dfa2e8234	1622
whismanoid	8:3a9dfa2e8234	1623	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1624	// restrict channel selection to valid index range
whismanoid	8:3a9dfa2e8234	1625	if ((uint8_t)ainn > /* MAX11410_AINN_SEL_enum_t:: */ AINN_SEL_1010_GND)
whismanoid	8:3a9dfa2e8234	1626	{
whismanoid	8:3a9dfa2e8234	1627	ainn = /* MAX11410_AINN_SEL_enum_t:: */ AINN_SEL_1010_GND;
whismanoid	8:3a9dfa2e8234	1628	}
whismanoid	8:3a9dfa2e8234	1629
whismanoid	8:3a9dfa2e8234	1630	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1631	// write8 0x0B MUX_CTRL0 = 0x0A to select AINP=AIN0 and AINN=GND
whismanoid	1:d57c1a2cb83c	1632	Configure_MUX_CTRL0((uint8_t)ainp, (uint8_t)ainn);
whismanoid	1:d57c1a2cb83c	1633
whismanoid	1:d57c1a2cb83c	1634	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1635	// write8 0x09 CTRL to select reference REF2P/REF2N; Data Format = Bipolar 2's Complement
whismanoid	1:d57c1a2cb83c	1636	Configure_CTRL(/extclk/ 0, /u_bn/ 0, /format/ 0,
whismanoid	1:d57c1a2cb83c	1637	/refbufp_en/ 0, /refbufn_en/ 0,
whismanoid	1:d57c1a2cb83c	1638	/ref_sel/ (uint8_t)REF_SEL_010_REF2P_REF2N);
whismanoid	1:d57c1a2cb83c	1639
whismanoid	1:d57c1a2cb83c	1640	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1641	// write8 0x0E PGA
whismanoid	2:eac67184cc0c	1642	Configure_PGA((uint8_t) /* MAX11410_SIG_PATH_enum_t:: */ SIG_PATH_00_BUFFERED,
whismanoid	2:eac67184cc0c	1643	(uint8_t) /* MAX11410_GAIN_enum_t:: */ GAIN_000_1);
whismanoid	1:d57c1a2cb83c	1644
whismanoid	1:d57c1a2cb83c	1645	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1646	// write8 0x08 FILTER = 0x34 to select RATE_0100, LINEF_11_SINC4 60SPS (given CONV_TYPE_01_Continuous)
whismanoid	2:eac67184cc0c	1647	Configure_FILTER((uint8_t) /* MAX11410::MAX11410_LINEF_enum_t:: */ LINEF_11_SINC4,
whismanoid	2:eac67184cc0c	1648	(uint8_t) /* MAX11410::MAX11410_RATE_enum_t:: */ RATE_0100);
whismanoid	1:d57c1a2cb83c	1649
whismanoid	1:d57c1a2cb83c	1650	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1651	// write8 0x01 CONV_START = 0x01 to set Conversion Mode = Continuous
whismanoid	1:d57c1a2cb83c	1652	RegWrite(CMD_r000_0001_xddd_xxdd_CONV_START, 0x01);
whismanoid	0:68e64068330f	1653
whismanoid	0:68e64068330f	1654	//----------------------------------------
whismanoid	0:68e64068330f	1655	// read24 0x80\|0x38 STATUS (%SW 0xB8 0 0 0)
whismanoid	0:68e64068330f	1656	RegRead(CMD_r011_1000_dddd_dddd_dddd_dddd_dxxx_dddd_STATUS, &status);
whismanoid	0:68e64068330f	1657
whismanoid	0:68e64068330f	1658	//----------------------------------------
whismanoid	9:06ca88952f1c	1659	// TODO1: wait until STATUS_enum_t::STATUS_000010_DATA_RDY indicates data is available
whismanoid	9:06ca88952f1c	1660	#warning "Not Verified Yet: wait until STATUS indicates data is available"
whismanoid	13:df96a784cda6	1661	// A bad SPI interface can cause bit slippage, which makes this loop get stuck. Expect *PART_ID? = 0x000F02
whismanoid	13:df96a784cda6	1662	// while ((status & /* MAX11410_STATUS_enum_t:: */ STATUS_000010_DATA_RDY) == 0) {
whismanoid	13:df96a784cda6	1663	// possible infinite loop; need a timeout or futility countdown to escape
whismanoid	13:df96a784cda6	1664	for (int futility_countdown = 30;
whismanoid	13:df96a784cda6	1665	((futility_countdown > 0) &&
whismanoid	13:df96a784cda6	1666	((status & /* MAX11410_STATUS_enum_t:: */ STATUS_000010_DATA_RDY) == 0));
whismanoid	13:df96a784cda6	1667	futility_countdown--)
whismanoid	13:df96a784cda6	1668	{
whismanoid	9:06ca88952f1c	1669	RegRead(CMD_r011_1000_dddd_dddd_dddd_dddd_dxxx_dddd_STATUS, &status);
whismanoid	9:06ca88952f1c	1670	}
whismanoid	9:06ca88952f1c	1671
whismanoid	9:06ca88952f1c	1672	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1673	// read24 0x80\|0x30 DATA0 (%SW 0xB0 0 0 0): AINcode[ainp] = measurement
whismanoid	1:d57c1a2cb83c	1674	RegRead(CMD_r011_0000_dddd_dddd_dddd_dddd_dddd_dddd_DATA0, &AINcode[((int)ainp & 0x0F)]);
whismanoid	1:d57c1a2cb83c	1675	data0 = AINcode[((int)ainp & 0x0F)];
whismanoid	0:68e64068330f	1676
whismanoid	0:68e64068330f	1677	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1678	// ideal voltage calculated from raw LSB code and reference voltage
whismanoid	1:d57c1a2cb83c	1679	return VoltageOfCode(AINcode[((int)ainp & 0x0F)]);
whismanoid	0:68e64068330f	1680	}
whismanoid	0:68e64068330f	1681
whismanoid	0:68e64068330f	1682	//----------------------------------------
whismanoid	5:a2e74357cfc0	1683	// Menu item 'R' -> rtd_resistance, RTD_Temperature
whismanoid	0:68e64068330f	1684	// Trigger Measurement for Resistive Temperature Device (RTD).
whismanoid	0:68e64068330f	1685	//
whismanoid	0:68e64068330f	1686	// Example code for typical RTD measurement.
whismanoid	0:68e64068330f	1687	//
whismanoid	1:d57c1a2cb83c	1688	// @pre external connection REF1P-REF1N is a reference resistor
whismanoid	1:d57c1a2cb83c	1689	// @pre VRef_REF1 = reference resistance in ohms, default=4999
whismanoid	1:d57c1a2cb83c	1690	// @param[in] rtd_iout = channel RTD high side force, default=AINP_SEL_0111_AIN7
whismanoid	1:d57c1a2cb83c	1691	// @param[in] rtd_ainp = channel RTD high side sense, default=AINP_SEL_1000_AIN8
whismanoid	1:d57c1a2cb83c	1692	// @param[in] rtd_ainn = channel RTD low side, default=AINN_SEL_1001_AIN9
whismanoid	1:d57c1a2cb83c	1693	// @post AINcode[rtd_ainp]: measurement result LSB code
whismanoid	5:a2e74357cfc0	1694	// @post rtd_resistance: measurement result resistance in Ohms
whismanoid	5:a2e74357cfc0	1695	// @post RTD_Temperature: Temperature calculated from RTD Resistance; Thermocouple Cold Junction, in degrees C
whismanoid	0:68e64068330f	1696	//
whismanoid	3:658a93dfb2d8	1697	// @return resistance calculated from raw LSB code and reference resistance
whismanoid	1:d57c1a2cb83c	1698	double MAX11410::Measure_RTD(MAX11410_AINP_SEL_enum_t rtd_iout, MAX11410_AINP_SEL_enum_t rtd_ainp, MAX11410_AINN_SEL_enum_t rtd_ainn)
whismanoid	0:68e64068330f	1699	{
whismanoid	0:68e64068330f	1700
whismanoid	0:68e64068330f	1701	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1702	// restrict channel selection to valid index range
whismanoid	8:3a9dfa2e8234	1703	if ((uint8_t)rtd_iout > /* MAX11410_AINP_SEL_enum_t:: */ AINP_SEL_1010_AVDD)
whismanoid	8:3a9dfa2e8234	1704	{
whismanoid	8:3a9dfa2e8234	1705	rtd_iout = /* MAX11410_AINP_SEL_enum_t:: */ AINP_SEL_1010_AVDD;
whismanoid	8:3a9dfa2e8234	1706	}
whismanoid	8:3a9dfa2e8234	1707
whismanoid	8:3a9dfa2e8234	1708	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1709	// restrict channel selection to valid index range
whismanoid	8:3a9dfa2e8234	1710	if ((uint8_t)rtd_ainp > /* MAX11410_AINP_SEL_enum_t:: */ AINP_SEL_1010_AVDD)
whismanoid	8:3a9dfa2e8234	1711	{
whismanoid	8:3a9dfa2e8234	1712	rtd_ainp = /* MAX11410_AINP_SEL_enum_t:: */ AINP_SEL_1010_AVDD;
whismanoid	8:3a9dfa2e8234	1713	}
whismanoid	8:3a9dfa2e8234	1714
whismanoid	8:3a9dfa2e8234	1715	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1716	// restrict channel selection to valid index range
whismanoid	8:3a9dfa2e8234	1717	if ((uint8_t)rtd_ainn > /* MAX11410_AINN_SEL_enum_t:: */ AINN_SEL_1010_GND)
whismanoid	8:3a9dfa2e8234	1718	{
whismanoid	8:3a9dfa2e8234	1719	rtd_ainn = /* MAX11410_AINN_SEL_enum_t:: */ AINN_SEL_1010_GND;
whismanoid	8:3a9dfa2e8234	1720	}
whismanoid	8:3a9dfa2e8234	1721
whismanoid	8:3a9dfa2e8234	1722	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1723	// write8 0x08 FILTER = 0x34 to select RATE_0100, LINEF_11_SINC4 60SPS (given CONV_TYPE_01_Continuous)
whismanoid	2:eac67184cc0c	1724	Configure_FILTER((uint8_t) /* MAX11410::MAX11410_LINEF_enum_t:: */ LINEF_11_SINC4,
whismanoid	2:eac67184cc0c	1725	(uint8_t) /* MAX11410::MAX11410_RATE_enum_t:: */ RATE_0100);
whismanoid	1:d57c1a2cb83c	1726
whismanoid	1:d57c1a2cb83c	1727	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1728	// write8 0x09 CTRL to select reference resistor REF1P/REF1N; Data Format = Unipolar
whismanoid	1:d57c1a2cb83c	1729	Configure_CTRL(/extclk/ 0, /u_bn/ 1, /format/ 0,
whismanoid	1:d57c1a2cb83c	1730	/refbufp_en/ 0, /refbufn_en/ 0,
whismanoid	1:d57c1a2cb83c	1731	/ref_sel/ (uint8_t)REF_SEL_001_REF1P_REF1N);
whismanoid	1:d57c1a2cb83c	1732
whismanoid	1:d57c1a2cb83c	1733	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1734	// write8 0x0A SOURCE = 0x0B to select IDAC_MODE 400uA; AIN9=2.000V, AIN8(PT100)=2.040V, AIN8(PT1000)=2.400V
whismanoid	1:d57c1a2cb83c	1735	Configure_SOURCE(VBIAS_MODE_00_Active, BRN_MODE_00_disabled, IDAC_MODE_1011_400uA);
whismanoid	1:d57c1a2cb83c	1736
whismanoid	1:d57c1a2cb83c	1737	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1738	// write8 0x0B MUX_CTRL0 = 0x89 to select AINP=AIN8 and AINN=AIN9
whismanoid	1:d57c1a2cb83c	1739	Configure_MUX_CTRL0((uint8_t)rtd_ainp, (uint8_t)rtd_ainn);
whismanoid	1:d57c1a2cb83c	1740
whismanoid	1:d57c1a2cb83c	1741	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1742	// write8 0x0C MUX_CTRL1 = 0xF7 to select IDAC1_SEL=NC, IDAC0_SEL=AIN7
whismanoid	1:d57c1a2cb83c	1743	Configure_MUX_CTRL1((uint8_t)IDAC1_SEL_1111_unconnected, (uint8_t)rtd_iout);
whismanoid	1:d57c1a2cb83c	1744
whismanoid	1:d57c1a2cb83c	1745	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1746	// write8 0x0E PGA
whismanoid	2:eac67184cc0c	1747	Configure_PGA((uint8_t) /* MAX11410_SIG_PATH_enum_t:: */ SIG_PATH_10_PGA,
whismanoid	2:eac67184cc0c	1748	(uint8_t) /* MAX11410_GAIN_enum_t:: */ GAIN_001_2);
whismanoid	1:d57c1a2cb83c	1749
whismanoid	1:d57c1a2cb83c	1750	//----------------------------------------
whismanoid	9:06ca88952f1c	1751	// TODO1: timing delay after enable RTD bias current
whismanoid	9:06ca88952f1c	1752	#warning "Not Implemented Yet: timing delay after enable RTD bias current"
whismanoid	15:d5781c8fc002	1753	const int RTD_power_up_interval_msec = 100; // timing delay after enable RTD bias current
whismanoid	15:d5781c8fc002	1754	wait_ms(RTD_power_up_interval_msec); // timing delay function, platform-specific
whismanoid	9:06ca88952f1c	1755
whismanoid	9:06ca88952f1c	1756	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1757	// write8 0x01 CONV_START = 0x01 to set Conversion Mode = Continuous
whismanoid	1:d57c1a2cb83c	1758	RegWrite(CMD_r000_0001_xddd_xxdd_CONV_START, 0x01);
whismanoid	1:d57c1a2cb83c	1759
whismanoid	1:d57c1a2cb83c	1760	//----------------------------------------
whismanoid	0:68e64068330f	1761	// read24 0x80\|0x38 STATUS (%SW 0xB8 0 0 0)
whismanoid	0:68e64068330f	1762	RegRead(CMD_r011_1000_dddd_dddd_dddd_dddd_dxxx_dddd_STATUS, &status);
whismanoid	0:68e64068330f	1763
whismanoid	0:68e64068330f	1764	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1765	// read24 0x80\|0x30 DATA0 (%SW 0xB0 0 0 0): AINcode[ainp] = measurement
whismanoid	1:d57c1a2cb83c	1766	RegRead(CMD_r011_0000_dddd_dddd_dddd_dddd_dddd_dddd_DATA0, &AINcode[((int)rtd_ainp & 0x0F)]);
whismanoid	1:d57c1a2cb83c	1767	data0 = AINcode[((int)rtd_ainp & 0x0F)];
whismanoid	0:68e64068330f	1768
whismanoid	0:68e64068330f	1769	//----------------------------------------
whismanoid	15:d5781c8fc002	1770	// TODO1: turn off RTD bias current to avoid self-heating: write8 0x0C MUX_CTRL1 = 0xFF to select IDAC1_SEL=NC, IDAC0_SEL=NC
whismanoid	15:d5781c8fc002	1771	Configure_MUX_CTRL1((uint8_t)IDAC1_SEL_1111_unconnected, (uint8_t)IDAC0_SEL_1111_unconnected);
whismanoid	9:06ca88952f1c	1772
whismanoid	9:06ca88952f1c	1773	//----------------------------------------
whismanoid	5:a2e74357cfc0	1774	// resistance calculated from raw LSB code and VRef_REF1 reference resistance in ohms
whismanoid	5:a2e74357cfc0	1775	rtd_resistance = VoltageOfCode(AINcode[((int)rtd_ainp & 0x0F)]);
whismanoid	5:a2e74357cfc0	1776	TemperatureOfRTD_PT1000(rtd_resistance); // calculate RTD_Temperature
whismanoid	5:a2e74357cfc0	1777	return rtd_resistance;
whismanoid	0:68e64068330f	1778	}
whismanoid	0:68e64068330f	1779
whismanoid	0:68e64068330f	1780	//----------------------------------------
whismanoid	3:658a93dfb2d8	1781	// Return the physical temperature corresponding to measured resistance
whismanoid	3:658a93dfb2d8	1782	// of a PT1000 type Resistive Temperature Device (RTD).
whismanoid	3:658a93dfb2d8	1783	//
whismanoid	3:658a93dfb2d8	1784	// @param[in] rtd_resistance = RTD resistance in ohms, default=1000
whismanoid	5:a2e74357cfc0	1785	// @post RTD_Temperature: Temperature calculated from RTD Resistance; Thermocouple Cold Junction, in degrees C
whismanoid	3:658a93dfb2d8	1786	//
whismanoid	3:658a93dfb2d8	1787	// @return ideal temperature in degrees C, calculated from RTD resistance in ohms
whismanoid	5:a2e74357cfc0	1788	// @test group RTD_PT1000 TemperatureOfRTD_PT1000(842.94) expect -40.0 within 0.1 PT-1000 RTD at -40C
whismanoid	5:a2e74357cfc0	1789	// @test group RTD_PT1000 TemperatureOfRTD_PT1000(1000.0) expect 0.0 within 0.1 PT-1000 RTD at 0C
whismanoid	5:a2e74357cfc0	1790	// @test group RTD_PT1000 TemperatureOfRTD_PT1000(1097.3) expect 25.0 within 0.1 PT-1000 RTD at 25C
whismanoid	5:a2e74357cfc0	1791	// @test group RTD_PT1000 TemperatureOfRTD_PT1000(1328.1) expect 85.0 within 0.1 PT-1000 RTD at 85C
whismanoid	5:a2e74357cfc0	1792	// @test group RTD_PT1000 TemperatureOfRTD_PT1000(1479.5) expect 125.0 within 0.1 PT-1000 RTD at 125C
whismanoid	3:658a93dfb2d8	1793	//
whismanoid	3:658a93dfb2d8	1794	double MAX11410::TemperatureOfRTD_PT1000(double rtd_resistance)
whismanoid	3:658a93dfb2d8	1795	{
whismanoid	3:658a93dfb2d8	1796
whismanoid	3:658a93dfb2d8	1797	//----------------------------------------
whismanoid	3:658a93dfb2d8	1798	// Temperature from RTD Resistance maths
whismanoid	4:c169ba85d673	1799	// ITS-90 PT-1000 RTD
whismanoid	4:c169ba85d673	1800	double R0 = 1000.0;
whismanoid	4:c169ba85d673	1801	double a = 3.9083e-3;
whismanoid	4:c169ba85d673	1802	double b = -5.7750e-7;
whismanoid	5:a2e74357cfc0	1803	// calculate T from R and R0
whismanoid	4:c169ba85d673	1804	double sqrtTerm = sqrt(R0R0 aa - 4R0b(R0 - rtd_resistance));
whismanoid	4:c169ba85d673	1805	double denominator = 2 * R0 * b;
whismanoid	4:c169ba85d673	1806	RTD_Temperature = ((-R0 * a) + (sqrtTerm)) / denominator;
whismanoid	3:658a93dfb2d8	1807	return RTD_Temperature;
whismanoid	3:658a93dfb2d8	1808	}
whismanoid	3:658a93dfb2d8	1809
whismanoid	3:658a93dfb2d8	1810	//----------------------------------------
whismanoid	3:658a93dfb2d8	1811	// Menu item 'TM'
whismanoid	0:68e64068330f	1812	// Trigger Measurement for Thermocouple
whismanoid	0:68e64068330f	1813	//
whismanoid	0:68e64068330f	1814	// Example code for typical Thermocouple measurement.
whismanoid	1:d57c1a2cb83c	1815	// An RTD measures the "cold junction" where TC connects to the board,
whismanoid	1:d57c1a2cb83c	1816	// and the TC measures the temperature difference above the cold junction.
whismanoid	0:68e64068330f	1817	//
whismanoid	1:d57c1a2cb83c	1818	// @param[in] tc_ainp = channel of Thermocouple high side, default=AINP_SEL_0101_AIN5
whismanoid	1:d57c1a2cb83c	1819	// @param[in] tc_ainn = channel of Thermocouple low side, default=AINN_SEL_0110_AIN6
whismanoid	1:d57c1a2cb83c	1820	// @param[in] rtd_iout = channel RTD high side force, default=AINP_SEL_0111_AIN7
whismanoid	1:d57c1a2cb83c	1821	// @param[in] rtd_ainp = channel RTD high side sense, default=AINP_SEL_1000_AIN8
whismanoid	1:d57c1a2cb83c	1822	// @param[in] rtd_ainn = channel RTD low side, default=AINN_SEL_1001_AIN9
whismanoid	1:d57c1a2cb83c	1823	// @post AINcode[tc_ainp]: measurement result LSB code
whismanoid	0:68e64068330f	1824	//
whismanoid	0:68e64068330f	1825	// @return 1 on success; 0 on failure
whismanoid	1:d57c1a2cb83c	1826	double MAX11410::Measure_Thermocouple(MAX11410_AINP_SEL_enum_t tc_ainp, MAX11410_AINN_SEL_enum_t tc_ainn, MAX11410_AINP_SEL_enum_t rtd_iout, MAX11410_AINP_SEL_enum_t rtd_ainp, MAX11410_AINN_SEL_enum_t rtd_ainn)
whismanoid	0:68e64068330f	1827	{
whismanoid	0:68e64068330f	1828
whismanoid	0:68e64068330f	1829	//----------------------------------------
whismanoid	0:68e64068330f	1830	// warning -- WIP work in progress
whismanoid	0:68e64068330f	1831	#warning "Not Implemented Yet: MAX11410::Measure_Thermocouple..."
whismanoid	0:68e64068330f	1832
whismanoid	0:68e64068330f	1833	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1834	// restrict channel selection to valid index range
whismanoid	8:3a9dfa2e8234	1835	if ((uint8_t)tc_ainp > /* MAX11410_AINP_SEL_enum_t:: */ AINP_SEL_1010_AVDD)
whismanoid	8:3a9dfa2e8234	1836	{
whismanoid	8:3a9dfa2e8234	1837	tc_ainp = /* MAX11410_AINP_SEL_enum_t:: */ AINP_SEL_1010_AVDD;
whismanoid	8:3a9dfa2e8234	1838	}
whismanoid	8:3a9dfa2e8234	1839
whismanoid	8:3a9dfa2e8234	1840	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1841	// restrict channel selection to valid index range
whismanoid	8:3a9dfa2e8234	1842	if ((uint8_t)tc_ainn > /* MAX11410_AINN_SEL_enum_t:: */ AINN_SEL_1010_GND)
whismanoid	8:3a9dfa2e8234	1843	{
whismanoid	8:3a9dfa2e8234	1844	tc_ainn = /* MAX11410_AINN_SEL_enum_t:: */ AINN_SEL_1010_GND;
whismanoid	8:3a9dfa2e8234	1845	}
whismanoid	8:3a9dfa2e8234	1846
whismanoid	8:3a9dfa2e8234	1847	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1848	// restrict channel selection to valid index range
whismanoid	8:3a9dfa2e8234	1849	if ((uint8_t)rtd_iout > /* MAX11410_AINP_SEL_enum_t:: */ AINP_SEL_1010_AVDD)
whismanoid	8:3a9dfa2e8234	1850	{
whismanoid	8:3a9dfa2e8234	1851	rtd_iout = /* MAX11410_AINP_SEL_enum_t:: */ AINP_SEL_1010_AVDD;
whismanoid	8:3a9dfa2e8234	1852	}
whismanoid	8:3a9dfa2e8234	1853
whismanoid	8:3a9dfa2e8234	1854	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1855	// restrict channel selection to valid index range
whismanoid	8:3a9dfa2e8234	1856	if ((uint8_t)rtd_ainp > /* MAX11410_AINP_SEL_enum_t:: */ AINP_SEL_1010_AVDD)
whismanoid	8:3a9dfa2e8234	1857	{
whismanoid	8:3a9dfa2e8234	1858	rtd_ainp = /* MAX11410_AINP_SEL_enum_t:: */ AINP_SEL_1010_AVDD;
whismanoid	8:3a9dfa2e8234	1859	}
whismanoid	8:3a9dfa2e8234	1860
whismanoid	8:3a9dfa2e8234	1861	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1862	// restrict channel selection to valid index range
whismanoid	8:3a9dfa2e8234	1863	if ((uint8_t)rtd_ainn > /* MAX11410_AINN_SEL_enum_t:: */ AINN_SEL_1010_GND)
whismanoid	8:3a9dfa2e8234	1864	{
whismanoid	8:3a9dfa2e8234	1865	rtd_ainn = /* MAX11410_AINN_SEL_enum_t:: */ AINN_SEL_1010_GND;
whismanoid	8:3a9dfa2e8234	1866	}
whismanoid	8:3a9dfa2e8234	1867
whismanoid	8:3a9dfa2e8234	1868	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1869	// write8 0x0B MUX_CTRL0 = 0x0A to select AINP=AIN0 and AINN=GND
whismanoid	8:3a9dfa2e8234	1870	Configure_MUX_CTRL0((uint8_t)tc_ainp, (uint8_t)tc_ainn);
whismanoid	8:3a9dfa2e8234	1871
whismanoid	8:3a9dfa2e8234	1872	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1873	// write8 0x09 CTRL to select reference REF2P/REF2N; Data Format = Bipolar 2's Complement
whismanoid	8:3a9dfa2e8234	1874	Configure_CTRL(/extclk/ 0, /u_bn/ 0, /format/ 0,
whismanoid	8:3a9dfa2e8234	1875	/refbufp_en/ 0, /refbufn_en/ 0,
whismanoid	8:3a9dfa2e8234	1876	/ref_sel/ (uint8_t)REF_SEL_010_REF2P_REF2N);
whismanoid	8:3a9dfa2e8234	1877
whismanoid	8:3a9dfa2e8234	1878	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1879	// write8 0x0E PGA
whismanoid	8:3a9dfa2e8234	1880	Configure_PGA((uint8_t) /* MAX11410_SIG_PATH_enum_t:: */ SIG_PATH_00_BUFFERED,
whismanoid	8:3a9dfa2e8234	1881	(uint8_t) /* MAX11410_GAIN_enum_t:: */ GAIN_000_1);
whismanoid	8:3a9dfa2e8234	1882
whismanoid	8:3a9dfa2e8234	1883	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1884	// write8 0x08 FILTER = 0x34 to select RATE_0100, LINEF_11_SINC4 60SPS (given CONV_TYPE_01_Continuous)
whismanoid	8:3a9dfa2e8234	1885	Configure_FILTER((uint8_t) /* MAX11410::MAX11410_LINEF_enum_t:: */ LINEF_11_SINC4,
whismanoid	8:3a9dfa2e8234	1886	(uint8_t) /* MAX11410::MAX11410_RATE_enum_t:: */ RATE_0100);
whismanoid	8:3a9dfa2e8234	1887
whismanoid	8:3a9dfa2e8234	1888	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1889	// write8 0x01 CONV_START = 0x01 to set Conversion Mode = Continuous
whismanoid	8:3a9dfa2e8234	1890	RegWrite(CMD_r000_0001_xddd_xxdd_CONV_START, 0x01);
whismanoid	8:3a9dfa2e8234	1891
whismanoid	8:3a9dfa2e8234	1892	//----------------------------------------
whismanoid	0:68e64068330f	1893	// read24 0x80\|0x38 STATUS (%SW 0xB8 0 0 0)
whismanoid	0:68e64068330f	1894	RegRead(CMD_r011_1000_dddd_dddd_dddd_dddd_dxxx_dddd_STATUS, &status);
whismanoid	0:68e64068330f	1895
whismanoid	0:68e64068330f	1896	//----------------------------------------
whismanoid	8:3a9dfa2e8234	1897	// read24 0x80\|0x30 DATA0 (%SW 0xB0 0 0 0): AINcode[tc_ainp] = measurement
whismanoid	8:3a9dfa2e8234	1898	RegRead(CMD_r011_0000_dddd_dddd_dddd_dddd_dddd_dddd_DATA0, &AINcode[((int)tc_ainp & 0x0F)]);
whismanoid	8:3a9dfa2e8234	1899	data0 = AINcode[((int)tc_ainp & 0x0F)];
whismanoid	0:68e64068330f	1900
whismanoid	0:68e64068330f	1901	//----------------------------------------
whismanoid	1:d57c1a2cb83c	1902	// ideal voltage calculated from raw LSB code and reference voltage
whismanoid	8:3a9dfa2e8234	1903	return VoltageOfCode(AINcode[((int)tc_ainp & 0x0F)]);
whismanoid	0:68e64068330f	1904	}
whismanoid	0:68e64068330f	1905
whismanoid	3:658a93dfb2d8	1906	//----------------------------------------
whismanoid	3:658a93dfb2d8	1907	// Menu item 'TK'
whismanoid	3:658a93dfb2d8	1908	// Return the physical temperature corresponding to measured voltage
whismanoid	3:658a93dfb2d8	1909	// of a type K Thermocouple (TC).
whismanoid	3:658a93dfb2d8	1910	//
whismanoid	3:658a93dfb2d8	1911	// @pre {0}.RTD_Temperature = cold junction temperature, in degrees C
whismanoid	3:658a93dfb2d8	1912	// @param[in] tc_voltage = Thermocouple voltage in volts, default=0.0254
whismanoid	3:658a93dfb2d8	1913	//
whismanoid	3:658a93dfb2d8	1914	// @return ideal temperature in degrees C, calculated from RTD resistance in ohms
whismanoid	4:c169ba85d673	1915	// @test group TC_1 TemperatureOfTC_TypeK(0.000e-3) expect 0.0 within 0.1 TC_TypeK at 0C = 0.000mV
whismanoid	4:c169ba85d673	1916	// @test group TC_1 TemperatureOfTC_TypeK(0.039e-3) expect 1.0 within 0.1 TC_TypeK at 1C = 0.039mV
whismanoid	4:c169ba85d673	1917	// @test group TC_1 TemperatureOfTC_TypeK(0.079e-3) expect 2.0 within 0.1 TC_TypeK at 2C = 0.079mV
whismanoid	4:c169ba85d673	1918	// @test group TC_1 TemperatureOfTC_TypeK(0.119e-3) expect 3.0 within 0.1 TC_TypeK at 3C = 0.119mV
whismanoid	4:c169ba85d673	1919	// @test group TC_2 TemperatureOfTC_TypeK(0.158e-3) expect 4.0 within 0.1 TC_TypeK at 4C = 0.158mV
whismanoid	4:c169ba85d673	1920	// @test group TC_2 TemperatureOfTC_TypeK(0.198e-3) expect 5.0 within 0.1 TC_TypeK at 5C = 0.198mV
whismanoid	4:c169ba85d673	1921	// @test group TC_2 TemperatureOfTC_TypeK(0.238e-3) expect 6.0 within 0.1 TC_TypeK at 6C = 0.238mV
whismanoid	4:c169ba85d673	1922	// @test group TC_2 TemperatureOfTC_TypeK(0.2775e-3) expect 7.0 within 0.1 TC_TypeK at 7C = 0.2775mV
whismanoid	4:c169ba85d673	1923	// @test group TC_2 TemperatureOfTC_TypeK(0.317e-3) expect 8.0 within 0.1 TC_TypeK at 8C = 0.317mV
whismanoid	4:c169ba85d673	1924	// @test group TC_2 TemperatureOfTC_TypeK(0.357e-3) expect 9.0 within 0.1 TC_TypeK at 9C = 0.357mV
whismanoid	4:c169ba85d673	1925	// @test group TC_1 TemperatureOfTC_TypeK(0.397e-3) expect 10.0 within 0.1 TC_TypeK at 10C = 0.397mV
whismanoid	4:c169ba85d673	1926	// @test group TC_1 TemperatureOfTC_TypeK(0.798e-3) expect 20.0 within 0.1 TC_TypeK at 20C = 0.798mV
whismanoid	4:c169ba85d673	1927	// @test group TC_1 TemperatureOfTC_TypeK(1.081e-3) expect 27.0 within 0.1 TC_TypeK at 27C = 1.081mV
whismanoid	4:c169ba85d673	1928	// @test group TC_1 TemperatureOfTC_TypeK(1.203e-3) expect 30.0 within 0.1 TC_TypeK at 30C = 1.203mV
whismanoid	4:c169ba85d673	1929	// @test group TC_1 TemperatureOfTC_TypeK(1.612e-3) expect 40.0 within 0.1 TC_TypeK at 40C = 1.612mV
whismanoid	4:c169ba85d673	1930	// @test group TC_1 TemperatureOfTC_TypeK(2.023e-3) expect 50.0 within 0.1 TC_TypeK at 50C = 2.023mV
whismanoid	4:c169ba85d673	1931	// @test group TC_1 TemperatureOfTC_TypeK(2.436e-3) expect 60.0 within 0.1 TC_TypeK at 60C = 2.436mV
whismanoid	4:c169ba85d673	1932	// @test group TC_1 TemperatureOfTC_TypeK(2.851e-3) expect 70.0 within 0.1 TC_TypeK at 70C = 2.851mV
whismanoid	4:c169ba85d673	1933	// @test group TC_1 TemperatureOfTC_TypeK(3.267e-3) expect 80.0 within 0.1 TC_TypeK at 80C = 3.267mV
whismanoid	4:c169ba85d673	1934	// @test group TC_1 TemperatureOfTC_TypeK(3.682e-3) expect 90.0 within 0.1 TC_TypeK at 90C = 3.682mV
whismanoid	4:c169ba85d673	1935	// @test group TC_1 TemperatureOfTC_TypeK(4.096e-3) expect 100.0 within 0.1 TC_TypeK at 100C = 4.096mV
whismanoid	4:c169ba85d673	1936	// @test group TC_2 TemperatureOfTC_TypeK(4.509e-3) expect 110.0 within 0.1 TC_TypeK at 110C = 4.509mV
whismanoid	4:c169ba85d673	1937	// @test group TC_2 TemperatureOfTC_TypeK(4.920e-3) expect 120.0 within 0.1 TC_TypeK at 120C = 4.920mV
whismanoid	4:c169ba85d673	1938	// @test group TC_2 TemperatureOfTC_TypeK(5.328e-3) expect 130.0 within 0.1 TC_TypeK at 130C = 5.328mV
whismanoid	4:c169ba85d673	1939	// @test group TC_2 TemperatureOfTC_TypeK(5.735e-3) expect 140.0 within 0.1 TC_TypeK at 140C = 5.735mV
whismanoid	4:c169ba85d673	1940	// @test group TC_2 TemperatureOfTC_TypeK(6.138e-3) expect 150.0 within 0.1 TC_TypeK at 150C = 6.138mV
whismanoid	4:c169ba85d673	1941	// @test group TC_2 TemperatureOfTC_TypeK(6.540e-3) expect 160.0 within 0.1 TC_TypeK at 160C = 6.540mV
whismanoid	4:c169ba85d673	1942	// @test group TC_2 TemperatureOfTC_TypeK(6.941e-3) expect 170.0 within 0.1 TC_TypeK at 170C = 6.941mV
whismanoid	4:c169ba85d673	1943	// @test group TC_2 TemperatureOfTC_TypeK(7.340e-3) expect 180.0 within 0.1 TC_TypeK at 180C = 7.340mV
whismanoid	4:c169ba85d673	1944	// @test group TC_1 TemperatureOfTC_TypeK(7.739e-3) expect 190.0 within 0.1 TC_TypeK at 190C = 7.739mV
whismanoid	4:c169ba85d673	1945	// @test group TC_1 TemperatureOfTC_TypeK(8.138e-3) expect 200.0 within 0.1 TC_TypeK at 200C = 8.138mV
whismanoid	4:c169ba85d673	1946	// @test group TC_1 TemperatureOfTC_TypeK(8.539e-3) expect 210.0 within 0.1 TC_TypeK at 210C = 8.539mV
whismanoid	4:c169ba85d673	1947	// @test group TC_1 TemperatureOfTC_TypeK(8.940e-3) expect 220.0 within 0.1 TC_TypeK at 220C = 8.940mV
whismanoid	4:c169ba85d673	1948	// @test group TC_2 TemperatureOfTC_TypeK(9.343e-3) expect 230.0 within 0.1 TC_TypeK at 230C = 9.343mV
whismanoid	4:c169ba85d673	1949	// @test group TC_2 TemperatureOfTC_TypeK(9.747e-3) expect 240.0 within 0.1 TC_TypeK at 240C = 9.747mV
whismanoid	4:c169ba85d673	1950	// @test group TC_2 TemperatureOfTC_TypeK(10.153e-3) expect 250.0 within 0.1 TC_TypeK at 250C = 10.153mV
whismanoid	4:c169ba85d673	1951	// @test group TC_2 TemperatureOfTC_TypeK(10.561e-3) expect 260.0 within 0.1 TC_TypeK at 260C = 10.561mV
whismanoid	4:c169ba85d673	1952	// @test group TC_2 TemperatureOfTC_TypeK(10.971e-3) expect 270.0 within 0.1 TC_TypeK at 270C = 10.971mV
whismanoid	4:c169ba85d673	1953	// @test group TC_2 TemperatureOfTC_TypeK(11.382e-3) expect 280.0 within 0.1 TC_TypeK at 280C = 11.382mV
whismanoid	4:c169ba85d673	1954	// @test group TC_2 TemperatureOfTC_TypeK(11.795e-3) expect 290.0 within 0.1 TC_TypeK at 290C = 11.795mV
whismanoid	4:c169ba85d673	1955	// @test group TC_1 TemperatureOfTC_TypeK(12.209e-3) expect 300.0 within 0.1 TC_TypeK at 300C = 12.209mV
whismanoid	4:c169ba85d673	1956	// @test group TC_2 TemperatureOfTC_TypeK(14.293e-3) expect 350.0 within 0.1 TC_TypeK at 350C = 14.293mV
whismanoid	4:c169ba85d673	1957	// @test group TC_1 TemperatureOfTC_TypeK(16.397e-3) expect 400.0 within 0.1 TC_TypeK at 400C = 16.397mV
whismanoid	4:c169ba85d673	1958	// @test group TC_1 TemperatureOfTC_TypeK(18.516e-3) expect 450.0 within 0.1 TC_TypeK at 450C = 18.516mV
whismanoid	4:c169ba85d673	1959	// @test group TC_1 TemperatureOfTC_TypeK(20.218e-3) expect 490.0 TC_TypeK at 490C = 20.218mV
whismanoid	3:658a93dfb2d8	1960	//
whismanoid	3:658a93dfb2d8	1961	double MAX11410::TemperatureOfTC_TypeK(double tc_voltage)
whismanoid	3:658a93dfb2d8	1962	{
whismanoid	3:658a93dfb2d8	1963
whismanoid	3:658a93dfb2d8	1964	//----------------------------------------
whismanoid	3:658a93dfb2d8	1965	// Temperature from TC_TypeK voltage maths
whismanoid	5:a2e74357cfc0	1966	// define standard TC_TypeK coefficients
whismanoid	4:c169ba85d673	1967	// ITS-90 Thermocouple Inverse Polynomial for a Type K thermocouple
whismanoid	5:a2e74357cfc0	1968	// calculate deltaT from tc_voltage
whismanoid	4:c169ba85d673	1969	//
whismanoid	4:c169ba85d673	1970	// Voltage range -5891uV < tc_voltage < 0uV,
whismanoid	4:c169ba85d673	1971	// Temperature Range -200 deg C to 0 deg C
whismanoid	4:c169ba85d673	1972	static double coefficients_TCtypeK_V_lt_0[] = {
whismanoid	4:c169ba85d673	1973	0.00000,
whismanoid	4:c169ba85d673	1974	2.5173462e-2,
whismanoid	4:c169ba85d673	1975	-1.1662878e-6,
whismanoid	4:c169ba85d673	1976	-1.0833638e-9,
whismanoid	4:c169ba85d673	1977	-8.9773540e-13,
whismanoid	4:c169ba85d673	1978	-3.7342377e-16,
whismanoid	4:c169ba85d673	1979	-8.6632643e-20,
whismanoid	4:c169ba85d673	1980	-1.0450598e-23,
whismanoid	4:c169ba85d673	1981	-5.1920577e-28,
whismanoid	4:c169ba85d673	1982	};
whismanoid	4:c169ba85d673	1983	//
whismanoid	4:c169ba85d673	1984	// Voltage range 0uV < tc_voltage < 20.644uV,
whismanoid	4:c169ba85d673	1985	// Temperature Range 0 deg C to 500 deg C
whismanoid	4:c169ba85d673	1986	static double coefficients_TCtypeK_0_lt_V_lt_20u644V[] = {
whismanoid	4:c169ba85d673	1987	0.00000,
whismanoid	4:c169ba85d673	1988	2.508355e-2,
whismanoid	4:c169ba85d673	1989	7.860106e-8,
whismanoid	4:c169ba85d673	1990	-2.503131e-10,
whismanoid	4:c169ba85d673	1991	8.315270e-14,
whismanoid	4:c169ba85d673	1992	-1.228034e-17,
whismanoid	4:c169ba85d673	1993	9.804036e-22,
whismanoid	4:c169ba85d673	1994	-4.413030e-26,
whismanoid	4:c169ba85d673	1995	1.057734e-30,
whismanoid	4:c169ba85d673	1996	-1.052755e-35,
whismanoid	4:c169ba85d673	1997	};
whismanoid	4:c169ba85d673	1998	//
whismanoid	4:c169ba85d673	1999	// Voltage range 20.6440uV < tc_voltage < 54.886uV,
whismanoid	4:c169ba85d673	2000	// Temperature Range 500 deg C to 1372 deg C
whismanoid	4:c169ba85d673	2001	static double coefficients_TCtypeK_20u644V_lt_V_lt_54u886V[] = {
whismanoid	4:c169ba85d673	2002	-1.318058e2,
whismanoid	4:c169ba85d673	2003	4.830222e-2,
whismanoid	4:c169ba85d673	2004	-1.646031e-6,
whismanoid	4:c169ba85d673	2005	5.464731e-11,
whismanoid	4:c169ba85d673	2006	-9.650715e-16,
whismanoid	4:c169ba85d673	2007	8.802193e-21,
whismanoid	4:c169ba85d673	2008	-3.110810e-26,
whismanoid	4:c169ba85d673	2009	};
whismanoid	4:c169ba85d673	2010	//
whismanoid	3:658a93dfb2d8	2011	double deltaT = 0;
whismanoid	4:c169ba85d673	2012	double thermocouple_voltage_uV = tc_voltage * 1e6;
whismanoid	4:c169ba85d673	2013	if (thermocouple_voltage_uV < 0)
whismanoid	4:c169ba85d673	2014	{
whismanoid	4:c169ba85d673	2015	// Voltage range -5891uV < DMMavg < 0uV, Temperature Range -200 deg C to 0 deg C
whismanoid	4:c169ba85d673	2016	deltaT = temperatureDegC_polynomial(thermocouple_voltage_uV, 9, coefficients_TCtypeK_V_lt_0);
whismanoid	4:c169ba85d673	2017	}
whismanoid	4:c169ba85d673	2018	else if (thermocouple_voltage_uV > 20644)
whismanoid	4:c169ba85d673	2019	{
whismanoid	4:c169ba85d673	2020	// Voltage range 206440uV < DMMavg < 54886uV, Temperature Range 500 deg C to 1372 deg C
whismanoid	4:c169ba85d673	2021	deltaT = temperatureDegC_polynomial(thermocouple_voltage_uV, 7, coefficients_TCtypeK_20u644V_lt_V_lt_54u886V);
whismanoid	4:c169ba85d673	2022	}
whismanoid	4:c169ba85d673	2023	else
whismanoid	4:c169ba85d673	2024	{
whismanoid	4:c169ba85d673	2025	// Voltage range 0uV < DMMavg < 20.644uV, Temperature Range 0 deg C to 500 deg C
whismanoid	4:c169ba85d673	2026	deltaT = temperatureDegC_polynomial(thermocouple_voltage_uV, 10, coefficients_TCtypeK_0_lt_V_lt_20u644V);
whismanoid	4:c169ba85d673	2027	}
whismanoid	4:c169ba85d673	2028	return deltaT; // + RTD_Temperature; // cold junction
whismanoid	4:c169ba85d673	2029	}
whismanoid	4:c169ba85d673	2030
whismanoid	4:c169ba85d673	2031	//----------------------------------------
whismanoid	4:c169ba85d673	2032	// Calculate temperature in degrees C from input voltage,
whismanoid	4:c169ba85d673	2033	// using a given set of polynomial coefficients.
whismanoid	4:c169ba85d673	2034	// For example:
whismanoid	4:c169ba85d673	2035	//
whismanoid	4:c169ba85d673	2036	// t = coefficients[0] + coefficients[1] * DMMavg + coefficients[2] * DmMMavg**2
whismanoid	4:c169ba85d673	2037	//
whismanoid	4:c169ba85d673	2038	// @param[in] thermocouple_voltage_uV = Thermocouple voltage in microvolts
whismanoid	4:c169ba85d673	2039	//
whismanoid	4:c169ba85d673	2040	// @return ideal temperature in degrees C, calculated from polynomial coefficients
whismanoid	4:c169ba85d673	2041	//
whismanoid	4:c169ba85d673	2042	double MAX11410::temperatureDegC_polynomial(double thermocouple_voltage_uV, int num_coefficients, double coefficients[])
whismanoid	4:c169ba85d673	2043	{
whismanoid	4:c169ba85d673	2044
whismanoid	4:c169ba85d673	2045	//----------------------------------------
whismanoid	4:c169ba85d673	2046	// warning -- WIP work in progress
whismanoid	4:c169ba85d673	2047	#warning "Not Tested Yet: MAX11410::temperatureDegC_polynomial..."
whismanoid	4:c169ba85d673	2048
whismanoid	4:c169ba85d673	2049	//----------------------------------------
whismanoid	4:c169ba85d673	2050	// Temperature from polynomial coefficients maths
whismanoid	4:c169ba85d673	2051	double temperatureDegC = 0;
whismanoid	4:c169ba85d673	2052	int index;
whismanoid	4:c169ba85d673	2053	for (index = num_coefficients-1; index >= 0; index--)
whismanoid	4:c169ba85d673	2054	{
whismanoid	4:c169ba85d673	2055	temperatureDegC = (temperatureDegC * thermocouple_voltage_uV) + coefficients[index];
whismanoid	4:c169ba85d673	2056	}
whismanoid	4:c169ba85d673	2057	return temperatureDegC;
whismanoid	3:658a93dfb2d8	2058	}
whismanoid	3:658a93dfb2d8	2059
whismanoid	0:68e64068330f	2060
whismanoid	0:68e64068330f	2061	// End of file

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	18 Dec 2019
Imports:	14
Forks:	0
Commits:	36
Dependents:	2
Dependencies:	0
Followers:	110

The code in this repository is Apache licensed.

Components

MAX11410BOB

MAX11410.cpp@15:d5781c8fc002, 2020-03-10 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Components

Important Information for this Arm website

Access Warning