diff --git a/Home.md b/Home.md index 51ea18f..bb848b6 100644 --- a/Home.md +++ b/Home.md @@ -25,7 +25,6 @@ Or use the links to the right to navigate our documentation. * Configurable using simple JSON files * Is awesome - --- ## Documentation @@ -52,7 +51,7 @@ The `master` branch always contain the latest stable version. The `development` [GitFlow](https://nvie.com/posts/a-successful-git-branching-model/) will be used as the workflow for this collaborative project. To contribute, follow this process: -1. Fork this repository +1. Fork this repository ([More Info](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks)) 2. Create a branch using standard GitFlow branch prefixes (feature/hotfix/bugfix) followed by a descriptive name. - Example: `feature/add-awesomeness`,`bugfix/wow-im-dumb` or `hotfix/really-big-oops` - When working on a new feature or bugfix, branch from the `development` branch. When working on a hotfix, branch from `master`. diff --git a/SIMPL-Bridging.md b/SIMPL-Bridging.md index 1ff68d7..ce4209a 100644 --- a/SIMPL-Bridging.md +++ b/SIMPL-Bridging.md @@ -5,12 +5,12 @@ Essentials allows for devices defined within the SIMPL# Pro application to be br Some of the main advantages are: 1. The ability to instantiate devices from configuration. -2. The ability to leverage C# concepts to handle data intensive tasks (Serialization/Deserialization of JSON/XML, cyrptography, etc.). -3. The ability to reuse the same compiled SIMPL Windows program (regardless of target processor type) by offloading all the variables that may be room or hardware specific to Essentials. -4. The ability to handle multiple communciation types generically without changing the SIMPL Program (TCP/UDP/SSH/HTTP/HTTPS/CEC, etc.) -5. Much faster development cycle -6. Reduced processor overhead -7. Ability to easily share devices defined in Essentials between multiple other programs +1. The ability to leverage C# concepts to handle data intensive tasks (Serialization/Deserialization of JSON/XML, cyrptography, etc.). +1. The ability to reuse the same compiled SIMPL Windows program (regardless of target processor type) by offloading all the variables that may be room or hardware specific to Essentials. +1. The ability to handle multiple communciation types generically without changing the SIMPL Program (TCP/UDP/SSH/HTTP/HTTPS/CEC, etc.) +1. Much faster development cycle +1. Reduced processor overhead +1. Ability to easily share devices defined in Essentials between multiple other programs ## Implementation @@ -133,11 +133,11 @@ We have four Essentials Devices configured: 1. Pro3 with a Key of "processor" -2. Panasonic Display with a Key of "panasonicDisplay01" +1. Panasonic Display with a Key of "panasonicDisplay01" -3. Com port with a Key of "vtcComPort" +1. Com port with a Key of "vtcComPort" -4. Bridge with a Key of "deviceBridge" +1. Bridge with a Key of "deviceBridge" We want to have access to the com port for VTC Control from Simpl Windows and we want to control the display from Simpl Windows. To accomplish this, we have created a bridge device and added the devices to be bridged to the "devices" array on the bridge. As you can see we define the device key and the join start, which will determine which joins we will use on the resulting EISC to interact with the devices. In the Bridge control properties we defined ipid 03, and we will need a corresponding Ethernet System Intercommunication in the Simpl Windows program at ipid 03. @@ -350,23 +350,23 @@ Example device config: