Skip to content

Commit 782c23f

Browse files
committed
update readme
1 parent 1927d04 commit 782c23f

File tree

6 files changed

+25
-3
lines changed

6 files changed

+25
-3
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,29 @@ Now you're all set to enjoy the benefits of Helium integration in your Home Assi
4545

4646
## Configuration :gear:
4747

48-
Get ready to unlock the full potential of Helium integration in your Home Assistant with this simple configuration! :star:
48+
Unleash the full power of Helium integration in your Home Assistant by following these simple steps. :star:
49+
50+
### Simple Configuration using Configuration Flow
51+
52+
1. **Home Assistant Settings**: Begin by navigating to your Home Assistant settings. Then, select "Devices and Services".
53+
54+
2. **Add Integration**: Look for the "+ Add Integration" button in the lower right corner, click it and search for "Helium".
55+
56+
![Configuration Steps 1 and 2](./images/configuration0.png)
57+
58+
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.
59+
60+
![Configuration Step 3](./images/configuration1.png)
61+
62+
![Configuration Step 4](./images/configuration2.png)
63+
64+
4. **Restart Home Assistant**: After the sensors and devices have loaded, you may need to reload the integration to finalize the configuration.
65+
66+
![Configuration Step 5](./images/configuration3.png)
67+
68+
### Advanced Configuration using `configuration.yaml`
69+
70+
The simple configuration method should suffice for most users. However, some beta features may only be accessible through the advanced configuration method.
4971

5072
1. **Update your `configuration.yaml`** - Add the following code snippet to your `configuration.yaml` file:
5173
```yaml
@@ -63,7 +85,7 @@ sensor:
6385
wallets:
6486
- SOLANA WALLET ADDRESS HERE
6587
```
66-
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:
88+
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:
6789
```yaml
6890
sensor:
6991
- platform: helium_solana

custom_components/helium_solana/manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@
88
"iot_class": "cloud_polling",
99
"issue_tracker": "https://github.com/enes-oerdek/Home-Assistant-Helium-Integration/issues",
1010
"requirements": ["requests>=2.26.0"],
11-
"version": "2.1"
11+
"version": "2.2"
1212
}

images/configuration0.png

43.8 KB
Loading

images/configuration1.png

21 KB
Loading

images/configuration2.png

34.9 KB
Loading

images/configuration3.png

42 KB
Loading

0 commit comments

Comments
 (0)