mirror of
https://github.com/PepperDash/EssentialsPluginTemplate.git
synced 2026-01-27 19:34:37 +00:00
fix: update template repo
1. update workflow files 2. Add 3-series SLN and csproj files - Remove from project when using the template if not needed 3. Update 4-series SLN and csproj files 4. Moved SLN's to root of project 5. Rename *.cs files to identify naming convention of 'MakeModel' 6. Upate packages.config to reference latest Essentials v1 release
This commit is contained in:
195
src/MakeModelConfigObject.cs
Normal file
195
src/MakeModelConfigObject.cs
Normal file
@@ -0,0 +1,195 @@
|
||||
using System.Collections.Generic;
|
||||
using Newtonsoft.Json;
|
||||
using PepperDash.Essentials.Core;
|
||||
|
||||
namespace PepperDash.Essentials.Plugin
|
||||
{
|
||||
/// <summary>
|
||||
/// Plugin device configuration object
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Rename the class to match the device plugin being created
|
||||
/// </remarks>
|
||||
/// <example>
|
||||
/// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig"
|
||||
/// </example>
|
||||
[ConfigSnippet("\"properties\":{\"control\":{}")]
|
||||
public class EssentialsPluginTemplateConfigObject
|
||||
{
|
||||
/// <summary>
|
||||
/// JSON control object
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Typically this object is not required, but in some instances it may be needed. For example, when building a
|
||||
/// plugin that is using Telnet (TCP/IP) communications and requires login, the device will need to handle the login.
|
||||
/// In order to do so, you will need the username and password in the "tcpSshProperties" object.
|
||||
/// </remarks>
|
||||
/// <example>
|
||||
/// <code>
|
||||
/// "control": {
|
||||
/// "method": "tcpIp",
|
||||
/// "controlPortDevKey": "processor",
|
||||
/// "controlPortNumber": 1,
|
||||
/// "comParams": {
|
||||
/// "baudRate": 9600,
|
||||
/// "dataBits": 8,
|
||||
/// "stopBits": 1,
|
||||
/// "parity": "None",
|
||||
/// "protocol": "RS232",
|
||||
/// "hardwareHandshake": "None",
|
||||
/// "softwareHandshake": "None"
|
||||
/// },
|
||||
/// "tcpSshProperties": {
|
||||
/// "address": "172.22.0.101",
|
||||
/// "port": 23,
|
||||
/// "username": "admin",
|
||||
/// "password": "password",
|
||||
/// "autoReconnect": true,
|
||||
/// "autoReconnectIntervalMs": 10000
|
||||
/// }
|
||||
/// }
|
||||
/// </code>
|
||||
/// </example>
|
||||
[JsonProperty("control")]
|
||||
public EssentialsControlPropertiesConfig Control { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Serializes the poll time value
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built.
|
||||
/// </remarks>
|
||||
/// <value>
|
||||
/// PollTimeMs property gets/sets the value as a long
|
||||
/// </value>
|
||||
/// <example>
|
||||
/// <code>
|
||||
/// "properties": {
|
||||
/// "polltimeMs": 30000
|
||||
/// }
|
||||
/// </code>
|
||||
/// </example>
|
||||
[JsonProperty("pollTimeMs")]
|
||||
public long PollTimeMs { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Serializes the warning timeout value
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built.
|
||||
/// </remarks>
|
||||
/// <value>
|
||||
/// WarningTimeoutMs property gets/sets the value as a long
|
||||
/// </value>
|
||||
/// <example>
|
||||
/// <code>
|
||||
/// "properties": {
|
||||
/// "warningTimeoutMs": 180000
|
||||
/// }
|
||||
/// </code>
|
||||
/// </example>
|
||||
[JsonProperty("warningTimeoutMs")]
|
||||
public long WarningTimeoutMs { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Serializes the error timeout value
|
||||
/// </summary>
|
||||
/// /// <remarks>
|
||||
/// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built.
|
||||
/// </remarks>
|
||||
/// <value>
|
||||
/// ErrorTimeoutMs property gets/sets the value as a long
|
||||
/// </value>
|
||||
/// <example>
|
||||
/// <code>
|
||||
/// "properties": {
|
||||
/// "errorTimeoutMs": 300000
|
||||
/// }
|
||||
/// </code>
|
||||
/// </example>
|
||||
[JsonProperty("errorTimeoutMs")]
|
||||
public long ErrorTimeoutMs { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Example dictionary of objects
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is an example collection configuration object. This should be modified or deleted as needed for the plugin being built.
|
||||
/// </remarks>
|
||||
/// <example>
|
||||
/// <code>
|
||||
/// "properties": {
|
||||
/// "presets": {
|
||||
/// "preset1": {
|
||||
/// "enabled": true,
|
||||
/// "name": "Preset 1"
|
||||
/// }
|
||||
/// }
|
||||
/// }
|
||||
/// </code>
|
||||
/// </example>
|
||||
/// <example>
|
||||
/// <code>
|
||||
/// "properties": {
|
||||
/// "inputNames": {
|
||||
/// "input1": "Input 1",
|
||||
/// "input2": "Input 2"
|
||||
/// }
|
||||
/// }
|
||||
/// </code>
|
||||
/// </example>
|
||||
[JsonProperty("DeviceDictionary")]
|
||||
public Dictionary<string, EssentialsPluginTemplateConfigObjectDictionary> DeviceDictionary { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Constuctor
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// If using a collection you must instantiate the collection in the constructor
|
||||
/// to avoid exceptions when reading the configuration file
|
||||
/// </remarks>
|
||||
public EssentialsPluginTemplateConfigObject()
|
||||
{
|
||||
DeviceDictionary = new Dictionary<string, EssentialsPluginTemplateConfigObjectDictionary>();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Example plugin configuration dictionary object
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built.
|
||||
/// </remarks>
|
||||
/// <example>
|
||||
/// <code>
|
||||
/// "properties": {
|
||||
/// "dictionary": {
|
||||
/// "item1": {
|
||||
/// "name": "Item 1 Name",
|
||||
/// "value": "Item 1 Value"
|
||||
/// }
|
||||
/// }
|
||||
/// }
|
||||
/// </code>
|
||||
/// </example>
|
||||
public class EssentialsPluginTemplateConfigObjectDictionary
|
||||
{
|
||||
/// <summary>
|
||||
/// Serializes collection name property
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built.
|
||||
/// </remarks>
|
||||
[JsonProperty("name")]
|
||||
public string Name { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Serializes collection value property
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built.
|
||||
/// </remarks>
|
||||
[JsonProperty("value")]
|
||||
public uint Value { get; set; }
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user