Iota wallet by jinnerbichler · Pull Request #11398 · home-assistant/core

jinnerbichler · 2017-12-31T13:14:05Z

Description:

Added a new platform for IOTA. A cryptocurrency specialized for IoT use cases (including smart home applications :) )

Pull request in home-assistant.github.io with documentation: home-assistant/home-assistant.io#4314

Example entry for `configuration.yaml`:

# configuration.yaml example
iota:
  iri: https://testnet140.tangle.works:443
  testnet: true
  wallets:
    - name: Default Wallet
      seed: OYYAHJDBNPHLVCKWMVBCYBYSUSSWLIDQ9AAXOMAMAMSUA9Y9PWXOCYGXIMLLBURGRHEZAZPEMUIXVIVQC

Checklist:

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

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

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

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.

homeassistant · 2017-12-31T13:14:06Z

Hi @jinnerbichler,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

houndci-bot · 2017-12-31T13:14:12Z

+        """Fetch new attribures IRI node."""
+        node_info = self.api.get_node_info()
+        self._state = node_info.get('appVersion')
+        self._attr = {k: str(v) for k, v in node_info.items()}  # convert values to raw string formats


line too long (102 > 79 characters)

houndci-bot · 2017-12-31T13:14:12Z

+        """Initialize the sensor."""
+
+        super().__init__(name='Node Info', seed=None,
+                         iri=iota_config['iri'], is_testnet=iota_config['is_testnet'])


line too long (86 > 79 characters)

houndci-bot · 2017-12-31T13:14:13Z

+        """Initialize the sensor."""
+
+        super().__init__(name=wallet_config['name'], seed=wallet_config['seed'],
+                         iri=iota_config['iri'], is_testnet=iota_config['is_testnet'])


line too long (86 > 79 characters)

houndci-bot · 2017-12-31T13:14:13Z

