Correct typos in comments and documentation

Author: per1234

examples/BatteryCharger/BatteryCharger.ino

@@ -1,11 +1,11 @@
 /*
-  Battery charge Example
+  Battery Charge Example
 
   This example shows how to configure and enable charge mode on Arduino MKR boards
 
   Circuit:
   - Arduino MKR board
-  - 750 mAh lipo battery
+  - 750 mAh LiPo battery
 
   created 21 Aug 2019
   by Riccardo Rizzo
@@ -46,8 +46,8 @@ void setup() {
   }
 
   // Set the charge current to 375 mA
-  // the charge current should be definde as maximum at (C for hour)/2h
-  // to avoid battery explosion (for example for a 750mAh battery set to 0.375 A)
+  // the charge current should be defined as maximum at (C for hour)/2h
+  // to avoid battery explosion (for example for a 750 mAh battery set to 0.375 A)
   if (!PMIC.setChargeCurrent(0.375)) {
     Serial.println("Error in set charge current");
   }
@@ -77,4 +77,4 @@ void loop() {
     //isbatteryconnected = false;
   }
   delay(100);
-}
+}

examples/BatteryChargerInterrupt/BatteryChargerInterrupt.ino

@@ -1,11 +1,11 @@
 /*
-  Battery charge Interrupt Example
+  Battery Charge Interrupt Example
 
   This example shows how to configure and enable charge mode on Arduino MKR boards
 
   Circuit:
   - Arduino MKR board
-  - 750 mAh lipo battery
+  - 750 mAh LiPo battery
 
   created 21 Aug 2019
   by Riccardo Rizzo
@@ -15,15 +15,15 @@
 
 #include <Arduino_PMIC.h>
 
-volatile unsigned long time_last_interrurpt = millis();
+volatile unsigned long time_last_interrupt = millis();
 
 void setup() {
   Serial.begin(9600);
   while (!Serial) {
     ; // wait for serial port to connect. Needed for native USB port only
   }
 
-  // Attach the PMIC irq pin
+  // Attach the PMIC IRQ pin
   attachInterrupt(digitalPinToInterrupt(PMIC_IRQ_PIN), batteryConnected, FALLING);
 
   if (!PMIC.begin()) {
@@ -51,7 +51,7 @@ void setup() {
   }
 
   // Set the charge current to 375 mA
-  // the charge current should be definde as maximum at (C for hour)/2h
+  // the charge current should be defined as maximum at (C for hour)/2h
   // to avoid battery explosion (for example for a 750mAh battery set to 0.375 A)
   if (!PMIC.setChargeCurrent(0.375)) {
     Serial.println("Error in set charge current");
@@ -60,7 +60,7 @@ void setup() {
 }
 
 void loop() {
-  if (millis() - time_last_interrurpt > 100) {
+  if (millis() - time_last_interrupt > 100) {
     // Enable the Charger
     if (!PMIC.enableCharge()) {
       Serial.println("Error enabling Charge mode");
@@ -93,5 +93,5 @@ void loop() {
 }
 
 void batteryConnected() {
-  time_last_interrurpt = millis();
-}
+  time_last_interrupt = millis();
+}

examples/PMICBoostMode/PMICBoostMode.ino

@@ -1,5 +1,5 @@
 /*
-  PMIC Boost mode Example
+  PMIC Boost Mode Example
 
   This example shows how to enable boost mode on Arduino MKR boards
 
@@ -20,15 +20,15 @@ int usb_mode = UNKNOWM_MODE;
 void setup()
 {
   // Serial1 shall be used to print messages because the programming
-  // Port is busy by the guest device
+  // port is busy with the guest device
   Serial1.begin(9600);
   if (!PMIC.begin()) {
     Serial1.println("Failed to initialize PMIC!");
     while (1);
   }
 
-  // Enable boost mode, this mode allow to use the board as host and
-  // connect guest device like keyboard
+  // Enable boost mode, this mode allows using the board as host to
+  // connect a guest device such as a keyboard
   if (!PMIC.enableBoostMode()) {
     Serial1.println("Error enabling Boost Mode");
   }
@@ -40,9 +40,9 @@ void loop() {
   if (actual_mode != usb_mode) {
     usb_mode = actual_mode;
     if (actual_mode == BOOST_MODE) {
-      // if the boost mode was correctly enabled 5V should appear on 5V pin
+      // if the boost mode was correctly enabled, 5 V should appear on 5V pin
       // and on the USB connector
       Serial1.println("Boost mode status enabled");
     }
   }
-}
+}

examples/PMICFaultCheck/PMICFaultCheck.ino

@@ -1,5 +1,5 @@
 /*
-  PMIC fault Check Example
+  PMIC Fault Check Example
 
   This example shows how to check the PMIC fault states
 
@@ -37,7 +37,7 @@ void loop() {
       break;
     case THERMAL_SHUTDOWN: Serial.println("Thermal shutdown occurred");
       break;
-    case CHARGE_SAFETY_TIME_EXPIRED: Serial.println("Charge safetly timer expired");
+    case CHARGE_SAFETY_TIME_EXPIRED: Serial.println("Charge safety timer expired");
       break;
     case NO_CHARGE_FAULT: Serial.println("No Charge fault");
       break;
@@ -62,4 +62,4 @@ void loop() {
       break;
     default: break;
   }
-}
+}

keywords.txt

@@ -1,5 +1,5 @@
 #######################################
-# Syntax Coloring Map For Arduino_PMIC
+# Syntax Coloring Map For Arduino_BQ24195
 ####################################### 
 # Class
 #######################################
@@ -73,4 +73,4 @@ USB_HOST_MODE	LITERAL1
 ADAPTER_PORT_MODE	LITERAL1
 BOOST_MODE	LITERAL1
 
-PMIC_IRQ_PIN LITERAL1
+PMIC_IRQ_PIN LITERAL1

src/Arduino_PMIC.h

@@ -1,5 +1,5 @@
 /*
-  This file is part of the Arduino_PMIC library.
+  This file is part of the Arduino_BQ24195 library.
   Copyright (c) 2019 Arduino SA. All rights reserved.
 
   This library is free software; you can redistribute it and/or

src/BQ24195.cpp

@@ -1,5 +1,5 @@
 /*
-  This file is part of the Arduino_PMIC library.
+  This file is part of the Arduino_BQ24195 library.
   Copyright (c) 2019 Arduino SA. All rights reserved.
 
   This library is free software; you can redistribute it and/or
@@ -147,7 +147,7 @@ bool PMICClass::enableCharge() {
 
 /*******************************************************************************
  * Function Name  : enableBoostMode
- * Description    : Enables PMIC boost mode, allow to generate 5V from battery
+ * Description    : Enables PMIC boost mode, allow to generate 5 V from battery
  * Input          : NONE
  * Return         : 0 on Error, 1 on Success
  *******************************************************************************/
