diff --git a/README.md b/README.md index 9d2df4d..5f6993e 100644 --- a/README.md +++ b/README.md @@ -45,4 +45,77 @@ A nuget package is automatically generated when the plugin is build. To modify t 1. `PackageId` - This is the name that will be used to pull the package from Nuget once it's published 2. `PackgeProjectUrl` - This should match the URL for the plugin repo -3. `AssemblyTitle` - This is the dll file name that is will show on a processor when the plugin is loaded \ No newline at end of file +3. `AssemblyTitle` - This is the dll file name that is will show on a processor when the plugin is loaded + +### Minimum Essentials Framework Versions + +- 2.12.1 +- 2.12.1 +- 2.12.1 + + +### Config Example + +```json +{ + "key": "GeneratedKey", + "uid": 1, + "name": "GeneratedName", + "type": "examplePluginDevice", + "group": "Group", + "properties": { + "control": "SampleValue", + "pollTimeMs": 0, + "warningTimeoutMs": 0, + "errorTimeoutMs": 0, + "DeviceDictionary": { + "SampleString": { + "name": "SampleString", + "value": "SampleValue" + } + } + } +} +``` + + +### Supported Types + +- examplePluginDevice +- examplePluginCrestronDevice +- examplePluginLogicDevice + + + + + + + + +### Base Classes + +- CrestronGenericBridgeableBaseDevice +- EssentialsBridgeableDevice +- JoinMapBaseAdvanced + + +### Public Methods + +- public void SendText(string text) +- public void SendBytes(byte[] bytes) +- public void Poll() + + +### Bool Feedbacks + +- ConnectFeedback +- OnlineFeedback + + +### Int Feedbacks + +- StatusFeedback + + + +