Diff: MAX5715.h

Revision:

3:a3f0518094f4

Parent:

2:9d395fe10dbe

Child:

4:500c80398f90

--- a/MAX5715.h	Mon Jun 17 05:29:29 2019 +0000
+++ b/MAX5715.h	Sun Aug 04 01:47:26 2019 -0700
@@ -62,6 +62,7 @@
 #ifndef __MAX5715_H__
 #define __MAX5715_H__
 
+// standard include for target platform
 #include "mbed.h"
 
 // CODE GENERATOR: conditional defines
@@ -79,6 +80,7 @@
  * @code
  * // CODE GENERATOR: example code includes
  * // example code includes
+ * // standard include for target platform
  * #include "mbed.h"
  * //#include "max32625.h"
  * #include "MAX5715.h"
@@ -154,21 +156,23 @@
  *         //g_MAX5715_device.CODEallLOADall(code);
  *
  *         // CODE GENERATOR: example code: member function CODEnLOADn
+ *         uint16_t ch;
+ *         uint16_t code;
  *         //
- *         uint16_t ch = 0;
- *         uint16_t code = 0xccc;
+ *         ch = 0;
+ *         code = 0x0ccc; // 80.0% 2.00V (REF=2.50V)
  *         g_MAX5715_device.CODEnLOADn(ch, code);
  *         //
  *         ch = 1;
- *         code = 0x800;
+ *         code = 0x07ff; // 50.0% 1.25V (REF=2.50V)
  *         g_MAX5715_device.CODEnLOADn(ch, code);
  *         //
  *         ch = 2;
- *         code = 0x666;
+ *         code = 0x0666; // 40.0% 1.00V (REF=2.50V)
  *         g_MAX5715_device.CODEnLOADn(ch, code);
  *         //
  *         ch = 3;
- *         code = 0xFFF;
+ *         code = 0x0fff; // 100.0% 2.50V (REF=2.50V)
  *         g_MAX5715_device.CODEnLOADn(ch, code);
  *
  *         // CODE GENERATOR: example code: has no member function ScanManual
@@ -292,7 +296,7 @@
             // AnalogIn &OUTB_pin, // Analog Output from MAX5715 device
             // AnalogIn &OUTC_pin, // Analog Output from MAX5715 device
             // AnalogIn &OUTD_pin, // Analog Output from MAX5715 device
-            // DigitalIn &RDYb_pin, // Digital MAX5715 Output from MAX5715 device
+            // DigitalIn &RDYb_pin, // Digital DaisyChain Output from MAX5715 device
             MAX5715_ic_t ic_variant);
 
 // CODE GENERATOR: class destructor declaration
@@ -310,7 +314,7 @@
     ~MAX5715();
 
     // CODE GENERATOR: spi_frequency setter declaration
-    // set SPI SCLK frequency
+    /// set SPI SCLK frequency
     void spi_frequency(int spi_sclk_Hz);
 
 //----------------------------------------
@@ -560,6 +564,9 @@
 
     //----------------------------------------
     /// CMD_0100_0000_0000_dcba_0000_0000_POWERn_Normal
+    /// CMD_0100_0001_0000_dcba_0000_0000_POWERn_PD1k
+    /// CMD_0100_0010_0000_dcba_0000_0000_POWERn_PD100k
+    /// CMD_0100_0011_0000_dcba_0000_0000_POWERn_PDHiZ
     ///
     /// Sets the power mode of the selected DACs
     /// (DACs selected with a 1 in the corresponding DACn bit are updated,