Release 1.5.2

Luligu · Aug 30, 2024 · 3f6c111 · 3f6c111
1 parent a2c4fd7
commit 3f6c111
Show file tree

Hide file tree

Showing 4 changed files with 112 additions and 86 deletions.
diff --git a/README-ADVANCED.md → README-DOCKER.md b/README-ADVANCED.md → README-DOCKER.md
@@ -14,88 +14,7 @@
 
 # Advanced configuration
 
-## Run matterbridge as a daemon with systemctl (Linux only)
-
-Create a systemctl configuration file for Matterbridge
-
-```
-sudo nano /etc/systemd/system/matterbridge.service
-```
-
-Add the following to this file, replacing twice (!) USER with your user name (e.g. WorkingDirectory=/home/pi/Matterbridge and User=pi):
-
-You may need to adapt the configuration to your setup:
- - execStart on some linux distribution can also be ExecStart==/usr/bin/matterbridge -service
-
-```
-[Unit]
-Description=matterbridge
-After=network-online.target
-
-[Service]
-Type=simple
-ExecStart=matterbridge -service
-WorkingDirectory=/home/<USER>/Matterbridge
-StandardOutput=inherit
-StandardError=inherit
-Restart=always
-RestartSec=10s
-TimeoutStopSec=30s
-User=<USER>
-
-[Install]
-WantedBy=multi-user.target
-```
-
-If you modify it after, then run:
-
-```
-sudo systemctl daemon-reload
-```
-
-### Start Matterbridge
-
-```
-sudo systemctl start matterbridge
-```
-
-### Stop Matterbridge
-
-```
-sudo systemctl stop matterbridge
-```
-
-### Show Matterbridge status
-
-```
-sudo systemctl status matterbridge.service
-```
-
-### View the log of Matterbridge in real time (this will show the log with colors)
-
-```
-sudo journalctl -u matterbridge.service -f --output cat
-```
-
-### Delete the logs older then 3 days (all of them not only the ones of Matterbridge!)
-
-```
-sudo journalctl --vacuum-time=3d
-```
-
-### Enable Matterbridge to start automatically on boot
-
-```
-sudo systemctl enable matterbridge.service
-```
-
-### Disable Matterbridge from starting automatically on boot
-
-```
-sudo systemctl disable matterbridge.service
-```
-
-## Run matterbridge with docker
+## Run matterbridge with docker and docker compose
 
 The Matterbridge Docker image, which includes a manifest list for the linux/amd64, linux/arm64 and linux/arm/v7 architectures, is published on Docker Hub.
 

