Helium Integration for Home Assistant

Introduction

Welcome to the future of Home Assistant integration with Helium! 🎉 This project is designed to bring the power and versatility of Helium to your smart home, revolutionizing the way you interact with your connected devices. We've taken a fresh approach, building a comprehensive integration from the ground up to support the latest post-migration features of Helium. 🚀

By embracing not only the HNT state but also the subDAOs IOT and MOBILE, the integration unlocks new possibilities for seamless connectivity across your smart home ecosystem. 💡 Moreover, the solution incorporates the new staking system, ensuring that you stay ahead of the curve in the rapidly evolving world of decentralized networks. 🌐

Join us on this exciting journey as we redefine the way you interact with Home Assistant and Helium, and let's create a more connected and decentralized future together! ✨

Roadmap 🚀

• Price of HNT, IOT, and MOBILE - Stay informed with real-time price updates for HNT, IOT, and MOBILE tokens, empowering you to make smarter decisions and optimize your smart home experience! 💰
• General Helium Stats - Get a comprehensive overview of the Helium network with key performance metrics and insights, ensuring you always have your finger on the pulse of this dynamic ecosystem! 🔍
• Wallet Stats - Track your wallet balances and transactions with ease, helping you manage your assets and stay in control of your financial well-being! 📈
• Hotspot Stats - Monitor your Helium hotspot performance, so you can maximize your earnings and contribute to a robust decentralized network! 📡
• Hotspot Rewards - Keep track of your Helium hotspot rewards, including detailed reward breakdowns, to stay informed about your earnings and celebrate your successes! 🏆
• Staking Stats - Stay up to date with your staking positions, providing you with valuable information to help you navigate the exciting world of Helium staking! 🔒
• Staking Rewards - Keep tabs on your staking rewards, enabling you to make the most of your investments and celebrate your wins in the Helium ecosystem! 🎉
• Device Integration - Seamlessly integrate devices from a Helium Console and jumpstart your IoT projects with ease. Experience the power of Helium in every device and transform your smart home experience! 🔌
• Blueprints for Easy Automation - Blueprints allow rapid configuration of automations without diving too much into code, making it easier than ever to automate your smart home! 🔧
• Conf-Flow - With conf-flow, you can configure your Helium integration completely from the UI without updating your configuration.yaml, making setup even more user-friendly! ⚙️

Installation 🛠️

Follow these simple steps to get started.

1. Install the Home Assistant Community Store (HACS) - Before you can use this integration, you'll need to have HACS installed. Haven't set it up yet? No worries! Check out the HACS installation guide to get up and running in no time.

2. Add Custom Repository - As our plugin is still maturing and not yet available in the HACS store, you'll need to install it as a custom repository. Don't worry; it's a breeze! Simply follow these steps:

   • Navigate to HACS in your Home Assistant instance
   • Select "Integrations"
   • Click the three dots in the top right corner and choose "Custom repositories"
   • In the "Add custom repository" dialog, enter the following information:
     • Repository: enes-oerdek/Home-Assistant-Helium-Integration
     • Category: Integration
   • Click "Add" and you're good to go!

Now you're all set to enjoy the benefits of Helium integration in your Home Assistant! 🎉

Configuration ⚙️

Unleash the full power of Helium integration in your Home Assistant by following these simple steps. ⭐

Simple Configuration using Configuration Flow

1. Home Assistant Settings: Begin by navigating to your Home Assistant settings. Then, select "Devices and Services".

2. Add Integration: Look for the "+ Add Integration" button in the lower right corner, click it and search for "Helium".

   

3. Configure Helium Integration: You'll be prompted to enter the number of wallets you want to configure. If you only have one wallet, simply leave the default value. On the next screen, you'll need to enter your public address. This address can be found in the settings of the Helium Wallet App. Navigate to: Helium Wallet App (black) > Copy Address > Solana.

   

   

4. Restart Home Assistant: After the sensors and devices have loaded, you may need to reload the integration to finalize the configuration.

   

Advanced Configuration using configuration.yaml

The simple configuration method should suffice for most users. However, some beta features may only be accessible through the advanced configuration method.

1. Update your configuration.yaml - Add the following code snippet to your configuration.yaml file:

sensor:
  - platform: helium_solana

This one-liner will introduce new sensors for the prices of HNT, IOT, MOBILE, and SOL, providing you with valuable insights right at your fingertips! 💎

