PVOutput.Net 0.11.2

dotnet add package PVOutput.Net --version 0.11.2
NuGet\Install-Package PVOutput.Net -Version 0.11.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="PVOutput.Net" Version="0.11.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PVOutput.Net --version 0.11.2
#r "nuget: PVOutput.Net, 0.11.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install PVOutput.Net as a Cake Addin
#addin nuget:?package=PVOutput.Net&version=0.11.2

// Install PVOutput.Net as a Cake Tool
#tool nuget:?package=PVOutput.Net&version=0.11.2

PVOutput.Net

A .NET Core (Standard 2.0 compatible) wrapper library for API of the popular PVOutput service. PVOutput is a free service for sharing and comparing PV output data.

GitHub last commit (main) NuGet Version NuGet Downloads .NET Core Code coverage

Installation

Installation can be done through installation of the NuGet package:

PM> Install-Package PVOutput.Net

Changelog

See Changelog for information on changes per version, including coming but yet unreleased changes.

Support

This library is targeting .NET Standard 2.0 and above. For full compatibility details, check the Microsoft Docs.

Please note: that the default branch of the repository is develop. This means that it can contain bugfixes/features that are not yet available in the NuGet package. See main for the source code, that was used for building the NuGet package.

Basic usage

This section describes examples of functionality that the library provides.

Getting data out of PVOutput.org

var client = new PVOutputClient(apiKey: "myPvOutputKey", ownedSystemId: 1);

// Request output for today
var outputResponse = await client.Output.GetOutputForDateAsync(DateTime.Today);
var output = outputResponse.Value;
Console.WriteLine($"Output for date {output.OutputDate.ToShortDateString()}, {output.EnergyGenerated} Wh generated");

Adding data to a system in PVOutput.org

var client = new PVOutputClient(apiKey: "myPvOutputKey", ownedSystemId: 1);
var builder = new StatusPostBuilder<IStatusPost>();

// Build the status
var status = builder.SetTimeStamp(DateTime.Now)
                .SetGeneration(200)
                .Build();

// Push the status back to PVOutput
var response = await client.Status.AddStatusAsync(status);

Using the client in an ASP.Net Core application

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddPVOutputClient(options =>
        {
            options.ApiKey = "myPvOutputKey";
            options.OwnedSystemId = 1;
        });
    }

For more information on usage, please see the documentation.

API Coverage

As of 0.8.0 this library contains the complete public API that official PVOutput exposes. See documentation for details.

Contribute

See Contributing for information on how to contribute to this project.

Contributors

Building the project

As the whole solution has all that dotnet magic, you can just run:

dotnet build

to build the solution as a whole or a single project.

Running the Nunit tests can also be done from the cli, just run:

dotnet test

License

This project's structure and Request handling have been seriously inspired (in part, copied even) by Henrik Fröhling's work on Trakt.NET, when it was still called TraktApiSharp. While this project is licensed under the same license as Trakt.NET, I'd still like to make this absolutely clear.

MIT © Marcel Boersma

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.11.2 133 5/4/2023
0.11.1 421 7/24/2022
0.11.0 425 5/5/2022
0.10.0 466 3/16/2022
0.9.2 301 11/22/2021
0.9.1 326 6/1/2021
0.9.0 341 3/13/2021
0.8.1 459 11/7/2020
0.8.0 437 8/29/2020
0.7.1 438 4/26/2020
0.7.0 457 4/8/2020
0.6.0 497 3/28/2020
0.5.0 443 2/27/2020