NEnvoy 0.2.1-alpha

This is a prerelease version of NEnvoy.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package NEnvoy --version 0.2.1-alpha                
NuGet\Install-Package NEnvoy -Version 0.2.1-alpha                
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="NEnvoy" Version="0.2.1-alpha" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NEnvoy --version 0.2.1-alpha                
#r "nuget: NEnvoy, 0.2.1-alpha"                
#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 NEnvoy as a Cake Addin
#addin nuget:?package=NEnvoy&version=0.2.1-alpha&prerelease

// Install NEnvoy as a Cake Tool
#tool nuget:?package=NEnvoy&version=0.2.1-alpha&prerelease                

Logo NEnvoy

A .Net Enphase Envoy client available as a NuGet package.

Currently a work in progress. The list of currently implemented (and not yet implemented) items can be found here.

Quickstart

// Create client and login (assumes "envoy" hostname)
var ci = new ConnectionInfo("user@gmail.com", "sup3rs3cet");
var client = await EnvoyClient.FromLoginAsync(ci).ConfigureAwait(false);

// Get information from Envoy
var deviceinfo = await client.GetEnvoyInfoAsync();

Sessions

A login can be slow; once a session has been set up (logged in successfully) you can obtain sessioninfo with the GetSessionInfo() method. The information in the returned SessionInfo object can then be stored where you want. Next time, the session can be 'resumed' (assuming it hasn't expired) as follows:

var client = EnvoyClient.FromSession(new SessionInfo { Token = "eyJ...iJ9", Id = "i9O...p5Q" });

Which, again, assumes host envoy; if you need to specify another hostname or IP address you can do so:

var session = new SessionInfo { Token = "eyJ...iJ9", Id = "i9O...p5Q" };

var client = EnvoyClient.FromSession(session, "envoy.local");
// or:
var client = EnvoyClient.FromSession(session, "192.168.123.45");

Connection

You can specify a different hostname or IP address for your Envoy:

var ci = new ConnectionInfo("user@gmail.com", "sup3rs3cet", "envoy.local");
// or:
var ci = new ConnectionInfo("user@gmail.com", "sup3rs3cet", "192.168.123.45");

Similarly, the base URI's for the enphase portal can be overridden:

var ci = new ConnectionInfo("user@gmail.com", "sup3rs3cet", EnphaseBaseUri: "https://enlighten-new.enphaseenergy.com");
// or:
var ci = new ConnectionInfo("user@gmail.com", "sup3rs3cet", EnphaseEntrezBaseUri: "https://entrez-new.enphaseenergy.com");

Contributing

Yes please! Implement any of the methods and make a PR and we'll take it from there.

License

Licensed under MIT license. See LICENSE for details.


Icon made by Payungkead from www.flaticon.com is licensed by CC 3.0.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  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. 
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.3.2-alpha 79 3/7/2024
0.3.1-alpha 115 6/2/2023
0.3.0-alpha 90 6/2/2023
0.2.5-alpha 89 5/30/2023
0.2.4-alpha 79 5/30/2023
0.2.3-alpha 83 5/22/2023
0.2.2-alpha 80 5/22/2023
0.2.1-alpha 80 5/22/2023
0.2.0-alpha 84 5/22/2023
0.1.2-alpha 77 5/17/2023
0.1.1-alpha 76 5/17/2023
0.1.0-alpha 78 5/16/2023