Skip to content

Commit 16e935e

Browse files
committed
Updated workflows and README
1 parent 41c030c commit 16e935e

File tree

4 files changed

+14
-9
lines changed

4 files changed

+14
-9
lines changed

.github/workflows/arduino_lint.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ jobs:
1212
with:
1313
compliance: specification
1414
project-type: library
15+
library-manager: update
1516
recursive: true

.github/workflows/format.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ jobs:
88

99
steps:
1010
- uses: actions/checkout@v2
11-
- uses: DoozyX/clang-format-lint-action@v0.12
11+
- uses: DoozyX/clang-format-lint-action@v0.18.2
1212
with:
1313
source: "./src"
1414
exclude: "./src/libs"

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,28 @@
33
[![Make docs and publish to GitHub Pages](https://github.com/SolderedElectronics/Soldered-Digipot-MCP4018-Arduino-Library/actions/workflows/make_docs.yml/badge.svg?branch=dev)](https://github.com/SolderedElectronics/Soldered-Digipot-MCP4018-Arduino-Library/actions/workflows/make_docs.yml)
44
[![Arduino Library Manager Compatibility](https://github.com/SolderedElectronics/Soldered-Digipot-MCP4018-Arduino-Library/actions/workflows/arduino_lint.yml/badge.svg?branch=dev)](https://github.com/SolderedElectronics/Soldered-Digipot-MCP4018-Arduino-Library/actions/workflows/arduino_lint.yml)
55

6+
A digital potentiometer is a device identical to a potentiometer, except that instead of a physical rotating part that adjusts the resistance, it uses digital communication. Namely, the resistance of the digital potentiometer is adjusted via I2C communication.
7+
8+
Our module is based on the MCP4018 IC which has a total of 128 steps between 0 and 5k resistance values. This would mean that it is capable of doing resistance steps of approximately 39ohms. It is controlled via I2C which makes it extremely easy to use.
9+
610

711
| ![Digipot 5k MCP4018 breakout](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) |
812
| :---------------------------------------------------------------------------------------------------: |
9-
| [Digipot 5k MCP4018 breakout](https://www.solde.red/333090) |
13+
| [Digipot 5k MCP4018 breakout](https://solde.red/333090) |
1014

1115
| ![Digipot 10k MCP4018 breakout](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) |
1216
| :----------------------------------------------------------------------------------------------------: |
13-
| [Digipot 10k MCP4018 breakout](https://www.solde.red/333091) |
17+
| [Digipot 10k MCP4018 breakout](https://solde.red/333091) |
1418

1519
| ![Digipot 50k MCP4018 breakout](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) |
1620
| :----------------------------------------------------------------------------------------------------: |
17-
| [Digipot 50k MCP4018 breakout](https://www.solde.red/333092) |
21+
| [Digipot 50k MCP4018 breakout](https://solde.red/333092) |
1822

1923
| ![Digipot 100k MCP4018 breakout](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) |
2024
| :-----------------------------------------------------------------------------------------------------: |
21-
| [Digipot 100k MCP4018 breakout](https://www.solde.red/333093) |
25+
| [Digipot 100k MCP4018 breakout](https://solde.red/333093) |
2226

23-
Digipot compliant to [easyC ecosystem](https://www.soldered.com/en/easyC).
27+
Digipot compliant to [easyC ecosystem](https://www.soldered.com/easyC).
2428

2529
### Repository Contents
2630

library.properties

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
name=Soldered MCP4018 Digipot Library
1+
name=Soldered MCP4018 Arduino Library
22
version=1.0.0
33
author=Soldered
44
maintainer=Soldered <[email protected]>
5-
sentence=Arduino library for MCP4018 Digital potentiometer breakout board.
6-
paragraph=This library should be used with Soldered MCP4018 Digipot breakout board.
5+
sentence=Arduino library for MCP4018 Digital potentiometer breakout board
6+
paragraph=Our module is based on the MCP4018 IC which has a total of 128 steps between 0 and 5k resistance values. This would mean that it is capable of doing resistance steps of approximately 39ohms. It is controlled via I2C which makes it extremely easy to use.
77
category=Other
88
url=https://www.solde.red/333046
99
repository=https://github.com/SolderedElectronics/Soldered-Digipot-MCP4018-Arduino-Library

0 commit comments

Comments
 (0)