README and option docs

Anar/Services/Influx/InfluxOptions.cs

@@ -4,15 +4,27 @@ namespace Anar.Services;
 
 internal sealed class InfluxOptions
 {
+    /// <summary>
+    /// Influx DB bucket for data writing.
+    /// </summary>
     [Required]
-    public Uri Uri { get; set; } = default!;
+    public string? Bucket { get; set; } = null;
 
+    /// <summary>
+    /// Influx DB organization for data writing.
+    /// </summary>
     [Required]
-    public string Token { get; set; } = string.Empty;
+    public string? Organization { get; set; } = null;
 
+    /// <summary>
+    /// Influx DB token.  Token must grant write access to named bucket.
+    /// </summary>
     [Required]
-    public string? Bucket { get; set; } = null;
+    public string Token { get; set; } = string.Empty;
 
+    /// <summary>
+    /// Influx DB URL.
+    /// </summary>
     [Required]
-    public string? Organization { get; set; } = null;
+    public Uri Uri { get; set; } = default!;
 }

README.md

@@ -0,0 +1,83 @@
+# Anar
+
+On Tolkien's Middle-Earth, Anar is the sun. A vessel piloted through
+the heavens by the Maia Arien after the fall of the Two Trees.
+
+Anar here monitors my own solar system [heh] gathering data on my inverters
+and uploading the data to my InfluxDB database.
+
+Much of this progject was geared towards creating a .NET project the could
+be configured and run in a docker swarm environment.
+
+# Configuration
+Like most .NET apps, you can specify all configuration settings using a combination of config files `appsettings.json`, environment variables, or
+command line options.
+
+In addition, this project supports using Docker configs and secrets as follows.
+An envrionment varialbe APP_SETTINGS_DOCKER can be set to identify an
+additional location for appsettings.config.  This can be `/configname` to load
+from a docker config, or `/run/secrets/secretname` to load from a docker secret.
+
+## GatewayOptions
+This section controls settings for communcating with an Enphase IQ gateway.
+Enphase does not make direct access easy.
+
+### GatewayOptions : Inteval (TimeSpan) default = 0.00:05:00
+This setting controls how often to poll the data from the gateway.
+
+### GatewayOptions : Layout (Location[]) default []
+This optional setting provides a way to embed layout data directly into
+appsettings. Layout data can be used to augment the InfluxDB data with
+additional tags, but requires detailed information about your installation.
+
+### GatewayOptions : LayoutFile (string)
+This optional setting provides an alternative to Layout above. Instead of embedding the location array directly, layout information can be imported from
+`array_layout_x.json` which is one of the files downloaded in the background
+when you view your system on the [Enlighten Website](https://enlighten.enphaseenergy.com/). You'll need to use dev tools to capture this file.
+
+### GatewayOptions : Thumbprint (string)
+This is the SHA-1 value of the self-signed certificate of your Enphase gateway.
+You can capture this by reviewing browser security settings.  Value is a stream
+of hex digits with no punctuation.
+
+### GatewayOptions : Token (string)
+This is the security token the system should use when accessing your gateway.
+[This Technical Brief](https://enphase.com/download/accessing-iq-gateway-local-apis-or-local-ui-token-based-authentication) describes one way to get one.
+
+### GatewayOptions : Uri (string)
+This is the web address of your gateway. Usually it is going to be a local IP
+like `https://192.168.1.10`, but your setup may be different than mine.
+
+## InfluxOptions
+These opitons control how the app will connect to an InfluxDB database.
+
+### InfluxOptions : Bucket (string)
+This is the data bucket to insert data to.
+
+### InfluxOptions : Organization (string)
+This is the organization associated with the token.
+
+### InfluxOptions : Token (string)
+This is the InfluxDB authentication token.
+
+### InfluxOptions : Uri
+This is the web address of your database. For example `http://influxdb:8086`.
+Your setup may be different than mine.
+
+# Building
+Most of the ways you can build .NET apps will work. In addition a compose.yaml
+file in the folder can be done to build a docker container
+
+## Via Command line
+```shell
+# make sure appsettings.json has been properly filled out.
+dotnet build
+dotnet run --project Anar
+```
+
+## Via Docker
+```shell
+# make sure all your settings have been configured.
+docker compose build
+docker compose up -d
+```