Skip to content

Commit

Permalink
Merge pull request #59 from SV-Zanshin/Development_v1.0.11
Browse files Browse the repository at this point in the history
Development v1.0.11
  • Loading branch information
Arnd authored Jun 30, 2020
2 parents e1e596d + 0521b1c commit ccbe126
Show file tree
Hide file tree
Showing 22 changed files with 2,258 additions and 5,693 deletions.
175 changes: 175 additions & 0 deletions .clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
################################################################################
## Google formatting file. Auto-generated from "LLVM" Style and then modified ##
## ##
## Date Developer Description ##
## ========== ========== =====================================================##
## 2020-06-30 SV-Zanshin Changed indentation ##
## ##
################################################################################
---
Language: Cpp
AccessModifierOffset: -1
AlignAfterOpenBracket: Align
AlignConsecutiveMacros: true
AlignConsecutiveAssignments: true
AlignConsecutiveDeclarations: true
AlignEscapedNewlines: Left
AlignOperands: true
AlignTrailingComments: true
AllowAllArgumentsOnNextLine: true
AllowAllConstructorInitializersOnNextLine: true
AllowAllParametersOfDeclarationOnNextLine: true
AllowShortBlocksOnASingleLine: Never
AllowShortCaseLabelsOnASingleLine: false
AllowShortFunctionsOnASingleLine: All
AllowShortLambdasOnASingleLine: All
AllowShortIfStatementsOnASingleLine: WithoutElse
AllowShortLoopsOnASingleLine: true
AlwaysBreakAfterDefinitionReturnType: None
AlwaysBreakAfterReturnType: None
AlwaysBreakBeforeMultilineStrings: true
AlwaysBreakTemplateDeclarations: Yes
BinPackArguments: true
BinPackParameters: true
BraceWrapping:
AfterCaseLabel: false
AfterClass: false
AfterControlStatement: false
AfterEnum: false
AfterFunction: false
AfterNamespace: false
AfterObjCDeclaration: false
AfterStruct: false
AfterUnion: false
AfterExternBlock: false
BeforeCatch: false
BeforeElse: false
IndentBraces: false
SplitEmptyFunction: true
SplitEmptyRecord: true
SplitEmptyNamespace: true
BreakBeforeBinaryOperators: None
BreakBeforeBraces: Attach
BreakBeforeInheritanceComma: false
BreakInheritanceList: BeforeColon
BreakBeforeTernaryOperators: true
BreakConstructorInitializersBeforeComma: false
BreakConstructorInitializers: BeforeColon
BreakAfterJavaFieldAnnotations: false
BreakStringLiterals: true
ColumnLimit: 100
CommentPragmas: '^\\.+'
CompactNamespaces: false
ConstructorInitializerAllOnOneLineOrOnePerLine: true
ConstructorInitializerIndentWidth: 4
ContinuationIndentWidth: 4
Cpp11BracedListStyle: true
DeriveLineEnding: true
DerivePointerAlignment: true
DisableFormat: false
ExperimentalAutoDetectBinPacking: false
FixNamespaceComments: true
ForEachMacros:
- foreach
- Q_FOREACH
- BOOST_FOREACH
IncludeBlocks: Regroup
IncludeCategories:
- Regex: '^<ext/.*\.h>'
Priority: 2
SortPriority: 0
- Regex: '^<.*\.h>'
Priority: 1
SortPriority: 0
- Regex: '^<.*'
Priority: 2
SortPriority: 0
- Regex: '.*'
Priority: 3
SortPriority: 0
IncludeIsMainRegex: '([-_](test|unittest))?$'
IncludeIsMainSourceRegex: ''
IndentCaseLabels: true
IndentGotoLabels: true
IndentPPDirectives: None
IndentWidth: 2
IndentWrappedFunctionNames: false
JavaScriptQuotes: Leave
JavaScriptWrapImports: true
KeepEmptyLinesAtTheStartOfBlocks: false
MacroBlockBegin: ''
MacroBlockEnd: ''
MaxEmptyLinesToKeep: 1
NamespaceIndentation: None
ObjCBinPackProtocolList: Never
ObjCBlockIndentWidth: 2
ObjCSpaceAfterProperty: false
ObjCSpaceBeforeProtocolList: true
PenaltyBreakAssignment: 2
PenaltyBreakBeforeFirstCallParameter: 1
PenaltyBreakComment: 300
PenaltyBreakFirstLessLess: 120
PenaltyBreakString: 1000
PenaltyBreakTemplateDeclaration: 10
PenaltyExcessCharacter: 1000000
PenaltyReturnTypeOnItsOwnLine: 200
PointerAlignment: Left
RawStringFormats:
- Language: Cpp
Delimiters:
- cc
- CC
- cpp
- Cpp
- CPP
- 'c++'
- 'C++'
CanonicalDelimiter: ''
BasedOnStyle: google
- Language: TextProto
Delimiters:
- pb
- PB
- proto
- PROTO
EnclosingFunctions:
- EqualsProto
- EquivToProto
- PARSE_PARTIAL_TEXT_PROTO
- PARSE_TEST_PROTO
- PARSE_TEXT_PROTO
- ParseTextOrDie
- ParseTextProtoOrDie
CanonicalDelimiter: ''
BasedOnStyle: google
ReflowComments: true
SortIncludes: true
SortUsingDeclarations: true
SpaceAfterCStyleCast: false
SpaceAfterLogicalNot: false
SpaceAfterTemplateKeyword: true
SpaceBeforeAssignmentOperators: true
SpaceBeforeCpp11BracedList: false
SpaceBeforeCtorInitializerColon: true
SpaceBeforeInheritanceColon: true
SpaceBeforeParens: ControlStatements
SpaceBeforeRangeBasedForLoopColon: true
SpaceInEmptyBlock: false
SpaceInEmptyParentheses: false
SpacesBeforeTrailingComments: 2
SpacesInAngles: false
#SpacesInConditionalStatement: false
SpacesInContainerLiterals: true
SpacesInCStyleCastParentheses: false
SpacesInParentheses: false
SpacesInSquareBrackets: false
SpaceBeforeSquareBrackets: false
Standard: Auto
StatementMacros:
- Q_UNUSED
- QT_REQUIRE_VERSION
TabWidth: 8
UseCRLF: false
UseTab: Never
...

