mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-02-16 21:24:54 +00:00
updates for changing master->main
@@ -4,7 +4,7 @@ Configuration is central to Essentials. On this page we will cover configuration
|
|||||||
|
|
||||||
## Classes Referenced
|
## Classes Referenced
|
||||||
|
|
||||||
* `PepperDash.Essentials.Core.Config.DeviceConfig`
|
- `PepperDash.Essentials.Core.Config.DeviceConfig`
|
||||||
|
|
||||||
## Configure-first development
|
## Configure-first development
|
||||||
|
|
||||||
@@ -34,13 +34,13 @@ In Essentials, most everything we do is focused in one layer: The Devices layer.
|
|||||||
|
|
||||||
Types of devices:
|
Types of devices:
|
||||||
|
|
||||||
* Rooms
|
- Rooms
|
||||||
* Sources
|
- Sources
|
||||||
* Codecs, DSPs, displays, routing hardware
|
- Codecs, DSPs, displays, routing hardware
|
||||||
* IR Ports, Com ports, SSh Clients, ...
|
- IR Ports, Com ports, SSh Clients, ...
|
||||||
* Occupancy sensors and relay-driven devices
|
- Occupancy sensors and relay-driven devices
|
||||||
* Logical devices that manage multiple devices and other business, like shade or lighting scene controllers
|
- Logical devices that manage multiple devices and other business, like shade or lighting scene controllers
|
||||||
* Fusion connectors to rooms
|
- Fusion connectors to rooms
|
||||||
|
|
||||||
A Device doesn't always represent a physical piece of hardware, but rather a logical construct that "does something" and is used by one or more other devices in the running program. For example, we create a room device, and its corresponding Fusion device, and that room has a Cisco codec device, with an attached SSh client device. All of these lie in a flat collection in the `DeviceManager`.
|
A Device doesn't always represent a physical piece of hardware, but rather a logical construct that "does something" and is used by one or more other devices in the running program. For example, we create a room device, and its corresponding Fusion device, and that room has a Cisco codec device, with an attached SSh client device. All of these lie in a flat collection in the `DeviceManager`.
|
||||||
|
|
||||||
@@ -76,11 +76,11 @@ Often, code is written and tested first without consideration for configurabilit
|
|||||||
|
|
||||||
At the heart of the Essentials framework is the configuration system. While not technically necessary for a system written with the Essentials framework, it is the preferred and, currently, the only way to build an Essentials system. The configuration file is JSON, and well-defined (but not well documented, yet). It is comprised of blocks:
|
At the heart of the Essentials framework is the configuration system. While not technically necessary for a system written with the Essentials framework, it is the preferred and, currently, the only way to build an Essentials system. The configuration file is JSON, and well-defined (but not well documented, yet). It is comprised of blocks:
|
||||||
|
|
||||||
* info (object) Contains metadata about the config file
|
- info (object) Contains metadata about the config file
|
||||||
* devices (array) Contains, well, the devices we intend to build and load
|
- devices (array) Contains, well, the devices we intend to build and load
|
||||||
* rooms (array, typically only one) Contains the rooms we need
|
- rooms (array, typically only one) Contains the rooms we need
|
||||||
* sourceLists (object) Used by one or more rooms to represent list(s) of sources for those rooms
|
- sourceLists (object) Used by one or more rooms to represent list(s) of sources for those rooms
|
||||||
* tieLines (array) Used by the routing system to discover routing between sources and displays
|
- tieLines (array) Used by the routing system to discover routing between sources and displays
|
||||||
|
|
||||||
In addition, a downloaded Portal config file will most likely be in a template/system form, meaning that the file contains two main objects, representing the template configuration and its system-level overrides. Other metadata, such as Portal UUIDs or URLs may be present.
|
In addition, a downloaded Portal config file will most likely be in a template/system form, meaning that the file contains two main objects, representing the template configuration and its system-level overrides. Other metadata, such as Portal UUIDs or URLs may be present.
|
||||||
|
|
||||||
@@ -127,7 +127,7 @@ Once the ConfigReader has successfully read and deserialized the config file, th
|
|||||||
|
|
||||||
This ordering ensures that all devices are at least present before building tie lines and rooms. Rooms can be built without their required devices being present. In principle, this could break from the loosely-coupled goal we have described, but it is the clearest way to build the system in code. The goal is still to build a room class that doesn't have functional dependencies on devices that may not be ready for use.
|
This ordering ensures that all devices are at least present before building tie lines and rooms. Rooms can be built without their required devices being present. In principle, this could break from the loosely-coupled goal we have described, but it is the clearest way to build the system in code. The goal is still to build a room class that doesn't have functional dependencies on devices that may not be ready for use.
|
||||||
|
|
||||||
In each device/room step, a device factory process is called. We call subsequent device factory methods in the various libraries that make up Essentials until one of them returns a functional device. This allows us to break up the factory process into individual libraries, and not have a huge master list of types and build procedures. Here's part of the code:
|
In each device/room step, a device factory process is called. We call subsequent device factory methods in the various libraries that make up Essentials until one of them returns a functional device. This allows us to break up the factory process into individual libraries, and not have a huge list of types and build procedures. Here's part of the code:
|
||||||
|
|
||||||
```cs
|
```cs
|
||||||
// Try local factories first
|
// Try local factories first
|
||||||
|
|||||||
@@ -226,4 +226,4 @@ RMC3>devjson:1 {"deviceKey":"cec-1-cec", "methodName":"SendText", "params": ["he
|
|||||||
RMC3>devjson:1 {"deviceKey":"cec-1-cec", "methodName":"SimulateReceive", "params": ["hello citizen of Earth\r"]}
|
RMC3>devjson:1 {"deviceKey":"cec-1-cec", "methodName":"SimulateReceive", "params": ["hello citizen of Earth\r"]}
|
||||||
```
|
```
|
||||||
|
|
||||||
For additional examples, see this [file](https://github.com/PepperDash/Essentials/blob/master/devjson%20commands.json).
|
For additional examples, see this [file](https://github.com/PepperDash/Essentials/blob/main/devjson%20commands.json).
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Download or clone
|
## Download or clone
|
||||||
|
|
||||||
You may clone Essentials at <https://github.com/PepperDash/Essentials/tree/master>
|
You may clone Essentials at <https://github.com/PepperDash/Essentials/tree/main>
|
||||||
|
|
||||||
You may download ready-to-run Essentials at <https://github.com/PepperDash/Essentials-Builds>
|
You may download ready-to-run Essentials at <https://github.com/PepperDash/Essentials-Builds>
|
||||||
|
|
||||||
|
|||||||
24
Home.md
24
Home.md
@@ -8,8 +8,8 @@ Essentials is a collection of C# libraries that can be used in many ways. It is
|
|||||||
|
|
||||||
## Get started
|
## Get started
|
||||||
|
|
||||||
* [Download essentials build or clone repo](Get-started#)
|
- [Download essentials build or clone repo](Get-started#)
|
||||||
* [How to get started](Get-started)
|
- [How to get started](Get-started)
|
||||||
|
|
||||||
Or use the links to the right to navigate our documentation.
|
Or use the links to the right to navigate our documentation.
|
||||||
|
|
||||||
@@ -17,13 +17,13 @@ Or use the links to the right to navigate our documentation.
|
|||||||
|
|
||||||
## Benefits
|
## Benefits
|
||||||
|
|
||||||
* Runs on Crestron 3-Series, **4-Series** and VC-4 Control System platforms
|
- Runs on Crestron 3-Series, **4-Series** and VC-4 Control System platforms
|
||||||
* Reduced hardware overhead compared to S+ and Simpl solutions
|
- Reduced hardware overhead compared to S+ and Simpl solutions
|
||||||
* Quick development cycle
|
- Quick development cycle
|
||||||
* Shared resources made easily available
|
- Shared resources made easily available
|
||||||
* More flexibility with less code
|
- More flexibility with less code
|
||||||
* Configurable using simple JSON files
|
- Configurable using simple JSON files
|
||||||
* Is awesome
|
- Is awesome
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -47,14 +47,14 @@ Essentials is an open-source project and we encourage collaboration on this comm
|
|||||||
|
|
||||||
### Open-source-collaborative workflow
|
### Open-source-collaborative workflow
|
||||||
|
|
||||||
The `master` branch always contain the latest stable version. The `development` branch is used for most development efforts.
|
The `main` branch always contain the latest stable version. The `development` branch is used for most development efforts.
|
||||||
|
|
||||||
[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:
|
[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 ([More Info](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks))
|
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) followed by a descriptive name.
|
2. Create a branch using standard GitFlow branch prefixes (feature/hotfix) followed by a descriptive name.
|
||||||
* Example: `feature/add-awesomeness` or `hotfix/really-big-oops`
|
- Example: `feature/add-awesomeness` 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`.
|
- When working on a new feature or bugfix, branch from the `development` branch. When working on a hotfix, branch from `main`.
|
||||||
3. Make commits as necessary (often is better). And use concise, descriptive language, leveraging issue notation and/or [Closing Keywords](https://help.github.com/articles/closing-issues-using-keywords) to ensure any issues addressed by your work are referenced accordingly.
|
3. Make commits as necessary (often is better). And use concise, descriptive language, leveraging issue notation and/or [Closing Keywords](https://help.github.com/articles/closing-issues-using-keywords) to ensure any issues addressed by your work are referenced accordingly.
|
||||||
4. When the scope of the work for your branch is complete, make sure to rebase your branch in case further progress has been made since the repo was forked
|
4. When the scope of the work for your branch is complete, make sure to rebase your branch in case further progress has been made since the repo was forked
|
||||||
5. Create a Pull Request to pull your branch into the appropriate branch in the main repository.
|
5. Create a Pull Request to pull your branch into the appropriate branch in the main repository.
|
||||||
|
|||||||
@@ -272,7 +272,7 @@ To control diplay power from SIMPL Windows, we would connect Digital Signals to
|
|||||||
To utilize the com port device, we would connect Serial Signals (VTC_TX$ and VTC_RX$) to join 51 on the EISC.
|
To utilize the com port device, we would connect Serial Signals (VTC_TX$ and VTC_RX$) to join 51 on the EISC.
|
||||||
|
|
||||||
You can refer to our [SIMPL Windows Bridging Example](https://github.com/PepperDash/EssentialsSIMPLWindowsBridgeExample) for a more complex example.
|
You can refer to our [SIMPL Windows Bridging Example](https://github.com/PepperDash/EssentialsSIMPLWindowsBridgeExample) for a more complex example.
|
||||||
Example device config: <https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Example%20Configuration/SIMPLBridging/SIMPLBridgeExample_configurationFile.json>
|
Example device config: <https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Example%20Configuration/SIMPLBridging/SIMPLBridgeExample_configurationFile.json>
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
@@ -308,100 +308,100 @@ Please note that these joinmaps _may_ be using a deprecated implementation. The
|
|||||||
|
|
||||||
> supports: AM-200, AM-300
|
> supports: AM-200, AM-300
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/AirMediaControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/AirMediaControllerJoinMap.cs>
|
||||||
|
|
||||||
### AppleTvController
|
### AppleTvController
|
||||||
|
|
||||||
> supports: IR control of Apple TV
|
> supports: IR control of Apple TV
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/AppleTvJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/AppleTvJoinMap.cs>
|
||||||
|
|
||||||
### CameraControlBase
|
### CameraControlBase
|
||||||
|
|
||||||
> supports: any camera that derives from CameraBase
|
> supports: any camera that derives from CameraBase
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/CameraControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/CameraControllerJoinMap.cs>
|
||||||
|
|
||||||
### DisplayController
|
### DisplayController
|
||||||
|
|
||||||
> supports: IR controlled displays, any two way display driver that derives from PepperDash.Essentials.Core.DisplayBase
|
> supports: IR controlled displays, any two way display driver that derives from PepperDash.Essentials.Core.DisplayBase
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/DisplayControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/DisplayControllerJoinMap.cs>
|
||||||
|
|
||||||
### DmChasisController
|
### DmChasisController
|
||||||
|
|
||||||
> supports: All DM-MD-8x8/16x16/32x32 chassis, with or w/o DM-CPU3 Card
|
> supports: All DM-MD-8x8/16x16/32x32 chassis, with or w/o DM-CPU3 Card
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/DmChassisControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/DmChassisControllerJoinMap.cs>
|
||||||
|
|
||||||
### DmRmcController
|
### DmRmcController
|
||||||
|
|
||||||
> supports: All DM-RMC devices
|
> supports: All DM-RMC devices
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/DmRmcControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/DmRmcControllerJoinMap.cs>
|
||||||
|
|
||||||
### DmTxController
|
### DmTxController
|
||||||
|
|
||||||
> supports: All Dm-Tx devices
|
> supports: All Dm-Tx devices
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/DmTxControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/DmTxControllerJoinMap.cs>
|
||||||
|
|
||||||
### DmpsAudioOutputController
|
### DmpsAudioOutputController
|
||||||
|
|
||||||
> supports: Program, Aux1, Aux2 outputs of all DMPS3 Control Systems
|
> supports: Program, Aux1, Aux2 outputs of all DMPS3 Control Systems
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/DmpsAudioOutputControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/DmpsAudioOutputControllerJoinMap.cs>
|
||||||
|
|
||||||
### DmpsRoutingController
|
### DmpsRoutingController
|
||||||
|
|
||||||
> supports: Av routing for all DMPS3 Control Systems
|
> supports: Av routing for all DMPS3 Control Systems
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/DmpsRoutingControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/DmpsRoutingControllerJoinMap.cs>
|
||||||
|
|
||||||
### GenericRelayController
|
### GenericRelayController
|
||||||
|
|
||||||
> supports: Any relay port on a Crestron Control System or Dm Endpoint
|
> supports: Any relay port on a Crestron Control System or Dm Endpoint
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/GenericRelayControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/GenericRelayControllerJoinMap.cs>
|
||||||
|
|
||||||
### GenericLightingJoinMap
|
### GenericLightingJoinMap
|
||||||
|
|
||||||
> supports: Devices derived from PepperDash.Essentials.Core.Lighting.LightingBase
|
> supports: Devices derived from PepperDash.Essentials.Core.Lighting.LightingBase
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/GenericLightingJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/GenericLightingJoinMap.cs>
|
||||||
|
|
||||||
### GlsOccupancySensorBase
|
### GlsOccupancySensorBase
|
||||||
|
|
||||||
> supports: Any Crestron GLS-Type Occupancy sensor - single/dual type
|
> supports: Any Crestron GLS-Type Occupancy sensor - single/dual type
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/GlsOccupancySensorBaseJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/GlsOccupancySensorBaseJoinMap.cs>
|
||||||
|
|
||||||
### HdMdxxxCEController
|
### HdMdxxxCEController
|
||||||
|
|
||||||
> supports: HD-MD-400-C-E, HD-MD-300-C-E, HD-MD-200-C-E, HD-MD-200-C-1G-E-B/W
|
> supports: HD-MD-400-C-E, HD-MD-300-C-E, HD-MD-200-C-E, HD-MD-200-C-1G-E-B/W
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/HdMdxxxCEControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/HdMdxxxCEControllerJoinMap.cs>
|
||||||
|
|
||||||
### IBasicCommunication
|
### IBasicCommunication
|
||||||
|
|
||||||
> supports: Any COM Port on a Control System or Dm Endpoint device, TCP Client, SSH Client, or UDP Server
|
> supports: Any COM Port on a Control System or Dm Endpoint device, TCP Client, SSH Client, or UDP Server
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/IBasicCommunicationJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/IBasicCommunicationJoinMap.cs>
|
||||||
|
|
||||||
### IDigitalInput
|
### IDigitalInput
|
||||||
|
|
||||||
> supports: Any Digital Input on a Control System, or DM Endpoint device
|
> supports: Any Digital Input on a Control System, or DM Endpoint device
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/IDigitalInputJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/IDigitalInputJoinMap.cs>
|
||||||
|
|
||||||
### SystemMonitorController
|
### SystemMonitorController
|
||||||
|
|
||||||
> supports: Exposing the system monitor slot for any Control System
|
> supports: Exposing the system monitor slot for any Control System
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/SystemMonitorJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/essentials-framework/Essentials%20Core/PepperDashEssentialsBase/Bridges/JoinMaps/SystemMonitorJoinMap.cs>
|
||||||
|
|
||||||
## Example SIMPL Windows Program
|
## Example SIMPL Windows Program
|
||||||
|
|
||||||
We've provided an [example program](https://github.com/PepperDash/EssentialsSIMPLWindowsBridgeExample) for SIMPL Windows that works with the provided example Essentials configuration file [SIMPLBridgeExample_configurationFile.json](https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Example%20Configuration/SIMPLBridging/SIMPLBridgeExample_configurationFile.json). Load Essentials and the example SIMPL program to two slots on the same processor and you can get a better idea of how to take advantage of SIMPL Windows bridging.
|
We've provided an [example program](https://github.com/PepperDash/EssentialsSIMPLWindowsBridgeExample) for SIMPL Windows that works with the provided example Essentials configuration file [SIMPLBridgeExample_configurationFile.json](https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Example%20Configuration/SIMPLBridging/SIMPLBridgeExample_configurationFile.json). Load Essentials and the example SIMPL program to two slots on the same processor and you can get a better idea of how to take advantage of SIMPL Windows bridging.
|
||||||
|
|
||||||
Next: [Essentials architecture](Arch-summary)
|
Next: [Essentials architecture](Arch-summary)
|
||||||
|
|||||||
@@ -346,7 +346,7 @@ To control diplay power from Simpl Windows, we would connect Digital Signals to
|
|||||||
To utilize the com port device, we would connect Serial Signals (VTC_TX$ and VTC_RX$) to join 51 on the EISC.
|
To utilize the com port device, we would connect Serial Signals (VTC_TX$ and VTC_RX$) to join 51 on the EISC.
|
||||||
|
|
||||||
You can refer to our [Simpl Windows Bridging Example](https://github.com/PepperDash/EssentialsSIMPLWindowsBridgeExample) for a more complex example.
|
You can refer to our [Simpl Windows Bridging Example](https://github.com/PepperDash/EssentialsSIMPLWindowsBridgeExample) for a more complex example.
|
||||||
Example device config: <https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Example%20Configuration/SIMPLBridging/SIMPLBridgeExample_configurationFile.json>
|
Example device config: <https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Example%20Configuration/SIMPLBridging/SIMPLBridgeExample_configurationFile.json>
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
@@ -376,100 +376,100 @@ Example device config: <https://github.com/PepperDash/Essentials/blob/master/Pep
|
|||||||
|
|
||||||
> supports: AM-200, AM-300
|
> supports: AM-200, AM-300
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/AirMediaControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/AirMediaControllerJoinMap.cs>
|
||||||
|
|
||||||
### AppleTvController
|
### AppleTvController
|
||||||
|
|
||||||
> supports: IR control of Apple TV
|
> supports: IR control of Apple TV
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/AppleTvJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/AppleTvJoinMap.cs>
|
||||||
|
|
||||||
### CameraControlBase
|
### CameraControlBase
|
||||||
|
|
||||||
> supports: any camera that derives from CameraBase
|
> supports: any camera that derives from CameraBase
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/CameraControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/CameraControllerJoinMap.cs>
|
||||||
|
|
||||||
### DisplayController
|
### DisplayController
|
||||||
|
|
||||||
> supports: IR controlled displays, any two way display driver that derives from PepperDash.Essentials.Core.DisplayBase
|
> supports: IR controlled displays, any two way display driver that derives from PepperDash.Essentials.Core.DisplayBase
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/DisplayControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/DisplayControllerJoinMap.cs>
|
||||||
|
|
||||||
### DmChasisController
|
### DmChasisController
|
||||||
|
|
||||||
> supports: All DM-MD-8x8/16x16/32x32 chassis, with or w/o DM-CPU3 Card
|
> supports: All DM-MD-8x8/16x16/32x32 chassis, with or w/o DM-CPU3 Card
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/DmChassisControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/DmChassisControllerJoinMap.cs>
|
||||||
|
|
||||||
### DmRmcController
|
### DmRmcController
|
||||||
|
|
||||||
> supports: All DM-RMC devices
|
> supports: All DM-RMC devices
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/DmRmcControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/DmRmcControllerJoinMap.cs>
|
||||||
|
|
||||||
### DmTxController
|
### DmTxController
|
||||||
|
|
||||||
> supports: All Dm-Tx devices
|
> supports: All Dm-Tx devices
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/DmTxControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/DmTxControllerJoinMap.cs>
|
||||||
|
|
||||||
### DmpsAudioOutputController
|
### DmpsAudioOutputController
|
||||||
|
|
||||||
> supports: Program, Aux1, Aux2 outputs of all DMPS3 Control Systems
|
> supports: Program, Aux1, Aux2 outputs of all DMPS3 Control Systems
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/DmpsAudioOutputControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/DmpsAudioOutputControllerJoinMap.cs>
|
||||||
|
|
||||||
### DmpsRoutingController
|
### DmpsRoutingController
|
||||||
|
|
||||||
> supports: Av routing for all DMPS3 Control Systems
|
> supports: Av routing for all DMPS3 Control Systems
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/DmpsRoutingControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/DmpsRoutingControllerJoinMap.cs>
|
||||||
|
|
||||||
### GenericRelayController
|
### GenericRelayController
|
||||||
|
|
||||||
> supports: Any relay port on a Crestron Control System or Dm Endpoint
|
> supports: Any relay port on a Crestron Control System or Dm Endpoint
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/GenericRelayControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/GenericRelayControllerJoinMap.cs>
|
||||||
|
|
||||||
### GenericLightingJoinMap
|
### GenericLightingJoinMap
|
||||||
|
|
||||||
> supports: Devices derived from PepperDash.Essentials.Core.Lighting.LightingBase
|
> supports: Devices derived from PepperDash.Essentials.Core.Lighting.LightingBase
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/GenericLightingJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/GenericLightingJoinMap.cs>
|
||||||
|
|
||||||
### GlsOccupancySensorBase
|
### GlsOccupancySensorBase
|
||||||
|
|
||||||
> supports: Any Crestron GLS-Type Occupancy sensor - single/dual type
|
> supports: Any Crestron GLS-Type Occupancy sensor - single/dual type
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/GlsOccupancySensorBaseJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/GlsOccupancySensorBaseJoinMap.cs>
|
||||||
|
|
||||||
### HdMdxxxCEController
|
### HdMdxxxCEController
|
||||||
|
|
||||||
> supports: HD-MD-400-C-E, HD-MD-300-C-E, HD-MD-200-C-E, HD-MD-200-C-1G-E-B/W
|
> supports: HD-MD-400-C-E, HD-MD-300-C-E, HD-MD-200-C-E, HD-MD-200-C-1G-E-B/W
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/HdMdxxxCEControllerJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/HdMdxxxCEControllerJoinMap.cs>
|
||||||
|
|
||||||
### IBasicCommunication
|
### IBasicCommunication
|
||||||
|
|
||||||
> supports: Any COM Port on a Control System or Dm Endpoint device, TCP Client, SSH Client, or UDP Server
|
> supports: Any COM Port on a Control System or Dm Endpoint device, TCP Client, SSH Client, or UDP Server
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/IBasicCommunicationJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/IBasicCommunicationJoinMap.cs>
|
||||||
|
|
||||||
### IDigitalInput
|
### IDigitalInput
|
||||||
|
|
||||||
> supports: Any Digital Input on a Control System, or DM Endpoint device
|
> supports: Any Digital Input on a Control System, or DM Endpoint device
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/IDigitalInputJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/IDigitalInputJoinMap.cs>
|
||||||
|
|
||||||
### SystemMonitorController
|
### SystemMonitorController
|
||||||
|
|
||||||
> supports: Exposing the system monitor slot for any Control System
|
> supports: Exposing the system monitor slot for any Control System
|
||||||
|
|
||||||
<https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Bridges/JoinMaps/SystemMonitorJoinMap.cs>
|
<https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Bridges/JoinMaps/SystemMonitorJoinMap.cs>
|
||||||
|
|
||||||
## Example SIMPL Windows Program
|
## Example SIMPL Windows Program
|
||||||
|
|
||||||
We've provided an [example program](https://github.com/PepperDash/EssentialsSIMPLWindowsBridgeExample) for SIMPL Windows that works with the provided example Essentials configuration file [SIMPLBridgeExample_configurationFile.json](https://github.com/PepperDash/Essentials/blob/master/PepperDashEssentials/Example%20Configuration/SIMPLBridging/SIMPLBridgeExample_configurationFile.json). Load Essentials and the example SIMPL program to two slots on the same processor and you can get a better idea of how to take advantage of SIMPL Windows bridging.
|
We've provided an [example program](https://github.com/PepperDash/EssentialsSIMPLWindowsBridgeExample) for SIMPL Windows that works with the provided example Essentials configuration file [SIMPLBridgeExample_configurationFile.json](https://github.com/PepperDash/Essentials/blob/main/PepperDashEssentials/Example%20Configuration/SIMPLBridging/SIMPLBridgeExample_configurationFile.json). Load Essentials and the example SIMPL program to two slots on the same processor and you can get a better idea of how to take advantage of SIMPL Windows bridging.
|
||||||
|
|
||||||
Next: [Essentials architecture](Arch-summary)
|
Next: [Essentials architecture](Arch-summary)
|
||||||
|
|||||||
Reference in New Issue
Block a user