bissen21/Marlin_Firmware
1
0
Fork 0
Code Issues Pull Requests Projects Releases 4 Wiki Activity

Further cleanup of comments, partial Doxygen-style

Browse Source 
Following up on #3231
This commit is contained in:
Scott Lahteine
2016-03-24 23:19:46 -07:00
parent 4823791eb0
commit 0da744b7b0
191 changed files with 904 additions and 496 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
Marlin/dac_mcp4728.cpp
View File

@ -1,4 +1,4 @@
/*
/**
* Marlin 3D Printer Firmware
* Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
*
@ -20,7 +20,7 @@
*
*/
/*
/**
* mcp4728.cpp - Arduino library for MicroChip MCP4728 I2C D/A converter
*
* For implementation details, please take a look at the datasheet:
@ -30,18 +30,15 @@
* http://arduino.cc/forum/index.php/topic,51842.0.html
*/
/* _____PROJECT INCLUDES_____________________________________________________ */
#include "dac_mcp4728.h"
#if ENABLED(DAC_STEPPER_CURRENT)
// Used Global variables
uint16_t mcp4728_values[4];
/*
Begin I2C, get current values (input register and eeprom) of mcp4728
*/
/**
* Begin I2C, get current values (input register and eeprom) of mcp4728
*/
void mcp4728_init() {
Wire.begin();
Wire.requestFrom(int(DAC_DEV_ADDRESS), 24);
@ -58,19 +55,19 @@ void mcp4728_init() {
}
}
/*
Write input resister value to specified channel using fastwrite method.
Channel : 0-3, Values : 0-4095
*/
/**
* Write input resister value to specified channel using fastwrite method.
* Channel : 0-3, Values : 0-4095
*/
uint8_t mcp4728_analogWrite(uint8_t channel, uint16_t value) {
mcp4728_values[channel] = value;
return mcp4728_fastWrite();
}
/*
Write all input resistor values to EEPROM using SequencialWrite method.
This will update both input register and EEPROM value
This will also write current Vref, PowerDown, Gain settings to EEPROM
*/
/**
* Write all input resistor values to EEPROM using SequencialWrite method.
* This will update both input register and EEPROM value
* This will also write current Vref, PowerDown, Gain settings to EEPROM
*/
uint8_t mcp4728_eepromWrite() {
Wire.beginTransmission(DAC_DEV_ADDRESS);
Wire.send(SEQWRITE);
@ -81,31 +78,32 @@ uint8_t mcp4728_eepromWrite() {
return Wire.endTransmission();
}
/*
Write Voltage reference setting to all input regiters
*/
/**
* Write Voltage reference setting to all input regiters
*/
uint8_t mcp4728_setVref_all(uint8_t value) {
Wire.beginTransmission(DAC_DEV_ADDRESS);
Wire.send(VREFWRITE | value << 3 | value << 2 | value << 1 | value);
return Wire.endTransmission();
}
/*
Write Gain setting to all input regiters
*/
/**
* Write Gain setting to all input regiters
*/
uint8_t mcp4728_setGain_all(uint8_t value) {
Wire.beginTransmission(DAC_DEV_ADDRESS);
Wire.send(GAINWRITE | value << 3 | value << 2 | value << 1 | value);
return Wire.endTransmission();
}
/*
Return Input Regiter value
*/
/**
* Return Input Regiter value
*/
uint16_t mcp4728_getValue(uint8_t channel) { return mcp4728_values[channel]; }
/*
// Steph: Might be useful in the future
// Return Vout
/**
* Steph: Might be useful in the future
* Return Vout
*
uint16_t mcp4728_getVout(uint8_t channel) {
uint32_t vref = 2048;
uint32_t vOut = (vref * mcp4728_values[channel] * (_DAC_STEPPER_GAIN + 1)) / 4096;
@ -114,11 +112,11 @@ uint16_t mcp4728_getVout(uint8_t channel) {
}
*/
/*
FastWrite input register values - All DAC ouput update. refer to DATASHEET 5.6.1
DAC Input and PowerDown bits update.
No EEPROM update
*/
/**
* FastWrite input register values - All DAC ouput update. refer to DATASHEET 5.6.1
* DAC Input and PowerDown bits update.
* No EEPROM update
*/
uint8_t mcp4728_fastWrite() {
Wire.beginTransmission(DAC_DEV_ADDRESS);
for (uint8_t channel=0; channel <= 3; channel++) {
@ -128,9 +126,9 @@ uint8_t mcp4728_fastWrite() {
return Wire.endTransmission();
}
/*
Common function for simple general commands
*/
/**
* Common function for simple general commands
*/
uint8_t mcp4728_simpleCommand(byte simpleCommand) {
Wire.beginTransmission(GENERALCALL);
Wire.send(simpleCommand);