Add IBM Watson IoT Platform component by mtreinish · Pull Request #13664 · home-assistant/core

mtreinish · 2018-04-03T21:32:56Z

Description:

This commit adds a new history component for the IBM Watson IoT
Platform. The IBM Watson IoT Platform allows for tracking of devices
and analytics on top of the device data. This new component allows
users to have home assistant automatically populate a watson iot
platform board with device data from devices managed by home assistant.

Related issue (if applicable): fixes #

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#5100

Example entry for `configuration.yaml` (if applicable):

watson_iot:
  organization: 'organization_id'
  type: 'device_type'
  id: 'device_id'
  token: 'auth_token'

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass

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:

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.

houndci-bot · 2018-04-03T21:56:40Z

undefined name 'event'

stevemar

i came here out of interest to check out @mtreinish's PR, stumbled upon a typo or two. Neat stuff.

stevemar · 2018-04-04T00:30:25Z

typos: IoT* Platform*

ezar · 2018-04-04T12:34:48Z

Like it!

dgomes · 2018-05-05T20:05:12Z

Why are you touching xiaomi_miio.py ?

This was a rebase mistake, fixed in the next rev.

dgomes · 2018-05-05T20:21:23Z

You already defined defaults, no need to use get with default just use []

dgomes · 2018-05-05T20:22:01Z

CONF_ORG is required, use conf[CONF_ORG]

dgomes · 2018-05-05T20:24:06Z

You know I'm looking at this again, and I'm not sure what my intent was when I wrote this a month ago. False wouldn't make much sense because if we get a ValueError there _include_state will already be false. I can only assume I meant for it to be true, but I can't remember why. I'm just going to leave it as is, and if I remember what my intent was I'll add a comment here.

Well I think that using exception handling to implement logic is not the best approach... maybe you can rework this part of the code into something more readable and less prone to confusion.

dgomes · 2018-05-05T20:26:34Z

Make 3 a constant declared in the beginning of the file

balloob · 2018-05-17T21:38:22Z

May I ask why you closed this? This was so close to being done 🏁

mtreinish · 2018-06-01T19:14:21Z

The latest revision reworks the logic around setting the device state in the output json to be a bit more clear to address @dgomes comments.

MartinHjelmare · 2018-06-02T11:49:39Z

+
+    include = conf[CONF_INCLUDE]
+    exclude = conf[CONF_EXCLUDE]
+    whitelist_e = set(include.get(CONF_ENTITIES, []))


The empty list default value is already set in the config schema. Don't use dict.get if there are defaults in place. Just use dict[key].

MartinHjelmare · 2018-06-02T11:56:15Z

+
+    client_args = {
+        'org': conf[CONF_ORG],
+        'type': conf.get(CONF_TYPE),


Don't use dict.get for required keys.

MartinHjelmare · 2018-06-02T12:00:48Z

+        self.gateway = gateway
+        self.gateway.connect()
+        self.event_to_json = event_to_json
+        self.max_tries = MAX_TRIES


You can use the constant directly. You don't need to store it in an instance attribute.

This commit adds a new history component for the IBM Watson IoT Platform. The IBM Watson IoT Platform allows for tracking of devices and analytics on top of the device data. This new component allows users to have home assistant automatically populate a watson iot platform board with device data from devices managed by home assistant.

MartinHjelmare

Looks good!

dgomes · 2018-06-02T16:06:11Z

Thanks for coming back and finishing :)

* Add documentation for the new watson_iot component This commit adds documention for the new watson_iot component which was added in home-assistant/core#13664 It links to the official documentation for setting up the cloud service and generating the required auth information. * ✏️ Missing comma * Use configuration tags This commit updates the formatting of the configuration section of the documentation. Previously it manually formatted a list instead of leveraging the templating format. This corrects that oversight and uses the standard format. * 🎨 Adds logo * ⬆️ ha_release -> 0.68 * ✏️ Processed RFC's

gnkarn · 2018-06-28T15:46:13Z

it would be good to add more detail on a config example , as following the docs , the config fails in loading the component :
in my case the config is simple but couldnt make it to work

