Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
enes-oerdek committed May 24, 2023
1 parent 1927d04 commit 782c23f
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 3 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,29 @@ Now you're all set to enjoy the benefits of Helium integration in your Home Assi

## Configuration :gear:

Get ready to unlock the full potential of Helium integration in your Home Assistant with this simple configuration! :star:
Unleash the full power of Helium integration in your Home Assistant by following these simple steps. :star:

### 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".

![Configuration Steps 1 and 2](./images/configuration0.png)

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.

![Configuration Step 3](./images/configuration1.png)

![Configuration Step 4](./images/configuration2.png)

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

![Configuration Step 5](./images/configuration3.png)

### 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:
```yaml
Expand All @@ -63,7 +85,7 @@ sensor:
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 configuraiton might look like this:
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:
```yaml
sensor:
- platform: helium_solana
Expand Down
2 changes: 1 addition & 1 deletion custom_components/helium_solana/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
"iot_class": "cloud_polling",
"issue_tracker": "https://github.com/enes-oerdek/Home-Assistant-Helium-Integration/issues",
"requirements": ["requests>=2.26.0"],
"version": "2.1"
"version": "2.2"
}
Binary file added images/configuration0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/configuration1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/configuration2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/configuration3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 782c23f

Please sign in to comment.