Configuration API

• Be the same machine running the Elve Master Service.
• or have a MachineSettings.config file here: C:\ProgramData\Codecore Technologies\Elve\MachineSettings.config
  

Example

using CodecoreTechnologies.Elve.Configuration;
using CodecoreTechnologies.Elve.RemoteAccess;
    
Configuration config;
try
{
    config = new Configuration("admin", "admin");
}
catch (SocketException ex)
{
    // TODO: failed to connect to master service
}
catch (Exception ex)
{
    // TODO: user account does not have access
}

try
{
    // Prepare the device settings
    DeviceSettingDictionary settings = new DeviceSettingDictionary();
    settings.Add("HostName", "192.168.0.12");
    settings.Add("Port", 2101");

    DeviceConfiguration devConfig = new DeviceConfiguration("WINDOWSPC", "elkm1", new string[]{"security", "climate"}, "Elk M1", "ElkM1Driver", settings, true, LoggerVerbosity.Normal)

    // Save the new device
    config.SaveDevice( devConfig );

    // Remove a device
    config.RemoveDevice("lighting");
}
catch (SocketException ex)
{
    // TODO: failed to connect to master service
}
catch (Exception ex)
{
    // TODO: a variety of other exceptions may occur, for example if an argument is invalid, etc.
}

Configuration Class Members

Constructors

Configuration( string username, string password )

Instance Methods

SaveDevice( DeviceConfiguration deviceConfig )

SaveDevice( string originalDeviceName, DeviceConfiguration deviceConfig )

RemoveDevice( string deviceName )

EnableDevice( string deviceName )

DisableDevice( string deviceName )

GetDeviceConfiguration( string deviceName )

GetAllDeviceConfigurations()

GetDeviceConfigurations( params string[] deviceNames )

DeviceConfiguration Class Members

Constructors

DeviceConfiguration(string serverName, string name, IEnumerable aliases, string displayName, string driverName, DeviceSettingDictionary settings, bool enabled, LoggerVerbosity verbosity)