43 Commits

Author SHA1 Message Date
Franck Nijhof
af26c20de5
Add icon translations documentation (#2047)
Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
2024-01-19 16:57:06 +01:00
Michael
735b7c04b3
Add placeholder for entity name translations (#1989) 2024-01-19 15:28:18 +01:00
Erik Montnemery
7b109160ce
Add warning about changing device_class etc for entities (#2019) 2023-12-21 08:13:07 +01:00
Erik Montnemery
43dddb8532
Document undocumented entity properties (#2010)
* Document undocumented entity properties

* Apply suggestions from code review

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2023-12-18 17:41:59 +01:00
Erik Montnemery
944533363a
Improve formatting of entity property documentation (#2009) 2023-12-13 15:14:47 +01:00
Erik Montnemery
39be9041e9
Document how entity properties are consumed (#2008)
Co-authored-by: Franck Nijhof <git@frenck.dev>
2023-12-13 14:33:30 +01:00
Martin Hjelmare
32fbbb42bd
Use kw_only in entity description example (#1979) 2023-11-16 13:05:25 +01:00
Martin Hjelmare
55ee5f1d9b
Add entity description docs (#1963)
* Add entity description docs

* Fix typing

* Set available True

* Correct English

Co-authored-by: Allen Porter <allen@thebends.org>

* Sort imports

* Mention description key

---------

Co-authored-by: Allen Porter <allen@thebends.org>
2023-10-31 23:24:15 +01:00
Erik Montnemery
f9ad66c6be
Document how to exclude state attributes from recording (#1926)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Franck Nijhof <git@frenck.dev>
2023-09-21 13:57:09 +02:00
Erik Montnemery
ae7bf6b080
Revert "Document how entity properties are consumed (#1908)" (#1909)
This reverts commit 0e8d42850253af0a1f2e3bc70033e15c62bfd8a8.
2023-09-15 11:49:07 +02:00
J. Nick Koston
0e8d428502
Document how entity properties are consumed (#1908) 2023-09-14 17:49:16 -05:00
Erik Montnemery
e68b90c654
Document that some entities are named by their device class (#1823)
* Document that some entities are named by their device class

* Update docs/core/entity.md

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2023-06-28 17:31:07 +02:00
Erik Montnemery
2265e5c5ae
Clarify translated entity names are preferred (#1808) 2023-06-26 17:33:17 +02:00
Scott Giminiani
6d3f0204d3
Fix minor typo in example code (#1806) 2023-06-19 20:16:29 +02:00
Gregory Zdanowski-House
6b87400525
Correct entity_category to use enum (#1790) 2023-06-05 13:44:46 +02:00
Erik Montnemery
dab13a9432
Add blog post about translatable entity names + improve docs (#1726)
Co-authored-by: Franck Nijhof <git@frenck.dev>
2023-03-27 10:37:36 +02:00
Sameer Puri
44203a143c
Fix internationalization link in entity.md (#1634) 2023-01-18 10:17:24 +01:00
Franck Nijhof
dfd77cabdf
Replace device class strings with enums in dev docs (#1610) 2023-01-04 00:37:28 +02:00
Erik Montnemery
f1212b221d
Document entity translation_key property (#1558) 2022-12-01 09:34:29 +01:00
Erik Montnemery
ee769c7d60
Clarify entity naming (#1437)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2022-08-18 17:16:41 +02:00
Erik Montnemery
6fd2d1babe
Document entity.has_entity_name (#1387)
* Update entity.md

* Tweak

Co-authored-by: Franck Nijhof <git@frenck.dev>
2022-07-08 10:01:03 +02:00
Erik Montnemery
1a1d25eef3
Remove documentation of entity category system (#1320) 2022-05-03 11:28:39 +02:00
Franck Nijhof
e1e4f7f2af
Add visible by default property to base Entity (#1301) 2022-04-25 09:05:20 -07:00
J. Nick Koston
de074a2415
Document impact of extra_state_attributes on frequently updating entities (#1245) 2022-03-21 15:42:25 -07:00
avee87
2962614406
Updated architecture discussions link from issues to discussions (#1199) 2022-01-30 02:09:36 +01:00
Erik Montnemery
427d437ac5
Add examples of entity property methods vs attributes (#1004)
Co-authored-by: Tobias Sauerwein <cgtobi@users.noreply.github.com>
2022-01-24 14:31:38 +01:00
bwduncan
3d7a22aa9f
Fix typos in code example (#1138) 2021-11-16 20:34:20 +01:00
Dave T
79d3ff5ab2
Fix minor typos (#1126) 2021-11-05 07:20:54 +00:00
Erik Montnemery
9b7f099e0e
Document entity category system (#1111)
* Document system entity category

* Add example

* Update entity.md
2021-10-28 15:19:35 +02:00
Erik Montnemery
fc7ffff330
Document entity category (#1088)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Franck Nijhof <git@frenck.dev>
2021-10-15 13:01:08 +02:00
Franck Nijhof
26d427f396
Move attribution attribute to Entity base class (#1080) 2021-10-11 23:15:42 +02:00
Allan Lin
7475cdb1d2
Fix missing link. (#1010) 2021-07-29 16:46:42 +01:00
Erik Montnemery
76f6b1ac08
Further tweak documentation about _attr-style shorthand for properties (#1000)
* Further tweak documentation about _attr-style shorthand for properties

* Update entity.md

* Update air-quality.md

* Update entity.md

* Update air-quality.md

* Update air-quality.md

* Update device-tracker.md

* Update device-tracker.md

* Update fan.md

* Update vacuum.md

* Update entity.md

* Update entity.md

* Move the example to a separate PR
2021-07-15 15:47:48 +02:00
Erik Montnemery
a4fd68603d
Tweak documentation about _attr-style shorthand for properties (#999) 2021-07-08 11:21:43 +02:00
Franck Nijhof
6a85f3685f
Add information about using entity class attribute (#945)
Co-authored-by: Teemu R. <tpr@iki.fi>
2021-05-22 18:19:19 +02:00
Erik Montnemery
4677318bca
Update wording for Entity.icon (#894) 2021-04-22 17:00:53 -07:00
Matthias Alphart
880e00d8f1
use SwitchEntity in example (#887)
instead of deprecated SwitchDevice
2021-04-14 17:33:44 +02:00
J. Nick Koston
5594e42aec
Document that icon should not be set when device_class is set. (#844) 2021-03-10 15:21:23 -08:00
Paulus Schoutsen
bc55ccd987
Reorganize architecture section (#839) 2021-03-10 09:17:54 -08:00
Franck Nijhof
dd7b026064
Replace Entity.device_state_attributes with Entity.extra_state_attributes (#837)
Co-authored-by: Erik Montnemery <erik@montnemery.com>
2021-03-09 15:05:23 +01:00
Thibaut
cc1dadba11
Remove battery related attributes description (#750)
The battery must be now a sensor, not an attribute.
2020-12-17 12:54:41 +01:00
Thibaut
ab8e8b62fc
Remove hidden property documentation (#620)
hidden property has been totally removed.
See https://github.com/home-assistant/core/pull/37041
2020-08-13 10:33:37 +02:00
Franck Nijhof
0145bbbfa7
Move and merge entity documentation (#544) 2020-05-18 14:57:50 +02:00