Skip to main content

Plugins installation

Let's look how to install plugins on example of SmartHomeApi.Plugins.VirtualState plugin.

Manual installation​

  1. Create SmartHomeApi.Plugins.VirtualState directory inside Plugins one which was created by SmartHomeApi during installation.
  2. Download latest plugin from Releases and extract its files into SmartHomeApi.Plugins.VirtualState directory.
  3. That's done. Some plugins will start to work automatically after putting them to appropriate directory but the most plugins require own config files (as VirtualState plugin). Create config file with any name (for example VirtualStates.json) in Configs directory which also was created during installation. Put next text inside VirtualStates.json:
{
    "ItemId": "MyVirtualStates",
    "ItemType": "Virtual_States"
}
  1. If you request now SmartHomeApi state you should see created item.

Installation via plugins manager​

It's in TODO list and will be implemented soon.