Skip to content

Commit 26d0497

Browse files
committed
Updates readme documentation
1 parent 114d3af commit 26d0497

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@ Provided under MIT license
88

99
Fork this repo when creating a new plugin for Essentials. For more information about plugins, refer to the Essentials Wiki [Plugins](https://github.com/PepperDash/Essentials/wiki/Plugins) article.
1010

11+
This repo contains example classes for the three main categories of devices:
12+
* `EssentialsPluginTemplateDevice`: Used for most third party devices which require communication over a streaming mechanism such as a Com port, TCP/SSh/UDP socket, CEC, etc
13+
* `EssentialsPluginTemplateLogicDevice`: Used for devices that contain logic, but don't require any communication with third parties outside the program
14+
* `EssentialsPluginTemplateCrestronDevice`: Used for devices that represent a piece of Crestron hardware
15+
16+
There are matching factory classes for each of the three categories of devices. The `EssentialsPluginTemplateConfigObject` should be used as a template and modified for any of the categories of device. Same goes for the `EssentialsPluginTemplateBridgeJoinMap`.
17+
18+
This also illustrates how a plugin can contain multiple devices.
19+
1120
## Cloning Instructions
1221

1322
After forking this repository into your own GitHub space, you can create a new repository using this one as the template. Then you must install the necessary dependencies as indicated below.

0 commit comments

Comments
 (0)