CCSWE.nanoFramework.Configuration 1.1.117

CCSWE.nanoFramework.Configuration

Pluggable configuration management for nanoFramework applications. Configuration objects are loaded from a storage backend, validated, and surfaced through IConfigurationManager. A ConfigurationChanged event notifies listeners when a section is updated.

API

IConfigurationManager

The primary interface for reading and writing configuration:

• Get(string section) — retrieve a configuration object by section name (cast to the expected type)
• Save(string section, object configuration) / SaveAsync(...) — persist a configuration object
• Clear(string section) — remove a section from storage
• Contains(string section) — check whether a section exists
• GetSections() — list all stored section names
• ConfigurationChanged — event raised after a section is saved or cleared

IConfigurationStorage

Pluggable backend that the ConfigurationManager delegates persistence to:

• ReadConfiguration(string section) — read raw configuration data
• WriteConfiguration(string section, object configuration) — write raw configuration data
• DeleteConfiguration(string section) — remove a section

The default backend stores configuration in the device's internal file system (I:\). File-system backed storage is available via CCSWE.nanoFramework.FileStorage.

IValidateConfiguration

Implement on a configuration class to enable validation before it is saved:

• Validate() — returns ValidateConfigurationResult; throw or return failure to abort the save

ConfigurationManagerOptions

Options passed during DI registration:

• UseInternalStorage — when true (default), uses the internal I:\ file system

DI Registration

Define a configuration class and bind it with defaults during startup:

public class WifiConfiguration
{
    public string Ssid { get; set; } = string.Empty;
    public string Password { get; set; } = string.Empty;
}

// In ConfigureServices:
services.AddConfigurationManager()
        .BindConfiguration("wifi", new WifiConfiguration { Ssid = "MyNetwork" });

Retrieve and save via IConfigurationManager at runtime:

// Read the current configuration
var config = (WifiConfiguration)configurationManager.Get("wifi");

// Persist changes
config.Password = "secret";
configurationManager.Save("wifi", config);

To use external file-system storage instead of the internal I:\ drive:

services.AddConfigurationManager(options => options.UseInternalStorage = false);
services.AddSingleton(typeof(IConfigurationStorage), typeof(YourConfigurationStorage));