+    def __init__(self, wallet_config, iota_config):
+        """Initialize the sensor."""
+
+        super().__init__(name=wallet_config['name'], seed=wallet_config['seed'],


line too long (80 > 79 characters)

houndci-bot · 2017-12-31T13:14:13Z

+
+    # Add sensors for wallet balance
+    iota_config = hass.data[IOTA_DOMAIN]
+    balance_sensors = [IotaBalanceSensor(wallet, iota_config) for wallet in iota_config['wallets']]


line too long (99 > 79 characters)

fabaff · 2018-01-05T22:30:19Z

@@ -0,0 +1,97 @@
+"""


There is only a sensor. This doesn't require to include a component.

Hey, not yet. I am going to add more features to this component. Is it necessary to be a sensor only PR?

No, it's the right way to create a component if there is coming a binary sensor or switch platform which can share the common stuff. Otherwise everything can be handled in the platform itself as no sharing is needed.

MartinHjelmare · 2018-01-11T20:15:31Z

+    add_devices(balance_sensors)
+
+    # Add sensor for node information
+    add_devices([IotaNodeSensor(iota_config=iota_config)])


Add all devices in one go.

MartinHjelmare · 2018-01-11T20:17:44Z

+        """Initialize the sensor."""
+        super().__init__(name='Node Info', seed=None, iri=iota_config['iri'],
+                         is_testnet=iota_config['is_testnet'])
+        self._state = ""


Unknown state should be initialized with None.

MartinHjelmare · 2018-01-11T20:18:57Z

+        super().__init__(name='Node Info', seed=None, iri=iota_config['iri'],
+                         is_testnet=iota_config['is_testnet'])
+        self._state = ""
+        self._attr = dict()


Init with {}.

MartinHjelmare · 2018-01-11T20:19:56Z

+    @property
+    def should_poll(self):
+        """Get polling requirement from IOTA device."""
+        return True


This is the default.

thx. removed it

MartinHjelmare · 2018-01-11T20:21:28Z

+
+CONFIG_SCHEMA = vol.Schema({
+    DOMAIN: vol.Schema({
+        vol.Required(CONF_IRI): vol.All(str),


Use cv.string.

You can remove vol.All.

MartinHjelmare · 2018-01-11T20:23:31Z

+    }
+
+    # Set states of IRI config
+    hass.states.set('iota.iri', hass.data[DOMAIN]['iri'])


Why do you want to set these states?

This is the URL of the IOTA node to connect to, which may change. It is a separate state in order to see current URL of the node in the UI.

Report it as a state attribute on the node sensor entity instead.

MartinHjelmare

Please report the two config settings as state attributes instead.

MartinHjelmare · 2018-01-12T06:20:16Z

+
+    # Set states of IRI config
+    hass.states.set('iota.iri', hass.data[DOMAIN]['iri'])
+    hass.states.set('iota.is_testnet', hass.data[DOMAIN]['is_testnet'])


Same as above.

MartinHjelmare

One comment. Otherwise looks good.

MartinHjelmare · 2018-01-14T09:26:01Z

+    """Setup IOTA component."""
+    # Set domain sepecific data
+    iota_config = config[DOMAIN]
+    hass.data[DOMAIN] = {


Configuration is supposed to be past in discovery info dict, ie fourth parameter of load_platform. Only non serializable objects need to go in hass.data.

Thx. Changed it.

So now you don't need to store the iota_config in hass.data. You also need to change setup_platform to access the discovery_info instead of hass.data.

MartinHjelmare · 2018-01-14T16:43:10Z

+
+    # Load platforms
+    for platform in IOTA_PLATFORMS:
+        load_platform(hass, platform, DOMAIN)


Pass the iota_config as the fourth argument and the original config as the fifth argument.

The proper arguments should be passed now.

fabaff · 2018-01-15T15:25:58Z

+    @property
+    def unit_of_measurement(self):
+        """Return the unit of measurement."""
+        return ''


This is not a valid unit of measurement.

fabaff · 2018-01-15T15:26:01Z

+
+        # add values of iri config
+        self._attr['url'] = self.iri
+        self._attr['testnet'] = self.is_testnet


No need to update this as it will never change. Set it when you initialize the sensor.

fabaff · 2018-01-15T15:28:24Z

+                         seed=wallet_config['seed'],
+                         iri=iota_config['iri'],
+                         is_testnet=iota_config['is_testnet'])
+        self._state = 0


Set it to None.

fabaff · 2018-01-15T15:30:29Z

+        self._state = self.api.get_inputs()['totalBalance']
+
+
+class IotaNodeSensor(IotaDevice):


I assume that this should be a binary sensor. A node can be offline or online.

Nope, a node can have multiple attributes, which are changing over time (https://iota.readme.io/v1.2.0/reference#getnodeinfo)

Attributes and state are not the same. A binary sensor can have attributes as well. If a node is always present then it's doesn't make sense.

There are a dozen values available from getNodeInfo. Those details should be exposed as attributes.

Information about the node is part of the attributes of the node sensor and should be part of the wallet.

fabaff · 2018-01-15T15:32:41Z

+    def update(self):
+        """Fetch new attribures IRI node."""
+        node_info = self.api.get_node_info()
+        self._state = node_info.get('appVersion')


How is it useful to know the appVersion of a node as state? Will that change on a regular base? If not then it's just another attribute.

The value of appVersion tells if the version of the node is up-to-date. Yes, the version of the node changes almost every other week.

It would still require an additional part because it only shows the version and not if the node is up-to-date.

fabaff · 2018-01-16T07:55:21Z

+    @property
+    def device_state_attributes(self):
+        """Return the state attributes of the device."""
+        return self._attr


At the moment this will stay empty.

Nope, it's updated in https://github.com/jinnerbichler/home-assistant/blob/iota-wallet/homeassistant/components/sensor/iota.py#L94

Missed that line.

Comments addressed

fabaff

🐦

* upstream/master: (465 commits) Update pyhomematic to 0.1.38 (home-assistant#11936) Implement Alexa temperature sensors (home-assistant#11930) Fixed rfxtrx binary_sensor KeyError on missing optional device_class (home-assistant#11925) Allow setting climate devices to AUTO mode via Google Assistant (home-assistant#11923) fixes home-assistant#11848 (home-assistant#11915) Add "write" service to system_log (home-assistant#11901) Update frontend to 20180126.0 Version 0.62 Allow separate command and state OIDs and payloads in SNMP switch (home-assistant#11075) Add ERC20 tokens to etherscan.io sensor (home-assistant#11916) Report scripts and groups as scenes to Alexa (home-assistant#11900) Minor fix to configuration validation and related log line. (home-assistant#11898) Multi-Room Support for Greenwave Reality (home-assistant#11364) Added Xeoma camera platform (home-assistant#11619) Improve foscam library exception support (home-assistant#11701) Iota wallet (home-assistant#11398) New venstar climate component (home-assistant#11639) Update python-wink version and multiple wink fixes/updates. (home-assistant#11833) Use API to discover Hue if no bridges specified (home-assistant#11909) Clarify emulated hue warning (home-assistant#11910) ...

jinnerbichler added 4 commits December 29, 2017 16:33

worked on first version of IOTA wallet

e3ea17b

added sensor for IRI node

6ddaa34

added requirements

8f07362

ignored new component in test coverage

a1c0bf2

jinnerbichler requested a review from andrey-git as a code owner December 31, 2017 13:14

homeassistant added new-platform integration: iota platform: sensor.iota cla-needed labels Dec 31, 2017

balloobbot added component platform requirement labels Dec 31, 2017

houndci-bot reviewed Dec 31, 2017

View reviewed changes

jinnerbichler mentioned this pull request Dec 31, 2017

Iota wallet home-assistant/home-assistant.io#4314

Merged

2 tasks

homeassistant added cla-signed and removed cla-needed labels Dec 31, 2017

changed length of line

4845cb7

homeassistant added the cla-signed label Dec 31, 2017

fixed linter issues

6cbdb9b

fabaff reviewed Jan 5, 2018

View reviewed changes

MartinHjelmare requested changes Jan 11, 2018

View reviewed changes

changed requested changes

e06b875

MartinHjelmare previously requested changes Jan 12, 2018

View reviewed changes

jinnerbichler added 3 commits January 14, 2018 00:48

moved attributes of IRI node

9890675

change coverage definitions

667146e

Merge remote-tracking branch 'upstream/dev' into iota-wallet

32db13a

MartinHjelmare reviewed Jan 14, 2018

View reviewed changes

changed loading of platforms

aa761ce

MartinHjelmare reviewed Jan 14, 2018

View reviewed changes

changed loading of platforms

676b800

fabaff reviewed Jan 15, 2018

View reviewed changes

jinnerbichler added 2 commits January 15, 2018 16:54

changed initial state of wallet sensor

8b3d767

changed handling of config

d7f1f10

fabaff reviewed Jan 16, 2018

View reviewed changes

jinnerbichler and others added 3 commits January 16, 2018 11:36

changed attribute handling for IOTA node sensor

1fae91a

Follow the component style

03347dc

Fix ordering and docstring

9290828

fabaff mentioned this pull request Jan 25, 2018

Fix remaining issue from #4314 home-assistant/home-assistant.io#4514

Merged

2 tasks

Fix pylint issue

87224b2

homeassistant added the cla-signed label Jan 25, 2018

fabaff approved these changes Jan 25, 2018

View reviewed changes

fabaff merged commit 0db9c04 into home-assistant:dev Jan 25, 2018

balloob mentioned this pull request Jan 26, 2018

0.62 #11921

Merged

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

ghost removed the platform: sensor.iota label Mar 21, 2019

		self._state = self.api.get_inputs()['totalBalance']


		class IotaNodeSensor(IotaDevice):

Uh oh!

Conversation

jinnerbichler commented Dec 31, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml:

Checklist:

Uh oh!

homeassistant commented Dec 31, 2017

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!

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!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare left a comment

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!

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

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!

jinnerbichler commented Dec 31, 2017 •

edited

Loading

Example entry for `configuration.yaml`:

jinnerbichler Jan 13, 2018 •

edited

Loading

MartinHjelmare Jan 14, 2018 •

edited

Loading