mirror of
https://github.com/PepperDash/EssentialsPluginTemplate.git
synced 2026-01-11 19:44:38 +00:00
Automated README update
This commit is contained in:
75
README.md
75
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
|
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
|
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
|
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 -->
|
||||||
|
|||||||
Reference in New Issue
Block a user