This repository serves as a template for creating Python plugins for Domoticz. It includes a basic structure, sample code, and placeholders to kickstart your plugin development.
-
Use This Template
Click the green "Use this template" button on the top-right of this page to create your own repository.
-
Customize Your Plugin
- Update
plugin.pywith your plugin logic. - Modify the
<plugin>XML block with your plugin's metadata. - Add any custom assets (e.g., icons) in the
config/folder.
- Update
-
Test Your Plugin
- Copy the plugin to your Domoticz
pluginsfolder and restart Domoticz.
- Copy the plugin to your Domoticz
Use the following template for documenting your plugin:
# π οΈ [Plugin Name]
[Short description of the plugin, e.g., "This plugin integrates Domoticz with [service/device]."]
---
## β¨ Features
- [Feature 1, e.g., "Monitor and control [device] from Domoticz."]
- [Feature 2, e.g., "Supports advanced debugging and detailed logging."]
- [Feature 3, e.g., "Custom icons for a polished interface."]
---
## π₯ Installation
1. **Clone or download this repository**:
git clone https://github.com/your-username/[plugin-repo].git
2. **Copy the plugin to your Domoticz plugins folder**:
cp -R [plugin-repo] /path/to/domoticz/plugins/
3. **Restart Domoticz** to load the new plugin:
sudo service domoticz.sh restart