mirror of
https://github.com/dtwardow/homebridge-multi-tap-switch.git
synced 2026-11-02 05:18:30 +00:00
Updated README.md
This commit is contained in:
dennis committed
1 parent
1a4cef059a
commit
6b4645556a
1 file changed
+45
-146
@@ -1,169 +1,68 @@
|
|||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
|
<img src="https://github.com/homebridge/branding/raw/master/logos/homebridge-wordmark-logo-vertical.png" width="150" alt="Homebridge">
|
||||||
<img src="https://github.com/homebridge/branding/raw/master/logos/homebridge-wordmark-logo-vertical.png" width="150">
|
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
# Homebridge Multi-Tap-Switch
|
||||||
|
|
||||||
# Homebridge Platform Plugin Template
|
This plugin provides a switch, which can be triggered multiple times to trigger different actions.
|
||||||
|
|
||||||
This is a template Homebridge platform plugin and can be used as a base to help you get started developing your own plugin.
|
Actions could be everything, which can be configured within **Automations**.
|
||||||
|
|
||||||
This template should be used in conjunction with the [developer documentation](https://developers.homebridge.io/). A full list of all supported service types, and their characteristics is available on this site.
|
## How it works?
|
||||||
|
|
||||||
## Clone As Template
|
The plugin provides a virtual **switch** which can be triggered manually (which doesn't really make sense) or
|
||||||
|
by **Automations**. A configurable set of **programmable** switches will than be used to
|
||||||
|
trigger scenes and/or devices (like for i.e. motion or contact sensors).
|
||||||
|
|
||||||
Click the link below to create a new GitHub Repository using this template, or click the *Use This Template* button above.
|
Each time the switch is triggered ```ON``` - what can be done multiple times without reset - the **stateless** switches
|
||||||
|
are triggered one after the other.
|
||||||
|
The switch is reset after a configurable timeout to start from the first **programmable** switch again.
|
||||||
|
|
||||||
<span align="center">
|
## Installation
|
||||||
|
|
||||||
### [Create New Repository From Template](https://github.com/homebridge/homebridge-plugin-template/generate)
|
Either install this plugin through [Homebridge Config UI X](https://github.com/oznu/homebridge-config-ui-x)
|
||||||
|
or manually by following these instructions:
|
||||||
|
|
||||||
</span>
|
1. Install Homebridge (follow [the instructions](https://github.com/homebridge/homebridge/wiki)).
|
||||||
|
2. Install this plugin by running `npm install -g homebridge-multitap-switch`.
|
||||||
|
3. Add this plugin to the Homebridge `config.json` (as described in the next section)
|
||||||
|
|
||||||
## Setup Development Environment
|
## Configuration
|
||||||
|
|
||||||
To develop Homebridge plugins you must have Node.js 12 or later installed, and a modern code editor such as [VS Code](https://code.visualstudio.com/). This plugin template uses [TypeScript](https://www.typescriptlang.org/) to make development easier and comes with pre-configured settings for [VS Code](https://code.visualstudio.com/) and ESLint. If you are using VS Code install these extensions:
|
The configuration allows the user to add multiple **Multi-Tap-Switches**. The following parameters are available:
|
||||||
|
|
||||||
* [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
| Option | Default Value | Characteristic (runtime configuration) | Description |
|
||||||
|
|------------------------------------|----------------|----------------------------------------|-------------------------------------------------------------------------------------------|
|
||||||
|
| `name` | MultiTapSwitch | | Name of the Platform Accessory (primarily shown in logs) |
|
||||||
|
| `devices[]` | | | Array of configured devices |
|
||||||
|
| `devices[].name` | | | Name of the switch |
|
||||||
|
| `devices[].numberConfiguredScenes` | 5 | `Configured Scenes` | Number of **stateless** switches (cannot be changed during runtime) |
|
||||||
|
| `devices[].triggerTimeout` | 10 | `Trigger Timeout` | Seconds, after which the switch is reset (starting from the first **programmable** switch |
|
||||||
|
| `devices[].resetAfterSwitchOff` | false | | Reset the switch (like after timeout), when it is turned ```OFF```. |
|
||||||
|
| `devices[].logging` | false | | Logging of switch/trigger actions. |
|
||||||
|
|
||||||
## Install Development Dependencies
|
The parameter ```triggerTimeout``` can be changed in the configuration during runtime. So, this is just the initial value.
|
||||||
|
|
||||||
Using a terminal, navigate to the project folder and run this command to install the development dependencies:
|
The parameter ```numberConfiguredScenes``` just defines how many **programmable** switches are available. The number of
|
||||||
|
really **used** switches can configured during runtime, between 0 and the configured number.
|
||||||
|
|
||||||
```
|
> **NOTE:** Additional parameters (also called **Characteristics**) can only be configured via 3rd-party HomeKit apps (i.e.
|
||||||
npm install
|
> Home+, Controller for HomeKit, etc.), but in the basic Home App!
|
||||||
```
|
|
||||||
|
|
||||||
## Update package.json
|
So, an example **platform** plugin config will look as follows:
|
||||||
|
|
||||||
Open the [`package.json`](./package.json) and change the following attributes:
|
````
|
||||||
|
|
||||||
* `name` - this should be prefixed with `homebridge-` or `@username/homebridge-` and contain no spaces or special characters apart from a dashes
|
|
||||||
* `displayName` - this is the "nice" name displayed in the Homebridge UI
|
|
||||||
* `repository.url` - Link to your GitHub repo
|
|
||||||
* `bugs.url` - Link to your GitHub repo issues page
|
|
||||||
|
|
||||||
When you are ready to publish the plugin you should set `private` to false, or remove the attribute entirely.
|
|
||||||
|
|
||||||
## Update Plugin Defaults
|
|
||||||
|
|
||||||
Open the [`src/settings.ts`](./src/settings.ts) file and change the default values:
|
|
||||||
|
|
||||||
* `PLATFORM_NAME` - Set this to be the name of your platform. This is the name of the platform that users will use to register the plugin in the Homebridge `config.json`.
|
|
||||||
* `PLUGIN_NAME` - Set this to be the same name you set in the [`package.json`](./package.json) file.
|
|
||||||
|
|
||||||
Open the [`config.schema.json`](./config.schema.json) file and change the following attribute:
|
|
||||||
|
|
||||||
* `pluginAlias` - set this to match the `PLATFORM_NAME` you defined in the previous step.
|
|
||||||
|
|
||||||
## Build Plugin
|
|
||||||
|
|
||||||
TypeScript needs to be compiled into JavaScript before it can run. The following command will compile the contents of your [`src`](./src) directory and put the resulting code into the `dist` folder.
|
|
||||||
|
|
||||||
```
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
## Link To Homebridge
|
|
||||||
|
|
||||||
Run this command so your global install of Homebridge can discover the plugin in your development environment:
|
|
||||||
|
|
||||||
```
|
|
||||||
npm link
|
|
||||||
```
|
|
||||||
|
|
||||||
You can now start Homebridge, use the `-D` flag so you can see debug log messages in your plugin:
|
|
||||||
|
|
||||||
```
|
|
||||||
homebridge -D
|
|
||||||
```
|
|
||||||
|
|
||||||
## Watch For Changes and Build Automatically
|
|
||||||
|
|
||||||
If you want to have your code compile automatically as you make changes, and restart Homebridge automatically between changes, you first need to add your plugin as a platform in `~/.homebridge/config.json`:
|
|
||||||
```
|
|
||||||
{
|
|
||||||
...
|
|
||||||
"platforms": [
|
|
||||||
{
|
{
|
||||||
"name": "Config",
|
"platform": "MultiTapSwitch",
|
||||||
"port": 8581,
|
"name": "MTSwitch",
|
||||||
"platform": "config"
|
"devices": [
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"name": "<PLUGIN_NAME>",
|
"name": "MTSwitch 1",
|
||||||
//... any other options, as listed in config.schema.json ...
|
"numberConfiguredScenes": 5,
|
||||||
"platform": "<PLATFORM_NAME>"
|
"triggerTimeout": 10,
|
||||||
|
"resetAfterSwitchOff": true,
|
||||||
|
"logging": true
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
````
|
||||||
|
|
||||||
and then you can run:
|
|
||||||
|
|
||||||
```
|
|
||||||
npm run watch
|
|
||||||
```
|
|
||||||
|
|
||||||
This will launch an instance of Homebridge in debug mode which will restart every time you make a change to the source code. It will load the config stored in the default location under `~/.homebridge`. You may need to stop other running instances of Homebridge while using this command to prevent conflicts. You can adjust the Homebridge startup command in the [`nodemon.json`](./nodemon.json) file.
|
|
||||||
|
|
||||||
## Customise Plugin
|
|
||||||
|
|
||||||
You can now start customising the plugin template to suit your requirements.
|
|
||||||
|
|
||||||
* [`src/platform.ts`](./src/platform.ts) - this is where your device setup and discovery should go.
|
|
||||||
* [`src/accessoryInput.ts`](./src/accessoryInput.ts) - this is where your accessory control logic should go, you can rename or create multiple instances of this file for each accessory type you need to implement as part of your platform plugin. You can refer to the [developer documentation](https://developers.homebridge.io/) to see what characteristics you need to implement for each service type.
|
|
||||||
* [`config.schema.json`](./config.schema.json) - update the config schema to match the config you expect from the user. See the [Plugin Config Schema Documentation](https://developers.homebridge.io/#/config-schema).
|
|
||||||
|
|
||||||
## Versioning Your Plugin
|
|
||||||
|
|
||||||
Given a version number `MAJOR`.`MINOR`.`PATCH`, such as `1.4.3`, increment the:
|
|
||||||
|
|
||||||
1. **MAJOR** version when you make breaking changes to your plugin,
|
|
||||||
2. **MINOR** version when you add functionality in a backwards compatible manner, and
|
|
||||||
3. **PATCH** version when you make backwards compatible bug fixes.
|
|
||||||
|
|
||||||
You can use the `npm version` command to help you with this:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# major update / breaking changes
|
|
||||||
npm version major
|
|
||||||
|
|
||||||
# minor update / new features
|
|
||||||
npm version update
|
|
||||||
|
|
||||||
# patch / bugfixes
|
|
||||||
npm version patch
|
|
||||||
```
|
|
||||||
|
|
||||||
## Publish Package
|
|
||||||
|
|
||||||
When you are ready to publish your plugin to [npm](https://www.npmjs.com/), make sure you have removed the `private` attribute from the [`package.json`](./package.json) file then run:
|
|
||||||
|
|
||||||
```
|
|
||||||
npm publish
|
|
||||||
```
|
|
||||||
|
|
||||||
If you are publishing a scoped plugin, i.e. `@username/homebridge-xxx` you will need to add `--access=public` to command the first time you publish.
|
|
||||||
|
|
||||||
#### Publishing Beta Versions
|
|
||||||
|
|
||||||
You can publish *beta* versions of your plugin for other users to test before you release it to everyone.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# create a new pre-release version (eg. 2.1.0-beta.1)
|
|
||||||
npm version prepatch --preid beta
|
|
||||||
|
|
||||||
# publish to @beta
|
|
||||||
npm publish --tag=beta
|
|
||||||
```
|
|
||||||
|
|
||||||
Users can then install the *beta* version by appending `@beta` to the install command, for example:
|
|
||||||
|
|
||||||
```
|
|
||||||
sudo npm install -g homebridge-example-plugin@beta
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
Reference in new issue
Block a user