From 5bb72bc696ad00d261d8906d0a6676444c4625d9 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Wed, 30 May 2018 23:21:41 -0400 Subject: [PATCH] Add placeholders for entities --- docs/entity_climate.md | 16 ++++++++++++++++ docs/entity_cover.md | 16 ++++++++++++++++ docs/entity_fan.md | 16 ++++++++++++++++ docs/entity_light.md | 16 ++++++++++++++++ docs/entity_lock.md | 16 ++++++++++++++++ docs/entity_media_player.md | 16 ++++++++++++++++ docs/entity_remote.md | 16 ++++++++++++++++ docs/entity_vacuum.md | 16 ++++++++++++++++ website/i18n/en.json | 18 +++++++++++++++++- website/sidebars.json | 8 ++++++++ 10 files changed, 153 insertions(+), 1 deletion(-) create mode 100644 docs/entity_climate.md create mode 100644 docs/entity_cover.md create mode 100644 docs/entity_fan.md create mode 100644 docs/entity_light.md create mode 100644 docs/entity_lock.md create mode 100644 docs/entity_media_player.md create mode 100644 docs/entity_remote.md create mode 100644 docs/entity_vacuum.md diff --git a/docs/entity_climate.md b/docs/entity_climate.md new file mode 100644 index 00000000..a5e43701 --- /dev/null +++ b/docs/entity_climate.md @@ -0,0 +1,16 @@ +--- +title: Climate Entity +sidebar_label: Climate +--- + +> This entry is incomplete. Contribution welcome. + +## Properties + +> Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data. + +| Name | Type | Default | Description +| ---- | ---- | ------- | ----------- + +## Methods + diff --git a/docs/entity_cover.md b/docs/entity_cover.md new file mode 100644 index 00000000..0d53085c --- /dev/null +++ b/docs/entity_cover.md @@ -0,0 +1,16 @@ +--- +title: Cover Entity +sidebar_label: Cover +--- + +> This entry is incomplete. Contribution welcome. + +## Properties + +> Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data. + +| Name | Type | Default | Description +| ---- | ---- | ------- | ----------- + +## Methods + diff --git a/docs/entity_fan.md b/docs/entity_fan.md new file mode 100644 index 00000000..0605dd46 --- /dev/null +++ b/docs/entity_fan.md @@ -0,0 +1,16 @@ +--- +title: Fan Entity +sidebar_label: Fan +--- + +> This entry is incomplete. Contribution welcome. + +## Properties + +> Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data. + +| Name | Type | Default | Description +| ---- | ---- | ------- | ----------- + +## Methods + diff --git a/docs/entity_light.md b/docs/entity_light.md new file mode 100644 index 00000000..7fd9020e --- /dev/null +++ b/docs/entity_light.md @@ -0,0 +1,16 @@ +--- +title: Light Entity +sidebar_label: Light +--- + +> This entry is incomplete. Contribution welcome. + +## Properties + +> Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data. + +| Name | Type | Default | Description +| ---- | ---- | ------- | ----------- + +## Methods + diff --git a/docs/entity_lock.md b/docs/entity_lock.md new file mode 100644 index 00000000..30ef3168 --- /dev/null +++ b/docs/entity_lock.md @@ -0,0 +1,16 @@ +--- +title: Lock Entity +sidebar_label: Lock +--- + +> This entry is incomplete. Contribution welcome. + +## Properties + +> Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data. + +| Name | Type | Default | Description +| ---- | ---- | ------- | ----------- + +## Methods + diff --git a/docs/entity_media_player.md b/docs/entity_media_player.md new file mode 100644 index 00000000..a2798bac --- /dev/null +++ b/docs/entity_media_player.md @@ -0,0 +1,16 @@ +--- +title: Media Player Entity +sidebar_label: Media Player +--- + +> This entry is incomplete. Contribution welcome. + +## Properties + +> Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data. + +| Name | Type | Default | Description +| ---- | ---- | ------- | ----------- + +## Methods + diff --git a/docs/entity_remote.md b/docs/entity_remote.md new file mode 100644 index 00000000..75725f62 --- /dev/null +++ b/docs/entity_remote.md @@ -0,0 +1,16 @@ +--- +title: Remote Entity +sidebar_label: Remote +--- + +> This entry is incomplete. Contribution welcome. + +## Properties + +> Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data. + +| Name | Type | Default | Description +| ---- | ---- | ------- | ----------- + +## Methods + diff --git a/docs/entity_vacuum.md b/docs/entity_vacuum.md new file mode 100644 index 00000000..766862ca --- /dev/null +++ b/docs/entity_vacuum.md @@ -0,0 +1,16 @@ +--- +title: Vacuum Entity +sidebar_label: Vacuum +--- + +> This entry is incomplete. Contribution welcome. + +## Properties + +> Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data. + +| Name | Type | Default | Description +| ---- | ---- | ------- | ----------- + +## Methods + diff --git a/website/i18n/en.json b/website/i18n/en.json index 20183bbd..5189e486 100644 --- a/website/i18n/en.json +++ b/website/i18n/en.json @@ -52,12 +52,28 @@ "development_validation": "Validate the input", "entity_binary_sensor": "Binary Sensor Entity", "Binary Sensor": "Binary Sensor", + "entity_climate": "Climate Entity", + "Climate": "Climate", + "entity_cover": "Cover Entity", + "Cover": "Cover", + "entity_fan": "Fan Entity", + "Fan": "Fan", "entity_index": "Entity", + "entity_light": "Light Entity", + "Light": "Light", + "entity_lock": "Lock Entity", + "Lock": "Lock", + "entity_media_player": "Media Player Entity", + "Media Player": "Media Player", "entity_registry_index": "Entity Registry", + "entity_remote": "Remote Entity", + "Remote": "Remote", "entity_sensor": "Sensor Entity", "Sensor": "Sensor", "entity_switch": "Switch Entity", "Switch": "Switch", + "entity_vacuum": "Vacuum Entity", + "Vacuum": "Vacuum", "entity_weather": "Weather Entity", "Weather": "Weather", "external_api_rest_python": "REST API - Python bindings", @@ -106,7 +122,7 @@ "Data Entry Flow": "Data Entry Flow", "Entity Registry": "Entity Registry", "Extending the frontend": "Extending the frontend", - "Customizing the frontend": "Customizing the frontend", + "Custom UI": "Custom UI", "Developing a feature": "Developing a feature", "Development 101": "Development 101", "Creating Platforms": "Creating Platforms", diff --git a/website/sidebars.json b/website/sidebars.json index 072e5656..65138c6e 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -9,8 +9,16 @@ "Entities": [ "entity_index", "entity_binary_sensor", + "entity_climate", + "entity_cover", + "entity_fan", + "entity_light", + "entity_lock", + "entity_media_player", + "entity_remote", "entity_sensor", "entity_switch", + "entity_vacuum", "entity_weather" ], "Authentication": [