Provided under MIT license
Fork this repo when creating a new plugin for Essentials. For more information about plugins, refer to the Essentials Wiki Plugins article.
This repo contains example classes for the three main categories of devices:
MakeModelDevice: Used for most third party devices which require communication over a streaming mechanism such as a Com port, TCP/SSh/UDP socket, CEC, etcMakeModelLogicDevice: Used for devices that contain logic, but don't require any communication with third parties outside the programMakeModelCrestronDevice: Used for devices that represent a piece of Crestron hardware
There are matching factory classes for each of the three categories of devices. The MakeModelConfigObject should be used as a template and modified for any of the categories of device. Same goes for the MakeModeleBridgeJoinMap.
This also illustrates how a plugin can contain multiple devices.
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.
The Essentials libraries are required. They referenced via nuget. You must have nuget.exe installed and in the PATH environment variable to use the following command. Nuget.exe is available at nuget.org.
Dependencies will be automatically installed when
See the Task List in Visual Studio for a guide on how to start using the template. There is extensive inline documentation and examples as well.
For renaming instructions in particular, see the XML remarks tags on class definitions
This repo uses Husky.Net to run a pre-commit hook. The hook runs .github/scripts/Update-ReadmeBadges.ps1, which keeps the .NET and PepperDash Essentials badges at the top of this README in sync with the project:
.NETbadge -TargetFrameworkinsrc/*.4Series.csprojPepperDash Essentialsbadge - the highestMinimumEssentialsFrameworkVersioninsrc/*Factory.cs
If the badges change, README.md is re-staged automatically so the update is part of your commit. A warning is printed if the PepperDashEssentials package version in the csproj differs from MinimumEssentialsFrameworkVersion.
- .NET SDK (provides
dotnet tool) - PowerShell 7+ (
pwsh) on thePATH(Windows, macOS and Linux). Windows PowerShell 5.1 is not used.
The hook is installed automatically the first time you do any of the following in a fresh clone:
- Open the solution in Visual Studio, or run
dotnet restore/dotnet build - Open the folder in VS Code and allow the "Install git hooks" automatic task
To install it manually:
dotnet tool restore
dotnet husky install
Verify with git config core.hooksPath, which should print .husky.
- Commit as usual; the hook runs on every
git commit. - Run it on demand:
dotnet husky run - Check without modifying files (useful for CI):
pwsh -NoProfile -File .github/scripts/Update-ReadmeBadges.ps1 -Check - The hook refuses to run if
README.md, the.4Series.csproj, or a*Factory.csfile has unstaged or untracked changes, so a partial commit never picks up unrelated edits. Stage or stash them and commit again. - Skip the hook for a single commit:
git commit --no-verify - Skip the automatic install on restore: set the
HUSKY=0environment variable. It is also skipped whenCI=true.
The script locates files by pattern (*.4Series.csproj, *Factory.cs), so renaming the project or factory classes does not require changes. Keep a MinimumEssentialsFrameworkVersion = "x.y.z"; assignment in at least one factory, and keep the two badges in this README.
A nuget package is automatically generated when the plugin is build. To modify the name and other details of the package, edit the following properties in the .csproj file:
PackageId- This is the name that will be used to pull the package from Nuget once it's publishedPackgeProjectUrl- This should match the URL for the plugin repoAssemblyTitle- This is the dll file name that is will show on a processor when the plugin is loaded