|
| 1 | +name: Bug report |
| 2 | +description: Report a problem with Hame Relay |
| 3 | +title: "[Bug] short description of the problem" |
| 4 | +labels: ["bug", "needs-triage"] |
| 5 | +body: |
| 6 | + - type: markdown |
| 7 | + attributes: |
| 8 | + value: | |
| 9 | + Thanks for taking the time to file a report. Please fill in every required field — incomplete reports are hard to triage and may be closed. |
| 10 | +
|
| 11 | + - type: checkboxes |
| 12 | + id: preflight |
| 13 | + attributes: |
| 14 | + label: Before you submit |
| 15 | + options: |
| 16 | + - label: I have read the [README](https://github.com/tomquist/hame-relay#readme) and my question is not answered there. |
| 17 | + required: true |
| 18 | + - label: I have searched [existing issues](https://github.com/tomquist/hame-relay/issues?q=is%3Aissue) and this is not a duplicate. |
| 19 | + required: true |
| 20 | + |
| 21 | + - type: dropdown |
| 22 | + id: devices |
| 23 | + attributes: |
| 24 | + label: Battery / device models |
| 25 | + description: Which Marstek device(s) are involved? Select all that apply. |
| 26 | + multiple: true |
| 27 | + options: |
| 28 | + - Marstek Saturn / B2500 |
| 29 | + - Marstek Venus |
| 30 | + - Marstek Jupiter |
| 31 | + - Marstek Jupiter Plus |
| 32 | + - Marstek CT002 |
| 33 | + - Marstek CT003 |
| 34 | + - Other / not sure |
| 35 | + validations: |
| 36 | + required: true |
| 37 | + |
| 38 | + - type: input |
| 39 | + id: version |
| 40 | + attributes: |
| 41 | + label: Version |
| 42 | + description: Exact Home Assistant add-on version or Docker image tag. |
| 43 | + placeholder: "e.g. 1.3.4, latest, next" |
| 44 | + validations: |
| 45 | + required: true |
| 46 | + |
| 47 | + - type: dropdown |
| 48 | + id: deployment |
| 49 | + attributes: |
| 50 | + label: Deployment |
| 51 | + description: How are you running Hame Relay? |
| 52 | + options: |
| 53 | + - Home Assistant add-on |
| 54 | + - Docker |
| 55 | + - Docker Compose |
| 56 | + - Other |
| 57 | + validations: |
| 58 | + required: true |
| 59 | + |
| 60 | + - type: dropdown |
| 61 | + id: b2500-mode |
| 62 | + attributes: |
| 63 | + label: B2500 MQTT configuration |
| 64 | + description: | |
| 65 | + Only relevant if you have a B2500. See the *How It Works* section of the [README](https://github.com/tomquist/hame-relay#how-it-works) for the difference between Mode 1 and Mode 2. |
| 66 | + options: |
| 67 | + - "Yes — B2500 configured with my local MQTT broker (Mode 1)" |
| 68 | + - "No — B2500 using the Hame cloud broker (Mode 2)" |
| 69 | + - "Not applicable — I don't have a B2500" |
| 70 | + validations: |
| 71 | + required: true |
| 72 | + |
| 73 | + - type: dropdown |
| 74 | + id: hm2mqtt |
| 75 | + attributes: |
| 76 | + label: Are you using hm2mqtt? |
| 77 | + description: | |
| 78 | + Hame Relay does **not** create Home Assistant entities. If you expected entities to appear in Home Assistant, you likely want [hm2mqtt](https://github.com/tomquist/hm2mqtt) on top of Hame Relay. |
| 79 | + options: |
| 80 | + - "Yes" |
| 81 | + - "No" |
| 82 | + - "Not sure / what is hm2mqtt?" |
| 83 | + validations: |
| 84 | + required: true |
| 85 | + |
| 86 | + - type: textarea |
| 87 | + id: description |
| 88 | + attributes: |
| 89 | + label: What's happening? |
| 90 | + description: Describe what you observe, what you expected to happen, and how to reproduce it. |
| 91 | + placeholder: | |
| 92 | + - What I did: |
| 93 | + - What I expected: |
| 94 | + - What actually happened: |
| 95 | + validations: |
| 96 | + required: true |
| 97 | + |
| 98 | + - type: textarea |
| 99 | + id: config |
| 100 | + attributes: |
| 101 | + label: Configuration |
| 102 | + description: Your Hame Relay configuration. **Remove `username`, `password`, and any credentials in `mqtt_uri` / `broker_url` before pasting.** |
| 103 | + render: yaml |
| 104 | + placeholder: | |
| 105 | + # Add-on options or config.json contents (with credentials removed) |
| 106 | + validations: |
| 107 | + required: true |
| 108 | + |
| 109 | + - type: textarea |
| 110 | + id: logs |
| 111 | + attributes: |
| 112 | + label: Logs |
| 113 | + description: "Relevant log output. Set `LOG_LEVEL=debug` (or `log_level: debug` in the add-on) to capture more detail." |
| 114 | + render: shell |
| 115 | + validations: |
| 116 | + required: false |
0 commit comments