|
1 | | -name: Feature Request |
2 | | -description: Suggest a new feature |
3 | | -title: "[Feature]: " |
4 | | -labels: ["enhancement"] |
5 | | -body: |
6 | | -- type: markdown |
7 | | - attributes: |
8 | | - value: | |
9 | | - Thanks for suggesting a new feature! |
10 | | -- type: checkboxes |
11 | | - id: docs-read |
12 | | - attributes: |
13 | | - label: I have read the documentation and contribution instructions |
14 | | - options: |
15 | | - - label: I have read the [documentation](https://github.com/tomer-w/victron_mqtt?tab=contributing-ov-file#finding-mqtt-topics-with-mqtt-explorer). |
16 | | - required: true |
17 | | - - label: I tried to use mqtt-explorer as described in the docs to extract the topics I care about. |
18 | | - required: true |
19 | | -- type: textarea |
20 | | - id: feature-description |
21 | | - attributes: |
22 | | - label: Describe the feature |
23 | | - description: A clear and concise description of the feature you'd like to see. |
24 | | - placeholder: Tell us what you want! |
25 | | - validations: |
26 | | - required: true |
27 | | -- type: textarea |
28 | | - id: mqtt-topics |
29 | | - attributes: |
30 | | - label: Required MQTT topics |
31 | | - description: Please provide the MQTT topics required for this feature. Remove the installation ID from the topic strings (it is confidential). For each topic, include its meaning and units, and paste an example payload or value you observed in mqtt-explorer. |
32 | | - placeholder: | |
33 | | - Provide each topic using the format below: |
34 | | -
|
35 | | - Example format and entries: |
36 | | -
|
37 | | - - topic: N/+/battery/+/Dc/0/Voltage |
38 | | - meaning: Battery voltage |
39 | | - units: V |
40 | | - example_value: {"value":13.460000038146973} |
41 | | -
|
42 | | - - topic: N/+/battery/+/Dc/0/Current |
43 | | - meaning: Battery current (positive = charging, negative = discharging) |
44 | | - units: A |
45 | | - example_value: {"value":5.12345} |
46 | | -
|
47 | | - - topic: N/+/tank/+/Remaining |
48 | | - meaning: Remaining capacity of the tank |
49 | | - units: % |
50 | | - example_value: {"value":75} |
51 | | -
|
52 | | - If you have many topics, list them one per bullet using the same fields above (topic, meaning, units, example_value). |
53 | | - validations: |
54 | | - required: true |
55 | | -- type: textarea |
56 | | - id: additional-context |
57 | | - attributes: |
58 | | - label: Additional context |
59 | | - description: Add any other context or screenshots about the feature request here. |
60 | | - validations: |
61 | | - required: false |
| 1 | +name: Feature Request |
| 2 | +description: Suggest a new feature |
| 3 | +title: "[Feature]: " |
| 4 | +labels: ["enhancement"] |
| 5 | +body: |
| 6 | +- type: markdown |
| 7 | + attributes: |
| 8 | + value: | |
| 9 | + Thanks for suggesting a new feature! |
| 10 | +- type: checkboxes |
| 11 | + id: docs-read |
| 12 | + attributes: |
| 13 | + label: I have read the documentation and contribution instructions |
| 14 | + options: |
| 15 | + - label: I have read the [documentation](https://github.com/tomer-w/victron_mqtt?tab=contributing-ov-file#finding-mqtt-topics-with-mqtt-explorer). |
| 16 | + required: true |
| 17 | + - label: I tried to use mqtt-explorer as described in the docs to extract the topics I care about. |
| 18 | + required: true |
| 19 | +- type: textarea |
| 20 | + id: feature-description |
| 21 | + attributes: |
| 22 | + label: Describe the feature |
| 23 | + description: A clear and concise description of the feature you'd like to see. |
| 24 | + placeholder: Tell us what you want! |
| 25 | + validations: |
| 26 | + required: true |
| 27 | +- type: textarea |
| 28 | + id: mqtt-topics |
| 29 | + attributes: |
| 30 | + label: Required MQTT topics |
| 31 | + description: Please provide the MQTT topics required for this feature. Remove the installation ID from the topic strings (it is confidential). For each topic, include its meaning and units, and paste an example payload or value you observed in mqtt-explorer. |
| 32 | + placeholder: | |
| 33 | + Provide each topic using the format below: |
| 34 | +
|
| 35 | + Example format and entries: |
| 36 | +
|
| 37 | + - topic: N/+/battery/+/Dc/0/Voltage |
| 38 | + meaning: Battery voltage |
| 39 | + units: V |
| 40 | + example_value: {"value":13.460000038146973} |
| 41 | +
|
| 42 | + - topic: N/+/battery/+/Dc/0/Current |
| 43 | + meaning: Battery current (positive = charging, negative = discharging) |
| 44 | + units: A |
| 45 | + example_value: {"value":5.12345} |
| 46 | +
|
| 47 | + - topic: N/+/tank/+/Remaining |
| 48 | + meaning: Remaining capacity of the tank |
| 49 | + units: % |
| 50 | + example_value: {"value":75} |
| 51 | +
|
| 52 | + If you have many topics, list them one per bullet using the same fields above (topic, meaning, units, example_value). |
| 53 | + validations: |
| 54 | + required: true |
| 55 | +- type: textarea |
| 56 | + id: additional-context |
| 57 | + attributes: |
| 58 | + label: Additional context |
| 59 | + description: Add any other context or screenshots about the feature request here. |
| 60 | + validations: |
| 61 | + required: false |
0 commit comments