homebridge-multiple-switch 1.1.3 → 1.1.4

package/README.md

@@ -1,17 +1,70 @@
-# Homebridge Multiple Switch Plugin
-
-## Overview
-The **Homebridge Multiple Switch** plugin allows you to create and manage multiple virtual switches within the HomeKit environment. This plugin is ideal for users who want to control multiple devices or scenarios using a single accessory with multiple switch options.
-
-## Features
-- **Multiple Switches**: Add, manage, and control multiple virtual switches under one accessory in HomeKit.
-- **Master Switch**: Optionally add a master switch that controls all other switches simultaneously.
-- **Customizable**: Easily configure the number of switches and their names through the Homebridge UI.
-- **Flexible**: Supports dynamic addition of switches, allowing for easy scaling to your needs.
-
-## Installation
-1. Ensure you have [Homebridge](https://homebridge.io) installed and running.
-2. Install the plugin via Homebridge or npm:
-   ```bash
-   npm install -g homebridge-multiple-switch
-3. Configure the plugin through the Homebridge UI or manually edit your config.json.
+# homebridge-multiple-switch
+
+[![npm](https://img.shields.io/npm/v/homebridge-multiple-switch)](https://www.npmjs.com/package/homebridge-multiple-switch)
+[![GitHub issues](https://img.shields.io/github/issues/azadaydinli/homebridge-multiple-switch)](https://github.com/azadaydinli/homebridge-multiple-switch/issues)
+[![GitHub license](https://img.shields.io/github/license/azadaydinli/homebridge-multiple-switch)](https://github.com/azadaydinli/homebridge-multiple-switch/blob/master/LICENSE)
+
+A lightweight Homebridge plugin that lets you create multiple customizable dummy switches (Outlet/Fan/Light/Switch) with different behavior modes including Independent, Master, and Single-Switch Mode.
+
+---
+
+## ✨ Features
+
+- Multiple switches in a single accessory
+- Each switch can be `switch`, `outlet`, `lightbulb`, or `fan`
+- **Independent Mode** – all switches work separately
+- **Master Mode** – adds a master switch that controls all other switches
+- **Single Mode** – only one switch can be on at any time
+- Auto turn-off (in milliseconds)
+- Works seamlessly with HomeKit and Siri
+
+---
+
+## 📦 Installation
+
+Install the plugin via the Homebridge UI:
+
+1. Go to **Plugins**
+2. Search for `homebridge-multiple-switch`
+3. Click **Install**
+
+Or use the command line:
+
+```bash
+npm install -g homebridge-multiple-switch
+```
+
+---
+
+## ⚙️ Configuration
+
+You can configure the plugin directly via the Homebridge UI, or manually in config.json:
+
+```bash
+{
+  "accessory": "MultipleSwitchAccessory",
+  "name": "My Multi Switch",
+  "switchCount": 3,
+  "type": "outlet",
+  "mode": "independent",
+  "autoTurnOff": 1000,
+  "defaultState": false,
+  "states": [
+    { "type": "switch", "autoTurnOff": 3000 },
+    { "type": "fan" },
+    { "type": "lightbulb", "defaultState": true }
+  ]
+}
+```
+
+### 🔧 Configuration Options
+
+| Field         | Type    | Required | Description                                                                 |
+|---------------|---------|----------|-----------------------------------------------------------------------------|
+| `name`        | string  | ✅       | Name of the accessory                                                       |
+| `switchCount` | number  | ✅       | Number of switches to create (max depends on HomeKit limits)               |
+| `type`        | string  | ❌       | Default type: `switch`, `outlet`, `lightbulb`, or `fan`                    |
+| `mode`        | string  | ❌       | `independent`, `master`, or `single`                                       |
+| `autoTurnOff` | number  | ❌       | Global auto-off in milliseconds                                            |
+| `defaultState`| boolean | ❌       | Default on/off state on restart                                            |
+| `states`      | array   | ❌       | Per-switch custom settings (overrides global config)                       |

package/package.json

@@ -1,12 +1,25 @@
 {
   "name": "homebridge-multiple-switch",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Multiple switch accessory for Homebridge",
+  "homepage": "https://github.com/azadaydinli/homebridge-multiple-switch",
   "main": "index.js",
   "author": "Azad Aydınlı",
   "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/azadaydinli/homebridge-multiple-switch/issues"
+  },
   "keywords": [
-    "homebridge-plugin"
+    "homebridge-plugin",
+    "homebridge",
+    "homekit",
+    "switch",
+    "outlet",
+    "lightbulb",
+    "fan",
+    "dummy",
+    "multiple",
+    "accessory"
   ],
   "repository": {
     "type": "git",