Component for custom frontend cards by c727 · Pull Request #11866 · home-assistant/core

c727 · 2018-01-23T01:04:23Z

Description:

Show custom ha-cards and sate-cards on Home Assistant frontend (custom ui)

For more details or discussion please check the frontend PR.

Frontend PR: home-assistant/frontend#831
Docs PR: home-assistant/home-assistant.io#4552

Checklist:

The code change is tested and works locally.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code does not interact with devices:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
Tests have been added to verify that the new code works.

tbd

houndci-bot · 2018-01-23T01:04:35Z

+
+    return True
+
+class CustomCard(Entity):


expected 2 blank lines, found 1

houndci-bot · 2018-01-23T01:04:35Z

+
+
+    if not entities:
+        return False    


trailing whitespace

houndci-bot · 2018-01-23T01:04:35Z

+        entities.append(CustomCard(object_id, ha_card, state_card, more_info_card, config))
+
+
+    if not entities:


too many blank lines (2)

houndci-bot · 2018-01-23T01:04:35Z

+        state_card = cfg.get(CONF_STATE_CARD)
+        more_info_card = cfg.get(CONF_MORE_INFO_CARD)
+        config = cfg.get(CONF_CONFIG)
+        entities.append(CustomCard(object_id, ha_card, state_card, more_info_card, config))


line too long (91 > 79 characters)

houndci-bot · 2018-01-23T14:29:25Z

+        else:
+            self.entity_id = ENTITY_ID_FORMAT_STATE_CARD.format(object_id)
+            self._state = state_card
+


blank line contains whitespace

houndci-bot · 2018-01-23T14:29:25Z

+    """Representation of a custom card."""
+
+    def __init__(self, object_id, ha_card, state_card, more_info_card, config):
+        """Initialize a custom card."""        


trailing whitespace

houndci-bot · 2018-01-23T14:29:25Z

+            return False
+
+        entities.append(CustomCard(object_id, ha_card, state_card,
+                                    more_info_card, config))


continuation line over-indented for visual indent

houndci-bot · 2018-01-23T14:29:25Z

+        config = cfg.get(CONF_CONFIG)
+
+        if ha_card == None and state_card == None:
+            _LOGGER.error("Entity config must contain ha_card and/or state_card ({}).".format(object_id))


line too long (105 > 79 characters)

houndci-bot · 2018-01-23T14:29:26Z

+        more_info_card = cfg.get(CONF_MORE_INFO_CARD)
+        config = cfg.get(CONF_CONFIG)
+
+        if ha_card == None and state_card == None:


comparison to None should be 'if cond is None:'

houndci-bot · 2018-01-23T14:34:09Z

+            return False
+
+        entities.append(CustomCard(object_id, ha_card, state_card,
+            more_info_card, config))


continuation line under-indented for visual indent

houndci-bot · 2018-01-23T14:34:09Z

+
+        if ha_card is None and state_card is None:
+            _LOGGER.error("Entity config must contain ha_card " +
+                "and/or state_card ({}).".format(object_id))


continuation line under-indented for visual indent

balloob · 2018-01-24T06:53:52Z

+
+DOMAIN = 'custom_card'
+
+ENTITY_ID_FORMAT_HA_CARD = 'custom_ha_card' + '.{}'


Components are only allowed to create entities with the domain of the entity equal to the component name.

So I should create 2 components instead? The problem is that cards on frontend are domain specific

Hmm.. let me check the code again...

balloob · 2018-01-24T06:54:17Z

Great idea!

Don't forget to add tests.

andrey-git · 2018-01-24T20:09:41Z

I think this solution is too partial.

There are a few issue that we want to solve:

Use UI-only component like floorplan. Using this new custom_component for this is no easier than using sensor.template or something similar.
Passing configuration to UI custom components: This solution doesn't address that at all.
Changing a state-card/full-card/more-info - this addresses this for UI-only component, but "real" components still need to use customize.

My proposal (all steps independent):

