Soldered HallEffect MicroPython Library


Hall effect sensor breakout with analog output & easyC (opens in a new tab) (SI7211-B-00-IV, SKU 333081)	Hall effect sensor breakout with digital output & easyC (opens in a new tab) (SI7201-B-06, SKU 333082)

This library drives Soldered's Hall effect sensor family, available as two boards, each supporting both Native (GPIO/ADC) and Qwiic (I2C) modes:

Hall effect sensor breakout with analog output - outputs a continuous voltage proportional to magnetic field strength.
Hall effect sensor breakout with digital output - outputs a digital threshold signal when a magnetic field is detected.

Supply voltage range 2.25V-5V. Common uses: position sensing, current sensing, speed detection.

How to install

After installing the mpremote package (opens in a new tab), install the library on your board using the following command:

  mpremote mip install github:SolderedElectronics/Soldered-HallEffect-MicroPython-Library

Or, if you're running a Windows OS:

  python -m mpremote mip install github:SolderedElectronics/Soldered-HallEffect-MicroPython-Library

Repository Contents

HallEffect.py - MicroPython driver classes (HallEffectAnalog, HallEffectDigital; Native + Qwiic)
Qwiic.py - shared I2C base class this driver depends on
package.json - mip install manifest
/Examples - Native and Qwiic examples for both analog and digital variants

Hardware design

You can find hardware design for these boards in the Hall effect sensor breakout with analog output and Hall effect sensor breakout with digital output hardware repositories.

Documentation

Access library documentation here (opens in a new tab).

About Soldered

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:

Open-source license

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.

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.

Have fun!

And thank you from your fellow makers at Soldered Electronics.