Automated README update

This commit is contained in:
GitHub Action
2025-07-29 19:05:42 +00:00
parent b833024582
commit 09a6270da8

View File

@@ -46,3 +46,76 @@ 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
<!-- START Minimum Essentials Framework Versions -->
### Minimum Essentials Framework Versions
- 2.12.1
- 2.12.1
- 2.12.1
<!-- END Minimum Essentials Framework Versions -->
<!-- START Config Example -->
### 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"
}
}
}
}
```
<!-- END Config Example -->
<!-- START Supported Types -->
### Supported Types
- examplePluginDevice
- examplePluginCrestronDevice
- examplePluginLogicDevice
<!-- END Supported Types -->
<!-- START Join Maps -->
<!-- END Join Maps -->
<!-- START Interfaces Implemented -->
<!-- END Interfaces Implemented -->
<!-- START Base Classes -->
### Base Classes
- CrestronGenericBridgeableBaseDevice
- EssentialsBridgeableDevice
- JoinMapBaseAdvanced
<!-- END Base Classes -->
<!-- START Public Methods -->
### Public Methods
- public void SendText(string text)
- public void SendBytes(byte[] bytes)
- public void Poll()
<!-- END Public Methods -->
<!-- START Bool Feedbacks -->
### Bool Feedbacks
- ConnectFeedback
- OnlineFeedback
<!-- END Bool Feedbacks -->
<!-- START Int Feedbacks -->
### Int Feedbacks
- StatusFeedback
<!-- END Int Feedbacks -->
<!-- START String Feedbacks -->
<!-- END String Feedbacks -->