Make a (core) service instead that can add/remove a dummy entity, like is already implemented for groups.
Implement the proposal from here: RFC: Customization and attributes #10732 (comment) to make a component that hold config data.
The FE PR can still be submitted with minor changes - state/full/more-info cards are controlled via attributes set by customize (and will move to config from (2) once implemented)

c727 · 2018-01-24T20:41:10Z

thanks for the feedback and linking your RFC, I will check it :)

c727 · 2018-01-24T23:32:59Z

@andrey-git

I can't understand your comparison with template.sensor. Custom_card cards use their own entity instead of hijacking another entity's card. Also I don't see an advantage in using a service since I don't want to add/remove/change my entities/cards at runtime
As I suggested in frontend PR I'd like to add an API to load the config. Is there a path to store data in frontend like window.storage.domain[domain].config or window.storage.entity[entity_id].config as I don't want to call the API 3 times (one for every cardtype) for each entity?
Correct, "real" components still should use customize:. Also the config API is only for custom_card UI's and not for "real" component cards or for your state-card-custom-ui.

@balloob
I need 2 domains since full card or state card is bound to domain name. I can create 2/3 (2 services) separate components if you want?

balloob · 2018-01-25T23:39:20Z

Note that there is already an API to create/update "dummy" entities. It's the StateMachine set_state API.

It's however lower layer and thus shouldn't be linked to services (it's available via Rest API though).

You can always do a custom component like this:

@asyncio.coroutine
def async_setup(hass, config):
    hass.states.async_set('custom_card.bla', 'yay', { 'custom_card': 'slim-camera' })

houndci-bot · 2018-01-26T15:49:04Z

+        return web.Response(
+            body = str(res),
+            status = state,
+            content_type = 'application/json',


unexpected spaces around keyword / parameter equals

houndci-bot · 2018-01-26T15:49:04Z

+
+        return web.Response(
+            body = str(res),
+            status = state,


unexpected spaces around keyword / parameter equals

houndci-bot · 2018-01-26T15:49:04Z

+            state = 200
+
+        return web.Response(
+            body = str(res),


unexpected spaces around keyword / parameter equals

houndci-bot · 2018-01-26T15:49:04Z

+            res = { "config": None }
+            state = 400
+        else:
+            res = { "config": config }


whitespace after '{'
whitespace before '}'

houndci-bot · 2018-01-26T15:49:04Z

+        try:
+            config = self._card_configs[data['entity_id']]
+        except KeyError:
+            res = { "config": None }


whitespace after '{'
whitespace before '}'

houndci-bot · 2018-01-26T15:49:04Z

+        vol.Required('entity_id'): str,
+    }))
+
+    @asyncio.coroutine


blank lines found after function decorator

houndci-bot · 2018-01-26T15:49:04Z

+            card_configs[entity_id] = config
+
+        hass.states.async_set(entity_id, state, attributes)
+


blank line contains whitespace

houndci-bot · 2018-01-30T00:39:02Z

+        self.assertEqual('full-card',
+                         state_3.attributes.get('full_card'))
+        self.assertEqual('state-card',
+                         state_3.attributes.get('state_card'))                         


trailing whitespace

houndci-bot · 2018-01-30T00:39:02Z

+                'full_card': 'full-card',
+            },
+            'test_2': {
+                'state_card': 'state-card',                


trailing whitespace

houndci-bot · 2018-01-30T00:39:02Z

+                setup_component(self.hass, DOMAIN, {DOMAIN: cfg}))
+
+
+    def test_config_options(self):


too many blank lines (2)

houndci-bot · 2018-01-30T00:39:02Z

+import logging
+
+from homeassistant.core import CoreState, State
+from homeassistant.setup import setup_component, async_setup_component


'homeassistant.setup.async_setup_component' imported but unused

houndci-bot · 2018-01-30T00:39:02Z

+import unittest
+import logging
+
+from homeassistant.core import CoreState, State


'homeassistant.core.CoreState' imported but unused
'homeassistant.core.State' imported but unused

houndci-bot · 2018-01-30T00:39:02Z

@@ -0,0 +1,86 @@
+"""The tests the custom cards component."""
+# pylint: disable=protected-access
+import asyncio


