https://github.com/cedargrovestudios/circuitpython_ohmslaw

A CircuitPython helper for calculating an Ohm’s Law result from two input parameters.
https://github.com/cedargrovestudios/circuitpython_ohmslaw

circuitpython circuitpython-community-bundle ohms-law

Last synced: 12 days ago
JSON representation

A CircuitPython helper for calculating an Ohm’s Law result from two input parameters.

• Host: GitHub
• URL: https://github.com/cedargrovestudios/circuitpython_ohmslaw
• Owner: CedarGroveStudios
• License: mit
• Created: 2022-10-28T05:31:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-07T02:12:43.000Z (almost 2 years ago)
• Last Synced: 2024-11-20T10:59:35.558Z (2 months ago)
• Topics: circuitpython, circuitpython-community-bundle, ohms-law
• Language: Python
• Homepage:
• Size: 97.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/CedarGroveStudios/CircuitPython_OhmsLaw/workflows/Build%20CI/badge.svg

    :target: https://github.com/CedarGroveStudios/CircuitPython_OhmsLaw/actions

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Code Style: Black

A CircuitPython helper for calculating an Ohm's Law formula result from two input parameters.

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver bundle `_

or individual libraries can be installed using

`circup `_.

Installing to a Connected CircuitPython Device with Circup

==========================================================

Make sure that you have ``circup`` installed in your Python environment.

Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the

following command to install:

.. code-block:: shell

    circup install cedargrove_ohmslaw

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example

=============

.. code-block:: python

    >>> from cedargrove_ohmslaw import ohms_law

    >>> ohms_law(ohms=1000, volts=3.3)

    3.3  # current in milliamperes

    >>> ohms_law(volts=5, milliamperes=100)

    50.0  # resistance in ohms

    >>> ohms_law(milliamperes=5, ohms=2000)

    10.0  # voltage in volts

Documentation

=============

API documentation for this library can be found `here `_.

For information on building library documentation, please check out

`this guide `_.

Contributing

============

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.