Readme update

akkoyun · Jul 28, 2022 · f417a05 · f417a05
1 parent a75b859
commit f417a05
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -10,21 +10,27 @@ This is a helper library to abstract away I2C transactions and registers.
 
 ```C++
 // Declare Object
-I2C_Functions HDC2010(0x40, true, 3);
+I2C_Functions HDC2010(0x40, true, 3); // Connect 0x40 adres with I2C mux channel 3
+
+// Write Register
+HDC2010.Write_Register(0x10, 0x22, true); // Write 0x22 data to 0x10 register
+
+// Read Register
+uint8_t Result = HDC2010.Read_Register(0x01); // Read register 0x01
 ```
 
 Library includes some helper I2C functions and a generic I2C multiplexer function.
 
     * Read_Register
     * Write_Register
     * Read_Multiple_Register
+    * Read_Multiple_Register_u16
     * Write_Multiple_Register
     * Write_Command
+    * Write_Multiple_Command
     * Set_Register_Bit
     * Clear_Register_Bit
     * Read_Register_Bit
-    * BCDtoDEC
-    * DECtoBCD
     * Control_Device
     * Detect
     * Address

diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
 	"name": "I2C_Functions",
-	"version": "1.8.2",
+	"version": "1.8.3",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/akkoyun/I2C_Functions.git"

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=I2C_Functions
-version=1.8.2
+version=1.8.3
 author=Gunce Akkoyun <akkoyun@me.com>
 maintainer=Gunce Akkoyun <akkoyun@me.com>
 sentence=This is a helper library to abstract away I2C transactions and registers also this tool scans the master I2C bus and reports connected devices. 

diff --git a/src/Definition.h b/src/Definition.h
@@ -1,5 +1,5 @@
 // I2C Library Definitions
-#define __I2C_Functions_Version__	"01.06.03"
+#define __I2C_Functions_Version__	"01.08.03"
 
 // Sensor Address Definitions
 #define __I2C_Addr_TCA9548__		(uint8_t)0x70
@@ -10,7 +10,6 @@
 #define __I2C_Addr_BQ24298__		(uint8_t)0x6B
 #define __I2C_Addr_SHT21__			(uint8_t)0x40
 #define __I2C_Addr_SDP810__			(uint8_t)0x25
-
 #define __I2C_Addr_PCF8574_A__		(uint8_t)0x3F
 #define __I2C_Addr_PCF8574_B__		(uint8_t)0x3B
 #define __I2C_Addr_PCF8574_C__		(uint8_t)0x39

diff --git a/src/I2C_Functions.h b/src/I2C_Functions.h
@@ -3,17 +3,17 @@
 
 // Include Arduino Library
 #ifndef __Arduino__
-#include <Arduino.h>
+	#include <Arduino.h>
 #endif
 
 // Include Wire Library
 #ifndef __Wire__
-#include <Wire.h>
+	#include <Wire.h>
 #endif
 
 // Include Definitions
 #ifndef __I2C_Functions_Definitions__
-#include "Definition.h"
+	#include "Definition.h"
 #endif
 
 // I2C Control Functions