2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

![Zanshin Logo](https://www.sv-zanshin.com/r/images/site/gif/zanshinkanjitiny.gif) <img src="https://www.sv-zanshin.com/r/images/site/gif/zanshintext.gif" width="75"/>
[![Zanshin Logo](https://zanduino.github.io/Images/zanshinkanjitiny.gif) <img src="https://zanduino.github.io/Images/zanshintext.gif" width="75"/>](https://www.sv-zanshin.com)
8 changes: 5 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ Push to your fork and submit a gitHub pull request.

At this point the ball is no longer in your court but on our side. There will be a response within a couple of days, at most.

Some things that will increase the spped at which a pull request is completed:
Some things that will increase the speed at which a pull request is completed:

* Write tests.
* Follow the existing coding style (comments are done with [doxygen](http://www.doxygen.nl/).
* Write as much information as a beginner would need to understand the problem and solution.
* Follow the existing coding style, using [Google Style Guide](https://google.github.io/styleguide/cppguide.html)
* Follow the existing program documentation style using [doxygen](http://www.doxygen.nl/)
* Write as much information as a beginner would need to understand the problem and solution

[![Zanshin Logo](https://zanduino.github.io/Images/zanshinkanjitiny.gif) <img src="https://zanduino.github.io/Images/zanshintext.gif" width="75"/>](https://www.sv-zanshin.com)
25 changes: 17 additions & 8 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,31 @@
---
name: Bug report
about: Submit a bug report
title: {Add Short one-line Bug title}
labels: bug
assignees: SV-Zanshin

---

## Expected Behavior

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
_Detail what the expected program behavior should be, or what is expected to happen._

## Actual Behavior

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
_Detail what actually happens._

## Steps to Reproduce the Problem

_Explain what needs to be done in order to reproduce the problem._
1.
1.
1.
2.
3.

## Specifications

- Version:
- Library Version:
- IDE Version:
- Platform:
- Subsystem:


![Zanshin Logo](https://www.sv-zanshin.com/r/images/site/gif/zanshinkanjitiny.gif) <img src="https://www.sv-zanshin.com/r/images/site/gif/zanshintext.gif" width="75"/>
- _any other details needed to reproduce the problem_
18 changes: 8 additions & 10 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
title: {add one-line description of the feature request}
labels: enhancement
assignees: SV-Zanshin

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe what the feature request is and if it solves an issue or adds functionality**
_A clear and concise description of what the problem is which would be solved by the feature request. Example "It would be helpful to add a function newFunc() to solve the problem of [...]"_

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
_A clear and concise description of what you want to have changed or added._

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
_A clear and concise description of any alternative solutions or features you've considered._

**Additional context**
Add any other context or screenshots about the feature request here.

![Zanshin Logo](https://www.sv-zanshin.com/r/images/site/gif/zanshinkanjitiny.gif) <img src="https://www.sv-zanshin.com/r/images/site/gif/zanshintext.gif" width="75"/>
_Add any other context or screenshots about the feature request here._
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/implementation-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Implementation Question
about: Ask a question about the library implementation
title: {One-Line descriptive question title}
labels: question
assignees: SV-Zanshin

---

_Ask your question or post your comment here, adding any information, examples, links, etc. that someone would reasonably be expected to have in order to give a response._
20 changes: 12 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Description
Please include a text summary of the change and which issue(s) is/are fixed or addressed. Should the change have any dependencies
then these should be listed here.
_Please include a text summary of the change and which issue(s) is/are fixed or addressed. Should the change have any dependencies
then these should be listed here._

Fixes # (issue)
In order to make tracking easier and to properly document the process,
pull requests should always refer to an active issue in the list - be it a bug fix or an enhancement or some other type of issue.
_In order to make tracking easier and to properly document the process,
pull requests should always refer to an active issue in the list - be it a bug fix or an enhancement or some other type of issue._

## Type of change

Please delete options that are not relevant.
_Please delete options that are not relevant._

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
Expand All @@ -17,26 +17,30 @@ Please delete options that are not relevant.

# How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
_Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration_

- [ ] Test A
- [ ] Test B

**Test Configuration**:
* Arduino version:
* Arduino Hardware:
* SDK: (Arduino IDE, Atmel Studio, etc.)
* SDK: (Arduino IDE, Atmel Studio, Visual Studio, Visual Micro, etc.)
* Development sytem: (Windows, Web, Linux, etc.)

# Checklist:

- [ ] The changes made link back to an existing issue number
- [ ] I have performed a self-review of my own code
- [ ] My code follows the style guidelines of this project
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] The code adheres to the [Google Style Guide](https://google.github.io/styleguide/cppguide.html)
- [ ] The code follows the existing program documentation style using [doxygen](http://www.doxygen.nl/)
- [ ] I have made corresponding changes to the documentation / Wiki Page(s)
- [ ] My changes generate no new warnings
- [ ] The automated TRAVIS-CI run has a status of "passed"
- [ ] I have checked potential areas where regression errors could occur and have found no issues
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes

![Zanshin Logo](https://www.sv-zanshin.com/r/images/site/gif/zanshinkanjitiny.gif) <img src="https://www.sv-zanshin.com/r/images/site/gif/zanshintext.gif" width="75"/>
[![Zanshin Logo](https://zanduino.github.io/Images/zanshinkanjitiny.gif) <img src="https://zanduino.github.io/Images/zanshintext.gif" width="75"/>](https://www.sv-zanshin.com)
5 changes: 3 additions & 2 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="../images/horizontal_narrow.png" alt="INA" align="right" height="40px">

# INA2*xx* Devices<br>[![Build Status](https://travis-ci.org/SV-Zanshin/INA.svg?branch=master)](https://travis-ci.org/SV-Zanshin/INA) [![DOI](https://zenodo.org/badge/136879464.svg)](https://zenodo.org/badge/latestdoi/136879464) [![arduino-library-badge](https://www.ardu-badge.com/badge/INA2xx.svg?)](https://www.ardu-badge.com/INA2xx) [![Doxygen](https://github.com/SV-Zanshin/BME680/blob/master/Images/Doxygen-complete.svg)](https://sv-zanshin.github.io/INA/html/index.html) [![Wiki](https://github.com/SV-Zanshin/BME680/blob/master/Images/Documentation-wiki.svg)](https://github.com/SV-Zanshin/INA/wiki)
_Arduino_ library to access multiple INA2xx High-Side/Low-Side Bi-Directional I2C Current and Power Monitors at the same time. Details of the library methods and example programs are to be found [at the INA wiki pages](https://github.com/SV-Zanshin/INA/wiki).
_Arduino_ library to access multiple INA2xx High-Side/Low-Side Bi-Directional I2C Current and Power Monitors at the same time. Details of the library methods and example programs are to be found [at the INA wiki pages]


Texas Instruments produces this family of power monitors and the library supports the following devices:

Expand Down Expand Up @@ -30,4 +31,4 @@ Since the functionality differs between the supported devices there are some fun
The documentation has been done using Doxygen and can be found at [doxygen documentation](https://sv-zanshin.github.io/INA/html/index.html)

<img src="https://github.com/SV-Zanshin/INA/blob/master/images/horizontal_narrow.png" alt="INA" align="left" height="75px">
<img src="https://www.sv-zanshin.com/r/images/site/gif/zanshintext.gif" align="right" width="75"/><img src="https://www.sv-zanshin.com/r/images/site/gif/zanshinkanjitiny.gif" align="right">
[![Zanshin Logo](https://zanduino.github.io/Images/zanshinkanjitiny.gif) <img src="https://zanduino.github.io/Images/zanshintext.gif" width="75"/>](https://www.sv-zanshin.com)
6 changes: 3 additions & 3 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
## ##
## Date Developer Comments ##
## ========== =================== ================================================================= ##
## 2020-06-06 Arnd@SV-Zanshin Updated to version v1.0.11 ##
## 2020-05-10 Arnd@SV-Zanshin Removed all comments in order to compact this file ##
## ##
######################################################################################################

DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = INA2xx
PROJECT_NUMBER = "Version 1.0.10"
PROJECT_NUMBER = "Version 1.0.11"
PROJECT_BRIEF = "Arduino Library for INA2xx power measurement devices"
PROJECT_LOGO = images/horizontal_narrow_small.png
OUTPUT_DIRECTORY =
Expand Down Expand Up @@ -284,4 +284,4 @@ MAX_DOT_GRAPH_DEPTH = 0
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
DOT_CLEANUP = YES
Loading

0 comments on commit ccbe126

Please sign in to comment.