Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Plugins and their components are contained in a standard zip file. The zip file may be created on any Windows system. The root of the zip file should contain your plugin EXE file and any dependent DLL files and HTML files. Your zip file should be named using the following format:

pluginID_version.zip

For example, the sample plugin zip file for version 1.0.0.0 of the plugin would be named:

HomeSeerSamplePlugin_1-0-0-0.zip

On the target system, the files need to be copied to specific folders, this is accomplished with the file named install.txt. This file instructs HomeSeer on where to copy the included files. Here is the sample plugin install.txt file:

...

It is recommended that you name the folder in the bin folder with your plugin ID in order to avoid conflicts with other plugins.

Note

Make sure you note the case of the files and paths in the install.txt file. While Windows does not care about the case, Linux does, and your plugin will fail to install or not run properly if the case in the install.txt file does not match the actual case of the file.


In order for your plugin to find your dependent DLL files, make sure you have this path entered in your plugin.exe.config file. For example, using the DLL above, the sample plugin config file would be named "HSPI_HomeSeerSamplePlugin.exe.config" and the contents would be:

...