Skip to content

Commit a6eb194

Browse files
author
Main Push Robot
committed
Committing dev changes
1 parent 818232a commit a6eb194

File tree

2 files changed

+29
-24
lines changed

2 files changed

+29
-24
lines changed

README.md

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
# Hall Effect Sensor Arduino library
22

3-
[![Make docs and publish to GitHub Pages](https://github.com/e-radionicacom/Soldered-Hall-Effect-Sensor-Arduino-Library/actions/workflows/make_docs.yml/badge.svg?branch=dev)](https://github.com/e-radionicacom/Soldered-Hall-Effect-Sensor-Arduino-Library/actions/workflows/make_docs.yml)
3+
[![Make docs and publish to GitHub Pages](https://github.com/SolderedElectronics/Soldered-Hall-Effect-Sensor-Arduino-Library/actions/workflows/make_docs.yml/badge.svg?branch=dev)](https://github.com/SolderedElectronics/Soldered-Hall-Effect-Sensor-Arduino-Library/actions/workflows/make_docs.yml)
44

55
| ![Hall effect sensor breakout with digital output](https://github.com/SolderedElectronics/Hall-effect-sensor-breakout-with-digital-output-hardware-design/blob/main/OUTPUTS/V1.1.1/333080.jpg) |
6-
| :---------------------------------------------------------------------------------------------: |
7-
| [Hall effect sensor breakout with digital output](https://www.solde.red/333080)
6+
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
7+
8+
| [Hall effect sensor breakout with digital output](https://www.solde.red/333080)
89

910
| ![Hall effect sensor breakout with analog output](https://github.com/SolderedElectronics/Hall-effect-sensor-breakout-with-analog-output-hardware-design/blob/main/OUTPUTS/V1.1.1/333079.jpg) |
10-
| :---------------------------------------------------------------------------------------------: |
11-
| [Hall effect sensor breakout with analog output](https://www.solde.red/333079)
11+
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
12+
13+
| [Hall effect sensor breakout with analog output](https://www.solde.red/333079)
1214

1315
| ![Hall effect sensor breakout with digital output & easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) |
14-
| :---------------------------------------------------------------------------------------------: |
15-
| [Hall effect sensor breakout with digital output & easyC](https://www.solde.red333081) |
16+
| :-------------------------------------------------------------------------------------------------------------------------------: |
17+
| [Hall effect sensor breakout with digital output & easyC](https://www.solde.red333081) |
1618

1719
| ![Hall effect sensor breakout with analog output & easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) |
18-
| :---------------------------------------------------------------------------------------------: |
19-
| [Hall effect sensor breakout with analog output & easyC](https://www.solde.red333082) |
20+
| :------------------------------------------------------------------------------------------------------------------------------: |
21+
| [Hall effect sensor breakout with analog output & easyC](https://www.solde.red333082) |
2022

2123
The analog Hall Effect sensor will be able to detect the magnetic field in its vicinity thanks to the aforementioned physical law. A magnetic field that can be created by a magnet, a current flowing through a conductor or some third source, the Hall effect sensor will recognize each. The stronger the magnetic field, the higher the voltage will be at the output of this sensor, so it is a sensor with analog output. Available as an EasyC board and standalone.
2224

@@ -25,7 +27,7 @@ The analog Hall Effect sensor will be able to detect the magnetic field in its v
2527
- Operating voltage: 2.25V - 5V
2628
- Sensor: SI7211-B-00-IV
2729
- Output: analog
28-
- Mounting holes: 2
30+
- Mounting holes: 2
2931

3032
The digital Hall Effect sensor will be able to detect the magnetic field in its vicinity thanks to the aforementioned physical law. A magnetic field that can be created by a magnet, a current flowing through a conductor or some third source, the Hall effect sensor will recognize each. This sensor has a programmed threshold at which it will change the state of its output signal, so it is a sensor with a digital output. Available as an EasyC board and standalone.
3133

@@ -37,18 +39,20 @@ The digital Hall Effect sensor will be able to detect the magnetic field in its
3739
- Mounting holes: 2
3840

3941
### Repository Contents
42+
4043
- **/src** - source files for the library (.h & .cpp)
4144
- **/examples** - examples for using the library
42-
- ***other*** - *keywords* file highlights function words in your IDE, *library.properties* enables implementation with Arduino Library Manager.
45+
- **_other_** - _keywords_ file highlights function words in your IDE, _library.properties_ enables implementation with Arduino Library Manager.
4346

4447
### Hardware design
45-
You can find hardware design for this board in [*Hall effect sensor breakout with analog output*](https://github.com/SolderedElectronics/Hall-effect-sensor-breakout-with-analog-output-hardware-design) hardware repository.
4648

47-
You can find hardware design for this board in [*Hall effect sensor breakout with digital output*](https://github.com/SolderedElectronics/Hall-effect-sensor-breakout-with-digital-output-hardware-design) hardware repository.
49+
You can find hardware design for this board in [_Hall effect sensor breakout with analog output_](https://github.com/SolderedElectronics/Hall-effect-sensor-breakout-with-analog-output-hardware-design) hardware repository.
50+
51+
You can find hardware design for this board in [_Hall effect sensor breakout with digital output_](https://github.com/SolderedElectronics/Hall-effect-sensor-breakout-with-digital-output-hardware-design) hardware repository.
4852

49-
You can find hardware design for this board in [*Hall effect sensor breakout with digital output & easyC*](https://github.com/SolderedElectronics/Hall-effect-sensor-breakout-with-digital-output---easyC-hardware-design) hardware repository.
53+
You can find hardware design for this board in [_Hall effect sensor breakout with digital output & easyC_](https://github.com/SolderedElectronics/Hall-effect-sensor-breakout-with-digital-output---easyC-hardware-design) hardware repository.
5054

51-
You can find hardware design for this board in [*Hall effect sensor breakout with analog output & easyC*](https://github.com/SolderedElectronics/Hall-effect-sensor-breakout-with-analog-output---easyC-hardware-design) hardware repository.
55+
You can find hardware design for this board in [_Hall effect sensor breakout with analog output & easyC_](https://github.com/SolderedElectronics/Hall-effect-sensor-breakout-with-analog-output---easyC-hardware-design) hardware repository.
5256

5357
### Documentation
5458

@@ -59,12 +63,12 @@ Access Arduino library documentation [here](https://solderedelectronics.github.i
5963

6064
### Board compatibility
6165

62-
The library is compatible with board & microcontroller families shown in green below:
63-
64-
[![Compile Sketches](http://github-actions.40ants.com/e-radionicacom/Soldered-Hall-Effect-Sensor-Arduino-Library/matrix.svg?branch=dev&only=Compile%20Sketches)](https://github.com/e-radionicacom/Soldered-Hall-Effect-Sensor-Arduino-Library/actions/workflows/compile_test.yml)
66+
The library is compatible with board & microcontroller families shown in green below:
6567

68+
[![Compile Sketches](http://github-actions.40ants.com/e-radionicacom/Soldered-Hall-Effect-Sensor-Arduino-Library/matrix.svg?branch=dev&only=Compile%20Sketches)](https://github.com/SolderedElectronics/Soldered-Hall-Effect-Sensor-Arduino-Library/actions/workflows/compile_test.yml)
6669

6770
### About Soldered
71+
6872
<img src="https://raw.githubusercontent.com/e-radionicacom/Soldered-Hall-Effect-Sensor-Arduino-Library/dev/extras/Soldered-logo-color.png" alt="soldered-logo" width="500"/>
6973

7074
At Soldered, we design and manufacture a wide selection of electronic products to help you turn your ideas into acts and bring you one step closer to your final project. Our products are intented for makers and crafted in-house by our experienced team in Osijek, Croatia. We believe that sharing is a crucial element for improvement and innovation, and we work hard to stay connected with all our makers regardless of their skill or experience level. Therefore, all our products are open-source. Finally, we always have your back. If you face any problem concerning either your shopping experience or your electronics project, our team will help you deal with it, offering efficient customer service and cost-free technical support anytime. Some of those might be useful for you:
@@ -73,11 +77,12 @@ At Soldered, we design and manufacture a wide selection of electronic products t
7377
- [Tutorials & Projects](https://soldered.com/learn)
7478
- [Community & Technical support](https://soldered.com/community)
7579

76-
7780
### Open-source license
78-
Soldered invests vast amounts of time into hardware & software for these products, which are all open-source. Please support future development by buying one of our products.
7981

80-
Check license details in the LICENSE file. Long story short, use these open-source files for any purpose you want to, as long as you apply the same open-source licence to it and disclose the original source. No warranty - all designs in this repository are distributed in the hope that they will be useful, but without any warranty. They are provided "AS IS", therefore without warranty of any kind, either expressed or implied. The entire quality and performance of what you do with the contents of this repository are your responsibility. In no event, Soldered (TAVU) will be liable for your damages, losses, including any general, special, incidental or consequential damage arising out of the use or inability to use the contents of this repository.
82+
Soldered invests vast amounts of time into hardware & software for these products, which are all open-source. Please support future development by buying one of our products.
83+
84+
Check license details in the LICENSE file. Long story short, use these open-source files for any purpose you want to, as long as you apply the same open-source licence to it and disclose the original source. No warranty - all designs in this repository are distributed in the hope that they will be useful, but without any warranty. They are provided "AS IS", therefore without warranty of any kind, either expressed or implied. The entire quality and performance of what you do with the contents of this repository are your responsibility. In no event, Soldered (TAVU) will be liable for your damages, losses, including any general, special, incidental or consequential damage arising out of the use or inability to use the contents of this repository.
85+
86+
## Have fun!
8187

82-
## Have fun!
83-
And thank you from your fellow makers at Soldered Electronics.
88+
And thank you from your fellow makers at Soldered Electronics.

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ sentence=Hall Effect Sensor library (Analog and Digital, regular and EasyC)
66
paragraph=This is a library for the Hall Effect sensor product family by Soldered.
77
category=Sensor
88
url=https://solde.red/333079
9-
repository=https://github.com/e-radionicacom/Soldered-Hall-Effect-Sensor-Arduino-Library
9+
repository=https://github.com/SolderedElectronics/Soldered-Hall-Effect-Sensor-Arduino-Library
1010
architectures=*
1111
includes=Hall-Effect-SOLDERED.h

0 commit comments

Comments
 (0)