mirror of
https://github.com/PepperDash/EssentialsPluginTemplate.git
synced 2026-02-01 05:44:42 +00:00
Compare commits
25 Commits
1.0.6-alph
...
robot-docs
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
09a6270da8 | ||
|
|
b833024582 | ||
|
|
a86f97c4f4 | ||
|
|
22faf9ef10 | ||
|
|
cf3f35a53c | ||
|
|
ba5d0f33a6 | ||
|
|
4283fb2abd | ||
|
|
4ee211576f | ||
|
|
085a2d7659 | ||
|
|
952d5b61a4 | ||
|
|
c225184021 | ||
|
|
3f2ef80877 | ||
|
|
de4cbcac73 | ||
|
|
61b8c51db2 | ||
|
|
eee7822de0 | ||
|
|
85d2e4e1dc | ||
|
|
7c3c0bea71 | ||
|
|
a427afaf3c | ||
|
|
2264d90372 | ||
|
|
809fb79bf1 | ||
|
|
507ca486ab | ||
|
|
4ec7550625 | ||
|
|
d327f2def8 | ||
|
|
1b3c28da0c | ||
|
|
7ba409d64c |
20
.editorconfig
Normal file
20
.editorconfig
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
root=true
|
||||||
|
|
||||||
|
[*.cs]
|
||||||
|
indent_style=space
|
||||||
|
indent_size=2
|
||||||
|
|
||||||
|
# .editorconfig
|
||||||
|
|
||||||
|
# Define a naming style for camelCase without an underscore prefix
|
||||||
|
dotnet_naming_style.private_field_camel_case.capitalization = camel_case
|
||||||
|
dotnet_naming_style.private_field_camel_case.required_prefix =
|
||||||
|
|
||||||
|
# Define a naming rule for private fields to use the defined style
|
||||||
|
dotnet_naming_rule.private_field_no_underscore.symbols = private_fields
|
||||||
|
dotnet_naming_rule.private_field_no_underscore.style = private_field_camel_case
|
||||||
|
dotnet_naming_rule.private_field_no_underscore.severity = warning
|
||||||
|
|
||||||
|
# Define the symbol kind for private fields
|
||||||
|
dotnet_naming_symbols.private_fields.applicable_kinds = field
|
||||||
|
dotnet_naming_symbols.private_fields.applicable_accessibilities = private
|
||||||
22
.github/workflows/EssentialsPlugins-builds-caller.yml
vendored
Normal file
22
.github/workflows/EssentialsPlugins-builds-caller.yml
vendored
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
name: Build Essentials Plugin
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- '**'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
getVersion:
|
||||||
|
uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-getversion.yml@main
|
||||||
|
secrets: inherit
|
||||||
|
|
||||||
|
build-4Series:
|
||||||
|
uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-4Series-builds.yml@main
|
||||||
|
secrets: inherit
|
||||||
|
needs: getVersion
|
||||||
|
if: needs.getVersion.outputs.newVersion == 'true'
|
||||||
|
with:
|
||||||
|
newVersion: ${{ needs.getVersion.outputs.newVersion }}
|
||||||
|
version: ${{ needs.getVersion.outputs.version }}
|
||||||
|
tag: ${{ needs.getVersion.outputs.tag }}
|
||||||
|
channel: ${{ needs.getVersion.outputs.channel }}
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
name: Beta Build
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches-ignore:
|
|
||||||
- "main"
|
|
||||||
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
branch:
|
|
||||||
description: 'Branch to build'
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
call-workflow:
|
|
||||||
uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-builds.yml@main
|
|
||||||
secrets: inherit
|
|
||||||
with:
|
|
||||||
branch: ${{ github.ref_name }}
|
|
||||||
default-branch: "main"
|
|
||||||
|
|
||||||
@@ -1,227 +0,0 @@
|
|||||||
name: Main Build using Docker
|
|
||||||
|
|
||||||
on:
|
|
||||||
release:
|
|
||||||
types:
|
|
||||||
- released
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
|
|
||||||
env:
|
|
||||||
# Do not edit this, we're just creating it here
|
|
||||||
VERSION: 0.0.0-buildtype-buildnumber
|
|
||||||
# Defaults to debug for build type
|
|
||||||
BUILD_TYPE: Debug
|
|
||||||
# Defaults to master as the release branch. Change as necessary
|
|
||||||
RELEASE_BRANCH: main
|
|
||||||
jobs:
|
|
||||||
Build_Project:
|
|
||||||
runs-on: windows-2019
|
|
||||||
steps:
|
|
||||||
# First we checkout the source repo
|
|
||||||
- name: Checkout repo
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
# Fetch all tags
|
|
||||||
- name: Fetch tags
|
|
||||||
run: git fetch --tags
|
|
||||||
# Generate the appropriate version number
|
|
||||||
- name: Set Version Number
|
|
||||||
shell: powershell
|
|
||||||
env:
|
|
||||||
TAG_NAME: ${{ github.event.release.tag_name }}
|
|
||||||
run: echo "VERSION=$($Env:TAG_NAME)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
|
|
||||||
# Use the version number to set the version of the assemblies
|
|
||||||
- name: Update AssemblyInfo.cs
|
|
||||||
shell: powershell
|
|
||||||
run: |
|
|
||||||
function Update-SourceVersion {
|
|
||||||
Param ([string]$Version)
|
|
||||||
#$fullVersion = $Version
|
|
||||||
$baseVersion = [regex]::Match($Version, "(\d+.\d+.\d+).*").captures.groups[1].value
|
|
||||||
$NewAssemblyVersion = 'AssemblyVersion("' + $baseVersion + '.*")'
|
|
||||||
Write-Output "AssemblyVersion = $NewAssemblyVersion"
|
|
||||||
$NewAssemblyInformationalVersion = 'AssemblyInformationalVersion("' + $Version + '")'
|
|
||||||
Write-Output "AssemblyInformationalVersion = $NewAssemblyInformationalVersion"
|
|
||||||
foreach ($o in $input) {
|
|
||||||
Write-output $o.FullName
|
|
||||||
$TmpFile = $o.FullName + ".tmp"
|
|
||||||
get-content $o.FullName |
|
|
||||||
ForEach-Object {
|
|
||||||
$_ -replace 'AssemblyVersion\(".*"\)', $NewAssemblyVersion } |
|
|
||||||
ForEach-Object {
|
|
||||||
$_ -replace 'AssemblyInformationalVersion\(".*"\)', $NewAssemblyInformationalVersion
|
|
||||||
} > $TmpFile
|
|
||||||
move-item $TmpFile $o.FullName -force
|
|
||||||
}
|
|
||||||
}
|
|
||||||
function Update-AllAssemblyInfoFiles ( $version ) {
|
|
||||||
foreach ($file in "AssemblyInfo.cs", "AssemblyInfo.vb" ) {
|
|
||||||
get-childitem -Path $Env:GITHUB_WORKSPACE -recurse | Where-Object { $_.Name -eq $file } | Update-SourceVersion $version ;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
# validate arguments
|
|
||||||
$r = [System.Text.RegularExpressions.Regex]::Match($Env:VERSION, "\d+\.\d+\.\d+.*");
|
|
||||||
if ($r.Success) {
|
|
||||||
Write-Output "Updating Assembly Version to $Env:VERSION ...";
|
|
||||||
Update-AllAssemblyInfoFiles $Env:VERSION;
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
Write-Output " ";
|
|
||||||
Write-Output "Error: Input version $Env:VERSION does not match x.y.z format!"
|
|
||||||
Write-Output " ";
|
|
||||||
Write-Output "Unable to apply version to AssemblyInfo.cs files";
|
|
||||||
}
|
|
||||||
- name: restore Nuget Packages
|
|
||||||
run: nuget install .\packages.config -OutputDirectory .\packages -ExcludeVersion
|
|
||||||
# Set the SOLUTION_PATH
|
|
||||||
- name: Get SLN Path
|
|
||||||
shell: powershell
|
|
||||||
run: |
|
|
||||||
$solution_path = Get-ChildItem *.sln -recurse
|
|
||||||
$solution_path = $solution_path.FullName
|
|
||||||
$solution_path = $solution_path -replace "(?:[^\\]*\\){4}", ""
|
|
||||||
Write-Output $solution_path
|
|
||||||
echo "SOLUTION_PATH=$($solution_path)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
|
|
||||||
# Set the SOLUTION_FILE
|
|
||||||
- name: Get SLN File
|
|
||||||
shell: powershell
|
|
||||||
run: |
|
|
||||||
$solution_file = Get-ChildItem .\*.sln -recurse -Path "$($Env:GITHUB_WORKSPACE)"
|
|
||||||
echo "SOLUTION_FILE=$($solution_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
|
|
||||||
# Login to Docker
|
|
||||||
- name: Login to Docker
|
|
||||||
uses: azure/docker-login@v1
|
|
||||||
with:
|
|
||||||
username: ${{ secrets.DOCKERHUB_USER }}
|
|
||||||
password: ${{ secrets.DOCKERHUB_PASSWORD }}
|
|
||||||
# Build the solutions in the docker image
|
|
||||||
- name: Build Solution
|
|
||||||
shell: powershell
|
|
||||||
run: |
|
|
||||||
Invoke-Expression "docker run --rm --mount type=bind,source=""$($Env:GITHUB_WORKSPACE)"",target=""c:/project"" pepperdash/sspbuilder c:\cihelpers\vsidebuild.exe -Solution ""c:\project\$($Env:SOLUTION_PATH)"" -BuildSolutionConfiguration $($ENV:BUILD_TYPE)"
|
|
||||||
# Zip up the output files as needed
|
|
||||||
- name: Zip Build Output
|
|
||||||
shell: powershell
|
|
||||||
run: |
|
|
||||||
$destination = "$($Env:GITHUB_HOME)\output"
|
|
||||||
New-Item -ItemType Directory -Force -Path ($destination)
|
|
||||||
Get-ChildItem ($destination)
|
|
||||||
$exclusions = "packages"
|
|
||||||
# Trying to get any .json schema files (not currently working)
|
|
||||||
# Gets any files with the listed extensions.
|
|
||||||
Get-ChildItem -recurse -Path "$($Env:GITHUB_WORKSPACE)" -include "*.clz", "*.cpz", "*.cplz", "*.nuspec", "*.md" | ForEach-Object {
|
|
||||||
$allowed = $true;
|
|
||||||
# Exclude any files in submodules
|
|
||||||
foreach ($exclude in $exclusions) {
|
|
||||||
if ((Split-Path $_.FullName -Parent).contains("$($exclude)")) {
|
|
||||||
$allowed = $false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if ($allowed) {
|
|
||||||
Write-Host "allowing $($_)"
|
|
||||||
$_;
|
|
||||||
}
|
|
||||||
} | Copy-Item -Destination ($destination) -Force
|
|
||||||
Write-Host "Getting matching files..."
|
|
||||||
# Get any files from the output folder that match the following extensions
|
|
||||||
Get-ChildItem -Path $destination | Where-Object {($_.Extension -eq ".clz") -or ($_.Extension -eq ".cpz" -or ($_.Extension -eq ".cplz"))} | ForEach-Object {
|
|
||||||
# Replace the extensions with dll and xml and create an array
|
|
||||||
$filenames = @($($_ -replace "cpz|clz|cplz", "dll"), $($_ -replace "cpz|clz|cplz", "xml"))
|
|
||||||
Write-Host "Filenames:"
|
|
||||||
Write-Host $filenames
|
|
||||||
if ($filenames.length -gt 0) {
|
|
||||||
# Attempt to get the files and return them to the output directory
|
|
||||||
Get-ChildItem -Recurse -Path "$($Env:GITHUB_WORKSPACE)" -include $filenames | Copy-Item -Destination ($destination) -Force
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Get-ChildItem -Path $destination\*.cplz | Rename-Item -NewName { "$($_.BaseName)-$($Env:VERSION)$($_.Extension)" }
|
|
||||||
Compress-Archive -Path $destination -DestinationPath "$($Env:GITHUB_WORKSPACE)\$($Env:SOLUTION_FILE)-$($Env:VERSION).zip" -Force
|
|
||||||
Write-Host "Output Contents post Zip"
|
|
||||||
Get-ChildItem -Path $destination
|
|
||||||
# Write the version to a file to be consumed by the push jobs
|
|
||||||
- name: Write Version
|
|
||||||
run: Write-Output "$($Env:VERSION)" | Out-File -FilePath "$($Env:GITHUB_HOME)\output\version.txt"
|
|
||||||
# Upload output files
|
|
||||||
- name: Upload Build Output
|
|
||||||
uses: actions/upload-artifact@v1
|
|
||||||
with:
|
|
||||||
name: Build
|
|
||||||
path: ./${{ env.SOLUTION_FILE}}-${{ env.VERSION}}.zip
|
|
||||||
# Upload the Version file as an artifact
|
|
||||||
- name: Upload version.txt
|
|
||||||
uses: actions/upload-artifact@v1
|
|
||||||
with:
|
|
||||||
name: Version
|
|
||||||
path: ${{env.GITHUB_HOME}}\output\version.txt
|
|
||||||
# Upload the build package to the release
|
|
||||||
- name: Upload Release Package
|
|
||||||
id: upload_release
|
|
||||||
uses: actions/upload-release-asset@v1
|
|
||||||
with:
|
|
||||||
upload_url: ${{ github.event.release.upload_url }}
|
|
||||||
asset_path: ./${{ env.SOLUTION_FILE}}-${{ env.VERSION}}.zip
|
|
||||||
asset_name: ${{ env.SOLUTION_FILE}}-${{ env.VERSION}}.zip
|
|
||||||
asset_content_type: application/zip
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
Push_Nuget_Package:
|
|
||||||
needs: Build_Project
|
|
||||||
runs-on: windows-2019
|
|
||||||
steps:
|
|
||||||
- name: Download Build Version Info
|
|
||||||
uses: actions/download-artifact@v1
|
|
||||||
with:
|
|
||||||
name: Version
|
|
||||||
- name: Set Version Number
|
|
||||||
shell: powershell
|
|
||||||
run: |
|
|
||||||
Get-ChildItem "./Version"
|
|
||||||
$version = Get-Content -Path ./Version/version.txt
|
|
||||||
Write-Host "Version: $version"
|
|
||||||
echo "VERSION=$version" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
|
|
||||||
Remove-Item -Path ./Version/version.txt
|
|
||||||
Remove-Item -Path ./Version
|
|
||||||
- name: Download Build output
|
|
||||||
uses: actions/download-artifact@v1
|
|
||||||
with:
|
|
||||||
name: Build
|
|
||||||
path: ./
|
|
||||||
- name: Unzip Build file
|
|
||||||
run: |
|
|
||||||
Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\
|
|
||||||
Remove-Item -Path .\*.zip
|
|
||||||
- name: Copy Files to root & delete output directory
|
|
||||||
run: |
|
|
||||||
Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz")
|
|
||||||
Get-ChildItem -Path .\output\* | Copy-Item -Destination .\
|
|
||||||
Remove-Item -Path .\output -Recurse
|
|
||||||
- name: Get nuget File
|
|
||||||
shell: powershell
|
|
||||||
run: |
|
|
||||||
$nuspec_file = (Get-ChildItem *.nuspec -recurse).BaseName
|
|
||||||
echo "NUSPEC_FILE=$($nuspec_file)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
|
|
||||||
# Pulls the nuget builder packages
|
|
||||||
- name: Add nuget.exe
|
|
||||||
if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')"
|
|
||||||
uses: nuget/setup-nuget@v1
|
|
||||||
# Creating nuget Packages
|
|
||||||
- name: Add Github Packages source
|
|
||||||
if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')"
|
|
||||||
run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
- name: Create nuget package
|
|
||||||
if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')"
|
|
||||||
run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }}
|
|
||||||
# Pushes to internal github registry
|
|
||||||
- name: Publish nuget package to Github registry
|
|
||||||
if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')"
|
|
||||||
run: nuget push **/*.nupkg -source github
|
|
||||||
# Pushes to nuget gallery
|
|
||||||
- name: Add nuget.org API Key
|
|
||||||
if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')
|
|
||||||
run: nuget setApiKey ${{ secrets.NUGET_API_KEY }}
|
|
||||||
- name: Publish nuget package to nuget.org
|
|
||||||
if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')
|
|
||||||
run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json
|
|
||||||
14
.github/workflows/essentialsplugins-updatereadme-caller.yml
vendored
Normal file
14
.github/workflows/essentialsplugins-updatereadme-caller.yml
vendored
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
|
||||||
|
name: Generate README
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches-ignore:
|
||||||
|
- 'robot-docs'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
call-update-readme:
|
||||||
|
uses: PepperDash/workflow-templates/.github/workflows/update-readme.yml@main
|
||||||
|
with:
|
||||||
|
target-branch: ${{ github.ref_name }}
|
||||||
|
|
||||||
34
.releaserc.json
Normal file
34
.releaserc.json
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
{
|
||||||
|
"plugins": [
|
||||||
|
[
|
||||||
|
"@semantic-release/commit-analyzer",
|
||||||
|
{
|
||||||
|
"releaseRules": [
|
||||||
|
{ "scope": "force-patch", "release": "patch" },
|
||||||
|
{ "scope": "no-release", "release": false }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"@semantic-release/release-notes-generator",
|
||||||
|
["@semantic-release/changelog",
|
||||||
|
{
|
||||||
|
"changelogFile": "CHANGELOG.md"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"@semantic-release/exec",
|
||||||
|
{
|
||||||
|
"verifyReleaseCmd": "echo \"newVersion=true\" >> $GITHUB_OUTPUT",
|
||||||
|
"publishCmd": "echo \"version=${nextRelease.version}\" >> $GITHUB_OUTPUT && echo \"tag=${nextRelease.gitTag}\" >> $GITHUB_OUTPUT && echo \"type=${nextRelease.type}\" >> $GITHUB_OUTPUT && echo \"channel=${nextRelease.channel}\" >> $GITHUB_OUTPUT"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
],
|
||||||
|
"branches": [
|
||||||
|
"main",
|
||||||
|
{
|
||||||
|
"name": "replace-me-feature-branch",
|
||||||
|
"prerelease": "replace-me-prerelease",
|
||||||
|
"channel": "replace-me-prerelease"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
9
.vscode/extensions.json
vendored
Normal file
9
.vscode/extensions.json
vendored
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"recommendations": [
|
||||||
|
"ms-dotnettools.vscode-dotnet-runtime",
|
||||||
|
"ms-dotnettools.csharp",
|
||||||
|
"ms-dotnettools.csdevkit",
|
||||||
|
"vivaxy.vscode-conventional-commits",
|
||||||
|
"mhutchie.git-graph"
|
||||||
|
]
|
||||||
|
}
|
||||||
32
.vscode/settings.json
vendored
Normal file
32
.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
{
|
||||||
|
"workbench.colorCustomizations": {
|
||||||
|
"activityBar.activeBackground": "#8c57e5",
|
||||||
|
"activityBar.background": "#8c57e5",
|
||||||
|
"activityBar.foreground": "#e7e7e7",
|
||||||
|
"activityBar.inactiveForeground": "#e7e7e799",
|
||||||
|
"activityBarBadge.background": "#6e3411",
|
||||||
|
"activityBarBadge.foreground": "#e7e7e7",
|
||||||
|
"commandCenter.border": "#e7e7e799",
|
||||||
|
"sash.hoverBorder": "#8c57e5",
|
||||||
|
"statusBar.background": "#6e2bde",
|
||||||
|
"statusBar.foreground": "#e7e7e7",
|
||||||
|
"statusBarItem.hoverBackground": "#8c57e5",
|
||||||
|
"statusBarItem.remoteBackground": "#6e2bde",
|
||||||
|
"statusBarItem.remoteForeground": "#e7e7e7",
|
||||||
|
"titleBar.activeBackground": "#6e2bde",
|
||||||
|
"titleBar.activeForeground": "#e7e7e7",
|
||||||
|
"titleBar.inactiveBackground": "#6e2bde99",
|
||||||
|
"titleBar.inactiveForeground": "#e7e7e799"
|
||||||
|
},
|
||||||
|
"peacock.color": "#6e2bde",
|
||||||
|
"[csharp]": {
|
||||||
|
"editor.defaultFormatter": "ms-dotnettools.csharp",
|
||||||
|
"editor.formatOnSave": true,
|
||||||
|
"editor.formatOnSaveMode": "file"
|
||||||
|
},
|
||||||
|
"csharp.inlayHints.enableInlayHintsForImplicitObjectCreation": true,
|
||||||
|
"csharp.inlayHints.enableInlayHintsForImplicitVariableTypes": true,
|
||||||
|
"csharp.inlayHints.enableInlayHintsForLambdaParameterTypes": true,
|
||||||
|
"csharp.inlayHints.enableInlayHintsForTypes": true,
|
||||||
|
"dotnet.formatting.organizeImportsOnFormat": true
|
||||||
|
}
|
||||||
107
README.md
107
README.md
@@ -1,4 +1,6 @@
|
|||||||
# Essentials Plugin Template (c) 2020
|

|
||||||
|
|
||||||
|
# Essentials Plugin Template (c) 2025
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
@@ -6,14 +8,14 @@ Provided under MIT license
|
|||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
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.
|
Fork this repo when creating a new plugin for Essentials. For more information about plugins, refer to the Essentials Wiki [Plugins](https://pepperdash.github.io/Essentials/docs/Plugins.html) article.
|
||||||
|
|
||||||
This repo contains example classes for the three main categories of devices:
|
This repo contains example classes for the three main categories of devices:
|
||||||
* `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
|
* `MakeModelDevice`: Used for most third party devices which require communication over a streaming mechanism such as a Com port, TCP/SSh/UDP socket, CEC, etc
|
||||||
* `EssentialsPluginTemplateLogicDevice`: Used for devices that contain logic, but don't require any communication with third parties outside the program
|
* `MakeModelLogicDevice`: Used for devices that contain logic, but don't require any communication with third parties outside the program
|
||||||
* `EssentialsPluginTemplateCrestronDevice`: Used for devices that represent a piece of Crestron hardware
|
* `MakeModelCrestronDevice`: Used for devices that represent a piece of Crestron hardware
|
||||||
|
|
||||||
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`.
|
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.
|
This also illustrates how a plugin can contain multiple devices.
|
||||||
|
|
||||||
@@ -27,14 +29,7 @@ The [Essentials](https://github.com/PepperDash/Essentials) libraries are require
|
|||||||
|
|
||||||
### Installing Dependencies
|
### Installing Dependencies
|
||||||
|
|
||||||
To install dependencies once nuget.exe is installed, run the following command from the root directory of your repository:
|
Dependencies will be automatically installed when
|
||||||
`nuget install .\packages.config -OutputDirectory .\packages -excludeVersion`.
|
|
||||||
Alternatively, you can simply run the `GetPackages.bat` file.
|
|
||||||
To verify that the packages installed correctly, open the plugin solution in your repo and make sure that all references are found, then try and build it.
|
|
||||||
|
|
||||||
### Installing Different versions of PepperDash Core
|
|
||||||
|
|
||||||
If you need a different version of PepperDash Core, use the command `nuget install .\packages.config -OutputDirectory .\packages -excludeVersion -Version {versionToGet}`. Omitting the `-Version` option will pull the version indicated in the packages.config file.
|
|
||||||
|
|
||||||
### Instructions for Renaming Solution and Files
|
### Instructions for Renaming Solution and Files
|
||||||
|
|
||||||
@@ -44,15 +39,83 @@ For renaming instructions in particular, see the XML `remarks` tags on class def
|
|||||||
|
|
||||||
## Build Instructions (PepperDash Internal)
|
## Build Instructions (PepperDash Internal)
|
||||||
|
|
||||||
## Generating Nuget Package
|
## Generating Nuget Package
|
||||||
|
|
||||||
In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec"
|
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:
|
||||||
|
|
||||||
1. Rename the file to match your plugin solution name
|
1. `PackageId` - This is the name that will be used to pull the package from Nuget once it's published
|
||||||
2. Edit the file to include your project specifics including
|
2. `PackgeProjectUrl` - This should match the URL for the plugin repo
|
||||||
1. <id>PepperDash.Essentials.Plugin.MakeModel</id> Convention is to use the prefix "PepperDash.Essentials.Plugin" and include the MakeModel of the device.
|
3. `AssemblyTitle` - This is the dll file name that is will show on a processor when the plugin is loaded
|
||||||
2. <projectUrl>https://github.com/PepperDash/EssentialsPluginTemplate</projectUrl> Change to your url to the project repo
|
<!-- START Minimum Essentials Framework Versions -->
|
||||||
|
### Minimum Essentials Framework Versions
|
||||||
|
|
||||||
There is no longer a requirement to adjust workflow files for nuget generation for private and public repositories. This is now handled automatically in the workflow.
|
- 2.12.1
|
||||||
|
- 2.12.1
|
||||||
|
- 2.12.1
|
||||||
|
<!-- END Minimum Essentials Framework Versions -->
|
||||||
|
<!-- START Config Example -->
|
||||||
|
### Config Example
|
||||||
|
|
||||||
__If you do not make these changes to the nuspec file, the project will not generate a nuget package__
|
```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 -->
|
||||||
|
|||||||
25
epi-make-model.4Series.sln
Normal file
25
epi-make-model.4Series.sln
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
|
||||||
|
Microsoft Visual Studio Solution File, Format Version 12.00
|
||||||
|
# Visual Studio Version 17
|
||||||
|
VisualStudioVersion = 17.11.35327.3
|
||||||
|
MinimumVisualStudioVersion = 10.0.40219.1
|
||||||
|
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "epi-make-model.4Series", "src\epi-make-model.4Series.csproj", "{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}"
|
||||||
|
EndProject
|
||||||
|
Global
|
||||||
|
GlobalSection(SolutionConfigurationPlatforms) = preSolution
|
||||||
|
Debug|Any CPU = Debug|Any CPU
|
||||||
|
Release|Any CPU = Release|Any CPU
|
||||||
|
EndGlobalSection
|
||||||
|
GlobalSection(ProjectConfigurationPlatforms) = postSolution
|
||||||
|
{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||||
|
{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||||
|
{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||||
|
{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}.Release|Any CPU.Build.0 = Release|Any CPU
|
||||||
|
EndGlobalSection
|
||||||
|
GlobalSection(SolutionProperties) = preSolution
|
||||||
|
HideSolutionNode = FALSE
|
||||||
|
EndGlobalSection
|
||||||
|
GlobalSection(ExtensibilityGlobals) = postSolution
|
||||||
|
SolutionGuid = {45BE70E2-A4DC-4851-92ED-CE67B99F5D86}
|
||||||
|
EndGlobalSection
|
||||||
|
EndGlobal
|
||||||
BIN
images/essentials-plugin-blue.png
Normal file
BIN
images/essentials-plugin-blue.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
BIN
images/essentials-plugin-white.png
Normal file
BIN
images/essentials-plugin-white.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
@@ -1,3 +0,0 @@
|
|||||||
<packages>
|
|
||||||
<package id="PepperDashEssentials" version="1.10.2" targetFramework="net35" allowedVersions="[1.0,2.0)"/>
|
|
||||||
</packages>
|
|
||||||
21
src/Directory.Build.props
Normal file
21
src/Directory.Build.props
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<Project>
|
||||||
|
<PropertyGroup>
|
||||||
|
<Version>1.0.0-local</Version>
|
||||||
|
<InformationalVersion>$(Version)</InformationalVersion>
|
||||||
|
<Authors>PepperDash Technology</Authors>
|
||||||
|
<Company>PepperDash Technology</Company>
|
||||||
|
<Product>PepperDash Essentials Plugin Template</Product>
|
||||||
|
<Copyright>Copyright © 2025</Copyright>
|
||||||
|
<RepositoryUrl>https://github.com/PepperDash/EssentialsPluginTemplate.git</RepositoryUrl>
|
||||||
|
<RepositoryType>git</RepositoryType>
|
||||||
|
<PackageTags>Crestron; 4series</PackageTags>
|
||||||
|
<PackageOutputPath>..\output</PackageOutputPath>
|
||||||
|
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
|
||||||
|
<PackageLicenseFile>LICENSE.md</PackageLicenseFile>
|
||||||
|
<PackageReadmeFile>README.md</PackageReadmeFile>
|
||||||
|
</PropertyGroup>
|
||||||
|
<ItemGroup>
|
||||||
|
<None Include="..\LICENSE.md" Pack="true" PackagePath=""/>
|
||||||
|
<None Include="..\README.md" Pack="true" PackagePath=""/>
|
||||||
|
</ItemGroup>
|
||||||
|
</Project>
|
||||||
20
src/Directory.Build.targets
Normal file
20
src/Directory.Build.targets
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
<Project>
|
||||||
|
<ItemGroup>
|
||||||
|
<None Include="$(TargetDir)\$(TargetName).$(Version).cpz" Condition="$(ProjectType) == 'Program'">
|
||||||
|
<Pack>true</Pack>
|
||||||
|
<PackagePath>content;</PackagePath>
|
||||||
|
</None>
|
||||||
|
<None Include="$(PackageOutputPath)\$(TargetName).$(Version).cplz" Condition="$(ProjectType) == 'ProgramLibrary'">
|
||||||
|
<Pack>true</Pack>
|
||||||
|
<PackagePath>content;</PackagePath>
|
||||||
|
</None>
|
||||||
|
</ItemGroup>
|
||||||
|
<Target Name="Create CPLZ" AfterTargets="Build; Rebuild" Condition="$(ProjectType) == 'ProgramLibrary'">
|
||||||
|
<Message Text="Creating CPLZ"></Message>
|
||||||
|
<MakeDir Directories="$(PackageOutputPath)" Condition="!Exists($(PackageOutputPath))"></MakeDir>
|
||||||
|
<ZipDirectory SourceDirectory="$(TargetDir)" DestinationFile="$(PackageOutputPath)\$(TargetName).$(Version).cplz" Overwrite="true"/>
|
||||||
|
</Target>
|
||||||
|
<Target Name="Clean CPLZ" AfterTargets="AfterClean" Condition="$(ProjectType) == 'ProgramLibrary'">
|
||||||
|
<Delete Files="$(PackageOutputPath)\$(TargetName).$(Version).cplz"/>
|
||||||
|
</Target>
|
||||||
|
</Project>
|
||||||
@@ -1,299 +0,0 @@
|
|||||||
// For Basic SIMPL# Classes
|
|
||||||
// For Basic SIMPL#Pro classes
|
|
||||||
|
|
||||||
using Crestron.SimplSharpPro.DeviceSupport;
|
|
||||||
using PepperDash.Core;
|
|
||||||
using PepperDash.Essentials.Core;
|
|
||||||
using PepperDash.Essentials.Core.Bridges;
|
|
||||||
using PepperDash.Essentials.Core.Queues;
|
|
||||||
|
|
||||||
|
|
||||||
namespace EssentialsPluginTemplate
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// Plugin device template for third party devices that use IBasicCommunication
|
|
||||||
/// </summary>
|
|
||||||
/// <remarks>
|
|
||||||
/// Rename the class to match the device plugin being developed.
|
|
||||||
/// </remarks>
|
|
||||||
/// <example>
|
|
||||||
/// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice"
|
|
||||||
/// </example>
|
|
||||||
public class EssentialsPluginTemplateDevice : EssentialsBridgeableDevice
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// It is often desirable to store the config
|
|
||||||
/// </summary>
|
|
||||||
private EssentialsPluginTemplateConfigObject _config;
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Provides a queue and dedicated worker thread for processing feedback messages from a device.
|
|
||||||
/// </summary>
|
|
||||||
private GenericQueue ReceiveQueue;
|
|
||||||
|
|
||||||
#region IBasicCommunication Properties and Constructor. Remove if not needed.
|
|
||||||
|
|
||||||
// TODO [ ] Add, modify, remove properties and fields as needed for the plugin being developed
|
|
||||||
private readonly IBasicCommunication _comms;
|
|
||||||
private readonly GenericCommunicationMonitor _commsMonitor;
|
|
||||||
|
|
||||||
// _comms gather for ASCII based API's
|
|
||||||
// TODO [ ] If not using an ASCII based API, delete the properties below
|
|
||||||
private readonly CommunicationGather _commsGather;
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Set this value to that of the delimiter used by the API (if applicable)
|
|
||||||
/// </summary>
|
|
||||||
private const string CommsDelimiter = "\r";
|
|
||||||
|
|
||||||
// _comms byte buffer for HEX/byte based API's
|
|
||||||
// TODO [ ] If not using an HEX/byte based API, delete the properties below
|
|
||||||
private byte[] _commsByteBuffer = { };
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Connects/disconnects the comms of the plugin device
|
|
||||||
/// </summary>
|
|
||||||
/// <remarks>
|
|
||||||
/// triggers the _comms.Connect/Disconnect as well as thee comms monitor start/stop
|
|
||||||
/// </remarks>
|
|
||||||
public bool Connect
|
|
||||||
{
|
|
||||||
get { return _comms.IsConnected; }
|
|
||||||
set
|
|
||||||
{
|
|
||||||
if (value)
|
|
||||||
{
|
|
||||||
_comms.Connect();
|
|
||||||
_commsMonitor.Start();
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
_comms.Disconnect();
|
|
||||||
_commsMonitor.Stop();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Reports connect feedback through the bridge
|
|
||||||
/// </summary>
|
|
||||||
public BoolFeedback ConnectFeedback { get; private set; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Reports online feedback through the bridge
|
|
||||||
/// </summary>
|
|
||||||
public BoolFeedback OnlineFeedback { get; private set; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Reports socket status feedback through the bridge
|
|
||||||
/// </summary>
|
|
||||||
public IntFeedback StatusFeedback { get; private set; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Plugin device constructor for devices that need IBasicCommunication
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="key"></param>
|
|
||||||
/// <param name="name"></param>
|
|
||||||
/// <param name="config"></param>
|
|
||||||
/// <param name="comms"></param>
|
|
||||||
public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplateConfigObject config, IBasicCommunication comms)
|
|
||||||
: base(key, name)
|
|
||||||
{
|
|
||||||
Debug.Console(0, this, "Constructing new {0} instance", name);
|
|
||||||
|
|
||||||
// TODO [ ] Update the constructor as needed for the plugin device being developed
|
|
||||||
|
|
||||||
_config = config;
|
|
||||||
|
|
||||||
ReceiveQueue = new GenericQueue(key + "-rxqueue"); // If you need to set the thread priority, use one of the available overloaded constructors.
|
|
||||||
|
|
||||||
ConnectFeedback = new BoolFeedback(() => Connect);
|
|
||||||
OnlineFeedback = new BoolFeedback(() => _commsMonitor.IsOnline);
|
|
||||||
StatusFeedback = new IntFeedback(() => (int)_commsMonitor.Status);
|
|
||||||
|
|
||||||
_comms = comms;
|
|
||||||
_commsMonitor = new GenericCommunicationMonitor(this, _comms, _config.PollTimeMs, _config.WarningTimeoutMs, _config.ErrorTimeoutMs, Poll);
|
|
||||||
|
|
||||||
var socket = _comms as ISocketStatus;
|
|
||||||
if (socket != null)
|
|
||||||
{
|
|
||||||
// device comms is IP **ELSE** device comms is RS232
|
|
||||||
socket.ConnectionChange += socket_ConnectionChange;
|
|
||||||
Connect = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
#region Communication data event handlers. Comment out any that don't apply to the API type
|
|
||||||
|
|
||||||
// Only one of the below handlers should be necessary.
|
|
||||||
|
|
||||||
// _comms gather for any API that has a defined delimiter
|
|
||||||
// TODO [ ] If not using an ASCII based API, remove the line below
|
|
||||||
_commsGather = new CommunicationGather(_comms, CommsDelimiter);
|
|
||||||
_commsGather.LineReceived += Handle_LineRecieved;
|
|
||||||
|
|
||||||
// _comms byte buffer for HEX/byte based API's with no delimiter
|
|
||||||
// TODO [ ] If not using an HEX/byte based API, remove the line below
|
|
||||||
_comms.BytesReceived += Handle_BytesReceived;
|
|
||||||
|
|
||||||
// _comms byte buffer for HEX/byte based API's with no delimiter
|
|
||||||
// TODO [ ] If not using an HEX/byte based API, remove the line below
|
|
||||||
_comms.TextReceived += Handle_TextReceived;
|
|
||||||
|
|
||||||
#endregion
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args)
|
|
||||||
{
|
|
||||||
if (ConnectFeedback != null)
|
|
||||||
ConnectFeedback.FireUpdate();
|
|
||||||
|
|
||||||
if (StatusFeedback != null)
|
|
||||||
StatusFeedback.FireUpdate();
|
|
||||||
}
|
|
||||||
|
|
||||||
// TODO [ ] If not using an API with a delimeter, delete the method below
|
|
||||||
private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args)
|
|
||||||
{
|
|
||||||
// TODO [ ] Implement method
|
|
||||||
|
|
||||||
// Enqueues the message to be processed in a dedicated thread, but the specified method
|
|
||||||
ReceiveQueue.Enqueue(new ProcessStringMessage(args.Text, ProcessFeedbackMessage));
|
|
||||||
}
|
|
||||||
|
|
||||||
// TODO [ ] If not using an HEX/byte based API with no delimeter, delete the method below
|
|
||||||
private void Handle_BytesReceived(object sender, GenericCommMethodReceiveBytesArgs args)
|
|
||||||
{
|
|
||||||
// TODO [ ] Implement method
|
|
||||||
throw new System.NotImplementedException();
|
|
||||||
}
|
|
||||||
|
|
||||||
// TODO [ ] If not using an ASCII based API with no delimeter, delete the method below
|
|
||||||
void Handle_TextReceived(object sender, GenericCommMethodReceiveTextArgs e)
|
|
||||||
{
|
|
||||||
// TODO [ ] Implement method
|
|
||||||
throw new System.NotImplementedException();
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// This method should perform any necessary parsing of feedback messages from the device
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="message"></param>
|
|
||||||
void ProcessFeedbackMessage(string message)
|
|
||||||
{
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// TODO [ ] If not using an ACII based API, delete the properties below
|
|
||||||
/// <summary>
|
|
||||||
/// Sends text to the device plugin comms
|
|
||||||
/// </summary>
|
|
||||||
/// <remarks>
|
|
||||||
/// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands
|
|
||||||
/// </remarks>
|
|
||||||
/// <param name="text">Command to be sent</param>
|
|
||||||
public void SendText(string text)
|
|
||||||
{
|
|
||||||
if (string.IsNullOrEmpty(text)) return;
|
|
||||||
|
|
||||||
_comms.SendText(string.Format("{0}{1}", text, CommsDelimiter));
|
|
||||||
}
|
|
||||||
|
|
||||||
// TODO [ ] If not using an HEX/byte based API, delete the properties below
|
|
||||||
/// <summary>
|
|
||||||
/// Sends bytes to the device plugin comms
|
|
||||||
/// </summary>
|
|
||||||
/// <remarks>
|
|
||||||
/// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands
|
|
||||||
/// </remarks>
|
|
||||||
/// <param name="bytes">Bytes to be sent</param>
|
|
||||||
public void SendBytes(byte[] bytes)
|
|
||||||
{
|
|
||||||
if (bytes == null) return;
|
|
||||||
|
|
||||||
_comms.SendBytes(bytes);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Polls the device
|
|
||||||
/// </summary>
|
|
||||||
/// <remarks>
|
|
||||||
/// Poll method is used by the communication monitor. Update the poll method as needed for the plugin being developed
|
|
||||||
/// </remarks>
|
|
||||||
public void Poll()
|
|
||||||
{
|
|
||||||
// TODO [ ] Update Poll method as needed for the plugin being developed
|
|
||||||
// Example: SendText("getstatus");
|
|
||||||
throw new System.NotImplementedException();
|
|
||||||
}
|
|
||||||
|
|
||||||
#endregion
|
|
||||||
|
|
||||||
|
|
||||||
#region Overrides of EssentialsBridgeableDevice
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Links the plugin device to the EISC bridge
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="trilist"></param>
|
|
||||||
/// <param name="joinStart"></param>
|
|
||||||
/// <param name="joinMapKey"></param>
|
|
||||||
/// <param name="bridge"></param>
|
|
||||||
public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
|
|
||||||
{
|
|
||||||
var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart);
|
|
||||||
|
|
||||||
// This adds the join map to the collection on the bridge
|
|
||||||
if (bridge != null)
|
|
||||||
{
|
|
||||||
bridge.AddJoinMap(Key, joinMap);
|
|
||||||
}
|
|
||||||
|
|
||||||
var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
|
|
||||||
|
|
||||||
if (customJoins != null)
|
|
||||||
{
|
|
||||||
joinMap.SetCustomJoinData(customJoins);
|
|
||||||
}
|
|
||||||
|
|
||||||
Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X"));
|
|
||||||
Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name);
|
|
||||||
|
|
||||||
// TODO [ ] Implement bridge links as needed
|
|
||||||
|
|
||||||
// links to bridge
|
|
||||||
trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
|
|
||||||
|
|
||||||
trilist.SetBoolSigAction(joinMap.Connect.JoinNumber, sig => Connect = sig);
|
|
||||||
ConnectFeedback.LinkInputSig(trilist.BooleanInput[joinMap.Connect.JoinNumber]);
|
|
||||||
|
|
||||||
StatusFeedback.LinkInputSig(trilist.UShortInput[joinMap.Status.JoinNumber]);
|
|
||||||
OnlineFeedback.LinkInputSig(trilist.BooleanInput[joinMap.IsOnline.JoinNumber]);
|
|
||||||
|
|
||||||
UpdateFeedbacks();
|
|
||||||
|
|
||||||
trilist.OnlineStatusChange += (o, a) =>
|
|
||||||
{
|
|
||||||
if (!a.DeviceOnLine) return;
|
|
||||||
|
|
||||||
trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
|
|
||||||
UpdateFeedbacks();
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
private void UpdateFeedbacks()
|
|
||||||
{
|
|
||||||
// TODO [ ] Update as needed for the plugin being developed
|
|
||||||
ConnectFeedback.FireUpdate();
|
|
||||||
OnlineFeedback.FireUpdate();
|
|
||||||
StatusFeedback.FireUpdate();
|
|
||||||
}
|
|
||||||
|
|
||||||
#endregion
|
|
||||||
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
@@ -1,239 +0,0 @@
|
|||||||
using System.Collections.Generic;
|
|
||||||
using PepperDash.Core;
|
|
||||||
using PepperDash.Essentials.Core;
|
|
||||||
using Crestron.SimplSharpPro.UI;
|
|
||||||
|
|
||||||
namespace EssentialsPluginTemplate
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// Plugin device factory for devices that use IBasicCommunication
|
|
||||||
/// </summary>
|
|
||||||
/// <remarks>
|
|
||||||
/// Rename the class to match the device plugin being developed
|
|
||||||
/// </remarks>
|
|
||||||
/// <example>
|
|
||||||
/// "EssentialsPluginFactoryTemplate" renamed to "MyDeviceFactory"
|
|
||||||
/// </example>
|
|
||||||
public class EssentialsPluginTemplateFactory : EssentialsPluginDeviceFactory<EssentialsPluginTemplateDevice>
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// Plugin device factory constructor
|
|
||||||
/// </summary>
|
|
||||||
/// <remarks>
|
|
||||||
/// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin
|
|
||||||
/// </remarks>
|
|
||||||
/// <example>
|
|
||||||
/// Set the minimum Essentials Framework Version
|
|
||||||
/// <code>
|
|
||||||
/// MinimumEssentialsFrameworkVersion = "1.6.4;
|
|
||||||
/// </code>
|
|
||||||
/// In the constructor we initialize the list with the typenames that will build an instance of this device
|
|
||||||
/// <code>
|
|
||||||
/// TypeNames = new List<string>() { "SamsungMdc", "SamsungMdcDisplay" };
|
|
||||||
/// </code>
|
|
||||||
/// </example>
|
|
||||||
public EssentialsPluginTemplateFactory()
|
|
||||||
{
|
|
||||||
// Set the minimum Essentials Framework Version
|
|
||||||
// TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against
|
|
||||||
MinimumEssentialsFrameworkVersion = "1.6.4";
|
|
||||||
|
|
||||||
// In the constructor we initialize the list with the typenames that will build an instance of this device
|
|
||||||
// TODO [ ] Update the TypeNames for the plugin being developed
|
|
||||||
TypeNames = new List<string>() { "examplePluginDevice" };
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Builds and returns an instance of EssentialsPluginDeviceTemplate
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="dc">device configuration</param>
|
|
||||||
/// <returns>plugin device or null</returns>
|
|
||||||
/// <remarks>
|
|
||||||
/// The example provided below takes the device key, name, properties config and the comms device created.
|
|
||||||
/// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device.
|
|
||||||
/// </remarks>
|
|
||||||
/// <seealso cref="PepperDash.Core.eControlMethod"/>
|
|
||||||
public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc)
|
|
||||||
{
|
|
||||||
Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type);
|
|
||||||
|
|
||||||
// get the plugin device properties configuration object & check for null
|
|
||||||
var propertiesConfig = dc.Properties.ToObject<EssentialsPluginTemplateConfigObject>();
|
|
||||||
if (propertiesConfig == null)
|
|
||||||
{
|
|
||||||
Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name);
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
// attempt build the plugin device comms device & check for null
|
|
||||||
// TODO { ] As of PepperDash Core 1.0.41, HTTP and HTTPS are not valid eControlMethods and will throw an exception.
|
|
||||||
var comms = CommFactory.CreateCommForDevice(dc);
|
|
||||||
if (comms == null)
|
|
||||||
{
|
|
||||||
Debug.Console(1, "[{0}] Factory Notice: No control object present for device {1}", dc.Key, dc.Name);
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
return new EssentialsPluginTemplateDevice(dc.Key, dc.Name, propertiesConfig, comms);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Plugin device factory for logic devices that don't communicate
|
|
||||||
/// </summary>
|
|
||||||
/// <remarks>
|
|
||||||
/// Rename the class to match the device plugin being developed
|
|
||||||
/// </remarks>
|
|
||||||
/// <example>
|
|
||||||
/// "EssentialsPluginFactoryTemplate" renamed to "MyLogicDeviceFactory"
|
|
||||||
/// </example>
|
|
||||||
public class EssentialsPluginTemplateFactoryLogicDevice : EssentialsPluginDeviceFactory<EssentialsPluginTemplateLogicDevice>
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// Plugin device factory constructor
|
|
||||||
/// </summary>
|
|
||||||
/// <remarks>
|
|
||||||
/// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin
|
|
||||||
/// </remarks>
|
|
||||||
/// <example>
|
|
||||||
/// Set the minimum Essentials Framework Version
|
|
||||||
/// <code>
|
|
||||||
/// MinimumEssentialsFrameworkVersion = "1.6.4;
|
|
||||||
/// </code>
|
|
||||||
/// In the constructor we initialize the list with the typenames that will build an instance of this device
|
|
||||||
/// <code>
|
|
||||||
/// TypeNames = new List<string>() { "SamsungMdc", "SamsungMdcDisplay" };
|
|
||||||
/// </code>
|
|
||||||
/// </example>
|
|
||||||
public EssentialsPluginTemplateFactoryLogicDevice()
|
|
||||||
{
|
|
||||||
// Set the minimum Essentials Framework Version
|
|
||||||
// TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against
|
|
||||||
MinimumEssentialsFrameworkVersion = "1.6.4";
|
|
||||||
|
|
||||||
// In the constructor we initialize the list with the typenames that will build an instance of this device
|
|
||||||
// TODO [ ] Update the TypeNames for the plugin being developed
|
|
||||||
TypeNames = new List<string>() { "examplePluginLogicDevice" };
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Builds and returns an instance of EssentialsPluginTemplateLogicDevice
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="dc">device configuration</param>
|
|
||||||
/// <returns>plugin device or null</returns>
|
|
||||||
/// <remarks>
|
|
||||||
/// The example provided below takes the device key, name, properties config and the comms device created.
|
|
||||||
/// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device.
|
|
||||||
/// </remarks>
|
|
||||||
/// <seealso cref="PepperDash.Core.eControlMethod"/>
|
|
||||||
public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc)
|
|
||||||
{
|
|
||||||
|
|
||||||
Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type);
|
|
||||||
|
|
||||||
// get the plugin device properties configuration object & check for null
|
|
||||||
var propertiesConfig = dc.Properties.ToObject<EssentialsPluginTemplateConfigObject>();
|
|
||||||
if (propertiesConfig == null)
|
|
||||||
{
|
|
||||||
Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name);
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
var controlConfig = CommFactory.GetControlPropertiesConfig(dc);
|
|
||||||
|
|
||||||
if (controlConfig == null)
|
|
||||||
{
|
|
||||||
return new EssentialsPluginTemplateLogicDevice(dc.Key, dc.Name, propertiesConfig);
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
Debug.Console(0, "[{0}] Factory: Unable to get control properties from device config for {1}", dc.Key, dc.Name);
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Plugin device factory for Crestron wrapper devices
|
|
||||||
/// </summary>
|
|
||||||
/// <remarks>
|
|
||||||
/// Rename the class to match the device plugin being developed
|
|
||||||
/// </remarks>
|
|
||||||
/// <example>
|
|
||||||
/// "EssentialsPluginFactoryTemplate" renamed to "MyCrestronDeviceFactory"
|
|
||||||
/// </example>
|
|
||||||
public class EssentialsPluginTemplateFactoryCrestronDevice : EssentialsPluginDeviceFactory<EssentialsPluginTemplateCrestronDevice>
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// Plugin device factory constructor
|
|
||||||
/// </summary>
|
|
||||||
/// <remarks>
|
|
||||||
/// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin
|
|
||||||
/// </remarks>
|
|
||||||
/// <example>
|
|
||||||
/// Set the minimum Essentials Framework Version
|
|
||||||
/// <code>
|
|
||||||
/// MinimumEssentialsFrameworkVersion = "1.6.4;
|
|
||||||
/// </code>
|
|
||||||
/// In the constructor we initialize the list with the typenames that will build an instance of this device
|
|
||||||
/// <code>
|
|
||||||
/// TypeNames = new List<string>() { "SamsungMdc", "SamsungMdcDisplay" };
|
|
||||||
/// </code>
|
|
||||||
/// </example>
|
|
||||||
public EssentialsPluginTemplateFactoryCrestronDevice()
|
|
||||||
{
|
|
||||||
// Set the minimum Essentials Framework Version
|
|
||||||
// TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against
|
|
||||||
MinimumEssentialsFrameworkVersion = "1.7.5";
|
|
||||||
|
|
||||||
// In the constructor we initialize the list with the typenames that will build an instance of this device
|
|
||||||
// TODO [ ] Update the TypeNames for the plugin being developed
|
|
||||||
TypeNames = new List<string>() { "examplePluginCrestronDevice" };
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Builds and returns an instance of EssentialsPluginTemplateCrestronDevice
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="dc">device configuration</param>
|
|
||||||
/// <returns>plugin device or null</returns>
|
|
||||||
/// <remarks>
|
|
||||||
/// The example provided below takes the device key, name, properties config and the comms device created.
|
|
||||||
/// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device.
|
|
||||||
/// </remarks>
|
|
||||||
/// <seealso cref="PepperDash.Core.eControlMethod"/>
|
|
||||||
public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc)
|
|
||||||
{
|
|
||||||
|
|
||||||
Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type);
|
|
||||||
|
|
||||||
// get the plugin device properties configuration object & check for null
|
|
||||||
var propertiesConfig = dc.Properties.ToObject<EssentialsPluginTemplateConfigObject>();
|
|
||||||
if (propertiesConfig == null)
|
|
||||||
{
|
|
||||||
Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name);
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
var controlConfig = CommFactory.GetControlPropertiesConfig(dc);
|
|
||||||
|
|
||||||
if (controlConfig == null)
|
|
||||||
{
|
|
||||||
var myTouchpanel = new Tsw760(controlConfig.IpIdInt, Global.ControlSystem);
|
|
||||||
|
|
||||||
return new EssentialsPluginTemplateCrestronDevice(dc.Key, dc.Name, propertiesConfig, myTouchpanel);
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
Debug.Console(0, "[{0}] Factory: Unable to get control properties from device config for {1}", dc.Key, dc.Name);
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,101 +1,101 @@
|
|||||||
using PepperDash.Essentials.Core;
|
using PepperDash.Essentials.Core;
|
||||||
|
|
||||||
namespace EssentialsPluginTemplate
|
namespace PepperDash.Essentials.Plugin
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Plugin device Bridge Join Map
|
/// Plugin device Bridge Join Map
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <remarks>
|
/// <remarks>
|
||||||
/// Rename the class to match the device plugin being developed. Reference Essentials JoinMaps, if one exists for the device plugin being developed
|
/// Rename the class to match the device plugin being developed. Reference Essentials JoinMaps, if one exists for the device plugin being developed
|
||||||
/// </remarks>
|
/// </remarks>
|
||||||
/// <see cref="PepperDash.Essentials.Core.Bridges"/>
|
/// <see cref="PepperDash.Essentials.Core.Bridges"/>
|
||||||
/// <example>
|
/// <example>
|
||||||
/// "EssentialsPluginBridgeJoinMapTemplate" renamed to "SamsungMdcBridgeJoinMap"
|
/// "EssentialsPluginBridgeJoinMapTemplate" renamed to "SamsungMdcBridgeJoinMap"
|
||||||
/// </example>
|
/// </example>
|
||||||
public class EssentialsPluginTemplateBridgeJoinMap : JoinMapBaseAdvanced
|
public class EssentialsPluginTemplateBridgeJoinMap : JoinMapBaseAdvanced
|
||||||
{
|
{
|
||||||
#region Digital
|
#region Digital
|
||||||
|
|
||||||
// TODO [ ] Add digital joins below plugin being developed
|
// TODO [ ] Add digital joins below plugin being developed
|
||||||
|
|
||||||
[JoinName("IsOnline")]
|
[JoinName("IsOnline")]
|
||||||
public JoinDataComplete IsOnline = new JoinDataComplete(
|
public JoinDataComplete IsOnline = new JoinDataComplete(
|
||||||
new JoinData
|
new JoinData
|
||||||
{
|
{
|
||||||
JoinNumber = 1,
|
JoinNumber = 1,
|
||||||
JoinSpan = 1
|
JoinSpan = 1
|
||||||
},
|
},
|
||||||
new JoinMetadata
|
new JoinMetadata
|
||||||
{
|
{
|
||||||
Description = "Is Online",
|
Description = "Is Online",
|
||||||
JoinCapabilities = eJoinCapabilities.ToSIMPL,
|
JoinCapabilities = eJoinCapabilities.ToSIMPL,
|
||||||
JoinType = eJoinType.Digital
|
JoinType = eJoinType.Digital
|
||||||
});
|
});
|
||||||
|
|
||||||
[JoinName("Connect")]
|
[JoinName("Connect")]
|
||||||
public JoinDataComplete Connect = new JoinDataComplete(
|
public JoinDataComplete Connect = new JoinDataComplete(
|
||||||
new JoinData
|
new JoinData
|
||||||
{
|
{
|
||||||
JoinNumber = 2,
|
JoinNumber = 2,
|
||||||
JoinSpan = 1
|
JoinSpan = 1
|
||||||
},
|
},
|
||||||
new JoinMetadata
|
new JoinMetadata
|
||||||
{
|
{
|
||||||
Description = "Connect (Held)/Disconnect (Release) & corresponding feedback",
|
Description = "Connect (Held)/Disconnect (Release) & corresponding feedback",
|
||||||
JoinCapabilities = eJoinCapabilities.ToFromSIMPL,
|
JoinCapabilities = eJoinCapabilities.ToFromSIMPL,
|
||||||
JoinType = eJoinType.Digital
|
JoinType = eJoinType.Digital
|
||||||
});
|
});
|
||||||
|
|
||||||
#endregion
|
#endregion
|
||||||
|
|
||||||
|
|
||||||
#region Analog
|
#region Analog
|
||||||
|
|
||||||
// TODO [ ] Add analog joins below plugin being developed
|
// TODO [ ] Add analog joins below plugin being developed
|
||||||
|
|
||||||
[JoinName("Status")]
|
[JoinName("Status")]
|
||||||
public JoinDataComplete Status = new JoinDataComplete(
|
public JoinDataComplete Status = new JoinDataComplete(
|
||||||
new JoinData
|
new JoinData
|
||||||
{
|
{
|
||||||
JoinNumber = 1,
|
JoinNumber = 1,
|
||||||
JoinSpan = 1
|
JoinSpan = 1
|
||||||
},
|
},
|
||||||
new JoinMetadata
|
new JoinMetadata
|
||||||
{
|
{
|
||||||
Description = "Socket Status",
|
Description = "Socket Status",
|
||||||
JoinCapabilities = eJoinCapabilities.ToSIMPL,
|
JoinCapabilities = eJoinCapabilities.ToSIMPL,
|
||||||
JoinType = eJoinType.Analog
|
JoinType = eJoinType.Analog
|
||||||
});
|
});
|
||||||
|
|
||||||
#endregion
|
#endregion
|
||||||
|
|
||||||
|
|
||||||
#region Serial
|
#region Serial
|
||||||
|
|
||||||
// TODO [ ] Add serial joins below plugin being developed
|
// TODO [ ] Add serial joins below plugin being developed
|
||||||
|
|
||||||
public JoinDataComplete DeviceName = new JoinDataComplete(
|
public JoinDataComplete DeviceName = new JoinDataComplete(
|
||||||
new JoinData
|
new JoinData
|
||||||
{
|
{
|
||||||
JoinNumber = 1,
|
JoinNumber = 1,
|
||||||
JoinSpan = 1
|
JoinSpan = 1
|
||||||
},
|
},
|
||||||
new JoinMetadata
|
new JoinMetadata
|
||||||
{
|
{
|
||||||
Description = "Device Name",
|
Description = "Device Name",
|
||||||
JoinCapabilities = eJoinCapabilities.ToSIMPL,
|
JoinCapabilities = eJoinCapabilities.ToSIMPL,
|
||||||
JoinType = eJoinType.Serial
|
JoinType = eJoinType.Serial
|
||||||
});
|
});
|
||||||
|
|
||||||
#endregion
|
#endregion
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Plugin device BridgeJoinMap constructor
|
/// Plugin device BridgeJoinMap constructor
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="joinStart">This will be the join it starts on the EISC bridge</param>
|
/// <param name="joinStart">This will be the join it starts on the EISC bridge</param>
|
||||||
public EssentialsPluginTemplateBridgeJoinMap(uint joinStart)
|
public EssentialsPluginTemplateBridgeJoinMap(uint joinStart)
|
||||||
: base(joinStart, typeof(EssentialsPluginTemplateBridgeJoinMap))
|
: base(joinStart, typeof(EssentialsPluginTemplateBridgeJoinMap))
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
using Newtonsoft.Json;
|
using Newtonsoft.Json;
|
||||||
using PepperDash.Essentials.Core;
|
using PepperDash.Essentials.Core;
|
||||||
|
|
||||||
namespace EssentialsPluginTemplate
|
namespace PepperDash.Essentials.Plugin
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Plugin device configuration object
|
/// Plugin device configuration object
|
||||||
@@ -14,7 +14,7 @@ namespace EssentialsPluginTemplate
|
|||||||
/// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig"
|
/// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig"
|
||||||
/// </example>
|
/// </example>
|
||||||
[ConfigSnippet("\"properties\":{\"control\":{}")]
|
[ConfigSnippet("\"properties\":{\"control\":{}")]
|
||||||
public class EssentialsPluginTemplateConfigObject
|
public class MakeModelConfig
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// JSON control object
|
/// JSON control object
|
||||||
@@ -27,7 +27,7 @@ namespace EssentialsPluginTemplate
|
|||||||
/// <example>
|
/// <example>
|
||||||
/// <code>
|
/// <code>
|
||||||
/// "control": {
|
/// "control": {
|
||||||
/// "method": "tcpIp",
|
/// "method": "tcpIp",
|
||||||
/// "controlPortDevKey": "processor",
|
/// "controlPortDevKey": "processor",
|
||||||
/// "controlPortNumber": 1,
|
/// "controlPortNumber": 1,
|
||||||
/// "comParams": {
|
/// "comParams": {
|
||||||
@@ -139,7 +139,7 @@ namespace EssentialsPluginTemplate
|
|||||||
/// </code>
|
/// </code>
|
||||||
/// </example>
|
/// </example>
|
||||||
[JsonProperty("DeviceDictionary")]
|
[JsonProperty("DeviceDictionary")]
|
||||||
public Dictionary<string, EssentialsPluginTemplateConfigObjectDictionary> DeviceDictionary { get; set; }
|
public Dictionary<string, MakeModelConfigDictionary> DeviceDictionary { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Constuctor
|
/// Constuctor
|
||||||
@@ -148,9 +148,9 @@ namespace EssentialsPluginTemplate
|
|||||||
/// If using a collection you must instantiate the collection in the constructor
|
/// If using a collection you must instantiate the collection in the constructor
|
||||||
/// to avoid exceptions when reading the configuration file
|
/// to avoid exceptions when reading the configuration file
|
||||||
/// </remarks>
|
/// </remarks>
|
||||||
public EssentialsPluginTemplateConfigObject()
|
public MakeModelConfig()
|
||||||
{
|
{
|
||||||
DeviceDictionary = new Dictionary<string, EssentialsPluginTemplateConfigObjectDictionary>();
|
DeviceDictionary = new Dictionary<string, MakeModelConfigDictionary>();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -172,7 +172,7 @@ namespace EssentialsPluginTemplate
|
|||||||
/// }
|
/// }
|
||||||
/// </code>
|
/// </code>
|
||||||
/// </example>
|
/// </example>
|
||||||
public class EssentialsPluginTemplateConfigObjectDictionary
|
public class MakeModelConfigDictionary
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Serializes collection name property
|
/// Serializes collection name property
|
||||||
@@ -1,29 +1,29 @@
|
|||||||
// For Basic SIMPL# Classes
|
// For Basic SIMPL# Classes
|
||||||
// For Basic SIMPL#Pro classes
|
// For Basic SIMPL#Pro classes
|
||||||
|
|
||||||
using Crestron.SimplSharpPro.DeviceSupport;
|
|
||||||
using Crestron.SimplSharpPro;
|
using Crestron.SimplSharpPro;
|
||||||
using PepperDash.Core;
|
using Crestron.SimplSharpPro.DeviceSupport;
|
||||||
|
using PepperDash.Core.Logging;
|
||||||
using PepperDash.Essentials.Core;
|
using PepperDash.Essentials.Core;
|
||||||
using PepperDash.Essentials.Core.Bridges;
|
using PepperDash.Essentials.Core.Bridges;
|
||||||
|
|
||||||
namespace EssentialsPluginTemplate
|
namespace PepperDash.Essentials.Plugin
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Plugin device
|
/// Plugin device
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <remarks>
|
/// <remarks>
|
||||||
/// Rename the class to match the device plugin being developed.
|
/// Rename the class to match the device plugin being developed.
|
||||||
/// </remarks>
|
/// </remarks>
|
||||||
/// <example>
|
/// <example>
|
||||||
/// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice"
|
/// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice"
|
||||||
/// </example>
|
/// </example>
|
||||||
public class EssentialsPluginTemplateCrestronDevice : CrestronGenericBridgeableBaseDevice
|
public class MakeModelCrestronDevice : CrestronGenericBridgeableBaseDevice
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// It is often desirable to store the config
|
/// It is often desirable to store the config
|
||||||
/// </summary>
|
/// </summary>
|
||||||
private EssentialsPluginTemplateConfigObject _config;
|
private readonly MakeModelConfig config;
|
||||||
|
|
||||||
|
|
||||||
#region Constructor for Devices without IBasicCommunication. Remove if not needed
|
#region Constructor for Devices without IBasicCommunication. Remove if not needed
|
||||||
@@ -34,16 +34,16 @@ namespace EssentialsPluginTemplate
|
|||||||
/// <param name="name"></param>
|
/// <param name="name"></param>
|
||||||
/// <param name="config"></param>
|
/// <param name="config"></param>
|
||||||
/// <param name="hardware"></param>
|
/// <param name="hardware"></param>
|
||||||
public EssentialsPluginTemplateCrestronDevice(string key, string name, EssentialsPluginTemplateConfigObject config, GenericBase hardware)
|
public MakeModelCrestronDevice(string key, string name, MakeModelConfig config, GenericBase hardware)
|
||||||
: base(key, name, hardware)
|
: base(key, name, hardware)
|
||||||
{
|
{
|
||||||
Debug.Console(0, this, "Constructing new {0} instance", name);
|
this.LogInformation("Constructing new {0} instance", name);
|
||||||
|
|
||||||
// The base class takes care of registering the hardware device for you
|
// The base class takes care of registering the hardware device for you
|
||||||
|
|
||||||
// TODO [ ] Update the constructor as needed for the plugin device being developed
|
// TODO [ ] Update the constructor as needed for the plugin device being developed
|
||||||
|
|
||||||
_config = config;
|
this.config = config;
|
||||||
}
|
}
|
||||||
|
|
||||||
#endregion
|
#endregion
|
||||||
@@ -63,10 +63,7 @@ namespace EssentialsPluginTemplate
|
|||||||
var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart);
|
var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart);
|
||||||
|
|
||||||
// This adds the join map to the collection on the bridge
|
// This adds the join map to the collection on the bridge
|
||||||
if (bridge != null)
|
bridge?.AddJoinMap(Key, joinMap);
|
||||||
{
|
|
||||||
bridge.AddJoinMap(Key, joinMap);
|
|
||||||
}
|
|
||||||
|
|
||||||
var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
|
var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
|
||||||
|
|
||||||
@@ -75,8 +72,8 @@ namespace EssentialsPluginTemplate
|
|||||||
joinMap.SetCustomJoinData(customJoins);
|
joinMap.SetCustomJoinData(customJoins);
|
||||||
}
|
}
|
||||||
|
|
||||||
Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X"));
|
this.LogDebug("Linking to Trilist {id}", trilist.ID.ToString("X"));
|
||||||
Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name);
|
this.LogInformation("Linking to Bridge Type {type}", GetType().Name);
|
||||||
|
|
||||||
// TODO [ ] Implement bridge links as needed
|
// TODO [ ] Implement bridge links as needed
|
||||||
|
|
||||||
87
src/MakeModelCrestronDeviceFactory.cs
Normal file
87
src/MakeModelCrestronDeviceFactory.cs
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using Crestron.SimplSharpPro.UI;
|
||||||
|
using PepperDash.Core;
|
||||||
|
using PepperDash.Essentials.Core;
|
||||||
|
|
||||||
|
namespace PepperDash.Essentials.Plugin
|
||||||
|
{
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Plugin device factory for Crestron wrapper devices
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// Rename the class to match the device plugin being developed
|
||||||
|
/// </remarks>
|
||||||
|
/// <example>
|
||||||
|
/// "EssentialsPluginFactoryTemplate" renamed to "MyCrestronDeviceFactory"
|
||||||
|
/// </example>
|
||||||
|
public class MakeModelCrestronDeviceFactory : EssentialsPluginDeviceFactory<MakeModelCrestronDevice>
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Plugin device factory constructor
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin
|
||||||
|
/// </remarks>
|
||||||
|
/// <example>
|
||||||
|
/// Set the minimum Essentials Framework Version
|
||||||
|
/// <code>
|
||||||
|
/// MinimumEssentialsFrameworkVersion = "1.6.4;
|
||||||
|
/// </code>
|
||||||
|
/// In the constructor we initialize the list with the typenames that will build an instance of this device
|
||||||
|
/// <code>
|
||||||
|
/// TypeNames = new List<string>() { "SamsungMdc", "SamsungMdcDisplay" };
|
||||||
|
/// </code>
|
||||||
|
/// </example>
|
||||||
|
public MakeModelCrestronDeviceFactory()
|
||||||
|
{
|
||||||
|
// Set the minimum Essentials Framework Version
|
||||||
|
// TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against
|
||||||
|
MinimumEssentialsFrameworkVersion = "2.12.1";
|
||||||
|
|
||||||
|
// In the constructor we initialize the list with the typenames that will build an instance of this device
|
||||||
|
// TODO [ ] Update the TypeNames for the plugin being developed
|
||||||
|
TypeNames = new List<string>() { "examplePluginCrestronDevice" };
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Builds and returns an instance of EssentialsPluginTemplateCrestronDevice
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="dc">device configuration</param>
|
||||||
|
/// <returns>plugin device or null</returns>
|
||||||
|
/// <remarks>
|
||||||
|
/// The example provided below takes the device key, name, properties config and the comms device created.
|
||||||
|
/// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device.
|
||||||
|
/// </remarks>
|
||||||
|
/// <seealso cref="PepperDash.Core.eControlMethod"/>
|
||||||
|
public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc)
|
||||||
|
{
|
||||||
|
|
||||||
|
Debug.LogDebug("[{key}] Factory Attempting to create new device from type: {type}", dc.Key, dc.Type);
|
||||||
|
|
||||||
|
// get the plugin device properties configuration object & check for null
|
||||||
|
var propertiesConfig = dc.Properties.ToObject<MakeModelConfig>();
|
||||||
|
if (propertiesConfig == null)
|
||||||
|
{
|
||||||
|
Debug.LogWarning("[{key}] Factory: failed to read properties config for {name}", dc.Key, dc.Name);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
var controlConfig = CommFactory.GetControlPropertiesConfig(dc);
|
||||||
|
|
||||||
|
if (controlConfig != null)
|
||||||
|
{
|
||||||
|
var myTouchpanel = new Tsw760(controlConfig.IpIdInt, Global.ControlSystem);
|
||||||
|
|
||||||
|
return new MakeModelCrestronDevice(dc.Key, dc.Name, propertiesConfig, myTouchpanel);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
Debug.LogWarning("[{key}] Factory: Unable to get control properties from device config for {name}", dc.Key, dc.Name);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
294
src/MakeModelDevice.cs
Normal file
294
src/MakeModelDevice.cs
Normal file
@@ -0,0 +1,294 @@
|
|||||||
|
// For Basic SIMPL# Classes
|
||||||
|
// For Basic SIMPL#Pro classes
|
||||||
|
|
||||||
|
using Crestron.SimplSharpPro.DeviceSupport;
|
||||||
|
using PepperDash.Core;
|
||||||
|
using PepperDash.Core.Logging;
|
||||||
|
using PepperDash.Essentials.Core;
|
||||||
|
using PepperDash.Essentials.Core.Bridges;
|
||||||
|
using PepperDash.Essentials.Core.Queues;
|
||||||
|
|
||||||
|
namespace PepperDash.Essentials.Plugin
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Plugin device template for third party devices that use IBasicCommunication
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// Rename the class to match the device plugin being developed.
|
||||||
|
/// </remarks>
|
||||||
|
/// <example>
|
||||||
|
/// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice"
|
||||||
|
/// </example>
|
||||||
|
public class MakeModelDevice : EssentialsBridgeableDevice
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// It is often desirable to store the config
|
||||||
|
/// </summary>
|
||||||
|
private readonly MakeModelConfig config;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Provides a queue and dedicated worker thread for processing feedback messages from a device.
|
||||||
|
/// </summary>
|
||||||
|
private readonly GenericQueue receiveQueue;
|
||||||
|
|
||||||
|
#region IBasicCommunication Properties and Constructor. Remove if not needed.
|
||||||
|
|
||||||
|
// TODO [ ] Add, modify, remove properties and fields as needed for the plugin being developed
|
||||||
|
private readonly IBasicCommunication comms;
|
||||||
|
private readonly GenericCommunicationMonitor commsMonitor;
|
||||||
|
|
||||||
|
// comms gather for ASCII based API's
|
||||||
|
// TODO [ ] If not using an ASCII based API, delete the properties below
|
||||||
|
private readonly CommunicationGather commsGather;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Set this value to that of the delimiter used by the API (if applicable)
|
||||||
|
/// </summary>
|
||||||
|
private const string commsDelimiter = "\r";
|
||||||
|
|
||||||
|
// comms byte buffer for HEX/byte based API's
|
||||||
|
// TODO [ ] If not using an HEX/byte based API, delete the properties below
|
||||||
|
private readonly byte[] commsByteBuffer = { };
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Connects/disconnects the comms of the plugin device
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// triggers the comms.Connect/Disconnect as well as thee comms monitor start/stop
|
||||||
|
/// </remarks>
|
||||||
|
public bool Connect
|
||||||
|
{
|
||||||
|
get { return comms.IsConnected; }
|
||||||
|
set
|
||||||
|
{
|
||||||
|
if (value)
|
||||||
|
{
|
||||||
|
comms.Connect();
|
||||||
|
commsMonitor.Start();
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
comms.Disconnect();
|
||||||
|
commsMonitor.Stop();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Reports connect feedback through the bridge
|
||||||
|
/// </summary>
|
||||||
|
public BoolFeedback ConnectFeedback { get; private set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Reports online feedback through the bridge
|
||||||
|
/// </summary>
|
||||||
|
public BoolFeedback OnlineFeedback { get; private set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Reports socket status feedback through the bridge
|
||||||
|
/// </summary>
|
||||||
|
public IntFeedback StatusFeedback { get; private set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Plugin device constructor for devices that need IBasicCommunication
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="key"></param>
|
||||||
|
/// <param name="name"></param>
|
||||||
|
/// <param name="config"></param>
|
||||||
|
/// <param name="comms"></param>
|
||||||
|
public MakeModelDevice(string key, string name, MakeModelConfig config, IBasicCommunication comms)
|
||||||
|
: base(key, name)
|
||||||
|
{
|
||||||
|
this.LogInformation("Constructing new {0} instance", name);
|
||||||
|
|
||||||
|
// TODO [ ] Update the constructor as needed for the plugin device being developed
|
||||||
|
|
||||||
|
this.config = config;
|
||||||
|
|
||||||
|
receiveQueue = new GenericQueue(key + "-rxqueue"); // If you need to set the thread priority, use one of the available overloaded constructors.
|
||||||
|
|
||||||
|
ConnectFeedback = new BoolFeedback("connect", () => Connect);
|
||||||
|
OnlineFeedback = new BoolFeedback("online", () => commsMonitor.IsOnline);
|
||||||
|
StatusFeedback = new IntFeedback("status", () => (int)commsMonitor.Status);
|
||||||
|
|
||||||
|
this.comms = comms;
|
||||||
|
commsMonitor = new GenericCommunicationMonitor(this, this.comms, this.config.PollTimeMs, this.config.WarningTimeoutMs, this.config.ErrorTimeoutMs, Poll);
|
||||||
|
|
||||||
|
var socket = this.comms as ISocketStatus;
|
||||||
|
if (socket != null)
|
||||||
|
{
|
||||||
|
// device comms is IP **ELSE** device comms is RS232
|
||||||
|
socket.ConnectionChange += socket_ConnectionChange;
|
||||||
|
Connect = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
#region Communication data event handlers. Comment out any that don't apply to the API type
|
||||||
|
|
||||||
|
// Only one of the below handlers should be necessary.
|
||||||
|
|
||||||
|
// comms gather for any API that has a defined delimiter
|
||||||
|
// TODO [ ] If not using an ASCII based API, remove the line below
|
||||||
|
commsGather = new CommunicationGather(this.comms, commsDelimiter);
|
||||||
|
commsGather.LineReceived += Handle_LineRecieved;
|
||||||
|
|
||||||
|
// comms byte buffer for HEX/byte based API's with no delimiter
|
||||||
|
// TODO [ ] If not using an HEX/byte based API, remove the line below
|
||||||
|
this.comms.BytesReceived += Handle_BytesReceived;
|
||||||
|
|
||||||
|
// comms byte buffer for HEX/byte based API's with no delimiter
|
||||||
|
// TODO [ ] If not using an HEX/byte based API, remove the line below
|
||||||
|
this.comms.TextReceived += Handle_TextReceived;
|
||||||
|
|
||||||
|
#endregion
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args)
|
||||||
|
{
|
||||||
|
ConnectFeedback?.FireUpdate();
|
||||||
|
|
||||||
|
StatusFeedback?.FireUpdate();
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO [ ] If not using an API with a delimeter, delete the method below
|
||||||
|
private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args)
|
||||||
|
{
|
||||||
|
// TODO [ ] Implement method
|
||||||
|
|
||||||
|
// Enqueues the message to be processed in a dedicated thread, but the specified method
|
||||||
|
receiveQueue.Enqueue(new ProcessStringMessage(args.Text, ProcessFeedbackMessage));
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO [ ] If not using an HEX/byte based API with no delimeter, delete the method below
|
||||||
|
private void Handle_BytesReceived(object sender, GenericCommMethodReceiveBytesArgs args)
|
||||||
|
{
|
||||||
|
// TODO [ ] Implement method
|
||||||
|
throw new System.NotImplementedException();
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO [ ] If not using an ASCII based API with no delimeter, delete the method below
|
||||||
|
void Handle_TextReceived(object sender, GenericCommMethodReceiveTextArgs e)
|
||||||
|
{
|
||||||
|
// TODO [ ] Implement method
|
||||||
|
throw new System.NotImplementedException();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// This method should perform any necessary parsing of feedback messages from the device
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="message"></param>
|
||||||
|
void ProcessFeedbackMessage(string message)
|
||||||
|
{
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// TODO [ ] If not using an ACII based API, delete the properties below
|
||||||
|
/// <summary>
|
||||||
|
/// Sends text to the device plugin comms
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands
|
||||||
|
/// </remarks>
|
||||||
|
/// <param name="text">Command to be sent</param>
|
||||||
|
public void SendText(string text)
|
||||||
|
{
|
||||||
|
if (string.IsNullOrEmpty(text)) return;
|
||||||
|
|
||||||
|
comms.SendText(string.Format("{0}{1}", text, commsDelimiter));
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO [ ] If not using an HEX/byte based API, delete the properties below
|
||||||
|
/// <summary>
|
||||||
|
/// Sends bytes to the device plugin comms
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands
|
||||||
|
/// </remarks>
|
||||||
|
/// <param name="bytes">Bytes to be sent</param>
|
||||||
|
public void SendBytes(byte[] bytes)
|
||||||
|
{
|
||||||
|
if (bytes == null) return;
|
||||||
|
|
||||||
|
comms.SendBytes(bytes);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Polls the device
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// Poll method is used by the communication monitor. Update the poll method as needed for the plugin being developed
|
||||||
|
/// </remarks>
|
||||||
|
public void Poll()
|
||||||
|
{
|
||||||
|
// TODO [ ] Update Poll method as needed for the plugin being developed
|
||||||
|
// Example: SendText("getstatus");
|
||||||
|
throw new System.NotImplementedException();
|
||||||
|
}
|
||||||
|
|
||||||
|
#endregion
|
||||||
|
|
||||||
|
|
||||||
|
#region Overrides of EssentialsBridgeableDevice
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Links the plugin device to the EISC bridge
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="trilist"></param>
|
||||||
|
/// <param name="joinStart"></param>
|
||||||
|
/// <param name="joinMapKey"></param>
|
||||||
|
/// <param name="bridge"></param>
|
||||||
|
public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
|
||||||
|
{
|
||||||
|
var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart);
|
||||||
|
|
||||||
|
// This adds the join map to the collection on the bridge
|
||||||
|
bridge?.AddJoinMap(Key, joinMap);
|
||||||
|
|
||||||
|
var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
|
||||||
|
|
||||||
|
if (customJoins != null)
|
||||||
|
{
|
||||||
|
joinMap.SetCustomJoinData(customJoins);
|
||||||
|
}
|
||||||
|
|
||||||
|
this.LogDebug("Linking to Trilist {id}", trilist.ID.ToString("X"));
|
||||||
|
this.LogInformation("Linking to Bridge Type {type}", GetType().Name);
|
||||||
|
|
||||||
|
// TODO [ ] Implement bridge links as needed
|
||||||
|
|
||||||
|
// links to bridge
|
||||||
|
trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
|
||||||
|
|
||||||
|
trilist.SetBoolSigAction(joinMap.Connect.JoinNumber, sig => Connect = sig);
|
||||||
|
ConnectFeedback.LinkInputSig(trilist.BooleanInput[joinMap.Connect.JoinNumber]);
|
||||||
|
|
||||||
|
StatusFeedback.LinkInputSig(trilist.UShortInput[joinMap.Status.JoinNumber]);
|
||||||
|
OnlineFeedback.LinkInputSig(trilist.BooleanInput[joinMap.IsOnline.JoinNumber]);
|
||||||
|
|
||||||
|
UpdateFeedbacks();
|
||||||
|
|
||||||
|
trilist.OnlineStatusChange += (o, a) =>
|
||||||
|
{
|
||||||
|
if (!a.DeviceOnLine) return;
|
||||||
|
|
||||||
|
trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
|
||||||
|
UpdateFeedbacks();
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private void UpdateFeedbacks()
|
||||||
|
{
|
||||||
|
// TODO [ ] Update as needed for the plugin being developed
|
||||||
|
ConnectFeedback.FireUpdate();
|
||||||
|
OnlineFeedback.FireUpdate();
|
||||||
|
StatusFeedback.FireUpdate();
|
||||||
|
}
|
||||||
|
|
||||||
|
#endregion
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
85
src/MakeModelDeviceFactory.cs
Normal file
85
src/MakeModelDeviceFactory.cs
Normal file
@@ -0,0 +1,85 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using PepperDash.Core;
|
||||||
|
using PepperDash.Essentials.Core;
|
||||||
|
|
||||||
|
namespace PepperDash.Essentials.Plugin
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Plugin device factory for devices that use IBasicCommunication
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// Rename the class to match the device plugin being developed
|
||||||
|
/// </remarks>
|
||||||
|
/// <example>
|
||||||
|
/// "EssentialsPluginFactoryTemplate" renamed to "MyDeviceFactory"
|
||||||
|
/// </example>
|
||||||
|
public class MakeModelDeviceFactory : EssentialsPluginDeviceFactory<MakeModelDevice>
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Plugin device factory constructor
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin
|
||||||
|
/// </remarks>
|
||||||
|
/// <example>
|
||||||
|
/// Set the minimum Essentials Framework Version
|
||||||
|
/// <code>
|
||||||
|
/// MinimumEssentialsFrameworkVersion = "2.12.1;
|
||||||
|
/// </code>
|
||||||
|
/// In the constructor we initialize the list with the typenames that will build an instance of this device
|
||||||
|
/// <code>
|
||||||
|
/// TypeNames = new List<string>() { "SamsungMdc", "SamsungMdcDisplay" };
|
||||||
|
/// </code>
|
||||||
|
/// </example>
|
||||||
|
public MakeModelDeviceFactory()
|
||||||
|
{
|
||||||
|
// Set the minimum Essentials Framework Version
|
||||||
|
// TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against
|
||||||
|
MinimumEssentialsFrameworkVersion = "2.12.1";
|
||||||
|
|
||||||
|
// In the constructor we initialize the list with the typenames that will build an instance of this device
|
||||||
|
// TODO [ ] Update the TypeNames for the plugin being developed
|
||||||
|
TypeNames = new List<string>() { "examplePluginDevice" };
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Builds and returns an instance of EssentialsPluginDeviceTemplate
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="dc">device configuration</param>
|
||||||
|
/// <returns>plugin device or null</returns>
|
||||||
|
/// <remarks>
|
||||||
|
/// The example provided below takes the device key, name, properties config and the comms device created.
|
||||||
|
/// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device.
|
||||||
|
/// </remarks>
|
||||||
|
/// <seealso cref="PepperDash.Core.eControlMethod"/>
|
||||||
|
public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc)
|
||||||
|
{
|
||||||
|
Debug.LogVerbose("[{key}] Factory Attempting to create new device from type: {type}", dc.Key, dc.Type);
|
||||||
|
|
||||||
|
// get the plugin device properties configuration object & check for null
|
||||||
|
var propertiesConfig = dc.Properties.ToObject<MakeModelConfig>();
|
||||||
|
if (propertiesConfig == null)
|
||||||
|
{
|
||||||
|
Debug.LogError("[{key}] Factory: failed to read properties config for {name}", dc.Key, dc.Name);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// attempt build the plugin device comms device & check for null
|
||||||
|
// TODO { ] As of PepperDash Core 1.0.41, HTTP and HTTPS are not valid eControlMethods and will throw an exception.
|
||||||
|
var comms = CommFactory.CreateCommForDevice(dc);
|
||||||
|
if (comms == null)
|
||||||
|
{
|
||||||
|
Debug.LogError("[{key}] Factory Notice: No control object present for device {name}", dc.Key, dc.Name);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
return new MakeModelDevice(dc.Key, dc.Name, propertiesConfig, comms);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
@@ -1,25 +1,26 @@
|
|||||||
using Crestron.SimplSharpPro.DeviceSupport;
|
using Crestron.SimplSharpPro.DeviceSupport;
|
||||||
using PepperDash.Core;
|
using PepperDash.Core;
|
||||||
|
using PepperDash.Core.Logging;
|
||||||
using PepperDash.Essentials.Core;
|
using PepperDash.Essentials.Core;
|
||||||
using PepperDash.Essentials.Core.Bridges;
|
using PepperDash.Essentials.Core.Bridges;
|
||||||
|
|
||||||
namespace EssentialsPluginTemplate
|
namespace PepperDash.Essentials.Plugin
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Plugin device template for logic devices that don't communicate outside the program
|
/// Plugin device template for logic devices that don't communicate outside the program
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <remarks>
|
/// <remarks>
|
||||||
/// Rename the class to match the device plugin being developed.
|
/// Rename the class to match the device plugin being developed.
|
||||||
/// </remarks>
|
/// </remarks>
|
||||||
/// <example>
|
/// <example>
|
||||||
/// "EssentialsPluginTemplateLogicDevice" renamed to "SamsungMdcDevice"
|
/// "EssentialsPluginTemplateLogicDevice" renamed to "SamsungMdcDevice"
|
||||||
/// </example>
|
/// </example>
|
||||||
public class EssentialsPluginTemplateLogicDevice : EssentialsBridgeableDevice
|
public class MakeModelLogicDevice : EssentialsBridgeableDevice
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// It is often desirable to store the config
|
/// It is often desirable to store the config
|
||||||
/// </summary>
|
/// </summary>
|
||||||
private EssentialsPluginTemplateConfigObject _config;
|
private readonly MakeModelConfig config;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Plugin device constructor
|
/// Plugin device constructor
|
||||||
@@ -27,14 +28,14 @@ namespace EssentialsPluginTemplate
|
|||||||
/// <param name="key"></param>
|
/// <param name="key"></param>
|
||||||
/// <param name="name"></param>
|
/// <param name="name"></param>
|
||||||
/// <param name="config"></param>
|
/// <param name="config"></param>
|
||||||
public EssentialsPluginTemplateLogicDevice(string key, string name, EssentialsPluginTemplateConfigObject config)
|
public MakeModelLogicDevice(string key, string name, MakeModelConfig config)
|
||||||
: base(key, name)
|
: base(key, name)
|
||||||
{
|
{
|
||||||
Debug.Console(0, this, "Constructing new {0} instance", name);
|
this.LogInformation("Constructing new {0} instance", name);
|
||||||
|
|
||||||
// TODO [ ] Update the constructor as needed for the plugin device being developed
|
// TODO [ ] Update the constructor as needed for the plugin device being developed
|
||||||
|
|
||||||
_config = config;
|
this.config = config;
|
||||||
}
|
}
|
||||||
|
|
||||||
#region Overrides of EssentialsBridgeableDevice
|
#region Overrides of EssentialsBridgeableDevice
|
||||||
@@ -51,10 +52,7 @@ namespace EssentialsPluginTemplate
|
|||||||
var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart);
|
var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart);
|
||||||
|
|
||||||
// This adds the join map to the collection on the bridge
|
// This adds the join map to the collection on the bridge
|
||||||
if (bridge != null)
|
bridge?.AddJoinMap(Key, joinMap);
|
||||||
{
|
|
||||||
bridge.AddJoinMap(Key, joinMap);
|
|
||||||
}
|
|
||||||
|
|
||||||
var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
|
var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
|
||||||
|
|
||||||
@@ -63,8 +61,8 @@ namespace EssentialsPluginTemplate
|
|||||||
joinMap.SetCustomJoinData(customJoins);
|
joinMap.SetCustomJoinData(customJoins);
|
||||||
}
|
}
|
||||||
|
|
||||||
Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X"));
|
this.LogDebug("Linking to Trilist {id}", trilist.ID.ToString("X"));
|
||||||
Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name);
|
this.LogInformation("Linking to Bridge Type {type}", GetType().Name);
|
||||||
|
|
||||||
// TODO [ ] Implement bridge links as needed
|
// TODO [ ] Implement bridge links as needed
|
||||||
|
|
||||||
83
src/MakeModelLogicDeviceFactory.cs
Normal file
83
src/MakeModelLogicDeviceFactory.cs
Normal file
@@ -0,0 +1,83 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using PepperDash.Core;
|
||||||
|
using PepperDash.Essentials.Core;
|
||||||
|
|
||||||
|
namespace PepperDash.Essentials.Plugin
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Plugin device factory for logic devices that don't communicate
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// Rename the class to match the device plugin being developed
|
||||||
|
/// </remarks>
|
||||||
|
/// <example>
|
||||||
|
/// "EssentialsPluginFactoryTemplate" renamed to "MyLogicDeviceFactory"
|
||||||
|
/// </example>
|
||||||
|
public class MakeModelLogicDeviceFactory : EssentialsPluginDeviceFactory<MakeModelLogicDevice>
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Plugin device factory constructor
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin
|
||||||
|
/// </remarks>
|
||||||
|
/// <example>
|
||||||
|
/// Set the minimum Essentials Framework Version
|
||||||
|
/// <code>
|
||||||
|
/// MinimumEssentialsFrameworkVersion = "1.6.4;
|
||||||
|
/// </code>
|
||||||
|
/// In the constructor we initialize the list with the typenames that will build an instance of this device
|
||||||
|
/// <code>
|
||||||
|
/// TypeNames = new List<string>() { "SamsungMdc", "SamsungMdcDisplay" };
|
||||||
|
/// </code>
|
||||||
|
/// </example>
|
||||||
|
public MakeModelLogicDeviceFactory()
|
||||||
|
{
|
||||||
|
// Set the minimum Essentials Framework Version
|
||||||
|
// TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against
|
||||||
|
MinimumEssentialsFrameworkVersion = "2.12.1";
|
||||||
|
|
||||||
|
// In the constructor we initialize the list with the typenames that will build an instance of this device
|
||||||
|
// TODO [ ] Update the TypeNames for the plugin being developed
|
||||||
|
TypeNames = new List<string>() { "examplePluginLogicDevice" };
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Builds and returns an instance of EssentialsPluginTemplateLogicDevice
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="dc">device configuration</param>
|
||||||
|
/// <returns>plugin device or null</returns>
|
||||||
|
/// <remarks>
|
||||||
|
/// The example provided below takes the device key, name, properties config and the comms device created.
|
||||||
|
/// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device.
|
||||||
|
/// </remarks>
|
||||||
|
/// <seealso cref="PepperDash.Core.eControlMethod"/>
|
||||||
|
public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc)
|
||||||
|
{
|
||||||
|
|
||||||
|
Debug.LogDebug("[{key}] Factory Attempting to create new device from type: {type}", dc.Key, dc.Type);
|
||||||
|
|
||||||
|
// get the plugin device properties configuration object & check for null
|
||||||
|
var propertiesConfig = dc.Properties.ToObject<MakeModelConfig>();
|
||||||
|
if (propertiesConfig == null)
|
||||||
|
{
|
||||||
|
Debug.LogError("[{key}] Factory: failed to read properties config for {name}", dc.Key, dc.Name);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
var controlConfig = CommFactory.GetControlPropertiesConfig(dc);
|
||||||
|
|
||||||
|
if (controlConfig == null)
|
||||||
|
{
|
||||||
|
return new MakeModelLogicDevice(dc.Key, dc.Name, propertiesConfig);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
Debug.LogError("[{key}] Factory: Unable to get control properties from device config for {name}", dc.Key, dc.Name);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
|
|
||||||
Microsoft Visual Studio Solution File, Format Version 10.00
|
|
||||||
# Visual Studio 2008
|
|
||||||
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PDT.EssentialsPluginTemplate.EPI", "PDT.EssentialsPluginTemplate.EPI.csproj", "{9D249E47-8F95-4437-A6BB-563510287AD1}"
|
|
||||||
EndProject
|
|
||||||
Global
|
|
||||||
GlobalSection(SolutionConfigurationPlatforms) = preSolution
|
|
||||||
Debug|Any CPU = Debug|Any CPU
|
|
||||||
Release|Any CPU = Release|Any CPU
|
|
||||||
EndGlobalSection
|
|
||||||
GlobalSection(ProjectConfigurationPlatforms) = postSolution
|
|
||||||
{9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
|
||||||
{9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
|
||||||
{9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
|
||||||
{9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.Build.0 = Release|Any CPU
|
|
||||||
EndGlobalSection
|
|
||||||
GlobalSection(SolutionProperties) = preSolution
|
|
||||||
HideSolutionNode = FALSE
|
|
||||||
EndGlobalSection
|
|
||||||
EndGlobal
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<package >
|
|
||||||
<metadata>
|
|
||||||
<id>PDT.EssentialsPluginTemplate</id>
|
|
||||||
<readme>docs\README.md</readme>
|
|
||||||
<version>2.0.2</version>
|
|
||||||
<title>Essentials Plugin Template</title>
|
|
||||||
<authors>PepperDash Technologies</authors>
|
|
||||||
<owners>pepperdash</owners>
|
|
||||||
<requireLicenseAcceptance>false</requireLicenseAcceptance>
|
|
||||||
<license type="expression">MIT</license>
|
|
||||||
<projectUrl>https://github.com/PepperDash/EssentialsPluginTemplate</projectUrl>
|
|
||||||
<copyright>Copyright 2022</copyright>
|
|
||||||
<description>This software iserves as a template for generating new Essentials-Compliant plugins</description>
|
|
||||||
<tags>crestron 3series 4series essentials pepperdash pepperdashessentials epi essentials plugin</tags>
|
|
||||||
<repository type="git" url="https://github.com/PepperDash/EssentialsPluginTemplate"/>
|
|
||||||
</metadata>
|
|
||||||
<files>
|
|
||||||
<file src="**" target="lib\net35"/>
|
|
||||||
<file src="**" target="lib\net47"/>
|
|
||||||
<file src="README.md" target="docs\"/>
|
|
||||||
</files>
|
|
||||||
</package>
|
|
||||||
@@ -1,115 +1,115 @@
|
|||||||
<Project ToolsVersion="3.5" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
<Project ToolsVersion="3.5" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<Configuration Condition=" '$(Configuration)' == '' ">Release</Configuration>
|
<Configuration Condition=" '$(Configuration)' == '' ">Release</Configuration>
|
||||||
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
|
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
|
||||||
<ProductVersion>9.0.30729</ProductVersion>
|
<ProductVersion>9.0.30729</ProductVersion>
|
||||||
<SchemaVersion>2.0</SchemaVersion>
|
<SchemaVersion>2.0</SchemaVersion>
|
||||||
<ProjectGuid>{9D249E47-8F95-4437-A6BB-563510287AD1}</ProjectGuid>
|
<ProjectGuid>{9D249E47-8F95-4437-A6BB-563510287AD1}</ProjectGuid>
|
||||||
<OutputType>Library</OutputType>
|
<OutputType>Library</OutputType>
|
||||||
<AppDesignerFolder>Properties</AppDesignerFolder>
|
<AppDesignerFolder>Properties</AppDesignerFolder>
|
||||||
<RootNamespace>PDT.EssentialsPluginTemplate.EPI</RootNamespace>
|
<RootNamespace>PepperDash.Essentials.Plugin</RootNamespace>
|
||||||
<AssemblyName>PDT.EssentialsPluginTemplate.EPI</AssemblyName>
|
<AssemblyName>MakeModelPlugin</AssemblyName>
|
||||||
<ProjectTypeGuids>{0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids>
|
<ProjectTypeGuids>{0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids>
|
||||||
<PlatformFamilyName>WindowsCE</PlatformFamilyName>
|
<PlatformFamilyName>WindowsCE</PlatformFamilyName>
|
||||||
<PlatformID>E2BECB1F-8C8C-41ba-B736-9BE7D946A398</PlatformID>
|
<PlatformID>E2BECB1F-8C8C-41ba-B736-9BE7D946A398</PlatformID>
|
||||||
<OSVersion>5.0</OSVersion>
|
<OSVersion>5.0</OSVersion>
|
||||||
<DeployDirSuffix>SmartDeviceProject1</DeployDirSuffix>
|
<DeployDirSuffix>SmartDeviceProject1</DeployDirSuffix>
|
||||||
<TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
|
<TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
|
||||||
<NativePlatformName>Windows CE</NativePlatformName>
|
<NativePlatformName>Windows CE</NativePlatformName>
|
||||||
<FormFactorID>
|
<FormFactorID>
|
||||||
</FormFactorID>
|
</FormFactorID>
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
|
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
|
||||||
<AllowedReferenceRelatedFileExtensions>.allowedReferenceRelatedFileExtensions</AllowedReferenceRelatedFileExtensions>
|
<AllowedReferenceRelatedFileExtensions>.allowedReferenceRelatedFileExtensions</AllowedReferenceRelatedFileExtensions>
|
||||||
<DebugSymbols>true</DebugSymbols>
|
<DebugSymbols>true</DebugSymbols>
|
||||||
<DebugType>full</DebugType>
|
<DebugType>full</DebugType>
|
||||||
<Optimize>false</Optimize>
|
<Optimize>false</Optimize>
|
||||||
<OutputPath>bin\Debug\</OutputPath>
|
<OutputPath>bin\Debug\</OutputPath>
|
||||||
<DefineConstants>DEBUG;TRACE;</DefineConstants>
|
<DefineConstants>DEBUG;TRACE;</DefineConstants>
|
||||||
<ErrorReport>prompt</ErrorReport>
|
<ErrorReport>prompt</ErrorReport>
|
||||||
<WarningLevel>4</WarningLevel>
|
<WarningLevel>4</WarningLevel>
|
||||||
<FileAlignment>512</FileAlignment>
|
<FileAlignment>512</FileAlignment>
|
||||||
<NoStdLib>true</NoStdLib>
|
<NoStdLib>true</NoStdLib>
|
||||||
<NoConfig>true</NoConfig>
|
<NoConfig>true</NoConfig>
|
||||||
<GenerateSerializationAssemblies>off</GenerateSerializationAssemblies>
|
<GenerateSerializationAssemblies>off</GenerateSerializationAssemblies>
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
|
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
|
||||||
<AllowedReferenceRelatedFileExtensions>.allowedReferenceRelatedFileExtensions</AllowedReferenceRelatedFileExtensions>
|
<AllowedReferenceRelatedFileExtensions>.allowedReferenceRelatedFileExtensions</AllowedReferenceRelatedFileExtensions>
|
||||||
<DebugType>none</DebugType>
|
<DebugType>none</DebugType>
|
||||||
<Optimize>true</Optimize>
|
<Optimize>true</Optimize>
|
||||||
<OutputPath>bin\Release\</OutputPath>
|
<OutputPath>bin\Release\</OutputPath>
|
||||||
<ErrorReport>prompt</ErrorReport>
|
<ErrorReport>prompt</ErrorReport>
|
||||||
<WarningLevel>4</WarningLevel>
|
<WarningLevel>4</WarningLevel>
|
||||||
<FileAlignment>512</FileAlignment>
|
<FileAlignment>512</FileAlignment>
|
||||||
<NoStdLib>true</NoStdLib>
|
<NoStdLib>true</NoStdLib>
|
||||||
<NoConfig>true</NoConfig>
|
<NoConfig>true</NoConfig>
|
||||||
<GenerateSerializationAssemblies>off</GenerateSerializationAssemblies>
|
<GenerateSerializationAssemblies>off</GenerateSerializationAssemblies>
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<Reference Include="Crestron.SimplSharpPro.UI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
|
<Reference Include="Crestron.SimplSharpPro.UI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
|
||||||
<SpecificVersion>False</SpecificVersion>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
<HintPath>..\..\..\..\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll</HintPath>
|
<HintPath>C:\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll</HintPath>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="Essentials Devices Common, Version=1.6.2.33892, Culture=neutral, processorArchitecture=MSIL">
|
<Reference Include="Essentials Devices Common, Version=1.6.2.33892, Culture=neutral, processorArchitecture=MSIL">
|
||||||
<SpecificVersion>False</SpecificVersion>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
<HintPath>..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll</HintPath>
|
<HintPath>..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll</HintPath>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="mscorlib" />
|
<Reference Include="mscorlib" />
|
||||||
<Reference Include="PepperDashEssentials, Version=1.4.19.29953, Culture=neutral, processorArchitecture=MSIL">
|
<Reference Include="PepperDashEssentials, Version=1.4.19.29953, Culture=neutral, processorArchitecture=MSIL">
|
||||||
<SpecificVersion>False</SpecificVersion>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
<HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDashEssentials.dll</HintPath>
|
<HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDashEssentials.dll</HintPath>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="PepperDash_Core, Version=1.0.20.28344, Culture=neutral, processorArchitecture=MSIL">
|
<Reference Include="PepperDash_Core, Version=1.0.20.28344, Culture=neutral, processorArchitecture=MSIL">
|
||||||
<SpecificVersion>False</SpecificVersion>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
<HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDash_Core.dll</HintPath>
|
<HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDash_Core.dll</HintPath>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="PepperDash_Essentials_Core, Version=1.4.19.29946, Culture=neutral, processorArchitecture=MSIL">
|
<Reference Include="PepperDash_Essentials_Core, Version=1.4.19.29946, Culture=neutral, processorArchitecture=MSIL">
|
||||||
<SpecificVersion>False</SpecificVersion>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
<HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_Core.dll</HintPath>
|
<HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_Core.dll</HintPath>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="PepperDash_Essentials_DM, Version=1.3.7177.29951, Culture=neutral, processorArchitecture=MSIL">
|
<Reference Include="PepperDash_Essentials_DM, Version=1.3.7177.29951, Culture=neutral, processorArchitecture=MSIL">
|
||||||
<SpecificVersion>False</SpecificVersion>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
<HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_DM.dll</HintPath>
|
<HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_DM.dll</HintPath>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="SimplSharpCustomAttributesInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
|
<Reference Include="SimplSharpCustomAttributesInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
|
||||||
<SpecificVersion>False</SpecificVersion>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
<HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath>
|
<HintPath>C:\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath>
|
||||||
<Private>False</Private>
|
<Private>False</Private>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="SimplSharpHelperInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
|
<Reference Include="SimplSharpHelperInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
|
||||||
<SpecificVersion>False</SpecificVersion>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
<HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath>
|
<HintPath>C:\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath>
|
||||||
<Private>False</Private>
|
<Private>False</Private>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="SimplSharpNewtonsoft, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
|
<Reference Include="SimplSharpNewtonsoft, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
|
||||||
<SpecificVersion>False</SpecificVersion>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
<HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll</HintPath>
|
<HintPath>C:\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll</HintPath>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="SimplSharpPro, Version=1.5.3.17, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
|
<Reference Include="SimplSharpPro, Version=1.5.3.17, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
|
||||||
<SpecificVersion>False</SpecificVersion>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
<HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath>
|
<HintPath>C:\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath>
|
||||||
<Private>False</Private>
|
<Private>False</Private>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="SimplSharpReflectionInterface, Version=1.0.5583.25238, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
|
<Reference Include="SimplSharpReflectionInterface, Version=1.0.5583.25238, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
|
||||||
<SpecificVersion>False</SpecificVersion>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
<HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll</HintPath>
|
<HintPath>C:\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll</HintPath>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="System" />
|
<Reference Include="System" />
|
||||||
<Reference Include="System.Core" />
|
<Reference Include="System.Core" />
|
||||||
<Reference Include="System.Data" />
|
<Reference Include="System.Data" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<Compile Include="EssentialsPluginTemplateLogicDevice.cs" />
|
<Compile Include="MakeModelCrestronDevice.cs" />
|
||||||
<Compile Include="EssentialsPluginTemplateCrestronDevice.cs" />
|
<Compile Include="MakeModelBridgeJoinMap.cs" />
|
||||||
<Compile Include="EssentialsPluginTemplateBridgeJoinMap.cs" />
|
<Compile Include="MakeModelConfigObject.cs" />
|
||||||
<Compile Include="EssentialsPluginTemplateConfigObject.cs" />
|
<Compile Include="MakeModelDevice.cs" />
|
||||||
<Compile Include="EssentialsPluginTemplateFactory.cs" />
|
<Compile Include="MakeModelFactory.cs" />
|
||||||
<Compile Include="Properties\AssemblyInfo.cs" />
|
<Compile Include="MakeModelLogicDevice.cs" />
|
||||||
<Compile Include="EssentialsPluginTemplateDevice.cs" />
|
<Compile Include="Properties\AssemblyInfo.cs" />
|
||||||
<None Include="Properties\ControlSystem.cfg" />
|
<None Include="Properties\ControlSystem.cfg" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
<Import Project="$(MSBuildBinPath)\Microsoft.CompactFramework.CSharp.targets" />
|
<Import Project="$(MSBuildBinPath)\Microsoft.CompactFramework.CSharp.targets" />
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<PostBuildEvent>rem S# Pro preparation will execute after these operations</PostBuildEvent>
|
<PostBuildEvent>rem S# Pro preparation will execute after these operations</PostBuildEvent>
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
</Project>
|
</Project>
|
||||||
50
src/epi-make-model.4Series.csproj
Normal file
50
src/epi-make-model.4Series.csproj
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
|
<PropertyGroup>
|
||||||
|
<ProjectType>ProgramLibrary</ProjectType>
|
||||||
|
</PropertyGroup>
|
||||||
|
<PropertyGroup>
|
||||||
|
<TargetFramework>net472</TargetFramework>
|
||||||
|
<RootNamespace>PepperDash.Essentials.Plugin</RootNamespace>
|
||||||
|
<Deterministic>false</Deterministic>
|
||||||
|
<AssemblyTitle>PepperDash.Essentials.Plugin.Make.Model</AssemblyTitle>
|
||||||
|
<Company>PepperDash Technology</Company>
|
||||||
|
<Description>This software is a template for a PepperDash Essentials Plugin.</Description>
|
||||||
|
<Copyright>Copyright 2025</Copyright>
|
||||||
|
<Version>1.0.0-local</Version>
|
||||||
|
<GenerateAssemblyInfo>true</GenerateAssemblyInfo>
|
||||||
|
<InformationalVersion>$(Version)</InformationalVersion>
|
||||||
|
<OutputPath>bin\$(Configuration)\</OutputPath>
|
||||||
|
<Authors>PepperDash Technology</Authors>
|
||||||
|
<PackageId>Pepperdash.Essentials.Plugins.Template</PackageId>
|
||||||
|
<PackageProjectUrl>https://github.com/PepperDash/EssentialsPluginTemplate.git</PackageProjectUrl>
|
||||||
|
<PackageTags>crestron 4series essentials plugin template</PackageTags>
|
||||||
|
</PropertyGroup>
|
||||||
|
|
||||||
|
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
|
||||||
|
<DefineConstants>$(DefineConstants);SERIES4</DefineConstants>
|
||||||
|
</PropertyGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<Compile Remove="Properties\**" />
|
||||||
|
<EmbeddedResource Remove="Properties\**" />
|
||||||
|
<None Remove="Properties\**" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<None Remove="epi-make-model.projectinfo" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<PackageReference Include="PepperDashEssentials" Version="2.12.1" >
|
||||||
|
<ExcludeAssets>runtime</ExcludeAssets>
|
||||||
|
</PackageReference>
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<None Remove="../output\epi-make-model.4Series.1.0.0-local.cplz" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<None Remove="../output\epi-make-model.4Series.1.0.0-local.cplz" />
|
||||||
|
</ItemGroup>
|
||||||
|
</Project>
|
||||||
Reference in New Issue
Block a user