Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/just4give/helium-dyi-hotspot-balena-pi4
https://github.com/just4give/helium-dyi-hotspot-balena-pi4
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/just4give/helium-dyi-hotspot-balena-pi4
- Owner: just4give
- Created: 2020-07-20T15:14:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-11T12:28:55.000Z (10 months ago)
- Last Synced: 2024-05-10T22:32:22.108Z (6 months ago)
- Language: C
- Size: 397 KB
- Stars: 85
- Watchers: 14
- Forks: 29
- Open Issues: 10
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
- awesome-helium - just4give/helium-dyi-hotspot-balena-pi4 - "Build your own helium hotspot ( miner + packet forwader ) on Raspberry pi 4 using BalenaOS" (Software / DIY Hotspots)
README
[](https://twitter.com/tweetmithund)
## UPDATE: 04/11/2021 : [copied from helium discord] Any new DIY will not earn HNT. If you build a DIY packet forwarder today, it will only transfer data on the Helium network. There is no plan to resume the alpha program. If you would like to earn HNT, please visit helium.com/mine.
## Build your own helium hotspot ( miner + packet forwader ) on Raspberry pi 4 using BalenaOS
#### Hardwares you need
- Raspberry Pi 4 [link](https://www.amazon.com/gp/product/B07TC2BK1X)
- USBC power adapter [link](https://www.amazon.com/gp/product/B07TYQRXTK)
- 64GB Micro SD card [link](https://www.amazon.com/gp/product/B07NY4L4VZ)
- RAK2245 Pi HAT [link](https://www.amazon.com/gp/product/B085W5ZL4F) While purchasing please check frequency of your country.
#### Softwares you need
- Free Balena Cloud account [link](https://dashboard.balena-cloud.com/login)
- Mac or Windows ( I tested on Mac )
- BalenaEtcher to flash image [download](https://www.balena.io/etcher/)
- Balena CLI [install](https://github.com/balena-io/balena-cli/blob/master/INSTALL.md)
- jq [install](https://stedolan.github.io/jq/download/)
## Deploy with balena
Running Helium on [balenaCloud](https://balena.io) is a breeze. Just click the Deploy with balena button below:
[](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/just4give/helium-dyi-hotspot-balena-pi4/)
Alternatively, you can install manually on balenaCloud using the instructions below.
## Let's get started
As you got your hardwares and softwares let's get started and turn your Pi into a helium hotspot
##### Step 1: Prepare image with balenaOS
Log into balena cloud website and click on "Create Application" button
This wil bring a modal window as below. Type a name as you desire, choose device type as "Raspberry Pi 4" , application type as "Starter" and hit "Create new application" button.
Once the application is created, it will take you to the application page. You need to add a device now.
Click on "Add device" button which will open below modal.
Turn on "Wifi+Ethernet" and put your wifi credential there. After that click on "Download BalenaOS" button which will download a zip file on your comuter.
Next, click on Environment variable menu from left pane and create a new variable as "REGION" with value "US915" (you may need to change as per your region. This repo supports US915, EU868 and IN865. Please create PR if with your region)
##### Step 2: Flash image on SD card
Plug micro SD card into your computer. Open balenaEtcher software, select the downloaded zip file from your computer and select the SD card to format and click on "Flash"
Once completed, unplug SD card from your computer and insert in your Raspberry Pi and power up your Pi. In about 20-30 seconds your device should appear on balena cloud application as below.
Very exciting so far! Isn't is?
##### Step 3: Deploy helium miner and gateway to balena
Now the fun begins. Stack your RAK2245 HAT on your Pi. From balena cloud , generate a session token ( Preferences -> Access Tokens )
Next, clone this repo somewhere on your computer
```
git clone https://github.com/just4give/helium-dyi-hotspot-balena-pi4 && cd helium-dyi-hotspot-balena-pi4
```
Next log into balena cli
```
balena login
```
Choose "Authetication Token" from the list. This will ask you to enter the token you grabbed from balena cloud website. Paste and hit enter. You should receive successful login message.
Next, issue below commands one by one
```
chmod +x build.sh
./build.sh
balena push helium_diy_hotspot_pi4
```
Please note - the command is balena push . If you have used different name in step 1, then use that.
If everything goes fine, you will see a nice unicorn :)
And in few minutes, both gateway and miner will be distrubuted to your device. You should see some logs like. Now if you have a LoRa node, test it out.
```
22.07.20 12:05:36 (-0400) gateway INFO: [up] PUSH_ACK received in 0 ms
22.07.20 12:05:40 (-0400) gateway INFO: [down] PULL_ACK received in 0 ms
```
## How to enable GPS (Optional)
GPS is not a hard requirement to run your DIY hotspot. So you may entirely skip GPS setup. Make sure in global config JSON file GPS is set to false.
You need to activate UART and modify `dtoverlay` varible. Go to "Device Configuration" tab from left menu and modify dtoverlay value to pi3-disable-bt and activate UART.
#### Troubleshooting
- If you are not on Mac, you may see some issue running `build.sh` file. If so , remove `''` from `sed` command.
- If you are on Windows and are unable to build the run the bash script 'build.sh':
- First check the sed version using the command ``` sed --version ```
- If GNU sed version 3.02 is the version installed it wont support the -i option for sed, so update to the latest version of sed and try running it.
- Or replace the contents of the 'build.sh' file with the following one:
``` #!/bin/bash
cp docker-compose-template.yml docker-compose.yml
export MINER_TAG=$(curl -s 'https://quay.io/api/v1/repository/team-helium/miner/tag/?limit=100&page=1&onlyActiveTags=true' | jq -c '[ .tags[] | select( .namecontains("arm")) ][0].name' | cut -d'"' -f2)
sed.exe s/MINER_TAG/$MINER_TAG/g docker-compose.yml > docker-temp.yml
cp docker-temp.yml docker-compose.yml
```
## How to upgrade miner
Execute below commands from the repo. This will fetch the latest miner image from the hub.
```
rm docker-compose.yml
./build.sh
balena push helium_diy_hotspot_pi4
```
## Dashboard
Open your browser and navigate to http://. This is work in progress. You will see some useful metrics and can download swam key easily for backup.
## Special Thanks
I like to thank Marc from Balena and [PastaGringo](https://github.com/PastaGringo). They are the creators of the multi conatiner docker images which I reused.
## References
- Helium Developer Website [hotspot](https://developer.helium.com/hotspot/developer-setup)
- Balena Multi-container [link](https://www.balena.io/blog/two-projects-one-device-turn-your-raspberry-pi-into-a-multitool/)