Skip to content

Commit

Permalink
Enhance application help documentation with new content and support i…
Browse files Browse the repository at this point in the history
…nformation

- Updated 'assert-location.md' and 'claim-ownership.md' to include support contact details.
- Added new documents: 'custom-device-inverter.md' and 'custom-device.md' for inverter selection and device addition guidance.
- Improved clarity in existing documents by specifying 'Solana Wallet' in 'claim-ownership.md' and refining instructions in 'setup-inverter.md' and 'setup-network.md'.
- Ensured all documents now include a consistent support contact section for user assistance.
  • Loading branch information
Leitet committed Dec 19, 2024
1 parent b46adb1 commit 83fbcc3
Show file tree
Hide file tree
Showing 7 changed files with 86 additions and 10 deletions.
4 changes: 3 additions & 1 deletion docs/application-help-screens/assert-location.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,6 @@ Accurate location data is crucial for your Energy Gateway's operation:
- Accurate location data is required for optimal system performance
- The location is verified and stored on the blockchain for transparency

> For optimal performance and accurate energy forecasting, please ensure the pin is placed exactly where your solar installation is located.
> For optimal performance and accurate energy forecasting, please ensure the pin is placed exactly where your solar installation is located.
> Need more help? Please contact our support at [sourceful.energy/support](https://sourceful.energy/support) or browse trough our documentation at [docs.sourceful.energy](https://docs.sourceful.energy)
6 changes: 4 additions & 2 deletions docs/application-help-screens/claim-ownership.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sidebar_position: 4
## What Happens When You Claim Ownership

When you claim ownership of a gateway:
- The gateway is permanently linked to your Solana wallet
- The gateway is permanently linked to your Solana Wallet or Sourceful account
- You become eligible for rewards and incentives
- You gain access to gateway configuration options

Expand Down Expand Up @@ -59,4 +59,6 @@ If you:

Please contact support through our Discord channel before proceeding.

> Remember: Take your time to verify all details. This is a crucial step that cannot be easily reversed.
> Remember: Take your time to verify all details. This is a crucial step that cannot be easily reversed.
> Need more help? Please contact our support at [sourceful.energy/support](https://sourceful.energy/support) or browse trough our documentation at [docs.sourceful.energy](https://docs.sourceful.energy)
38 changes: 38 additions & 0 deletions docs/application-help-screens/custom-device-inverter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
sidebar_position: 5
---
# Selecting Your Inverter Brand

## Available Brands
Choose your inverter manufacturer from the list below:

### Standard Inverter Brands
- Deye Micro-inverter
- Growatt
- GoodWe
- Ferroamp
- Sofar
- Enphase
- ...

### Universal Options
- SunSpec Compatible Device
- Unknown/Other Brand

## Before Selecting
Make sure you have:
- Confirmed your inverter's brand and model
- Enabled Modbus TCP on your inverter
- Access to your inverter's network settings

## Not Sure About Compatibility?
If your inverter brand isn't listed or you're using a SunSpec-compliant device:
1. Try the "SunSpec Compatible Device" option if your inverter supports the SunSpec protocol
2. Select "Unknown" if you want to try a custom configuration

## Need Help?
- Check our [compatibility guide](https://docs.sourceful.io/energy-gateway/compatible-inverter/) for a full list of supported models

_Note: Support for additional inverter brands is continuously being added._

> Need more help? Please contact our support at [sourceful.energy/support](https://sourceful.energy/support) or browse trough our documentation at [docs.sourceful.energy](https://docs.sourceful.energy)
31 changes: 31 additions & 0 deletions docs/application-help-screens/custom-device.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
sidebar_position: 5
---
# Adding a Device to Your Energy Gateway

## Choose Your Device Type

### Inverter
Connect your solar inverter or battery system to start monitoring your renewable energy production.
- Supports major brands like SolarEdge, Fronius, Huawei, and more
- Requires Modbus TCP connection
- Provides real-time production data

### Power Meter (Coming Soon)
Monitor your home's energy consumption and production through a power meter connection.
- Support for smart meters and power analyzers
- Track total household energy usage
- Measure import/export to grid

## Before You Begin
Make sure you have:
- Your inverter's IP address (found in your router or inverter settings)
- Modbus TCP enabled on your inverter
- Your inverter model information

## Need Help?
If you need help finding your inverter information or enabling Modbus TCP:
- Check your inverter's user manual
- Visit our [compatibility guide](https://docs.sourceful.io/energy-gateway/compatible-inverter/)

> Need more help? Please contact our support at [sourceful.energy/support](https://sourceful.energy/support) or browse trough our documentation at [docs.sourceful.energy](https://docs.sourceful.energy)
5 changes: 3 additions & 2 deletions docs/application-help-screens/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ This guide will help you get your gateway up and running quickly and securely.
- Your Energy Gateway device
- Power supply (included)
- A Router with an Ethernet port (if wanting to connect via Ethernet)
- A mobile phone or computer for configuration

## Connection Steps

Expand Down Expand Up @@ -71,4 +70,6 @@ After the initial setup:
- You'll be guided through the remaining setup steps
- Follow the app's instructions to complete the process

> Note: Do not disconnect power or network during the firmware update process as this could interrupt critical setup procedures.
> Note: Do not disconnect power or network during the firmware update process as this could interrupt critical setup procedures.
> Need more help? Please contact our support at [sourceful.energy/support](https://sourceful.energy/support) or browse trough our documentation at [docs.sourceful.energy](https://docs.sourceful.energy)
5 changes: 4 additions & 1 deletion docs/application-help-screens/setup-inverter.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,7 @@ If you:

Contact our support team through Discord or email.

> Note: Keep your inverter manual handy during setup. Some manufacturers have specific requirements or settings that need to be enabled.
> Note: Keep your inverter manual handy during setup. Some manufacturers have specific requirements or settings that need to be enabled.

> Need more help? Please contact our support at [sourceful.energy/support](https://sourceful.energy/support) or browse trough our documentation at [docs.sourceful.energy](https://docs.sourceful.energy)
7 changes: 3 additions & 4 deletions docs/application-help-screens/setup-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,13 @@ A reliable alternative that provides:
2. **Configuration**
- Select "Use Ethernet connection"
- No additional setup required
- Click "Continue to Inverter Setup"
- Click "Continue"

## Troubleshooting

### WiFi Issues
- Verify your WiFi password
- Check signal strength
- Ensure 2.4GHz network compatibility
- Restart your router if needed

### Ethernet Issues
Expand All @@ -71,6 +70,6 @@ A reliable alternative that provides:
After successful connection:
- Gateway will download updates
- Connection will be verified
- You'll proceed to inverter setup

Need more help? Contact support through our Discord channel.

> Need more help? Please contact our support at [sourceful.energy/support](https://sourceful.energy/support) or browse trough our documentation at [docs.sourceful.energy](https://docs.sourceful.energy)

0 comments on commit 83fbcc3

Please sign in to comment.