Optional: If you are interested in your wallet stats as well, you need to add the "wallets" part in your configuration as well.

sensor:
  - platform: helium_solana
    wallets:
    - SOLANA WALLET ADDRESS HERE

Replace "SOLANA WALLET ADDRESS HERE" with your Solana Wallet Address. You can find this address in the settings of the black Helium App > Copy Address > Solana. Your resulting configuration might look like this:

sensor:
  - platform: helium_solana
    wallets:
    - rAwOnpD26GH8FcEo1H4ng3MPPsN8C5KdZ7N7MqAS

3. Customize your dashboard - Now that your sensors are set up, it's time to add them to your Home Assistant dashboard. Check out the examples below for inspiration and create a personalized display that suits your needs.

4. Introduce Automations - Stay ahead of the game by setting up automations to be notified of major price changes! 📣 Create an automation using the newly introduced price data, so you're always in the know when it comes to your investments.

Your Home Assistant is now supercharged with Helium integration, giving you unparalleled control and insights into your smart home ecosystem! 🎉 This will introduce new sensors with the prices of HNT, IOT, MOBILE and SOL. You can now add these sensors into your dashboard (see examples).

Examples 🌈

Discover the amazing possibilities of Helium integration in your Home Assistant through these inspiring examples! ⭐ These examples are very simple demonstrations on how the Helium integration entities can be used. Better examples will be added during upcoming updates, so stay tuned for more!

Price Monitoring 📊

Enhance your dashboard with sleek and informative price monitoring graphs using the mini-graph-card. Visualize price trends and make data-driven decisions with style!

Preview:

Or with multiple cards:

Code:

animate: true
entities:
  - entity: sensor.price_hnt
graph: line
hour24: true
font_size: 75
hours_to_show: 72
points_per_hour: 12
name: HNT/USD
decimals: 8
show:
  extrema: true
  icon: false
  name: true
type: custom:mini-graph-card

Network Monitoring 📊

Keep a close eye on the Helium network's Key Performance Indicators, and make well-informed decisions with essential data at your fingertips.

Preview:

Code:

type: entities
entities:
  - entity: sensor.helium_stats_iot_active_hotspots
    name: Active Hotspots
  - entity: sensor.helium_stats_iot_total_hotspots
    name: Total Hotspots
  - entity: sensor.helium_stats_iot_total_cities
    name: Total Cities
  - entity: sensor.helium_stats_iot_total_countries
    name: Total Countries
  - entity: sensor.helium_stats_iot_daily_average_rewards
    name: Daily Average Rewards
title: Helium IOT

Wallet Balance 💸

Effortlessly keep track of your wallet balance and stay informed about your assets in the Helium ecosystem.

Preview:

Code:

Each wallet has a unique entity ID. You need to add your identifier for your wallet. It is the first 4 chars of your solana address. Replace [YOUR ID HERE] (including brackets) with your wallet id.

type: entities
entities:
  - entity: sensor.helium_wallet_[YOUR ID HERE]_hnt_balance
    name: HNT Account
  - entity: sensor.helium_wallet_[YOUR ID HERE]_iot_balance
    name: IOT Account
  - entity: sensor.helium_wallet_[YOUR ID HERE]_mobile_balance
    name: MOBILE Account
  - entity: sensor.helium_wallet_[YOUR ID HERE]_sol_balance
    name: SOL Account
title: Wallet [YOUR ID HERE]

Contributing 🤝

We warmly welcome contributions from the community! Whether you have a brilliant idea, a bug report, or simply want to lend a helping hand, your input is greatly appreciated. ⭐

To get started, you can:

1. Submit an issue - Found a bug or have a feature request? Open a new issue on our GitHub repository and let us know.
2. Create a pull request - Have a fix or improvement you'd like to contribute? Fork the repo, make your changes, and submit a pull request for review.

Together, we can make this project even better! 💪

Acknowledgements 🙌

A big thank you to the following contributors for their invaluable resources and support that helped make this project possible:

1. Aaron Godfrey - For providing a comprehensive guide on creating a HACS integration.

2. lthiery - For providing the new hnt-explorer which makes consuming staking data easier.

3. rsnodgrass' hass-helium - Before creating a new integration, I used rsnodgrass' plugin and I liked it. Unfortunately it does not seem to get updated.

Stay tuned for more acknowledgements as our project evolves and grows! 🚀