matterbridge-litetouch 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -22
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -53,41 +53,28 @@ ls -la /dev/serial/by-id/
|
|
|
53
53
|
|
|
54
54
|
### 1. Install Matterbridge
|
|
55
55
|
|
|
56
|
+
If you haven't already, install Matterbridge:
|
|
57
|
+
|
|
56
58
|
```bash
|
|
57
59
|
sudo npm install -g matterbridge
|
|
58
60
|
```
|
|
59
61
|
|
|
60
62
|
### 2. Install This Plugin
|
|
61
63
|
|
|
62
|
-
|
|
63
|
-
```bash
|
|
64
|
-
# Clone the repository
|
|
65
|
-
git clone https://github.com/signal15/matterbridge-litetouch.git
|
|
66
|
-
cd matterbridge-litetouch
|
|
64
|
+
**Option A: Matterbridge Web UI (Recommended)**
|
|
67
65
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
66
|
+
1. Open the Matterbridge web UI (default: http://localhost:8283)
|
|
67
|
+
2. Click the three-dot menu next to the plugin search box
|
|
68
|
+
3. Find `matterbridge-litetouch` in the list
|
|
69
|
+
4. Click Install
|
|
71
70
|
|
|
72
|
-
|
|
73
|
-
sudo npm install -g .
|
|
74
|
-
```
|
|
71
|
+
**Option B: Command Line**
|
|
75
72
|
|
|
76
|
-
Then register with Matterbridge:
|
|
77
73
|
```bash
|
|
74
|
+
sudo npm install -g matterbridge-litetouch
|
|
78
75
|
sudo matterbridge -add matterbridge-litetouch
|
|
79
76
|
```
|
|
80
77
|
|
|
81
|
-
### Updating the Plugin
|
|
82
|
-
|
|
83
|
-
After making changes or pulling updates:
|
|
84
|
-
```bash
|
|
85
|
-
cd matterbridge-litetouch
|
|
86
|
-
npm run build
|
|
87
|
-
sudo cp -r dist/* /usr/lib/node_modules/matterbridge-litetouch/dist/
|
|
88
|
-
sudo systemctl restart matterbridge
|
|
89
|
-
```
|
|
90
|
-
|
|
91
78
|
### 3. Configure the Plugin
|
|
92
79
|
|
|
93
80
|
**Note:** The Matterbridge web UI does not support the array-of-objects format needed for load configuration. Edit the config file directly:
|
|
@@ -205,6 +192,19 @@ The Litetouch 2000 uses an ASCII protocol over RS-232:
|
|
|
205
192
|
|
|
206
193
|
Commands are terminated with carriage return (`\r`).
|
|
207
194
|
|
|
195
|
+
## Development
|
|
196
|
+
|
|
197
|
+
To build from source:
|
|
198
|
+
|
|
199
|
+
```bash
|
|
200
|
+
git clone https://github.com/signal15/matterbridge-litetouch.git
|
|
201
|
+
cd matterbridge-litetouch
|
|
202
|
+
npm install
|
|
203
|
+
npm run build
|
|
204
|
+
sudo npm install -g .
|
|
205
|
+
sudo matterbridge -add matterbridge-litetouch
|
|
206
|
+
```
|
|
207
|
+
|
|
208
208
|
## License
|
|
209
209
|
|
|
210
210
|
[PolyForm Noncommercial 1.0.0](https://polyformproject.org/licenses/noncommercial/1.0.0/) - Free for personal and noncommercial use.
|