hm-pyhelper 0.8.12

Helium Python Helper

Helium Python Helper

A helper module used across various Nebra repos to reduce redundant features.

This package is used in a number of Nebra software repos:

• hm-pktfwd
• hm-config
• hm-diag

The package is available on PyPI and PyPI test repos:

• PyPI hm-pyhelper
• PyPI Test hm-pyhelper

Helium Hardware Definitions

from hm_pyhelper.hardware_definitions import variant_definitions

This repository contains the python file that contains a GPIO map for all of the different hardware combinations to be supported by the Nebra Helium Hotspot Software.

All numbers below are their GPIO / BCM Numbers, not physical pin numbers.

Note: Light hotspot software will also work on all models listed as type "full".

Nebra Hotspots

Model	ENV Identifier	SPI Bus	Reset Pin	Status LED	Button	Type	Cellular	Notes
Nebra Indoor Hotspot Gen 1	NEBHNT-IN1	1.2	38	25	26	Full	False	CM3 based
Nebra Outdoor Hotspot Gen 1	NEBHNT-OUT1	1.2	38	25	24	Full	True	CM3 based
Nebra Pi 0 Light Hotspot S	NEBHNT-LGT-ZS	1.2	22	24	23	Light	False	SPI Based Ethernet
Nebra Pi 0 Light Hotspot X	NEBHNT-LGT-ZX	1.2	22	24	23	Light	False	USB Based Ethernet
Nebra Beaglebone Light Hotspot	NEBHNT-BBB	1.0	60	31	30	Light	False	In Planning
Nebra Pocket Beagle Light Hotspot	NEBHNT-PBB	1.0	60	31	30	Light	False	In Planning
Nebra Hotspot HAT RockPi4	NEBHNT-HHRK4	1.0	149	156	154	Full	False	In Planning
Nebra Hotspot HAT RPi	NEBHNT-HHRPI	0.0	22	24	23	Full	False	Should be compatible with 3+ & 4
Nebra Hotspot HAT RPi LIGHT	NEBHNT-HHRPL	0.0	22	24	23	Light	False	Light is compatible with all 40 pin headers
Nebra Hotspot HAT Tinkerboard 2	NEBHNT-HHTK	2.0	167	163	162	Full	False	Light would be compatible on TK1

Third Party Hotspots

We may be adding in support for other vendor's hotspots to use our software soon. Here are the variables for those.

These would also depend on their SOCs being supported by Balena.

Model	SOC/SBC	ENV Identifier	SPI Bus	Reset Pin	Status LED	Button	Type	Cellular	Notes
Rak Hotspot Miner	BCM2711 (Pi4 2gb RAM)	COMP-RAKHM	0.0	17	20	21	Full	False	Only Compatible with V2 hotspots with ECC Key.
OG Helium Hotspot	BCM2711 (Pi4 2gb RAM)	COMP-HELIUM	0.0	17	20	21	Full	False
Syncrobit Hotspot 1 (Pi)							Full	False
Syncrobit Hotspot 2 (RK)							Full	False
Bobcat Miner 300							Full	False
SenseCAP M1	BCM2711 (Pi4 2gb RAM)	COMP-SENSECAPM1	0.0	17	20	21	Full	False

DIY Hotspots

The following DIY options are also supported for light hotspot software only.

Please note, DIY Hotspots do not earn HNT.

Model	SOC/SBC	ENV Identifier	SPI Bus	Reset Pin	Status LED	Button	Type	Cellular	Notes
Pi Supply IoT LoRa Gateway HAT	RPi	DIY-PISLGH	0.0	22			Light	False	Any pi with 40 pin header
RAK2287	RPi	DIY-RAK2287	0.0	17			Light	False	Any pi with 40 pin header

logger

from hm_pyhelper.logger import get_logger
LOGGER = get_logger(__name__)
LOGGER.debug("message to log")

miner_param

retry_get_region(region_override, region_filepath)

Return the region from envvar region_override or from the contents of region_filepath

from hm_pyhelper.miner_param import retry_get_region
print(retry_get_region("US915", "/invalid/path"))
# US915

# echo "EU868" > /var/pktfwd/region
print(retry_get_region("", "/var/pktfwd/region"))
# EU868

Testing

To run tests:

pip install -r requirements.txt
pip install -r test-requirements.txt
PYTHONPATH=./ pytest

Referencing a branch for development

It is sometimes convenient to use recent changes in hm-pyhelper before an official release. To do so, first double check that you've added any relevant dependencies to the install_requires section of setup.py. Then add the following lines to the project's Dockerfile.

RUN pip3 install setuptools wheel
RUN pip3 install --target="$OUTPUTS_DIR" git+https://github.com/NebraLtd/hm-pyhelper@BRANCH_NAME

Releasing

To release, use the Github new release flow.

1. Create a new tag in format vX.Y.Z. You can use a previously tagged commit, but this is not necessary.
2. Make sure the tag you created matches the value in setup.py.
3. Select master as the target branch. If you do not select the master branch, the tag should be in format vX.Y.Z-rc.N.
4. Title: Release vX.Y.Z.
5. Body:

Note: you can create the release notes automatically by selecting the "Auto-generate release notes" option on the releases page.

## What's Changed
* Foo
* Bar

**Full Changelog**: https://github.com/NebraLtd/hm-pyhelper/compare/v0.0.A...v0.0.Z