Skip to content
This repository has been archived by the owner on May 16, 2024. It is now read-only.

Commit

Permalink
Update docs for v0.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeCasterNL committed Aug 25, 2022
1 parent eeea1f1 commit 28dcc82
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 10 deletions.
13 changes: 8 additions & 5 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,17 @@ We can update live data (realtime power generation, temperature and so on) up to

Other inputs and outputs (other inverter APIs, CSV), aggregations ([#26](https://github.com/CodeCasterNL/PVBridge/issues/26)), aggregations to CSV, Excel to CSV and [other features and improvements](https://github.com/CodeCasterNL/PVBridge/issues) are (far) future plans, help is more than welcome! See [Contributing.md](Contributing.md).

# Installation
Download the most recent version "PVBridge-{version}.msi" under "Releases" on [the GitHub page](https://github.com/CodeCasterNL/PVBridge). For older versions, check https://github.com/CodeCasterNL/PVBridge/releases.

# Uninstallation / updating
Unfortunately, the uninstaller is broken. Will fix before v1.0.

For now, manually uninstall before update: see the [downloads page on the documentation site](https://codecasternl.github.io/PVBridge/downloads.html).

# [Documentation](https://codecasternl.github.io/PVBridge/)
For documentation on installing and setting up, see the [documentation site](https://codecasternl.github.io/PVBridge/).

* TODO: document setting it up ([#13](https://github.com/CodeCasterNL/PVBridge/issues/13)).

# Status
Current status: as-is development-prerelease. This means that it might work on your computer, but if it doesn't, please [open an issue](https://github.com/CodeCasterNL/PVBridge/issues/new) with as much relevant details as possible and help me figure it out.

Expand All @@ -36,9 +42,6 @@ In order to install this program, you need:
* Administrative permissions to install the PVBridge Windows Service.
* The 64-bit version of the .NET Desktop Runtime, 6.0 or higher (should come with the installer).

# Installation
Download the most recent version "PVBridge.{version}.msi" under "Releases" on [the GitHub page](https://github.com/CodeCasterNL/PVBridge). For older versions, check https://github.com/CodeCasterNL/PVBridge/releases.

# Supported behavior
This is what the app should be able to do in its current state:

Expand Down
7 changes: 4 additions & 3 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ order: 40
---
## Changelog

### [v0.7.0] (upcoming)
### [v0.7.0](https://github.com/CodeCasterNL/PVBridge/releases/tag/v0.7.0)
Branched from 0.6.2, so no inverter selection yet, fixed:

* Command-line sync further back than 14 days
* Command-line sync further back than 14 days (`--snapshot-days 90`, see [Command line docs](https://codecasternl.github.io/PVBridge/commandline.html)).
* Loop logic rewritten, should now wait until the next interval and not fall back to backlog sync.
* Log JSON before deserializing, not after
* Log JSON before deserializing, not after.
* Nullability issues in GoodWe response.

### v0.6.4 (removed)
Fix GoodWe inverter selection, or so we hope.
Expand Down
2 changes: 1 addition & 1 deletion docs/commandline.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
menuTitle: Command line
title: Commandline Sync
title: Command line Sync
order: 20
---
## Syncing from the command line
Expand Down
17 changes: 16 additions & 1 deletion docs/downloads.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@ order: 50
## Latest release
Download the latest release on the [GitHub Releases page](https://github.com/CodeCasterNL/PVBridge/releases).

You'll need the latest PVBridge.{version}.msi (currently 0.7.0), ignore SmartScreen (click "More info" and "Run anyway").
You'll need the latest PVBridge-{version}.msi (currently 0.7.0), ignore SmartScreen (click "More info" and "Run anyway").

See [Configuring the service](./configuration.md) for configuring the service using the UI.

## Updating / uninstalling
Unfortunately, the setup doesn't properly delete the service on uninstall. This means the service will remain installed and active after uninstallation, unless you **manually delete PVBridge**.

You can do so by starting an administrative command prompt, and:

```bash
> cd "C:\Program Files\PVBridge"

> PVBridge.exe service uninstall
```

Now you can uninstall the earlier version from the Windows "Add or remove programs" control panel, i.e. "Apps & Features". If it doesn't appear there, it's now safe to delete `C:\Program Files\PVBridge` or wherever you installed it.

Uninstall also doesn't clean up log and configuration data on uninstall. You can delete `C:\ProgramData\PVBridge` whenever you want.

0 comments on commit 28dcc82

Please sign in to comment.