Skip to content

Commit 7c825d7

Browse files
edwardtfnedwardtfn
committed
Copy Blackymas repo
1 parent 82c8b9f commit 7c825d7

File tree

271 files changed

+27993
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

271 files changed

+27993
-2
lines changed

‎.gitattributes‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
*.tft binary
2+
*.HMI binary

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
---
2+
name: Bug Report
3+
description: If something isn't working as expected, let us know here.
4+
title: "`Bug` "
5+
labels: [Bug]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out a bug report!
11+
12+
We aim to keep everything working perfectly, so your detailed reports are crucial.
13+
14+
Report only one specific issue per submission. If you encounter another issue, create a new report for effective tracking and resolution.
15+
16+
The more detail you provide, the quicker we can help.
17+
18+
> [!WARNING]
19+
> Omit any private or sensitive information, as this bug report will be publicly visible.
20+
21+
- type: markdown
22+
attributes:
23+
value: |
24+
## Version Information
25+
Provide version numbers for TFT, ESPHome, and Blueprint. These can be found on your device's boot screen and in the automation where the blueprint is set.
26+
27+
- type: input
28+
attributes:
29+
label: TFT Version
30+
description: Enter the TFT version number.
31+
placeholder: e.g., 2026020
32+
validations:
33+
required: false
34+
35+
- type: input
36+
attributes:
37+
label: Firmware Version
38+
description: Enter the ESPHome firmware version number.
39+
placeholder: e.g., 2026020
40+
validations:
41+
required: false
42+
43+
- type: input
44+
attributes:
45+
label: Blueprint Version
46+
description: Enter the Blueprint version number.
47+
placeholder: e.g., 2026020
48+
validations:
49+
required: false
50+
51+
- type: dropdown
52+
attributes:
53+
label: Panel Model
54+
description: Select your NSPanel model.
55+
options:
56+
- EU
57+
- US
58+
- US (Landscape)
59+
validations:
60+
required: false
61+
62+
- type: markdown
63+
attributes:
64+
value: |
65+
## Bug Details
66+
67+
- type: textarea
68+
attributes:
69+
label: What is the bug?
70+
description: Describe the bug clearly and concisely.
71+
placeholder: e.g., When I try this, I get this result, but I expected that...
72+
73+
- type: textarea
74+
attributes:
75+
label: Steps to Reproduce
76+
description: Detail the steps to reproduce the behavior. Include screenshots or other relevant information.
77+
placeholder: |
78+
1. Go to '...'
79+
2. Click on '...'
80+
3. See error on '...'
81+
82+
- type: markdown
83+
attributes:
84+
value: |
85+
## Additional Information (Optional)
86+
87+
- type: textarea
88+
attributes:
89+
label: Your Panel's YAML
90+
description: Provide your panel's YAML configuration.
91+
render: yaml
92+
placeholder: |
93+
# Example YAML configuration
94+
# ...
95+
96+
- type: textarea
97+
attributes:
98+
label: ESPHome Logs
99+
render: text
100+
description: >
101+
Access these logs via the **Logs** button on the ESPHome Dashboard.
102+
These logs are crucial for diagnosing issues with your device.
103+
104+
105+
Please follow the guidelines below to ensure the logs are comprehensive:
106+
107+
- **Boot Issues**: If the problem occurs during boot, capture the logs from the start of your device to a minute or two after the boot completes.
108+
Look for errors or unusual messages during this period.
109+
110+
- **TFT File Update Issues**: For problems related to TFT file updates,
111+
include logs from the moment you press the **Update TFT Display** button until a few seconds after the device restarts.
112+
Pay attention to any error messages or warnings during the update process.
113+
114+
- **Other Issues**: For other types of problems, include logs that encompass the issue's onset and continue for a short duration thereafter.
115+
This will help in pinpointing the exact moment and nature of the issue.
116+
117+
118+
Remember, the more detailed the logs, the easier it is to identify and resolve the problem.
119+
120+
- type: textarea
121+
attributes:
122+
label: Home Assistant Logs
123+
render: text
124+
description: >
125+
To access Home Assistant logs, navigate to **Settings** > **System** > [**Logs**](https://my.home-assistant.io/redirect/logs/).
126+
127+
128+
When reporting an issue, please focus on providing logs specifically relevant to the problem:
129+
130+
- **NSPanel Blueprint Automation**: If your issue is related to automation using the NSPanel blueprint, include only those logs that directly pertain to this process.
131+
132+
- **Panel and ESPHome**: For issues involving your panel and ESPHome, carefully select and share logs that show interactions or errors between these components.
133+
134+
- **Relevancy is Key**: To expedite troubleshooting, avoid including logs that are not related to the issue at hand. This helps in focusing on the pertinent information.
135+
136+
137+
Your attention to sharing targeted and relevant log data is greatly appreciated and aids in efficient problem resolution.
138+
...

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
blank_issues_enabled: false
3+
4+
contact_links:
5+
- name: Questions & General Discussions
6+
url: https://github.com/Blackymas/NSPanel_HA_Blueprint/discussions
7+
about: Join our Discussions for community chats, questions, idea sharing, and collaboration. Use Issues for reporting bugs or requesting enhancements.
8+
9+
- name: Troubleshooting TFT Transfer Issues
10+
url: https://github.com/Blackymas/NSPanel_HA_Blueprint/blob/main/docs/tft_upload.md
11+
about: Having trouble transferring a TFT file? Our guide might have the solution.
12+
13+
- name: Resolve Compiling Errors
14+
url: https://github.com/Blackymas/NSPanel_HA_Blueprint/blob/main/docs/error_compiling.md
15+
about: Check this guide if you're experiencing compile errors.
16+
17+
- name: Getting Started Guide
18+
url: https://github.com/Blackymas/NSPanel_HA_Blueprint/blob/main/docs/install.md
19+
about: New to NSPanel HA Blueprint? Start here for installation and setup instructions.
20+
...

‎.github/ISSUE_TEMPLATE/enhancement.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Enhancement Request
3+
description: Suggest an idea for this project
4+
title: "`Enhancement` "
5+
labels: [Enhancement]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: "Thank you for taking the time to suggest an enhancement!"
10+
11+
- type: input
12+
attributes:
13+
label: Enhancement Summary
14+
description: A brief summary of the enhancement.
15+
placeholder: e.g., Add support for XYZ feature...
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
attributes:
21+
label: Detailed Description
22+
description: Please provide a detailed description of the enhancement. Include any specific use cases or functionality you envision.
23+
placeholder: "Describe the enhancement in detail..."
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
attributes:
29+
label: Additional Context
30+
description: "Provide any additional context or screenshots that might help us understand the enhancement better."
31+
placeholder: "Add any other context or screenshots about the enhancement request here."
32+
...

‎.github/workflows/esphome_analyze_memory.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: ESPHome Memory Analysis
3+
4+
# yamllint disable-line rule:truthy
5+
on:
6+
workflow_dispatch:
7+
8+
jobs:
9+
memory-report:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v4
15+
with:
16+
fetch-depth: 0
17+
persist-credentials: true
18+
19+
- name: Build ESPHome memory report in Docker
20+
run: |
21+
mkdir -p .dev
22+
docker run --rm \
23+
-v $PWD:/work \
24+
-w /work \
25+
esphome/esphome:dev \
26+
analyze-memory nspanel_esphome.yaml > .dev/memory_report.txt
27+
28+
- name: Configure Git
29+
run: |
30+
git config --global user.name "github-actions[bot]"
31+
git config --global user.email "github-actions[bot]@users.noreply.github.com"
32+
33+
- name: Commit memory report
34+
run: |
35+
git add .dev/memory_report.txt
36+
git commit -m "Update ESPHome memory report" || echo "No changes to commit"
37+
38+
- name: Push changes
39+
if: github.event_name == 'push'
40+
run: |
41+
git push origin HEAD:${GITHUB_REF#refs/heads/}
42+
...

0 commit comments

Comments
 (0)