Merge pull request #12 from arduino-libraries/refactor

Refactor common code into base classes.

Author: aentinger

.github/workflows/compile-examples.yml

@@ -31,6 +31,7 @@ jobs:
     env:
       UNIVERSAL_SKETCH_PATHS: |
         - examples/BasicUsage
+        - examples/ReadWriteRegs
       SKETCHES_REPORTS_PATH: sketches-reports
 
     strategy:

examples/BasicUsage/BasicUsage.ino

@@ -1,4 +1,8 @@
-#include "Arduino_PMIC.h"
+/*
+ * Demonstrate basic library usage.
+ */
+
+#include <Arduino_PMIC.h>
 
 void setup() {
   PMIC.begin();

examples/C33-Low-Power/C33-Low-Power.ino

@@ -1,3 +1,7 @@
+/*
+ * Test low power capability of Portenta C33.
+ */
+
 #include <Arduino_PMIC.h>
 
 #include <Wire.h>
@@ -32,6 +36,9 @@ void setup()
   PMIC.configLDO3(Ldo3Voltage::V_1_20, false, false, false);
   PMIC.configSw2(Sw2Voltage::V_3_30, Sw2Voltage::V_3_30, Sw2Voltage::V_3_30, Sw2CurrentLimit::I_1_5_A, false, false, false);
 
+  Serial.print("Device ID = ");
+  Serial.println(PMIC.getDeviceId(), HEX);
+
   p_cfg.low_power_mode = LPM_MODE_DEEP; //  LPM_MODE_SLEEP  LPM_MODE_STANDBY    LPM_MODE_STANDBY_SNOOZE    LPM_MODE_DEEP
   p_cfg.standby_wake_sources = LPM_STANDBY_WAKE_SOURCE_IRQ0 | LPM_STANDBY_WAKE_SOURCE_RTCALM;
   p_cfg.dtc_state_in_snooze = LPM_SNOOZE_DTC_DISABLE; // LPM_SNOOZE_DTC_ENABLE LPM_SNOOZE_DTC_DISABLE

examples/ReadWriteRegs/ReadWriteRegs.ino

@@ -1,40 +1,40 @@
-#include "Arduino_PMIC.h"
-#include "PF1550/PF1550_Register.h"
+/*
+ * Read and write some registers from the PF1550 PMIC.
+ */
 
-#define Serial Serial1
+#include <Arduino_PMIC.h>
 
-uint8_t regVal;
+//#define Serial Serial1
 
-void setup() {
+void setup()
+{
   Serial.begin(115200);
   while(!Serial);
 
   PMIC.begin();
-
   PMIC.debug(Serial);
-
 }
 
 
-void loop() {
+void loop()
+{
   PMIC.writePMICreg(Register::CHARGER_CHG_EOC_CNFG, 0x41);
-  regVal = PMIC.readPMICreg(Register::CHARGER_CHG_EOC_CNFG);
+  uint8_t reg_val = PMIC.readPMICreg(Register::CHARGER_CHG_EOC_CNFG);
 
   Serial.print("CHARGER_CHG_SNS register value: ");
-  Serial.println(regVal,HEX);
+  Serial.println(reg_val,HEX);
 
-  regVal = PMIC.readPMICreg(Register::CHARGER_VBUS_SNS);
+  reg_val = PMIC.readPMICreg(Register::CHARGER_VBUS_SNS);
 
   Serial.print("CHARGER_VBUS_SNS register value: ");
-  Serial.println(regVal,HEX);
+  Serial.println(reg_val,HEX);
 
-  regVal = PMIC.readPMICreg(Register::CHARGER_CHG_INT_OK);
+  reg_val = PMIC.readPMICreg(Register::CHARGER_CHG_INT_OK);
 
   Serial.print("CHARGER_CHG_INT_OK register value: ");
-  Serial.println(regVal,HEX);
+  Serial.println(reg_val,HEX);
   Serial.println();
   Serial.println();
 
   delay(5000);
-  
 }

src/PF1550.cpp

@@ -22,14 +22,16 @@
 
 #include "PF1550.h"
 
-#include "PF1550/PF1550_Io_C33.h"
-#include "PF1550/PF1550_Io_EnvieH747.h"
+#include <Wire.h>
+
+#include "PF1550/PF1550_IO_C33.h"
+#include "PF1550/PF1550_IO_Portenta_H7.h"
 
 /******************************************************************************
    CTOR/DTOR
  ******************************************************************************/
 
-PF1550::PF1550(interface::PF1550_Io & io)
+PF1550::PF1550(PF1550_IO & io)
 : _control(io),
   _debug(NULL)
 {
@@ -54,12 +56,12 @@ void PF1550::debug(Stream& stream)
   _control.debug(stream);
 }
 
-void PF1550::setPMICbit(Register const reg_addr, uint8_t posBit)
+void PF1550::setPMICbit(Register const reg_addr, uint8_t const posBit)
 {
   _control.setBit(reg_addr, posBit);
 }
 
-void PF1550::writePMICreg(Register const reg_addr, uint8_t val)
+void PF1550::writePMICreg(Register const reg_addr, uint8_t const val)
 {
   if (_debug) {
     _debug->print("PF1550::writePMICreg at address=");
@@ -144,9 +146,9 @@ void PF1550::configSw2(Sw2Voltage      const sw2_volt,
 }
 
 void PF1550::configCharger(IFastCharge        const i_fast_charge,
-                                        VFastCharge        const v_fast_charge,
-                                        IEndOfCharge       const i_end_of_charge,
-                                        IInputCurrentLimit const i_input_current_limit)
+                           VFastCharge        const v_fast_charge,
+                           IEndOfCharge       const i_end_of_charge,
+                           IInputCurrentLimit const i_input_current_limit)
 {
   _control.setFastChargeCurrent (i_fast_charge);
   _control.setFastChargeVoltage (v_fast_charge);
@@ -159,9 +161,9 @@ void PF1550::configCharger(IFastCharge        const i_fast_charge,
  ******************************************************************************/
 
 #ifdef ARDUINO_PORTENTA_H33
-static PF1550_Io_C33 io(interface::PF1550_I2C_DEFAULT_ADDR);
+static PF1550_IO_C33         io(&Wire3, PF1550_I2C_DEFAULT_ADDR);
 #else
-static PF1550_Io_EnvieH747 io(interface::PF1550_I2C_DEFAULT_ADDR);
+static PF1550_IO_Portenta_H7 io(&Wire1, PF1550_I2C_DEFAULT_ADDR);
 #endif
 
 PF1550 PMIC(io);

src/PF1550.h

@@ -19,13 +19,15 @@
 #ifndef ARDUINO_PF1550_H_
 #define ARDUINO_PF1550_H_
 
-#define PF1550_I2C_ADDR (interface::PF1550_I2C_DEFAULT_ADDR)
+#define PF1550_I2C_ADDR (PF1550_I2C_DEFAULT_ADDR)
 
 /******************************************************************************
    INCLUDE
  ******************************************************************************/
-#include "Arduino.h"
-#include "PF1550/interface/PF1550_Io.h"
+
+#include <Arduino.h>
+
+#include "PF1550/PF1550_IO.h"
 #include "PF1550/PF1550_Types.h"
 #include "PF1550/PF1550_Control.h"
 #include "PF1550/PF1550_Register.h"
@@ -34,7 +36,7 @@
    EXTERN DECLARATION
  ******************************************************************************/
 
-class PF1550; /* Forward declaration of class PF1550 */
+class PF1550;
 extern PF1550 PMIC;
 
 /******************************************************************************
@@ -45,14 +47,14 @@ class PF1550
 {
 public:
 
-  PF1550(interface::PF1550_Io & io);
+  PF1550(PF1550_IO & io);
 
   int begin();
 
   void debug(Stream& stream);
 
-  void setPMICbit(Register const reg_addr, uint8_t posBit);
-  void writePMICreg(Register const reg_addr, uint8_t val);
+  void setPMICbit(Register const reg_addr, uint8_t const posBit);
+  void writePMICreg(Register const reg_addr, uint8_t const val);
   uint8_t readPMICreg(Register const reg_addr);
 
   void configLDO1(Ldo1Voltage const ldo_1_volt, bool const enable, bool const enable_in_standby, bool const enable_in_sleep);
@@ -71,18 +73,18 @@ class PF1550
                      VFastCharge        const v_fast_charge,
                      IEndOfCharge       const i_end_of_charge,
                      IInputCurrentLimit const i_input_current_limit);
-  
+
+  uint8_t getDeviceId() { return _control.getDeviceId(); }
+
   /* Static function registered to be executed from within external interrupt ISR */
   static void ISR_onPMICEvent() { PMIC.onPMICEvent(); }
   /* Actual PMIC event ISR handler with access to member variables */
   inline void onPMICEvent() { _control.onPMICEvent(); }
 
-private:
 
+private:
   PF1550_Control _control;
-
   Stream* _debug;
-
 };
 
 #endif /* ARDUINO_PF1550_H_ */

src/PF1550/PF1550_Control.cpp

@@ -30,7 +30,7 @@
    CTOR/DTOR
  ******************************************************************************/
 
-PF1550_Control::PF1550_Control(interface::PF1550_Io & io)
+PF1550_Control::PF1550_Control(PF1550_IO & io)
 : _io(io)
 {
 
@@ -56,21 +56,16 @@ void PF1550_Control::setBit(Register const reg, uint8_t const bit_pos)
   _io.setBit(reg, bit_pos);
 }
 
-void PF1550_Control::writeReg(Register const reg_addr, uint8_t val)
+void PF1550_Control::writeReg(Register const reg_addr, uint8_t const val)
 {
-  uint8_t i2c_data[2];
-  
-  i2c_data[0] = (uint8_t)reg_addr;
-  i2c_data[1] = val;
-
   if (_debug) {
-    _debug->print("PF1550_Control::writeReg at address=");
-    _debug->print(i2c_data[0], HEX);
+    _debug->print("PF1550_Control::writeReg at address = ");
+    _debug->print(static_cast<uint8_t>(reg_addr), HEX);
     _debug->print(" data=");
-    _debug->println(i2c_data[1], HEX);
+    _debug->println(val, HEX);
   }
 
-  _io.writeRegister(PF1550_I2C_ADDR, i2c_data, 2, 0);
+  _io.writeRegister(reg_addr, val);
 }
 
 void PF1550_Control::readReg(Register const reg_addr, uint8_t *data)

src/PF1550/PF1550_Control.h

@@ -24,7 +24,7 @@
  ******************************************************************************/
 
 #include "PF1550_Types.h"
-#include "interface/PF1550_Io.h"
+#include "PF1550_IO.h"
 #include "Arduino.h"
 
 /******************************************************************************
@@ -42,15 +42,15 @@ class PF1550_Control
 
 public:
 
-  PF1550_Control(interface::PF1550_Io & io);
+  PF1550_Control(PF1550_IO & io);
 
 
   int begin();
   void debug(Stream& stream);
 
-  void setBit(Register const reg, uint8_t const bit_pos);
-  void writeReg(Register const reg_addr, uint8_t val);
-  void readReg(Register const reg_addr, uint8_t *data);
+  void setBit  (Register const reg, uint8_t const bit_pos);
+  void writeReg(Register const reg_addr, uint8_t const val);
+  void readReg (Register const reg_addr, uint8_t * data);
 
   /* LDO1 Configuration *******************************************************/
   void setLDO1Voltage   (Ldo1Voltage const ldo1_volt);
@@ -87,7 +87,7 @@ class PF1550_Control
 
 private:
 
-  interface::PF1550_Io & _io;
+  PF1550_IO & _io;
 
   void onChargerEvent();
   void onSwitch1Event();

src/PF1550/interface/PF1550_Io.cpp renamed to src/PF1550/PF1550_IO.cpp

@@ -21,49 +21,68 @@
  ******************************************************************************/
 
 #include "PF1550.h"
-#include "PF1550_Io.h"
+#include "PF1550_IO.h"
 
 #include <assert.h>
 
 /******************************************************************************
-   NAMESPACE
+   CTOR/DTOR
  ******************************************************************************/
 
-namespace interface
+PF1550_IO::PF1550_IO(arduino::HardwareI2C * wire, uint8_t const i2c_addr)
+: _wire{wire}
+, _i2c_addr{i2c_addr}
+, _debug{nullptr}
 {
 
+}
+
 /******************************************************************************
    PUBLIC MEMBER FUNCTIONS
  ******************************************************************************/
 
-void PF1550_Io::setBit(Register const reg, uint8_t const bit_pos)
+int PF1550_IO::begin()
+{
+  _wire->begin();
+  _wire->setClock(100000);
+  return derived_begin();
+}
+
+void PF1550_IO::readRegister(Register const reg_addr, uint8_t * data)
+{
+  _wire->beginTransmission(_i2c_addr);
+  _wire->write(static_cast<uint8_t>(reg_addr));
+  _wire->endTransmission(false); /* No Stop. */
+
+  _wire->requestFrom(_i2c_addr, 1, true);
+  while (_wire->available() < 1) { }
+  *data = _wire->read();
+}
+
+void PF1550_IO::writeRegister(Register const reg_addr, uint8_t const data)
+{
+  _wire->beginTransmission(_i2c_addr);
+  _wire->write(static_cast<uint8_t>(reg_addr));
+  _wire->write(data);
+  _wire->endTransmission(true);
+}
+
+void PF1550_IO::setBit(Register const reg, uint8_t const bit_pos)
 {
   assert(bit_pos < 8);
   uint8_t reg_val;
   readRegister(reg, &reg_val);
   reg_val |= (1<<bit_pos);
 
-  uint8_t i2c_data[2];
-  i2c_data[0] = (uint8_t)reg;
-  i2c_data[1] = reg_val;
-  writeRegister(PF1550_I2C_ADDR, i2c_data, 2, 0);
+  writeRegister(reg, reg_val);
 }
 
-void PF1550_Io::clrBit(Register const reg, uint8_t const bit_pos)
+void PF1550_IO::clrBit(Register const reg, uint8_t const bit_pos)
 {
   assert(bit_pos < 8);
   uint8_t reg_val;
   readRegister(reg, &reg_val);
   reg_val &= ~(1<<bit_pos);
 
-  uint8_t i2c_data[2];
-  i2c_data[0] = (uint8_t)reg;
-  i2c_data[1] = reg_val;
-  writeRegister(PF1550_I2C_ADDR, i2c_data, 2, 0);
+  writeRegister(reg, reg_val);
 }
-
-/******************************************************************************
-   NAMESPACE
- ******************************************************************************/
-
-} /* interface */