Skip to content

Latest commit

 

History

History
66 lines (51 loc) · 2.89 KB

README.md

File metadata and controls

66 lines (51 loc) · 2.89 KB
Raw

HNT Earnings Widget for Scriptable

cover

What's this?

Just got your Helium miner? Tired of checking the helium app every other hour during the day to see how much you earned? Want to see earnings right on your iOS home screen? Look no more!

This Scriptable widget lets you display the earnings of your hotspot on the home screen to help you keeping track of your daily/weekly/monthly earnings.

Features

Multi Language Support

Currently the widget is tranlated into:

  • 🇩🇪 German
  • 🇺🇸 English
  • 🇪🇸 Spanish

Different Aggregation Periods

The widget can be configured to display eigther earnings per day, per week or per month.

Dark Mode Support

Supports different color configurations for light ☀️ and dark 🕶️ mode

Instructions

  1. Download and extract the content of this repository into the Scriptable folder located in your iCloud Drive.

Your Scriptable folder structure should look like this:

iCloud Drive/
├─ Scriptable/
│  ├─ hnt-earnings.js
│  ├─ hnt-earnings/
│  │  ├─ assets/
│  │  │  ├─ helium.png
│  │  ├─ api.js
│  │  ├─ utils.js
│  │  ├─ config.js
│  │  ├─ widgets.js
│  │  ├─ i18n.js
  1. If you like to display your earnings in a different currency then the default (EUR) go to the config.js file and change the currency. Possible values are listed in the file.
  2. If you like, configure your color settings in the getColors() function to match the widget to your homescreen 🎨
  3. Launch Scriptable and make sure that hnt-earnings is listed in the scripts view.
  4. If you wish, add your hotspot name into the devParams object in hnt-earnings.js and run the script and verify that everything is working correctly.
  5. Go back to your home screen and add a Scriptable widget.
  6. Edit the Scriptable widget and choose hnt-earnings as the script.
  7. Configure the widget parameters with your hotspot name and the period you want to see the earnings for.

The configuration options have to be a JSON of the following format:

{ "name": "your-hotspot-name", "period": "day" }

Known Issues

  • Right now the widget only supports the small widget size. A medium and large sized version may follow in the future.

About this project

The script is authored by @thartwi (me) in order to keep track on how much I'm making with my magic internet money box ✨ without opening the helium app constantly and waiting for it to load slowly 🐌

Thanks 🙏

Thanks to the Helium Network for creating the peoples network!
Thanks to @simonbs for making an awesome app!

Disclaimer

This widget is not affiliated with or endorsed by the Helium project.