'asyncio' imported but unused

houndci-bot · 2018-01-30T14:21:28Z

+        try:
+            config = self._card_configs[data['entity_id']]
+        except KeyError:
+            return self.json_message('For this entity is no config available.', HTTP_BAD_REQUEST)


line too long (97 > 79 characters)

balloob · 2018-02-13T06:52:55Z

+            config = self._card_configs[data['entity_id']]
+        except KeyError:
+            return self.json_message('For this entity is no config available.',
+                                     HTTP_BAD_REQUEST)


Should be 404 (not found) instead of 400 (bad request)

balloob · 2018-02-13T07:01:01Z

+        more_info_card = cfg.get(CONF_MORE_INFO_CARD)
+        config = cfg.get(CONF_CONFIG)
+
+        if full_card is None and state_card is None:


Use cv.has_at_least_one_key

balloob · 2018-02-13T07:01:43Z

+        if config:
+            card_configs[entity_id] = json.dumps(config)
+
+        hass.states.async_set(entity_id, state, attributes)


We will need 2 components. We can't have 1 component create entities that are under another domain.

c727 · 2018-02-28T00:04:55Z

functionality will be included in frontend entity registry

Component for custom frontend cards

e954b70

tbd

homeassistant added cla-signed new-platform integration: custom_card labels Jan 23, 2018

houndci-bot reviewed Jan 23, 2018

View reviewed changes

c727 mentioned this pull request Jan 23, 2018

Add support for custom_card component home-assistant/frontend#831

Closed

c727 changed the title ~~Component for custom frontend cards~~ [WIP] Component for custom frontend cards Jan 23, 2018

Improve code

87fef66

homeassistant added the cla-signed label Jan 23, 2018

houndci-bot reviewed Jan 23, 2018

View reviewed changes

Fix Hound

21d2852

houndci-bot reviewed Jan 23, 2018

View reviewed changes

Fix Hound

7720351

balloob reviewed Jan 24, 2018

View reviewed changes

Update based on feedback

174da22

homeassistant added the cla-signed label Jan 26, 2018

houndci-bot reviewed Jan 26, 2018

View reviewed changes

c727 added 3 commits January 26, 2018 16:51

Hound

dac1609

Lint

2736fca

Added tests, need help here

ac915aa

houndci-bot reviewed Jan 30, 2018

View reviewed changes

Improvenents for config

53f7ff0

houndci-bot reviewed Jan 30, 2018

View reviewed changes

c727 added 2 commits January 30, 2018 15:25

Hound

5b1abbe

Update

56e40b4

c727 mentioned this pull request Jan 30, 2018

Docs for custom card component home-assistant/home-assistant.io#4552

Closed

2 tasks

c727 changed the title ~~[WIP] Component for custom frontend cards~~ Component for custom frontend cards Jan 30, 2018

Fix component

7fd87f5

homeassistant added the cla-signed label Jan 30, 2018

Fix tests

179c364

c727 mentioned this pull request Feb 1, 2018

RFC: Customization and attributes #10732

Closed

balloob reviewed Feb 13, 2018

View reviewed changes

c727 closed this Feb 28, 2018

home-assistant locked and limited conversation to collaborators May 29, 2018

		entities.append(CustomCard(object_id, ha_card, state_card, more_info_card, config))


		if not entities:


		DOMAIN = 'custom_card'

		ENTITY_ID_FORMAT_HA_CARD = 'custom_ha_card' + '.{}'

		card_configs[entity_id] = config

		hass.states.async_set(entity_id, state, attributes)

		setup_component(self.hass, DOMAIN, {DOMAIN: cfg}))


		def test_config_options(self):

Uh oh!

Conversation

c727 commented Jan 23, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

balloob commented Jan 24, 2018

Uh oh!

andrey-git commented Jan 24, 2018

Uh oh!

c727 commented Jan 24, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

c727 commented Jan 24, 2018

Uh oh!

balloob commented Jan 25, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

c727 commented Jan 23, 2018 •

edited

Loading

c727 commented Jan 24, 2018 •

edited

Loading