ParadoxAlarmInterface/pai

option to use entity numbers instead of names

Open

#181 opened on Oct 11, 2020

View on GitHub
 (4 comments) (1 reaction) (0 assignees)Python (113 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (414 stars)
PR merge metrics
 (PR metrics pending)

Description

PAI sends MQTT messages into topics pattern like "paradox/states/zones/name/property". In case of changing the zone labels, it requires the reconfiguration of any systems receiving the messages.

Feature description

It would be useful to have a configuration option, when enabled the mqtt topics look like "paradox/states/zones/zone#/property" (and likewise for other entities as partitions, outputs, etc). Also the entity name could be published in a separate subtopic (e.g. paradox/states/zones/zone#/label")

Contributor guide

Research direction
Look for where MQTT topic strings are constructed using entity names, and identify existing configuration options to add a new one for using entity numbers. Also consider how to publish the label separately.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70