Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 1.49 KB

README.md

File metadata and controls

28 lines (23 loc) · 1.49 KB
Raw

Open Commissioning Assistant SDK

The official SDK for creating Open Commissioning Assistant plugins.

NuGet Status

Quick Getting Started:

  1. Create a Class Library project with target framework .NET8 or .NET Framework 4.8.1
  2. Add the OC.Assistant.Sdk package via nuget
  3. Create a public class and inherit the OC.Assistant.Sdk.PluginBase
  4. Create a xml file with file extension *.plugin and let it copy to the output directory:
<?xml version="1.0" encoding="utf-8"?>
<Plugin>
    <!-- The name of the compiled dll file. -->
    <AssemblyFile>YourAssemblyName.dll</AssemblyFile>
    <!-- Optional directory to search dlls at runtime. Can be added multiple times. -->
    <AdditionalDirectory>path\to\directory1</AdditionalDirectory>
    <AdditionalDirectory>path\to\directory2</AdditionalDirectory>
</Plugin>

To run your plugin, simply place your *.dll and *.plugin files in the directory or a subdirectory of the OC.Assistant.exe

Further details how to use Attributes, Properties and Methods can be found within the SDK.
You can also learn how to build your own plugin by reviewing existing ones on our Open Commissioning GitHub page.
Also check out our YouTube channel for upcoming tutorials.