diff --git a/README-SERVICE.md b/README-SERVICE.md
@@ -0,0 +1,96 @@
+# <img src="https://github.com/Luligu/matterbridge/blob/main/frontend/public/matterbridge%2064x64.png" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge
+
+[![npm version](https://img.shields.io/npm/v/matterbridge.svg)](https://www.npmjs.com/package/matterbridge)
+[![npm downloads](https://img.shields.io/npm/dt/matterbridge.svg)](https://www.npmjs.com/package/matterbridge)
+[![Docker Version](https://img.shields.io/docker/v/luligu/matterbridge?label=docker%20version&sort=semver)](https://hub.docker.com/r/luligu/matterbridge)
+[![Docker Pulls](https://img.shields.io/docker/pulls/luligu/matterbridge.svg)](https://hub.docker.com/r/luligu/matterbridge)
+![Node.js CI](https://github.com/Luligu/matterbridge/actions/workflows/build.yml/badge.svg)
+
+[![power by](https://img.shields.io/badge/powered%20by-matter--history-blue)](https://www.npmjs.com/package/matter-history)
+[![power by](https://img.shields.io/badge/powered%20by-node--ansi--logger-blue)](https://www.npmjs.com/package/node-ansi-logger)
+[![power by](https://img.shields.io/badge/powered%20by-node--persist--manager-blue)](https://www.npmjs.com/package/node-persist-manager)
+
+---
+
+# Advanced configuration
+
+## Run matterbridge as a daemon with systemctl (Linux only)
+
+Create a systemctl configuration file for Matterbridge
+
+```
+sudo nano /etc/systemd/system/matterbridge.service
+```
+
+Add the following to this file, replacing twice (!) USER with your user name (e.g. WorkingDirectory=/home/pi/Matterbridge and User=pi):
+
+You may need to adapt the configuration to your setup:
+ - execStart on some linux distribution can also be ExecStart==/usr/bin/matterbridge -service
+
+```
+[Unit]
+Description=matterbridge
+After=network-online.target
+
+[Service]
+Type=simple
+ExecStart=matterbridge -service
+WorkingDirectory=/home/<USER>/Matterbridge
+StandardOutput=inherit
+StandardError=inherit
+Restart=always
+RestartSec=10s
+TimeoutStopSec=30s
+User=<USER>
+
+[Install]
+WantedBy=multi-user.target
+```
+
+If you modify it after, then run:
+
+```
+sudo systemctl daemon-reload
+```
+
+### Start Matterbridge
+
+```
+sudo systemctl start matterbridge
+```
+
+### Stop Matterbridge
+
+```
+sudo systemctl stop matterbridge
+```
+
+### Show Matterbridge status
+
+```
+sudo systemctl status matterbridge.service
+```
+
+### View the log of Matterbridge in real time (this will show the log with colors)
+
+```
+sudo journalctl -u matterbridge.service -f --output cat
+```
+
+### Delete the logs older then 3 days (all of them not only the ones of Matterbridge!)
+
+```
+sudo journalctl --vacuum-time=3d
+```
+
+### Enable Matterbridge to start automatically on boot
+
+```
+sudo systemctl enable matterbridge.service
+```
+
+### Disable Matterbridge from starting automatically on boot
+
+```
+sudo systemctl disable matterbridge.service
+```
diff --git a/README.md b/README.md
@@ -124,7 +124,13 @@ Config editor:
 
 ## Advanced configurations
 
-[Advanced configurations](https://github.com/Luligu/matterbridge/blob/main/README-ADVANCED.md)
+### Run matterbridge as a daemon with systemctl (Linux only)
+
+[Advanced configurations](https://github.com/Luligu/matterbridge/blob/main/README-SERVICE.md)
+
+### Run matterbridge with docker and docker compose
+
+[Advanced configurations](https://github.com/Luligu/matterbridge/blob/main/README-DOCKER.md)
 
 ## Development
 
@@ -147,7 +153,7 @@ Features:
 - Shelly wifi battery-powered devices with sleep_mode are supported.
 - Shelly BLU devices are supported through local devices configured as ble gateway.
 - Discovered shellies are stored in local storage for quick loading on startup.
-- The components exposed are Light (with brightness and RGB color), Switch, Relay, Roller, Cover, PowerMeter and Input.
+- The components exposed are Light (with brightness and RGB color), Switch, Relay, Roller, Cover, PowerMeter, Temperature, Humidity and Input.
 - All components expose the electrical measurements with the EveHistory cluster (displayed on HA), waiting for the controllers to upgrade to the Matter 1.3 specs.
 - Shellies are controlled locally, eliminating the need for cloud or MQTT (which can both be disabled).
 - Shelly Gen 1 devices are controlled using the CoIoT protocol (see the note below).
@@ -221,7 +227,12 @@ The history works in both bridge and childbridge mode.
 
 The Eve app only shows the history when the plugins run like an AccessoryPlatform in childbridge mode (this means the plugin is paired directly).
 
-## How to install and register a production-level plugin from a terminal (from npm)
+## How to install and add a plugin with the frontend (best option)
+
+Just open the frontend on the link provided in the log, select a plugin and click install.
+
+
+## How to install and add a plugin manually from a terminal (from npm)
 
 To install i.e. https://github.com/Luligu/matterbridge-zigbee2mqtt
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "1.5.2-beta2",
+  "version": "1.5.2",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",