Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/brianpugh/magnetometer

CLI Magnetometer using a CircuitPython board + Belay

https://github.com/brianpugh/magnetometer

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.1%) to scientific vocabulary

Keywords

belay circuitpython magnetometer micropython textual tui

Keywords from Contributors

serializer interactive projection generic archival sequences genomics observability autograding hacking
Last synced: 5 months ago · JSON representation

Repository

CLI Magnetometer using a CircuitPython board + Belay

Basic Info
  • Host: GitHub
  • Owner: BrianPugh
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 236 KB
Statistics
  • Stars: 4
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 3
Topics
belay circuitpython magnetometer micropython textual tui
Created over 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme License

README.md

Magnetometer

This is a magnetometer command-line tool that reads from physical magnetic sensors via Belay.

Installation

Install Magnetometer through pip:

pip install magnetometer

Usage

To start the program, invoke magnetometer along with the port your CircuitPython board is connected to.

magnetometer DEVICE_PORT --sensor SENSOR_TYPE

You can use the debugging sensor sin without any physical hardware interactions. CircuitPython must be installed on-device and must be configured with rw storage. Magnetometer will automatically upload all necessary code to device. Run magnetometer --help to see more options.

Supported Sensors

Want to support another sensor? Open an issue (or even a PR) on Github and we can try to add it!

Acknowledgements

This tool uses many awesome libraries that keep the implementation terse and the outputs beautiful: * Belay - Seameless python/hardware interactions. Used for all hardware interactions. * AutoRegistry - Automatic registry design-pattern library for mapping names to functionality. Used to manage sensor hardware abstraction layer. * Textual - Text User Interface framework for Python inspired by modern web development. Used for dynamic user input. * Rich - Python library for rich text and beautiful formatting in the terminal. Used for general UI text rendering. * AsciiChartPy - Nice-looking lightweight console ASCII line charts. Used for chart plotting. Modified to be rich-compatible. * CircuitPython Bundle - A bundle of useful CircuitPython libraries ready to use from the filesystem.

Owner

  • Name: Brian Pugh
  • Login: BrianPugh
  • Kind: user
  • Location: Washington D.C.

Deep Learning Scientist and blockchain enthusiast

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 14
  • Total Committers: 2
  • Avg Commits per committer: 7.0
  • Development Distribution Score (DDS): 0.214
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Brian Pugh b****7@g****m 11
dependabot[bot] 4****] 3

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 1
  • Total pull requests: 5
  • Average time to close issues: about 14 hours
  • Average time to close pull requests: 16 minutes
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • roaldarbol (1)
Pull Request Authors
  • dependabot[bot] (4)
  • BrianPugh (2)
Top Labels
Issue Labels
Pull Request Labels
dependencies (4)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 20 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 1
pypi.org: magnetometer
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 20 Last month
Rankings
Dependent packages count: 6.6%
Downloads: 18.2%
Average: 22.8%
Stargazers count: 28.2%
Forks count: 30.5%
Dependent repos count: 30.6%
Maintainers (1)
BrianPugh
Last synced: 6 months ago

Dependencies

poetry.lock pypi
  • Jinja2 3.1.2 develop
  • MarkupSafe 2.1.1 develop
  • PyYAML 6.0 develop
  • appnope 0.1.3 develop
  • asttokens 2.0.8 develop
  • atomicwrites 1.4.1 develop
  • backcall 0.2.0 develop
  • cfgv 3.3.1 develop
  • coverage 5.5 develop
  • decorator 5.1.1 develop
  • dunamai 1.13.0 develop
  • executing 1.0.0 develop
  • flake8 4.0.1 develop
  • identify 2.5.3 develop
  • iniconfig 1.1.1 develop
  • ipdb 0.13.9 develop
  • ipython 8.4.0 develop
  • jedi 0.18.1 develop
  • matplotlib-inline 0.1.6 develop
  • mccabe 0.6.1 develop
  • nodeenv 1.7.0 develop
  • parso 0.8.3 develop
  • pickleshare 0.7.5 develop
  • pluggy 1.0.0 develop
  • poetry-dynamic-versioning 0.16.0 develop
  • pre-commit 2.20.0 develop
  • prompt-toolkit 3.0.30 develop
  • pure-eval 0.2.2 develop
  • py 1.11.0 develop
  • pycodestyle 2.8.0 develop
  • pyflakes 2.4.0 develop
  • pytest 7.1.2 develop
  • pytest-cov 3.0.0 develop
  • pytest-mock 3.8.2 develop
  • setuptools 65.3.0 develop
  • stack-data 0.5.0 develop
  • toml 0.10.2 develop
  • tomli 2.0.1 develop
  • traitlets 5.3.0 develop
  • wcwidth 0.2.5 develop
  • CacheControl 0.12.11
  • Pygments 2.13.0
  • SecretStorage 3.3.3
  • attrs 22.1.0
  • autoregistry 0.8.0
  • belay 0.6.0
  • cachy 0.3.0
  • certifi 2022.6.15
  • cffi 1.15.1
  • charset-normalizer 2.1.1
  • cleo 1.0.0a5
  • click 8.1.3
  • colorama 0.4.5
  • commonmark 0.9.1
  • crashtest 0.3.1
  • cryptography 37.0.4
  • distlib 0.3.6
  • dulwich 0.20.45
  • filelock 3.8.0
  • html5lib 1.1
  • idna 3.3
  • importlib-metadata 4.12.0
  • importlib-resources 5.9.0
  • jaraco.classes 3.2.2
  • jeepney 0.8.0
  • jsonschema 4.15.0
  • keyring 23.9.1
  • lockfile 0.12.2
  • more-itertools 8.14.0
  • msgpack 1.0.4
  • packaging 21.3
  • pexpect 4.8.0
  • pkginfo 1.8.3
  • pkgutil_resolve_name 1.3.10
  • platformdirs 2.5.2
  • poetry 1.2.0
  • poetry-core 1.1.0
  • poetry-plugin-export 1.0.6
  • ptyprocess 0.7.0
  • pycparser 2.21
  • pylev 1.4.0
  • pyparsing 3.0.9
  • pyrsistent 0.18.1
  • pyserial 3.5
  • pywin32-ctypes 0.2.0
  • requests 2.28.1
  • requests-toolbelt 0.9.1
  • rich 12.5.1
  • shellingham 1.5.0
  • six 1.16.0
  • textual 0.1.18
  • tomlkit 0.11.4
  • typer 0.6.1
  • typing-extensions 4.3.0
  • urllib3 1.26.12
  • virtualenv 20.16.4
  • webencodings 0.5.1
  • xattr 0.9.9
  • zipp 3.8.1
pyproject.toml pypi
  • autoregistry ^0.8
  • belay ^0.6
  • python ^3.8
  • textual ^0.1.18
  • typer ^0.6
.github/workflows/deploy.yaml actions
  • JRubics/poetry-publish v1.13 composite
  • actions/checkout v2 composite
.github/workflows/pre-commit.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pre-commit/action v2.0.3 composite
.github/workflows/tests.yaml actions
  • actions/cache v2 composite
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • andstor/file-existence-action v1 composite
  • codecov/codecov-action v2 composite
  • snok/install-poetry v1 composite