pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-16 21:24:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Removes the json tag from the code blocks in the Configuration. It was causing the comments to render weird because comments are not legal in json.

Jason T Alborough
2020-02-21 18:11:50 -05:00
parent 4e0e32f76e
commit 20f4b8986b
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
ConfigurationStructure.md

@@ -8,7 +8,7 @@ At a high level, the idea is to define a template of all of the common configura
## Top Level Object Structure (Double Config) ## Top Level Object Structure (Double Config)
``` json ```
{ {
// This object is deserialized to type PepperDash.Essentials.Core.Config.EssentialsConfig // This object is deserialized to type PepperDash.Essentials.Core.Config.EssentialsConfig
@@ -64,7 +64,7 @@ The idea being that configuration values that are common to all systems can be s
Below is an example of a double configuration containing both template and system properties. Below is an example of a double configuration containing both template and system properties.
``` json ```
{ {
"template": { "template": {
"info": { "info": {
@@ -93,7 +93,7 @@ Below is an example of a double configuration containing both template and syste
} }
``` ```
Below is an example of the result of merging the above double configuration example into a single configuration. Below is an example of the result of merging the above double configuration example into a single configuration.
``` json ```
{ {
"info": { "info": {
"name": "System Name", // Since this property existed in both the template and system, the system value replaces the template value after the merge "name": "System Name", // Since this property existed in both the template and system, the system value replaces the template value after the merge
@@ -111,7 +111,7 @@ Below is an example of the result of merging the above double configuration exam
--- ---
## Device Object Structure ## Device Object Structure
The devices array is meant to hold a series of device objects.  The basic device object structure is defined below. The devices array is meant to hold a series of device objects.  The basic device object structure is defined below.
``` json ```
{ {
"key": "someUniqueString", // *required* a unique string "key": "someUniqueString", // *required* a unique string
"name": "A friendly Name", // *required* a friendly name meant for display to users "name": "A friendly Name", // *required* a friendly name meant for display to users
@@ -147,7 +147,7 @@ Some additional details about specific properties that are important to note:
## The Device Properties.Control Object ## The Device Properties.Control Object
The control object inside properties has some reserved properties that are used by configuration tools and Essentials that require some caution. The control object inside properties has some reserved properties that are used by configuration tools and Essentials that require some caution.
``` json ```
{ {
"properties": { // *required* an object where the configurable properties of the device are contained "properties": { // *required* an object where the configurable properties of the device are contained
"control": { // an object to contain all of the properties to connect to and control the device "control": { // an object to contain all of the properties to connect to and control the device
@@ -183,7 +183,7 @@ The control object inside properties has some reserved properties that are used
## Device Merging ## Device Merging
The following examples illustrate how the device key and uid properties affect how devices are merged together in a double configuration scenario.  In order for a template device and a system device to merge, they must have the same key and uid values The following examples illustrate how the device key and uid properties affect how devices are merged together in a double configuration scenario.  In order for a template device and a system device to merge, they must have the same key and uid values
``` json ```
{ {
"template": { "template": {
"info": { "info": {
@@ -239,7 +239,7 @@ The following examples illustrate how the device key and uid properties affect h
} }
``` ```
Below is an example of the result of merging the above double configuration example into a single configuration.   Below is an example of the result of merging the above double configuration example into a single configuration.  
``` json ```
{ {
"info": { "info": {
"name": "System Name", "name": "System Name",

2
Plugins.md

@@ -21,7 +21,7 @@ One or more plugins can be loaded to the /user/ProgramX/plugins as .dlls or .cpl
All plugin assemblies must contain a static method called LoadPlugin(): All plugin assemblies must contain a static method called LoadPlugin():
```csharp ```csharp
public class SomeDevice : Device , IBridge //IBridge only needs to be implemented if public class SomeDevice : Device , IBridge //IBridge only needs to be implemented if using a bridge
{ {
// This string is used to define the minimum version of the // This string is used to define the minimum version of the
// Essentials Framework required for this plugin // Essentials Framework required for this plugin