# Programmable HTTP Switch [![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins) [![Downloads](https://img.shields.io/npm/dt/homebridge-programmable-http-switch)](https://www.npmjs.com/package/homebridge-programmable-http-switch) [![Version](https://img.shields.io/npm/v/homebridge-programmable-http-switch)](https://www.npmjs.com/package/homebridge-programmable-http-switch)
[![Issues](https://img.shields.io/github/issues/StefanNienhuis/homebridge-programmable-http-switch)](https://github.com/StefanNienhuis/homebridge-programmable-http-switch/issues) [![Pull requests](https://img.shields.io/github/issues-pr/StefanNienhuis/homebridge-programmable-http-switch)](https://github.com/StefanNienhuis/homebridge-programmable-http-switch/pulls) This [Homebridge](https://homebridge.io) plugin allows users to create Stateless Programmable Switches which can be controlled using a HTTP API. ## Installation First, install Homebridge
`npm install --global homebridge` Then, install the Programmable HTTP Switch plugin
`npm install --global homebridge-programmable-http-switch` ## Configuration ### Platform configuration An example configuration can be found in the [config.example.json](config.example.json) file. | Property | Type | Details | | ------------- | ------------- | ------------------------------------------------------------------------------ | | `platform` | `string` | **Required**
Must always be `ProgrammableHTTPSwitch`. | | `accessories` | `Accessory[]` | **Required**
List of [accessory configurations](#accessory-configuration). | | `port` | `number` | Optional, default: `3000`
The port that the HTTP server should listen on. | ### Accessory configuration | Property | Type | Details | | ------------ | ---------- | ------------------------------------------------------------------------ | | `name` | `string` | **Required**
The name of the accessory. | | `identifier` | `string` | **Required**
The identifier used in the API. | | `buttons` | `Button[]` | **Required**
List of [button configurations](#button-configuration). | ### Button configuration | Property | Type | Details | | ------------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `name` | `string` | **Required**
The name of the button.
*Note:* Not shown in Apple's Home app. | | `identifier` | `string` | **Required**
The identifier used in the API. | | `supportedActions` | `string[]` | Optional, default: all
List of actions that this button supports.
*Supported values:* `singlePress` (`0`), `doublePress` (`1`) and `longPress` (`2`) | ## API endpoints ### `GET /accessories` **Description**
Returns all the currently configured accessoires. ### `GET /accessories/:accessoryIdentifier` **Description**
Returns an accessory with a specific identifier. ### `GET /accessories/:accessoryIdentifier/buttons` **Description**
Returns all buttons for an accessory with a specific identifier. ### `GET /accessories/:accessoryIdentifier/buttons/:buttonIdentifier` **Description**
Returns a button with a specific identifier for an accessory with a specific identifier. ### `PUT /accessories/:accessoryIdentifier/buttons/:buttonIdentifier` **Description**
Sets the state of a specific button on a specific accessory. **Body**
```json { "action": "singlePress" } ``` *Note:* Action must be one of the supported actions configured for the specific button.