watson_iot:
  organization: 'xxxxx'
  type: 'gateway'
  id: 'watson-hass-xxxx'
  token: 'xxxxxxxx'
  include:
    entities:
      - sensor.home_energy_sensor_current

--
tks

mtreinish · 2018-06-28T17:59:27Z

@gnkarn hmm, that config looks valid can you please open an issue with the details including the error in the logs when the component fails to load. (there likely is a stack trace in the logs if it's erroring on load) I'll take a look at it as soon as I can once you open it, there might be a bug in the include/exclude configuration I didn't test that bit as thoroughly as the rest of the component. But from a quick glance nothing looks wrong with that.

robmarkcole · 2018-06-28T18:26:00Z

@mtreinish have you published anywhere the analysis you have performed on the Watson platform?

gnkarn · 2018-06-28T19:07:52Z

@mtreinish there is nothing of help on the logs , as the configuration of the component : could not be loaded .
i have not deleting the include as i only want to publish a few sensors , starting with one .
tks

balloob · 2018-06-28T20:50:42Z

No support in pull requests. Open an issue as requested.

homeassistant added new-platform integration: watson_iot cla-signed labels Apr 3, 2018

mtreinish mentioned this pull request Apr 3, 2018

Add documentation for the new watson_iot component home-assistant/home-assistant.io#5100

Merged

2 tasks

mtreinish force-pushed the watson-iot branch from 6b1c5a5 to c992efc Compare April 3, 2018 21:56

homeassistant added the cla-signed label Apr 3, 2018

houndci-bot reviewed Apr 3, 2018

View reviewed changes

Comment thread homeassistant/components/watson_iot.py Outdated

Copy link
Copy Markdown

houndci-bot Apr 3, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

undefined name 'event'

mtreinish force-pushed the watson-iot branch from c992efc to ae7925e Compare April 3, 2018 22:01

homeassistant added the cla-signed label Apr 3, 2018

stevemar reviewed Apr 4, 2018

View reviewed changes

mtreinish force-pushed the watson-iot branch from ae7925e to 916a7f9 Compare April 4, 2018 12:27

homeassistant added the cla-signed label Apr 4, 2018

dgomes requested changes May 5, 2018

View reviewed changes

mtreinish force-pushed the watson-iot branch from c1ed38b to a88ab3c Compare May 11, 2018 20:44

homeassistant added the cla-signed label May 11, 2018

mtreinish closed this May 17, 2018

mtreinish reopened this May 24, 2018

mtreinish force-pushed the watson-iot branch from a88ab3c to 0ef0792 Compare June 1, 2018 19:12

homeassistant added the cla-signed label Jun 1, 2018

MartinHjelmare reviewed Jun 2, 2018

View reviewed changes

mtreinish force-pushed the watson-iot branch from 0ef0792 to cbc76f6 Compare June 2, 2018 14:41

homeassistant added the cla-signed label Jun 2, 2018

MartinHjelmare approved these changes Jun 2, 2018

View reviewed changes

dgomes approved these changes Jun 2, 2018

View reviewed changes

dgomes added the Ready for review label Jun 7, 2018

balloob merged commit d14d2fe into home-assistant:dev Jun 7, 2018

ghost removed the Ready for review label Jun 7, 2018

mtreinish deleted the watson-iot branch June 7, 2018 17:57

balloob mentioned this pull request Jun 22, 2018

0.72 #15088

Merged

home-assistant locked as resolved and limited conversation to collaborators Jun 28, 2018

Uh oh!

Conversation

mtreinish commented Apr 3, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stevemar 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!

ezar commented Apr 4, 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!

balloob commented May 17, 2018

Uh oh!

mtreinish commented Jun 1, 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!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

dgomes commented Jun 2, 2018

Uh oh!

gnkarn commented Jun 28, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mtreinish commented Jun 28, 2018

Uh oh!

robmarkcole commented Jun 28, 2018

Uh oh!

gnkarn commented Jun 28, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

balloob commented Jun 28, 2018

Uh oh!

mtreinish commented Apr 3, 2018 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

gnkarn commented Jun 28, 2018 •

edited

Loading

gnkarn commented Jun 28, 2018 •

edited

Loading