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

Commit 28dcc82

Browse files
committed
Update docs for v0.7.0
1 parent eeea1f1 commit 28dcc82

4 files changed

Lines changed: 29 additions & 10 deletions

File tree

Readme.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,17 @@ We can update live data (realtime power generation, temperature and so on) up to
1616

1717
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).
1818

19+
# Installation
20+
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.
21+
22+
# Uninstallation / updating
23+
Unfortunately, the uninstaller is broken. Will fix before v1.0.
24+
25+
For now, manually uninstall before update: see the [downloads page on the documentation site](https://codecasternl.github.io/PVBridge/downloads.html).
26+
1927
# [Documentation](https://codecasternl.github.io/PVBridge/)
2028
For documentation on installing and setting up, see the [documentation site](https://codecasternl.github.io/PVBridge/).
2129

22-
* TODO: document setting it up ([#13](https://github.com/CodeCasterNL/PVBridge/issues/13)).
23-
2430
# Status
2531
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.
2632

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

39-
# Installation
40-
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.
41-
4245
# Supported behavior
4346
This is what the app should be able to do in its current state:
4447

docs/changelog.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ order: 40
44
---
55
## Changelog
66

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

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

1415
### v0.6.4 (removed)
1516
Fix GoodWe inverter selection, or so we hope.

docs/commandline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
menuTitle: Command line
3-
title: Commandline Sync
3+
title: Command line Sync
44
order: 20
55
---
66
## Syncing from the command line

docs/downloads.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@ order: 50
55
## Latest release
66
Download the latest release on the [GitHub Releases page](https://github.com/CodeCasterNL/PVBridge/releases).
77

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

1010
See [Configuring the service](./configuration.md) for configuring the service using the UI.
11+
12+
## Updating / uninstalling
13+
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**.
14+
15+
You can do so by starting an administrative command prompt, and:
16+
17+
```bash
18+
> cd "C:\Program Files\PVBridge"
19+
20+
> PVBridge.exe service uninstall
21+
```
22+
23+
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.
24+
25+
Uninstall also doesn't clean up log and configuration data on uninstall. You can delete `C:\ProgramData\PVBridge` whenever you want.

0 commit comments

Comments
 (0)