Skip to content

Commit 8063373

Browse files
committed
change: update Readme
1 parent 4a6bdc5 commit 8063373

File tree

1 file changed

+30
-23
lines changed

1 file changed

+30
-23
lines changed

README.md

+30-23
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,37 @@
11
# homebridge-jvc-projector
2-
> A [Homebridge](https://github.com/nfarina/homebridge) plugin providing power control for JVC projectors over IP
32

4-
This plugin is a simple wrapper around an existing [Python JVC integration project](https://github.com/bezmi/jvc_projector).
3+
> A [Homebridge](https://homebridge.io) plugin providing power control for JVC projectors over IP
54
6-
# Installation
7-
1. Install homebridge using: `npm install -g homebridge`
8-
1. Install this plugin: `npm install -g homebridge-jvc-projector`
9-
1. Update your configuration file. See a sample `config.json` snippet below.
10-
1. Ensure `python` is installed and on the path
11-
2. Install the python project: `pip install -e git+https://github.com/bezmi/jvc_projector.git#egg=jvc-projector-remote`
5+
## Prerequisites
126

13-
# Configuration
14-
Example `config.json` entry:
7+
1. Python 3.8 or higher
8+
1. Install the package `JVC Projector Remote`:
159

10+
```console
11+
$ python3 -m pip install jvc-projector-remote
1612
```
13+
14+
## Installation
15+
16+
1. Install this plugin using the Homebridge Config UI X or via commandline `npm install -g homebridge-jvc-projector`
17+
1. Setup the plugin's configuration
18+
19+
> **NOTE** If you have both Python 2 and Python 3 installed, make sure you set the correct path to Python 3 in the config of this plugin.
20+
21+
## Configuration
22+
23+
| Property | Description | Default |
24+
| ------------------------- | ------------------------------------------------------------------------ | --------------- |
25+
| name | the name for the accessory instance | |
26+
| projector_ip | IP address of a JVC projector with support for Ethernet/IP based control | |
27+
| projector_password | optional network password for the JVC projector | |
28+
| python_path | the path to python binary (v3!) | /usr/bin/python |
29+
| poll_interval | polling interval in seconds for the power state | 3 |
30+
| connection_delay_interval | delay in seconds between consecutive connections to the projector | 1 |
31+
32+
Example `config.json` entry:
33+
34+
```json
1735
"accessories": [
1836
{
1937
"accessory": "JvcProjectorPower",
@@ -26,20 +44,9 @@ Example `config.json` entry:
2644
}
2745
]
2846
```
29-
Where:
3047

31-
* `name` is the name for the accessory instance.
32-
* `projector_ip` is the IP of a JVC projector supporting control over Ethernet based IP.
33-
* `projector_password` is an optional network password for the JVC projector.
34-
* `python_path` is the path to python for invoking JVC IP API. Default is `/usr/bin/python`.
35-
* `poll_interval` is the polling interval in seconds for the power state. Default is `3`.
36-
* `connection_delay_interval` is the delay in seconds between consecutive connections to the projector. Default is `1`.
48+
## Help
3749

38-
# Help etc.
39-
40-
**NOTE**: As projector power on and power off sequences usually take about a minute, if you are toggling the power switch
41-
during this time you will find that the switch state flips back to the previous state. Have patience and allow the projector
42-
time to do what it needs...
50+
> **NOTE**: As projector power on and power off sequences usually take about a minute, if you are toggling the power switch during this time you will find that the switch state flips back to the previous state. Have patience and allow the projector time to do what it needs...
4351
4452
If you have a query or problem, raise an issue in GitHub, or better yet submit a PR!
45-

0 commit comments

Comments
 (0)