Skip to content

Commit f417a05

Browse files
committed
Readme update
1 parent a75b859 commit f417a05

File tree

5 files changed

+15
-10
lines changed

5 files changed

+15
-10
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,27 @@ This is a helper library to abstract away I2C transactions and registers.
1010

1111
```C++
1212
// Declare Object
13-
I2C_Functions HDC2010(0x40, true, 3);
13+
I2C_Functions HDC2010(0x40, true, 3); // Connect 0x40 adres with I2C mux channel 3
14+
15+
// Write Register
16+
HDC2010.Write_Register(0x10, 0x22, true); // Write 0x22 data to 0x10 register
17+
18+
// Read Register
19+
uint8_t Result = HDC2010.Read_Register(0x01); // Read register 0x01
1420
```
1521
1622
Library includes some helper I2C functions and a generic I2C multiplexer function.
1723
1824
* Read_Register
1925
* Write_Register
2026
* Read_Multiple_Register
27+
* Read_Multiple_Register_u16
2128
* Write_Multiple_Register
2229
* Write_Command
30+
* Write_Multiple_Command
2331
* Set_Register_Bit
2432
* Clear_Register_Bit
2533
* Read_Register_Bit
26-
* BCDtoDEC
27-
* DECtoBCD
2834
* Control_Device
2935
* Detect
3036
* Address

library.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "I2C_Functions",
3-
"version": "1.8.2",
3+
"version": "1.8.3",
44
"repository": {
55
"type": "git",
66
"url": "https://github.com/akkoyun/I2C_Functions.git"

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name=I2C_Functions
2-
version=1.8.2
2+
version=1.8.3
33
author=Gunce Akkoyun <[email protected]>
44
maintainer=Gunce Akkoyun <[email protected]>
55
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.

src/Definition.h

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// I2C Library Definitions
2-
#define __I2C_Functions_Version__ "01.06.03"
2+
#define __I2C_Functions_Version__ "01.08.03"
33

44
// Sensor Address Definitions
55
#define __I2C_Addr_TCA9548__ (uint8_t)0x70
@@ -10,7 +10,6 @@
1010
#define __I2C_Addr_BQ24298__ (uint8_t)0x6B
1111
#define __I2C_Addr_SHT21__ (uint8_t)0x40
1212
#define __I2C_Addr_SDP810__ (uint8_t)0x25
13-
1413
#define __I2C_Addr_PCF8574_A__ (uint8_t)0x3F
1514
#define __I2C_Addr_PCF8574_B__ (uint8_t)0x3B
1615
#define __I2C_Addr_PCF8574_C__ (uint8_t)0x39

src/I2C_Functions.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33

44
// Include Arduino Library
55
#ifndef __Arduino__
6-
#include <Arduino.h>
6+
#include <Arduino.h>
77
#endif
88

99
// Include Wire Library
1010
#ifndef __Wire__
11-
#include <Wire.h>
11+
#include <Wire.h>
1212
#endif
1313

1414
// Include Definitions
1515
#ifndef __I2C_Functions_Definitions__
16-
#include "Definition.h"
16+
#include "Definition.h"
1717
#endif
1818

1919
// I2C Control Functions

0 commit comments

Comments
 (0)