Skip to content

Commit 7f56f74

Browse files
committed
docs: add placeholder mark and home-assistant/brands instructions
HA/HACS icons come from home-assistant/brands, not this repo. Add an original placeholder SVG, a README banner, and branding/ with the exact icon specs, PR steps and a note on the CHINT trademark.
1 parent d38b987 commit 7f56f74

3 files changed

Lines changed: 85 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<p align="center">
2+
<img src="branding/dtsu666_meter.svg" alt="DTSU666 Meter" width="120" height="120">
3+
</p>
4+
15
# DTSU666 Energy Meter — Home Assistant integration (Modbus TCP)
26

37
Home Assistant integration that reads a **CHINT DTSU666 / DTSU666-H** three-phase
@@ -94,6 +98,16 @@ logger:
9498
custom_components.dtsu666_meter: debug
9599
```
96100

101+
## Icon
102+
103+
Home Assistant / HACS pull the integration icon from the central
104+
[`home-assistant/brands`](https://github.com/home-assistant/brands) repo, **not
105+
from this repository** — so a generic placeholder is shown until a brand is
106+
accepted there. See [`branding/README.md`](branding/README.md) for the exact
107+
image specs and the submission steps (and the note on using the CHINT
108+
trademark). The mark in this README is an original placeholder, not the CHINT
109+
logo.
110+
97111
## License
98112

99113
MIT — see `LICENSE`.

‎branding/README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Branding / integration icon
2+
3+
Home Assistant and HACS **do not read icons from this repository**. The icon
4+
shown for an integration comes from the central
5+
[`home-assistant/brands`](https://github.com/home-assistant/brands) repo. Until
6+
a brand is accepted there, HA shows a generic placeholder — that is expected.
7+
8+
`dtsu666_meter.svg` here is an **original placeholder mark** (a neutral
9+
energy-meter motif), used only for this repo's README / GitHub social preview.
10+
It is intentionally **not** the CHINT corporate logo.
11+
12+
## How to get a real icon into Home Assistant
13+
14+
Submit a pull request to `home-assistant/brands`:
15+
16+
```
17+
brands/
18+
custom_integrations/
19+
dtsu666_meter/
20+
icon.png # 256 x 256, square, transparent background, trimmed
21+
logo.png # optional, wider wordmark; transparent background
22+
icon@2x.png # optional 512 x 512 hDPI
23+
```
24+
25+
Requirements (see `home-assistant/brands` CONTRIBUTING):
26+
27+
- PNG, transparent background, content trimmed to the edges.
28+
- `icon.png` exactly 256×256 (square). `icon@2x.png` 512×512 if provided.
29+
- Optimised (e.g. `pngquant` / `oxipng`).
30+
- The domain folder name **must** match the integration domain:
31+
`dtsu666_meter`.
32+
33+
Steps:
34+
35+
1. Fork `home-assistant/brands`, add the files above.
36+
2. `python3 -m script.hassfest` style checks run in CI there — keep sizes exact.
37+
3. Open the PR; the HA team reviews. Once merged, HA/HACS pick the icon up
38+
automatically (no release needed on this side).
39+
40+
## About the CHINT logo (trademark)
41+
42+
The CHINT logo is CHINT's trademark. `home-assistant/brands` does accept
43+
manufacturer logos for device integrations (common practice), **but the image
44+
must be an officially sourced asset** — obtain it from CHINT brand resources or
45+
an authorised source. Do not trace/recreate it.
46+
47+
This project cannot generate or reproduce that trademarked raster logo. Drop an
48+
officially sourced `icon.png` (256×256, transparent) into this folder and it can
49+
be wired into the brands PR.

‎branding/dtsu666_meter.svg‎

Lines changed: 22 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)