WireUtility Library
Generated by Doxygen 1.8.14
CONTENTS 1
Contents
1 File Index 1
1.1 File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
2 File Documentation 1
2.1 WireUtility.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
2.1.1 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2.1.2 Variable Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 WireUtility.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.2.1 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Index 11
1 File Index
1.1 File List
Here is a list of all files with brief descriptions:
WireUtility.cpp 1
WireUtility.h 6
2 File Documentation
2.1 WireUtility.cpp File Reference
#include <Wire.h>
#include <WireUtility.h>
Include dependency graph for WireUtility.cpp:
Generated by Doxygen
2 CONTENTS
Functions
• int scan (HardwareSerial &MySerial, TwoWire &ScanWire)
• int scanNext10bits (HardwareSerial &MySerial, TwoWire &ScanWire)
• int scanNext (HardwareSerial &MySerial, TwoWire &ScanWire)
• int readRegister (HardwareSerial &MySerial, TwoWire &ScanWire, int adddev, int addreg)
• int readMem2 (HardwareSerial &MySerial, TwoWire &ScanWire, int adddev, int addreg)
• int readMem3 (HardwareSerial &MySerial, TwoWire &ScanWire, int adddev, int addreg)
• void dump (HardwareSerial &MySerial, TwoWire &ScanWire, int adddev, int addreg, int size)
Variables
• int address
2.1.1 Function Documentation
2.1.1.1 dump()
void dump (
HardwareSerial & MySerial,
TwoWire & ScanWire,
int adddev,
int addreg,
int size )
This file content function to help to debug wire interface on component.dump a 8 bit address data memory map
from addreg up to (addreg+size)
Definition at line 216 of file WireUtility.cpp.
References readRegister().
Here is the call graph for this function:
Generated by Doxygen
2.1 WireUtility.cpp File Reference 3
2.1.1.2 readMem2()
int readMem2 (
HardwareSerial & MySerial,
TwoWire & ScanWire,
int adddev,
int addreg )
Definition at line 158 of file WireUtility.cpp.
2.1.1.3 readMem3()
int readMem3 (
HardwareSerial & MySerial,
TwoWire & ScanWire,
int adddev,
int addreg )
Definition at line 187 of file WireUtility.cpp.
2.1.1.4 readRegister()
int readRegister (
HardwareSerial & MySerial,
TwoWire & ScanWire,
int adddev,
int addreg )
Definition at line 131 of file WireUtility.cpp.
Referenced by dump().
Here is the caller graph for this function:
Generated by Doxygen
4 CONTENTS
2.1.1.5 scan()
int scan (
HardwareSerial & MySerial,
TwoWire & ScanWire )
scan a 7 bit device address. and stop after 1st find, use scanNext to get next.
Definition at line 36 of file WireUtility.cpp.
References address, and scanNext().
Here is the call graph for this function:
2.1.1.6 scanNext()
int scanNext (
HardwareSerial & MySerial,
TwoWire & ScanWire )
scan next 7 bit device address. if a 10bit device is found it can scanNext10bits
Definition at line 78 of file WireUtility.cpp.
References address, and scanNext10bits().
Referenced by scan().
Here is the call graph for this function:
Generated by Doxygen
2.1 WireUtility.cpp File Reference 5
Here is the caller graph for this function:
2.1.1.7 scanNext10bits()
int scanNext10bits (
HardwareSerial & MySerial,
TwoWire & ScanWire )
scan next 10 bit device address.
Definition at line 43 of file WireUtility.cpp.
References address.
Referenced by scanNext().
Here is the caller graph for this function:
2.1.2 Variable Documentation
2.1.2.1 address
int address
Definition at line 35 of file WireUtility.cpp.
Referenced by scan(), scanNext(), and scanNext10bits().
Generated by Doxygen
6 CONTENTS
2.2 WireUtility.h File Reference
#include "Arduino.h"
Include dependency graph for WireUtility.h:
This graph shows which files directly or indirectly include this file:
Functions
• void dump (HardwareSerial &MySerial, TwoWire &ScanWire, int adddev, int addreg, int size)
• int readRegister (TwoWire &ScanWire, int adddev, int addreg)
• int readMem2 (TwoWire &ScanWire, int adddev, int addreg)
• int readMem3 (TwoWire &ScanWire, int adddev, int addreg)
• int scan (HardwareSerial &MySerial, TwoWire &ScanWire)
• int scanNext (HardwareSerial &MySerial, TwoWire &ScanWire)
• int scanNext10bits (HardwareSerial &MySerial, TwoWire &ScanWire)
2.2.1 Function Documentation
Generated by Doxygen
2.2 WireUtility.h File Reference 7
2.2.1.1 dump()
void dump (
HardwareSerial & MySerial,
TwoWire & ScanWire,
int adddev,
int addreg,
int size )
This file content function to help to debug wire interface on component.dump a 8 bit address data memory map
from addreg up to (addreg+size)
Definition at line 216 of file WireUtility.cpp.
References readRegister().
Here is the call graph for this function:
2.2.1.2 readMem2()
int readMem2 (
TwoWire & ScanWire,
int adddev,
int addreg )
read a 16 bit address data(addreg)
2.2.1.3 readMem3()
int readMem3 (
TwoWire & ScanWire,
int adddev,
int addreg )
read a 24 bit address data(addreg)
2.2.1.4 readRegister()
int readRegister (
TwoWire & ScanWire,
int adddev,
int addreg )
read a 8 bit address data(addreg)
Generated by Doxygen
8 CONTENTS
2.2.1.5 scan()
int scan (
HardwareSerial & MySerial,
TwoWire & ScanWire )
scan a 7 bit device address. and stop after 1st find, use scanNext to get next.
Definition at line 36 of file WireUtility.cpp.
References address, and scanNext().
Here is the call graph for this function:
2.2.1.6 scanNext()
int scanNext (
HardwareSerial & MySerial,
TwoWire & ScanWire )
scan next 7 bit device address. if a 10bit device is found it can scanNext10bits
Definition at line 78 of file WireUtility.cpp.
References address, and scanNext10bits().
Referenced by scan().
Here is the call graph for this function:
Generated by Doxygen
2.2 WireUtility.h File Reference 9
Here is the caller graph for this function:
2.2.1.7 scanNext10bits()
int scanNext10bits (
HardwareSerial & MySerial,
TwoWire & ScanWire )
scan next 10 bit device address.
Definition at line 43 of file WireUtility.cpp.
References address.
Referenced by scanNext().
Here is the caller graph for this function:
Generated by Doxygen
Index
address
WireUtility.cpp, 5
dump
WireUtility.cpp, 2
WireUtility.h, 6
readMem2
WireUtility.cpp, 2
WireUtility.h, 7
readMem3
WireUtility.cpp, 3
WireUtility.h, 7
readRegister
WireUtility.cpp, 3
WireUtility.h, 7
scan
WireUtility.cpp, 3
WireUtility.h, 7
scanNext
WireUtility.cpp, 4
WireUtility.h, 8
scanNext10bits
WireUtility.cpp, 5
WireUtility.h, 9
WireUtility.cpp, 1
address, 5
dump, 2
readMem2, 2
readMem3, 3
readRegister, 3
scan, 3
scanNext, 4
scanNext10bits, 5
WireUtility.h, 6
dump, 6
readMem2, 7
readMem3, 7
readRegister, 7
scan, 7
scanNext, 8
scanNext10bits, 9