@@ -278,10 +278,10 @@ bool PMICClass::setInputVoltageLimit(float voltage) {
         voltage = 3.88;
     }
 
-    // round(((desired voltage - base_voltage_offset) / minimum_votage_value) * LSB value)
+    // round(((desired voltage - base_voltage_offset) / minimum_voltage_value) * LSB value)
     // where:
     // - BASE_VOLTAGE_OFFSET = 3.88 V;
-    // - minimum_votage_value = 0.008 V (80 mV);
+    // - minimum_voltage_value = 0.008 V (80 mV);
     // - LSB value = 8;
     // after mask with & 0x78 to set only the input voltage bits
     return writeRegister(INPUT_SOURCE_REGISTER, (mask | (round((voltage - 3.88) * 100) & 0x78)));
@@ -543,7 +543,7 @@ bool PMICClass::resetWatchdog() {
 /*******************************************************************************
  * Function Name  : setMinimumSystemVoltage
  * Description    : Set the minimum acceptable voltage to feed the onboard
-                    mcu and module
+                    MCU and module
  * Input          : Minimum system voltage in Volt
  * Return         : 0 Error, 1 Success
 *******************************************************************************/
@@ -887,7 +887,7 @@ bool PMICClass::disableBATFET(void) {
  * Function Name  : enableChargeFaultINT
  * Description    : Enable interrupt during Charge fault
  * Input          : NONE
- * Return         : 0 on Error, 1 on Succes
+ * Return         : 0 on Error, 1 on Success
 *******************************************************************************/
 bool PMICClass::enableChargeFaultINT() {
     int  DATA = readRegister(MISC_CONTROL_REGISTER);
@@ -905,7 +905,7 @@ bool PMICClass::enableChargeFaultINT() {
  * Function Name  : disableChargeFaultINT
  * Description    : Disable interrupt during Charge fault
  * Input          : NONE
- * Return         : 0 on Error, 1 on Succes
+ * Return         : 0 on Error, 1 on Success
 *******************************************************************************/
 bool PMICClass::disableChargeFaultINT() {
     int  DATA = readRegister(MISC_CONTROL_REGISTER);
@@ -923,7 +923,7 @@ bool PMICClass::disableChargeFaultINT() {
  * Function Name  : enableBatFaultINT
  * Description    : Enable interrupt during battery fault
  * Input          : NONE
- * Return         : 0 on Error, 1 on Succes
+ * Return         : 0 on Error, 1 on Success
 *******************************************************************************/
 bool PMICClass::enableBatFaultINT(){
     int  DATA = readRegister(MISC_CONTROL_REGISTER);
@@ -941,7 +941,7 @@ bool PMICClass::enableBatFaultINT(){
  * Function Name  : disableBatFaultINT
  * Description    : Disable interrupt during battery fault
  * Input          : NONE
- * Return         : 0 on Error, 1 on Succes
+ * Return         : 0 on Error, 1 on Success
 *******************************************************************************/
 bool PMICClass::disableBatFaultINT() {
     int  DATA = readRegister(MISC_CONTROL_REGISTER);
@@ -1024,7 +1024,7 @@ bool PMICClass::isPowerGood(void) {
  * Function Name  : isHot
  * Description    : Check if is in Thermal Regulation
  * Input          : NONE
- * Return         : 0 on Nomral state, 1 on Thermal Regulation state
+ * Return         : 0 on Normal state, 1 on Thermal Regulation state
  *******************************************************************************/
 bool PMICClass::isHot(void) {
 
@@ -1087,7 +1087,7 @@ bool PMICClass::isBattConnected(void) {
 }
 
 /*******************************************************************************
- * Function Name  : readSystemStatusRegeister
+ * Function Name  : readSystemStatusRegister
  * Description    : Query the PMIC and returns the System Status Register value
  * Input          : NONE
  * Return         : -1 on Error, System Status Register byte on Success
@@ -1236,4 +1236,4 @@ int PMICClass::writeRegister(byte address, byte val) {
   return 1;
 }
 
-PMICClass PMIC(Wire);
+PMICClass PMIC(Wire);

src/BQ24195.h

@@ -1,5 +1,5 @@
 /*
-  This file is part of the Arduino_PMIC library.
+  This file is part of the Arduino_BQ24195 library.
   Copyright (c) 2019 Arduino SA. All rights reserved.
 
   This library is free software; you can redistribute it and/or