Skip to content

Commit

Permalink
consistent labels for sensor-type accessories
Browse files Browse the repository at this point in the history
  • Loading branch information
bwp91 committed Nov 16, 2024
1 parent a24d570 commit c2c9c4f
Show file tree
Hide file tree
Showing 35 changed files with 82 additions and 67 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ All notable changes to `homebridge-config-ui-x` will be documented in this file.
- currently available for `de` `en` `es` `fr` `it` `pt` `zh`
- switch from a top menu to a sidebar menu
- show pairing status for bridges around the ui
- consistent labels for sensor-type accessories

### Other Changes

Expand Down
62 changes: 4 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@

# Homebridge UI

[![npm](https://badgen.net/npm/v/homebridge-config-ui-x/latest)](https://www.npmjs.com/package/homebridge-config-ui-x)
[![npm](https://badgen.net/npm/v/homebridge-config-ui-x/latest?label=latest)](https://www.npmjs.com/package/homebridge-config-ui-x)
[![npm](https://badgen.net/npm/v/homebridge-config-ui-x/beta?label=beta)](https://www.npmjs.com/package/homebridge-config-ui-x)
[![npm](https://badgen.net/npm/dt/homebridge-config-ui-x?label=downloads)](https://www.npmjs.com/package/homebridge-config-ui-x)
[![Discord](https://badgen.net/discord/online-members/C87Pvq3?icon=discord&label=discord)](https://discord.gg/C87Pvq3)
[![Donate](https://badgen.net/badge/donate/paypal/yellow)](https://paypal.me/oznu)

:gb: :de: :fr: :poland: :czech_republic: :ru: :cn: :hungary: :jp: :es: :netherlands: :tr: :it: :bulgaria: :sweden: :norway: :finland: :slovenia: :brazil: :portugal: :indonesia: :kr: :macedonia: :thailand: :israel: :ukraine:

Expand Down Expand Up @@ -59,11 +58,11 @@ This shows an overview of your Homebridge system. The dashboard is widget-based

### Plugin Screen

This shows you the currently installed plugins and allows you to install, remove and upgrade plugins.
This shows you the currently installed plugins and allows you to install, configure, update and remove plugins.

![Plugin](screenshots/homebridge-config-ui-x-darkmode-plugins.png?2020-01-07)

You can configure supported plugins using the graphical settings editor, removing the need to manually edit the `config.json`. Over 165 popular plugins have implemented support for this feature.
You can configure supported plugins using the graphical settings editor, or by editing the config JSON directly.

![Plugin Settings](screenshots/homebridge-config-ui-x-darkmode-alexa-settings.png?2020-01-07)

Expand All @@ -85,32 +84,6 @@ This shows you the Homebridge accessories for all the Homebridge instances on yo

![Accessories](screenshots/homebridge-config-ui-x-accessories.png?2020-01-07)

## Supported Browsers

The following browsers are supported by the Homebridge UI:

- Chrome - latest
- Edge - latest
- Firefox - latest
- Safari - 2 most recent major versions
- iOS - 2 most recent major versions

MS Internet Explorer (any version) is not supported!

## Supported Node.js Version

The Homebridge UI follows the same Node.js support schedule as Homebridge. See the [How-To-Update-Node.js](https://github.com/homebridge/homebridge/wiki/How-To-Update-Node.js) page in the Homebridge wiki for currently supported versions.

You can check your current versions using these commands:

```shell
# check node version
node -v

# check npm version
npm -v
```

## Plugin Development

The https://developers.homebridge.io website contains the Homebridge API reference, available service and characteristic types, and plugin examples.
Expand All @@ -119,33 +92,6 @@ The [Homebridge Plugin Template](https://github.com/homebridge/homebridge-plugin

There are many existing plugins you can study; you might start with the [Homebridge Example Plugins](https://github.com/homebridge/homebridge-examples) or a plugin that already implements the device type you need.

## Common Issues

### Errors during installation

Make sure you installed the package with `sudo` and used the `--unsafe-perm` flag. Most installation errors can be fixed by removing the Homebridge UI and reinstalling:

```shell
# cleanup
sudo npm uninstall -g homebridge-config-ui-x

# reinstall
sudo npm install -g --unsafe-perm homebridge-config-ui-x
```

Make sure you are running [supported versions of node and npm](#supported-nodejs-and-npm-versions).

### Home App Says Accessory Already Added

To fix this, [Reset Homebridge](https://github.com/homebridge/homebridge/wiki/Connecting-Homebridge-To-HomeKit#how-to-reset-homebridge).

### My iOS App Can't Find Homebridge

Try the following:

1. Swap between the `Bonjour HAP` and `Ciao` mDNS Advertiser options. See [the wiki](https://github.com/homebridge/homebridge/wiki/mDNS-Options) for more details.
2. iOS DNS cache has gone stale or gotten misconfigured. To fix this, turn airplane mode on and back off to flush the DNS cache.

## Community

The official Homebridge Discord server and Reddit community are where users can discuss Homebridge and ask for help.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@
<div [inlineSVG]="'/assets/hap-icons/leaksensor.svg'" [attr.aria-label]="'Leak Sensor'" class="accessory-svg"></div>
<div class="accessory-label mt-auto">{{ service.customName || service.serviceName }}</div>
<div class="accessory-label red-text" *ngIf="service.values.LeakDetected">
{{ 'accessories.control.triggered' | translate }}
{{ 'accessories.control.detected' | translate }}
</div>
<div class="accessory-label grey-text" *ngIf="!service.values.LeakDetected">
{{ 'accessories.control.not_detected' | translate }}
</div>
</div>
</div>
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
></div>
<div class="accessory-label mt-auto">{{ service.customName || service.serviceName }}</div>
<div class="accessory-label red-text" *ngIf="service.values.MotionDetected">
{{ 'accessories.control.triggered' | translate }}
{{ 'accessories.control.detected' | translate }}
</div>
<div class="accessory-label grey-text" *ngIf="!service.values.MotionDetected">
{{ 'accessories.control.not_detected' | translate }}
</div>
</div>
</div>
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
></div>
<div class="accessory-label mt-auto">{{ service.customName || service.serviceName }}</div>
<div class="accessory-label red-text" *ngIf="service.values.OccupancyDetected">
{{ 'accessories.control.triggered' | translate }}
{{ 'accessories.control.detected' | translate }}
</div>
<div class="accessory-label grey-text" *ngIf="!service.values.OccupancyDetected">
{{ 'accessories.control.not_detected' | translate }}
</div>
</div>
</div>
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
></div>
<div class="accessory-label mt-auto">{{ service.customName || service.serviceName }}</div>
<div class="accessory-label red-text" *ngIf="service.values.SmokeDetected">
{{ 'accessories.control.triggered' | translate }}
{{ 'accessories.control.detected' | translate }}
</div>
<div class="accessory-label grey-text" *ngIf="!service.values.SmokeDetected">
{{ 'accessories.control.not_detected' | translate }}
</div>
</div>
</div>
10 changes: 5 additions & 5 deletions ui/src/app/modules/config-editor/config-editor.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ export class ConfigEditorComponent implements OnInit, OnDestroy {
},
model: {
type: 'string',
description: 'The bridge model to be displayed in HomeKit',
description: 'The bridge model to be displayed in HomeKit',
},
bind: {
description: 'A string or an array of strings with the name(s) of the network interface(s) '
Expand Down Expand Up @@ -474,7 +474,7 @@ export class ConfigEditorComponent implements OnInit, OnDestroy {
},
ports: {
type: 'object',
description: 'The range of ports that should be used for certain accessories like Cameras and TVs',
description: 'The range of ports that should be used for certain accessories like cameras and TVs',
required: ['start', 'end'],
properties: {
start: {
Expand All @@ -497,7 +497,7 @@ export class ConfigEditorComponent implements OnInit, OnDestroy {
},
platforms: {
type: 'array',
description: 'Plugins that expose a "Platform" should have there config entered in this array.'
description: 'Any plugin that exposes a platform should have it\'s config entered in this array.'
+ '\nSeparate each plugin config block using a comma.',
items: {
type: 'object',
Expand Down Expand Up @@ -530,7 +530,7 @@ export class ConfigEditorComponent implements OnInit, OnDestroy {
},
name: {
type: 'string',
description: 'The name used in the Homebridge log',
description: 'The name used in the Homebridge log.',
},
},
},
Expand All @@ -539,7 +539,7 @@ export class ConfigEditorComponent implements OnInit, OnDestroy {
},
accessories: {
type: 'array',
description: 'Plugins that expose a "Accessory" should have there config entered in this array.'
description: 'Any plugin that exposes an accessory should have it\'s config entered in this array.'
+ '\nSeparate each plugin config block using a comma.',
items: {
type: 'object',
Expand Down
2 changes: 2 additions & 0 deletions ui/src/i18n/bg.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"accessories.control.default_room": "Стая по подразбиране",
"accessories.control.default_running_time": "Default Running Time",
"accessories.control.dehumidifying": "Dehumidifying",
"accessories.control.detected": "Detected",
"accessories.control.drag_here": "Drag Here",
"accessories.control.fan": "Вентилатор",
"accessories.control.heat": "Затопляне",
Expand All @@ -24,6 +25,7 @@
"accessories.control.locked": "Заключено",
"accessories.control.mute": "Mute",
"accessories.control.night": "Night",
"accessories.control.not_detected": "Not Detected",
"accessories.control.not_mute": "On",
"accessories.control.off": "Изключено",
"accessories.control.on": "Включено",
Expand Down
2 changes: 2 additions & 0 deletions ui/src/i18n/ca.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"accessories.control.default_room": "Habitació per defecte",
"accessories.control.default_running_time": "Temps d'execució per defecte",
"accessories.control.dehumidifying": "Deshumidificant",
"accessories.control.detected": "Detected",
"accessories.control.drag_here": "Arrossegar i deixar anar aquí",
"accessories.control.fan": "Ventilador",
"accessories.control.heat": "Calor",
Expand All @@ -24,6 +25,7 @@
"accessories.control.locked": "Bloquejat",
"accessories.control.mute": "Silenci",
"accessories.control.night": "Nit",
"accessories.control.not_detected": "Not Detected",
"accessories.control.not_mute": "On",
"accessories.control.off": "Apagat",
"accessories.control.on": "Engegat",
Expand Down
2 changes: 2 additions & 0 deletions ui/src/i18n/cs.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"accessories.control.default_room": "Výchozí místnost",
"accessories.control.default_running_time": "Výchozí doba spuštění",
"accessories.control.dehumidifying": "Odvlhčování",
"accessories.control.detected": "Detected",
"accessories.control.drag_here": "Přesunout Zde",
"accessories.control.fan": "Větrák",
"accessories.control.heat": "Topení",
Expand All @@ -24,6 +25,7 @@
"accessories.control.locked": "Zamčeno",
"accessories.control.mute": "Ztlumit",
"accessories.control.night": "Noc",
"accessories.control.not_detected": "Not Detected",
"accessories.control.not_mute": "Zapnuto",
"accessories.control.off": "Vypnuto",
"accessories.control.on": "Zapnuto",
Expand Down
2 changes: 2 additions & 0 deletions ui/src/i18n/de.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"accessories.control.default_room": "Standardraum",
"accessories.control.default_running_time": "Voreingestellte Laufzeit",
"accessories.control.dehumidifying": "Entfeuchten",
"accessories.control.detected": "Detected",
"accessories.control.drag_here": "Hierher ziehen",
"accessories.control.fan": "Ventilator",
"accessories.control.heat": "Heizen",
Expand All @@ -24,6 +25,7 @@
"accessories.control.locked": "Abgeschlossen",
"accessories.control.mute": "Stummschalten",
"accessories.control.night": "Nacht",
"accessories.control.not_detected": "Not Detected",
"accessories.control.not_mute": "An",
"accessories.control.off": "Aus",
"accessories.control.on": "An",
Expand Down
2 changes: 2 additions & 0 deletions ui/src/i18n/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"accessories.control.default_room": "Default Room",
"accessories.control.default_running_time": "Default Running Time",
"accessories.control.dehumidifying": "Dehumidifying",
"accessories.control.detected": "Detected",
"accessories.control.drag_here": "Drag Here",
"accessories.control.fan": "Fan",
"accessories.control.heat": "Heat",
Expand All @@ -24,6 +25,7 @@
"accessories.control.locked": "Locked",
"accessories.control.mute": "Mute",
"accessories.control.night": "Night",
"accessories.control.not_detected": "Not Detected",
"accessories.control.not_mute": "On",
"accessories.control.off": "Off",
"accessories.control.on": "On",
Expand Down
2 changes: 2 additions & 0 deletions ui/src/i18n/es.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"accessories.control.default_room": "Habitación predeterminada",
"accessories.control.default_running_time": "Tiempo de ejecución predeterminado",
"accessories.control.dehumidifying": "Deshumidificando",
"accessories.control.detected": "Detected",
"accessories.control.drag_here": "Arrastrar y soltar aquí.",
"accessories.control.fan": "Ventilador",
"accessories.control.heat": "Calor",
Expand All @@ -24,6 +25,7 @@
"accessories.control.locked": "Bloqueado",
"accessories.control.mute": "Silencio",
"accessories.control.night": "Noche",
"accessories.control.not_detected": "Not Detected",
"accessories.control.not_mute": "Encendido",
"accessories.control.off": "Apagado",
"accessories.control.on": "Encendido",
Expand Down
2 changes: 2 additions & 0 deletions ui/src/i18n/fi.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"accessories.control.default_room": "Oletus huone",
"accessories.control.default_running_time": "Oletus käyntiaika",
"accessories.control.dehumidifying": "Kosteuden poisto",
"accessories.control.detected": "Detected",
"accessories.control.drag_here": "Raaha tähän",
"accessories.control.fan": "Tuuletin",
"accessories.control.heat": "Lämmitys",
Expand All @@ -24,6 +25,7 @@
"accessories.control.locked": "Lukittu",
"accessories.control.mute": "Vaimennus",
"accessories.control.night": "",
"accessories.control.not_detected": "Not Detected",
"accessories.control.not_mute": "Päällä",
"accessories.control.off": "Pois",
"accessories.control.on": "Päällä",
Expand Down
2 changes: 2 additions & 0 deletions ui/src/i18n/fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"accessories.control.default_room": "Pièce par défaut",
"accessories.control.default_running_time": "Durée d'exécution par défaut",
"accessories.control.dehumidifying": "Déshumidifier",
"accessories.control.detected": "Detected",
"accessories.control.drag_here": "Glisser-déposer ici",
"accessories.control.fan": "Ventilateur",
"accessories.control.heat": "Chauffer",
Expand All @@ -24,6 +25,7 @@
"accessories.control.locked": "Verrouillé",
"accessories.control.mute": "Son Coupé",
"accessories.control.night": "Nuit",
"accessories.control.not_detected": "Not Detected",
"accessories.control.not_mute": "Son Actif",
"accessories.control.off": "Off",
"accessories.control.on": "On",
Expand Down
2 changes: 2 additions & 0 deletions ui/src/i18n/he.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"accessories.control.default_room": "חדר ברירת מחדל",
"accessories.control.default_running_time": "זמן ריצה דיפולטיבי",
"accessories.control.dehumidifying": "מוריד לחות",
"accessories.control.detected": "Detected",
"accessories.control.drag_here": "גרור לכאן",
"accessories.control.fan": "מאוורר",
"accessories.control.heat": "חום",
Expand All @@ -24,6 +25,7 @@
"accessories.control.locked": "נעול",
"accessories.control.mute": "השתק",
"accessories.control.night": "לילה",
"accessories.control.not_detected": "Not Detected",
"accessories.control.not_mute": "פועל",
"accessories.control.off": "כבוי",
"accessories.control.on": "פועל",
Expand Down
2 changes: 2 additions & 0 deletions ui/src/i18n/hu.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"accessories.control.default_room": "Default Room",
"accessories.control.default_running_time": "Default Running Time",
"accessories.control.dehumidifying": "Dehumidifying",
"accessories.control.detected": "Detected",
"accessories.control.drag_here": "Drag Here",
"accessories.control.fan": "Fan",
"accessories.control.heat": "Heat",
Expand All @@ -24,6 +25,7 @@
"accessories.control.locked": "Locked",
"accessories.control.mute": "Mute",
"accessories.control.night": "Night",
"accessories.control.not_detected": "Not Detected",
"accessories.control.not_mute": "On",
"accessories.control.off": "Off",
"accessories.control.on": "On",
Expand Down
2 changes: 2 additions & 0 deletions ui/src/i18n/id.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"accessories.control.default_room": "Ruangan Standar",
"accessories.control.default_running_time": "Waktu Berjalan Bawaan",
"accessories.control.dehumidifying": "Hilangkan Kelembaban",
"accessories.control.detected": "Detected",
"accessories.control.drag_here": "Seret Ke sini",
"accessories.control.fan": "Kipas",
"accessories.control.heat": "Panas",
Expand All @@ -24,6 +25,7 @@
"accessories.control.locked": "Terkunci",
"accessories.control.mute": "Bisu",
"accessories.control.night": "Malam",
"accessories.control.not_detected": "Not Detected",
"accessories.control.not_mute": "Hidup",
"accessories.control.off": "Mati",
"accessories.control.on": "Hidup",
Expand Down
2 changes: 2 additions & 0 deletions ui/src/i18n/it.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"accessories.control.default_room": "Stanza predefinita",
"accessories.control.default_running_time": "Tempo di esecuzione predefinito",
"accessories.control.dehumidifying": "Deumidificando",
"accessories.control.detected": "Detected",
"accessories.control.drag_here": "Trascina qui",
"accessories.control.fan": "Ventola",
"accessories.control.heat": "Caldo",
Expand All @@ -24,6 +25,7 @@
"accessories.control.locked": "Chiuso",
"accessories.control.mute": "Muto",
"accessories.control.night": "Notte",
"accessories.control.not_detected": "Not Detected",
"accessories.control.not_mute": "Acceso",
"accessories.control.off": "Spento",
"accessories.control.on": "Acceso",
Expand Down
Loading

0 comments on commit c2c9c4f

Please sign in to comment.