homebridge-prana-local 0.1.2 → 0.1.3

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.
Files changed (5) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.it.md +12 -10
  3. package/README.md +19 -17
  4. package/docs/installation.md +3 -3
  5. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.3
4
+
5
+ - Refresh the npm listing with the project cover, clearer package description and direct GitHub links.
6
+ - Use absolute documentation and screenshot URLs so they also resolve on package catalogs.
7
+ - Update installation examples to this documentation release; device-control runtime is unchanged.
8
+
3
9
  ## 0.1.2
4
10
 
5
11
  - Prepare npm distribution with the standard Homebridge plugin search and update path.
package/README.it.md CHANGED
@@ -1,4 +1,4 @@
1
- <div align="center">
1
+ ![PRANA — Local ventilation. In Apple Home.](https://raw.githubusercontent.com/viames/homebridge-prana-local/main/.github/assets/cover.jpg)
2
2
 
3
3
  # Homebridge Prana Local
4
4
 
@@ -7,15 +7,17 @@
7
7
  Regola i flussi, scegli la modalità e consulta i sensori.<br>
8
8
  Comunicazione Wi-Fi locale, senza account cloud PRANA.
9
9
 
10
+ [![npm](https://img.shields.io/npm/v/homebridge-prana-local?label=npm)](https://www.npmjs.com/package/homebridge-prana-local)
10
11
  [![Ultima versione](https://img.shields.io/github/v/release/viames/homebridge-prana-local?color=6554c0&label=release)](https://github.com/viames/homebridge-prana-local/releases/latest)
11
12
  [![Test](https://github.com/viames/homebridge-prana-local/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/viames/homebridge-prana-local/actions/workflows/test.yml)
12
- [![Licenza MIT](https://img.shields.io/badge/license-MIT-296a56)](LICENSE)
13
+ [![Licenza MIT](https://img.shields.io/badge/license-MIT-296a56)](https://github.com/viames/homebridge-prana-local/blob/main/LICENSE)
13
14
 
14
- [English](README.md) · **Italiano**
15
+ [Repository GitHub](https://github.com/viames/homebridge-prana-local)
15
16
 
16
- [Installazione](#installazione) · [Compatibilità](#compatibilità) · [Configurazione](#configurazione) · [Problemi comuni](#problemi-comuni)
17
+ [English](https://github.com/viames/homebridge-prana-local/blob/main/README.md) · **Italiano**
18
+
19
+ [npm](https://www.npmjs.com/package/homebridge-prana-local) · [Installazione](#installazione) · [Compatibilità](#compatibilità) · [Configurazione](#configurazione) · [Problemi comuni](#problemi-comuni)
17
20
 
18
- </div>
19
21
 
20
22
  ---
21
23
 
@@ -66,10 +68,10 @@ In **Homebridge UI → Plugin**, cerca `homebridge-prana-local` e installalo. In
66
68
 
67
69
  ```sh
68
70
  cd /var/lib/homebridge
69
- npm install --omit=dev --ignore-scripts homebridge-prana-local@0.1.2
71
+ npm install --omit=dev --ignore-scripts homebridge-prana-local@0.1.3
70
72
  ```
71
73
 
72
- Usa l'account proprietario della cartella. Via SSH potrebbe essere necessario passare all'utente del servizio Homebridge. Per un'installazione npm globale già esistente, usa invece `npm install -g --omit=dev --ignore-scripts homebridge-prana-local@0.1.2`. Segui le convenzioni di privilegi del tuo impianto. Gli archivi nelle release GitHub restano un'alternativa: consulta la [guida di installazione](docs/installation.md).
74
+ Usa l'account proprietario della cartella. Via SSH potrebbe essere necessario passare all'utente del servizio Homebridge. Per un'installazione npm globale già esistente, usa invece `npm install -g --omit=dev --ignore-scripts homebridge-prana-local@0.1.3`. Segui le convenzioni di privilegi del tuo impianto. Gli archivi nelle release GitHub restano un'alternativa: consulta la [guida di installazione](https://github.com/viames/homebridge-prana-local/blob/main/docs/installation.md).
73
75
 
74
76
  Su Docker/NAS usa la procedura del tuo installer e la cartella dei plugin effettivamente usata da Homebridge, con persistenza dopo la ricreazione del container. Non installare una seconda copia di Homebridge per risolvere un errore di permessi.
75
77
 
@@ -79,7 +81,7 @@ Il pacchetto è pronto all'uso e non richiede build o dipendenze a runtime. La [
79
81
 
80
82
  In **Plugins → Homebridge Prana Local → Plugin Actions → Plugin Config** (UI 5.29), aggiungi l'unità. Altre versioni possono chiamare la voce **Impostazioni/Settings**. Scegli un ID stabile come `prana-1`, il nome **Ventilazione PRANA** o quello che preferisci, e inserisci l'indirizzo reale. Imposta `language` su `it` per le etichette italiane. Nessuna stanza è predefinita.
81
83
 
82
- ![Impostazioni reali di Homebridge con dati di esempio e nome generico](docs/images/settings.png)
84
+ ![Impostazioni reali di Homebridge con dati di esempio e nome generico](https://raw.githubusercontent.com/viames/homebridge-prana-local/main/docs/images/settings.png)
83
85
 
84
86
  *Schermata di un'istanza separata per la documentazione, con dati di esempio. Non mostra la configurazione di un'abitazione.*
85
87
 
@@ -126,7 +128,7 @@ Se preferisci JSON, aggiungi questo oggetto all'array `platforms` esistente, con
126
128
  | `co2Threshold` | `1000` ppm, soglia dello stato CO₂eq anomalo; modulo 400–10000 |
127
129
  | `timeout` | `5000` ms; intervallo 500–30000 |
128
130
 
129
- Per più unità, aggiungi oggetti all'array `devices` con ID univoci. Configura ogni unità una sola volta. Quando cambia l'IP, modifica `host` e conserva `id` per mantenere l'identità HomeKit. [Esempio completo](docs/configuration.md#multiple-units).
131
+ Per più unità, aggiungi oggetti all'array `devices` con ID univoci. Configura ogni unità una sola volta. Quando cambia l'IP, modifica `host` e conserva `id` per mantenere l'identità HomeKit. [Esempio completo](https://github.com/viames/homebridge-prana-local/blob/main/docs/configuration.md#multiple-units).
130
132
 
131
133
  ## Come funzionano i comandi
132
134
 
@@ -180,4 +182,4 @@ Il collegamento PRANA–Homebridge funziona sulla LAN senza cloud PRANA. Aggiorn
180
182
 
181
183
  ---
182
184
 
183
- Software indipendente della comunità, di [viames](https://github.com/viames), con [licenza MIT](LICENSE). Non affiliato a PRANA o Apple e non verificato dal progetto Homebridge. [Guide tecniche in inglese](docs/configuration.md) · [Contribuire](CONTRIBUTING.md).
185
+ Software indipendente della comunità, di [viames](https://github.com/viames), con [licenza MIT](https://github.com/viames/homebridge-prana-local/blob/main/LICENSE). Non affiliato a PRANA o Apple e non verificato dal progetto Homebridge. [Guide tecniche in inglese](https://github.com/viames/homebridge-prana-local/blob/main/docs/configuration.md) · [Contribuire](https://github.com/viames/homebridge-prana-local/blob/main/CONTRIBUTING.md).
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- <div align="center">
1
+ ![PRANA — Local ventilation. In Apple Home.](https://raw.githubusercontent.com/viames/homebridge-prana-local/main/.github/assets/cover.jpg)
2
2
 
3
3
  # Homebridge Prana Local
4
4
 
@@ -7,15 +7,17 @@
7
7
  Control airflow, choose a mode and read your room's sensors.<br>
8
8
  Local Wi-Fi communication. No PRANA cloud account required.
9
9
 
10
+ [![npm](https://img.shields.io/npm/v/homebridge-prana-local?label=npm)](https://www.npmjs.com/package/homebridge-prana-local)
10
11
  [![Latest release](https://img.shields.io/github/v/release/viames/homebridge-prana-local?color=6554c0&label=release)](https://github.com/viames/homebridge-prana-local/releases/latest)
11
12
  [![Tests](https://github.com/viames/homebridge-prana-local/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/viames/homebridge-prana-local/actions/workflows/test.yml)
12
- [![License: MIT](https://img.shields.io/badge/license-MIT-296a56)](LICENSE)
13
+ [![License: MIT](https://img.shields.io/badge/license-MIT-296a56)](https://github.com/viames/homebridge-prana-local/blob/main/LICENSE)
13
14
 
14
- **English** · [Italiano](README.it.md)
15
+ [GitHub repository](https://github.com/viames/homebridge-prana-local)
15
16
 
16
- [Get started](#get-started) · [Compatibility](#compatibility) · [Settings](docs/configuration.md) · [Help](docs/troubleshooting.md)
17
+ **English** · [Italiano](https://github.com/viames/homebridge-prana-local/blob/main/README.it.md)
18
+
19
+ [npm](https://www.npmjs.com/package/homebridge-prana-local) · [Get started](#get-started) · [Compatibility](#compatibility) · [Settings](https://github.com/viames/homebridge-prana-local/blob/main/docs/configuration.md) · [Help](https://github.com/viames/homebridge-prana-local/blob/main/docs/troubleshooting.md)
17
20
 
18
- </div>
19
21
 
20
22
  ---
21
23
 
@@ -29,7 +31,7 @@ Add a compatible PRANA recuperator to the Homebridge you already use. Apple Home
29
31
  | Optional separate supply/extract controls | Night and Boost presets | Relative humidity |
30
32
  | Synchronized airflow mode | Winter and mini heater switches | Equivalent CO₂ estimate |
31
33
 
32
- Sensor and heater availability depend on the model. [See exactly how each control behaves →](docs/configuration.md#controls-and-sensors)
34
+ Sensor and heater availability depend on the model. [See exactly how each control behaves →](https://github.com/viames/homebridge-prana-local/blob/main/docs/configuration.md#controls-and-sensors)
33
35
 
34
36
  ```mermaid
35
37
  flowchart LR
@@ -60,17 +62,17 @@ Open your router's connected-device list and find the PRANA's IPv4 address. Rese
60
62
 
61
63
  ### 2. Install the release
62
64
 
63
- In **Homebridge UI → Plugins**, search for `homebridge-prana-local` and install it. The [npm package](https://www.npmjs.com/package/homebridge-prana-local) and [GitHub release archives](https://github.com/viames/homebridge-prana-local/releases/latest) contain the same ready-to-run plugin. Follow the [installation guide](docs/installation.md) for your Homebridge setup.
65
+ In **Homebridge UI → Plugins**, search for `homebridge-prana-local` and install it. The [npm package](https://www.npmjs.com/package/homebridge-prana-local) and [GitHub release archives](https://github.com/viames/homebridge-prana-local/releases/latest) contain the same ready-to-run plugin. Follow the [installation guide](https://github.com/viames/homebridge-prana-local/blob/main/docs/installation.md) for your Homebridge setup.
64
66
 
65
67
  ### 3. Add your unit
66
68
 
67
69
  Open the plugin's **Plugin Actions → Plugin Config** (or **Settings**, depending on UI version), add a device and enter its IP address. Choose a permanent ID such as `prana-1` and a name such as **PRANA ventilation**. The name and room are yours to choose; no room is assumed.
68
70
 
69
- ![Real Homebridge settings with a generic device name and documentation address](docs/images/settings.png)
71
+ ![Real Homebridge settings with a generic device name and documentation address](https://raw.githubusercontent.com/viames/homebridge-prana-local/main/docs/images/settings.png)
70
72
 
71
73
  *The real Homebridge UI, shown with example data in a separate documentation instance. Replace the example address with your unit's address.*
72
74
 
73
- Prefer JSON? Copy the [minimal configuration](docs/configuration.md#minimal-configuration). The reference includes multiple-unit examples and every optional setting.
75
+ Prefer JSON? Copy the [minimal configuration](https://github.com/viames/homebridge-prana-local/blob/main/docs/configuration.md#minimal-configuration). The reference includes multiple-unit examples and every optional setting.
74
76
 
75
77
  ### 4. Restart and open Apple Home
76
78
 
@@ -86,23 +88,23 @@ Assign the accessory to your chosen room. If controls are grouped, open the acce
86
88
  - **CO₂eq is an estimate.** It is not a direct CO₂ measurement or a safety alarm.
87
89
  - VOC, pressure, display brightness and sleep timers remain in the manufacturer's app; they are not exposed by this release.
88
90
 
89
- [Control behavior and limitations →](docs/configuration.md#controls-and-sensors)
91
+ [Control behavior and limitations →](https://github.com/viames/homebridge-prana-local/blob/main/docs/configuration.md#controls-and-sensors)
90
92
 
91
93
  ## Guides and support
92
94
 
93
95
  | I want to… | Open |
94
96
  | :--- | :--- |
95
- | Install, update or remove the plugin | [Installation guide](docs/installation.md) |
96
- | Configure one or several units | [Configuration reference](docs/configuration.md) |
97
- | Fix “No Response”, missing controls or connection errors | [Troubleshooting and FAQ](docs/troubleshooting.md) |
98
- | Read the guide in Italian | [Documentazione italiana](README.it.md) |
97
+ | Install, update or remove the plugin | [Installation guide](https://github.com/viames/homebridge-prana-local/blob/main/docs/installation.md) |
98
+ | Configure one or several units | [Configuration reference](https://github.com/viames/homebridge-prana-local/blob/main/docs/configuration.md) |
99
+ | Fix “No Response”, missing controls or connection errors | [Troubleshooting and FAQ](https://github.com/viames/homebridge-prana-local/blob/main/docs/troubleshooting.md) |
100
+ | Read the guide in Italian | [Documentazione italiana](https://github.com/viames/homebridge-prana-local/blob/main/README.it.md) |
99
101
  | Report a problem or another supported model | [Open an issue](https://github.com/viames/homebridge-prana-local/issues/new/choose) |
100
- | Contribute code or run checks | [Contributing](CONTRIBUTING.md) |
102
+ | Contribute code or run checks | [Contributing](https://github.com/viames/homebridge-prana-local/blob/main/CONTRIBUTING.md) |
101
103
 
102
- Keep the local HTTP API inside a trusted network. It has no authentication and must not be exposed through internet port forwarding. [Network details →](docs/troubleshooting.md#network-and-privacy)
104
+ Keep the local HTTP API inside a trusted network. It has no authentication and must not be exposed through internet port forwarding. [Network details →](https://github.com/viames/homebridge-prana-local/blob/main/docs/troubleshooting.md#network-and-privacy)
103
105
 
104
106
  ---
105
107
 
106
- Independent community software by [viames](https://github.com/viames), under the [MIT license](LICENSE). Not affiliated with PRANA or Apple and not verified by Homebridge. Product names belong to their respective owners.
108
+ Independent community software by [viames](https://github.com/viames), under the [MIT license](https://github.com/viames/homebridge-prana-local/blob/main/LICENSE). Not affiliated with PRANA or Apple and not verified by Homebridge. Product names belong to their respective owners.
107
109
 
108
110
  Built using the local API contract described by the [PRANA Home Assistant integration](https://www.home-assistant.io/integrations/prana/) and [PRANA API client](https://pypi.org/project/prana-api-client/). No Python or Home Assistant runtime is included.
package/docs/installation.md CHANGED
@@ -28,7 +28,7 @@ In the Homebridge UI terminal, use the standard storage directory:
28
28
 
29
29
  ```sh
30
30
  cd /var/lib/homebridge
31
- npm install --omit=dev --ignore-scripts homebridge-prana-local@0.1.2
31
+ npm install --omit=dev --ignore-scripts homebridge-prana-local@0.1.3
32
32
  ```
33
33
 
34
34
  Use the account that owns that directory. An SSH session may need to switch to the Homebridge service account first. Do not change directory ownership or install another Homebridge copy to resolve a permissions error.
@@ -40,7 +40,7 @@ Use the account that owns that directory. An SSH session may need to switch to t
40
40
  If your existing Homebridge plugins are installed globally:
41
41
 
42
42
  ```sh
43
- npm install -g --omit=dev --ignore-scripts homebridge-prana-local@0.1.2
43
+ npm install -g --omit=dev --ignore-scripts homebridge-prana-local@0.1.3
44
44
  ```
45
45
 
46
46
  Follow your existing privilege convention. Some system-wide setups need `sudo`; user-managed Node installations normally do not.
@@ -54,7 +54,7 @@ Use your container/NAS installer's documented plugin installation mechanism. Ins
54
54
  The [GitHub release](https://github.com/viames/homebridge-prana-local/releases/latest) also includes a ready-to-run archive. In the same plugin directory, you can install it with:
55
55
 
56
56
  ```sh
57
- npm install --omit=dev --ignore-scripts https://github.com/viames/homebridge-prana-local/releases/download/v0.1.2/homebridge-prana-local-0.1.2.tgz
57
+ npm install --omit=dev --ignore-scripts https://github.com/viames/homebridge-prana-local/releases/download/v0.1.3/homebridge-prana-local-0.1.3.tgz
58
58
  ```
59
59
 
60
60
  An “install version” dialog may expect an npm name/version rather than an arbitrary URL. Use a terminal when your UI does not explicitly support archive URLs.
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "homebridge-prana-local",
3
- "version": "0.1.2",
4
- "description": "Local Wi-Fi control of Prana ventilation units in Apple Home and Siri",
3
+ "version": "0.1.3",
4
+ "description": "Bring compatible PRANA ventilation into Apple Home and Siri over local Wi-Fi, without a PRANA cloud account.",
5
5
  "main": "index.js",
6
6
  "type": "commonjs",
7
7
  "license": "MIT",
8
- "author": "viames",
8
+ "author": "Viames Marino",
9
9
  "homepage": "https://github.com/viames/homebridge-prana-local#readme",
10
10
  "repository": {
11
11
  "type": "git",