Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Alpha Vantage sensor #10873

Merged
merged 4 commits into from Dec 3, 2017
Merged

Add Alpha Vantage sensor #10873

merged 4 commits into from Dec 3, 2017

Conversation

fabaff
Copy link
Member

@fabaff fabaff commented Nov 30, 2017

Description:

Alpha Vantage sensor for stock details. It's a replacement for the Yahoo! Finance which will no longer work as the service was decommissioned.

Related issue (if applicable): #9144, #10334

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

Example entry for configuration.yaml (if applicable):

sensor:
  - platform: alpha_vantage
    api_key: !secret av_api
    symbols:
      - RHT
      - GOOGL

Checklist:

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

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][ex-requir]).
  • New dependencies are only imported inside functions that use them ([example][ex-import]).
  • New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
  • New files were added to .coveragerc.

dev = []
for symbol in symbols:
try:
data = AlphaVantageData(timeserie, symbol)
Copy link
Member

Choose a reason for hiding this comment

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

If each data instance will only report one symbol, and the same goes for the sensor instance, I don't think there's a benefit of separating the data fetching from the entity class.

except ValueError:
_LOGGER.error(
"API Key is not valid or symbol '%s' not known", symbol)
return False
Copy link
Member

Choose a reason for hiding this comment

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

setup_platform should not return anything.

Copy link
Member Author

Choose a reason for hiding this comment

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

I guess that we should update the docs and the existing platforms as that's used pretty extensively.

self._name = symbol
self._timeserie = timeserie
self._symbol = symbol
self._state = None
Copy link
Member

Choose a reason for hiding this comment

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

Doesn't seem to be used.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks

@MartinHjelmare
Copy link
Member

Two minor comments. Looks good otherwise!

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Found another unused variable.


ATTR_CLOSE = 'close'
ATTR_HIGH = 'high'
ATTR_OPEN = 'open'
Copy link
Member

Choose a reason for hiding this comment

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

Not used at the moment.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks

def __init__(self, timeserie, symbol):
"""Initialize the sensor."""
self._name = symbol
self._timeserie = timeserie
Copy link
Contributor

Choose a reason for hiding this comment

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

Just a minor nitpick: I think in English, the singular form of "series" is "series".

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks, fixed.

@property
def state(self):
"""Return the state of the sensor."""
return self.values['1. open']
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if it should be configurable whether the open / current / whatever price should be returned?

Copy link
Member Author

Choose a reason for hiding this comment

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

For the initial implementation I just picked the first one. It's not a big deal to make it configurable in the future, if needed or if a financial guru says that this values doesn't make sense at all.

@fabaff fabaff merged commit 9577525 into dev Dec 3, 2017
@fabaff fabaff deleted the alpha-vantage branch December 3, 2017 20:35
jbarrancos added a commit to jbarrancos/home-assistant that referenced this pull request Dec 7, 2017
* Updated codeowner for Tile device tracker (home-assistant#10861)

* Revert "KNX: Added config option for broadcasting current time to KNX bus. (home-assistant#10654)" (home-assistant#10874)

This reverts commit cadd797.

As discussed within home-assistant#10708 we should chose a different implementation. Therefore we should revert this change to avoid a breaking change.

* Upgrade distro to 1.1.0 (home-assistant#10850)

* Bugfix trigger state with multible entities (home-assistant#10857)

* Bugfix trigger state with multible entities

* Fix numeric state

* fix lint

* fix dict

* fix unsub

* fix logic

* fix name

* fix new logic

* add test for state

* add numeric state test for unsub

* add test for multible entities

* Update numeric_state.py

* Update numeric_state.py

* Update state.py

* Fix logic for triple match

* Add clear to numeric state

* clear for state trigger

* tellstick fix DEPENDENCIES and update tellcore-net (home-assistant#10859)

* Update requirements_all.txt

* Update tellstick.py

* Fix DEPENDENCIES

* Update requirements_all.txt

* fix format

* fix lint

* fix lint

* Update tellstick.py

* update tellcore-net

* update tellcore-net

* besser validate

* Update frontend to 20171130.0

* Upgrade aiohttp to 2.3.5 (home-assistant#10889)

* Upgrade fastdotcom to 0.0.3 (home-assistant#10886)

* Upgrade schiene to 0.19 (home-assistant#10887)

* Xiaomi Vacuum: remove deprecated calls (home-assistant#10839)

* vacuum.xiaomi_miio: read dnd status properly instead of using imprecise dnd flag from vacuum_state

* vacuum.xiaomi_miio: use miio package instead of mirobo

* check only that wanted calls have taken place, ignore order of calls

* Fix linting issues

* Remove empty line after docstring

* Create ecobee weather platform (home-assistant#10869)

* Create ecobee weather component

* Update requirements_all for ecobee

* Fix missed lint issue

* Microsoft Text-to-speech: Fixing missing en-gb support bug (home-assistant#10429)

* Fixing missing en-gb support bug

* Microsoft TTS adding support for rate, volume, pitch and contour.

* Microsoft TTS fixing support for jp-jp.

* Fixing linting error on line 67

* make impossible things possible 🎉

* Upgrade youtube_dl to 2017.11.26 (home-assistant#10890)

* Upgrade yarl to 0.15.0 (home-assistant#10888)

* Fix tests (home-assistant#10891)

* Refactored WHOIS sensor to resolve assumed key errors (home-assistant#10662)

* Refactored WHOIS sensor to resolve assumed key errors

Altered it to now set an attribute key and value only if the attribute
is present in the WHOIS response. This prevents assumed keys (registrar)
from raising a KeyError on WHOIS lookups that don't contain registrar
information (onet.pl, wp.pl, for example).

* Removed non-used self._data

* WHOIS sensor now creates a new local attributes dict and overrides

* Corrected typos, refactored error cases to clear state adn attributes

* Resolved double return and refactored error logging

* Serve latest extra_html in dev mode (home-assistant#10863)

* Reload groups after saving a change via config API (home-assistant#10877)

* Version bump to 0.59.0

* Update ecobee version to fix stack-trace issue (home-assistant#10894)

* Pybotvac multi (home-assistant#10843)

* Update requirements_all.txt

* Update neato.py

* Fix issues from review of ecobee weather component (home-assistant#10903)

* Fix issues from review

* Don't use STATE_UNKNOWN

* Bugfix home-assistant#10902 (home-assistant#10904)

* Fix issues from review of ecobee weather component (home-assistant#10903)

* Fix issues from review

* Don't use STATE_UNKNOWN

* Bugfix home-assistant#10902 (home-assistant#10904)

* More declarative timeout syntax for manual alarm control panel. (home-assistant#10738)

More declarative timeout syntax for manual alarm control panel

* Unpacking RESTful sensor JSON results into attributes. (home-assistant#10753)

* Added support for extracting JSON attributes from RESTful values

Setting the json_attributes configuration option to true on the
RESTful sensor will cause the result of the REST request to be parsed
as a JSON string and if successful the resulting dictionary will be
used for the attributes of the sensor.

* Added support for extracting JSON attributes from RESTful values

Setting the json_attributes configuration option to true on the
RESTful sensor will cause the result of the REST request to be parsed
as a JSON string and if successful the resulting dictionary will be
used for the attributes of the sensor.

* Added requirement that RESTful JSON results used as attributes must be
objects, not lists.

* Expanded test coverage to test REFTful JSON attributes with and
without a value template.

* Added support for extracting JSON attributes from RESTful values

Setting the json_attributes configuration option to true on the
RESTful sensor will cause the result of the REST request to be parsed
as a JSON string and if successful the resulting dictionary will be
used for the attributes of the sensor.

* Added requirement that RESTful JSON results used as attributes must be
objects, not lists.

* Expanded test coverage to test REFTful JSON attributes with and
without a value template.

* sensor.envirophat: add missing requirement (home-assistant#7451)

Adding requirements that is not explicitly pulled in by the library
that manages the Enviro pHAT.

* PyPI Openzwave (home-assistant#7415)

* Remove default zwave config path

PYOZW now has much more comprehensive default handling for the config
path (in src-lib/libopenzwave/libopenzwave.pyx:getConfig()). It looks in
the same place we were looking, plus _many_ more. It will certainly do a
much better job of finding the config files than we will (and will be
updated as the library is changed, so we don't end up chasing it). The
getConfig() method has been there for a while, but was subsntially
improved recently.

This change simply leaves the config_path as None if it is not
specified, which will trigger the default handling in PYOZW.

* Install python-openzwave from PyPI

As of version 0.4, python-openzwave supports installation from PyPI,
which means we can use our 'normal' dependency management tooling to
install it. Yay.

This uses the default 'embed' build (which goes and downloads
statically sources to avoid having to compile anything locally). Check
out the python-openzwave readme for more details.

* Add python-openzwave deps to .travis.yml

Python OpenZwave require the libudev headers to build. This adds the
libudev-dev package to Travis runs via the 'apt' addon for Travis.

Thanks to @MartinHjelmare for this fix.

* Update docker build for PyPI openzwave

Now that PYOZW can be install from PyPI, the docker image build process
can be simplified to remove the explicit compilation of PYOZW.

* Add datadog component (home-assistant#7158)

* Add datadog component

* Improve test_invalid_config datadog test

* Use assert_setup_component for test setup

* Fix object type for default KNX port

home-assistant#7429 describes a TypeError that is raised if the port is omitted in the config for the KNX component (integer is required (got type str)). This commit changes the default port from a string to an integer. I expect this will resolve that issue...

* Added support for extracting JSON attributes from RESTful values

Setting the json_attributes configuration option to true on the
RESTful sensor will cause the result of the REST request to be parsed
as a JSON string and if successful the resulting dictionary will be
used for the attributes of the sensor.

* Added requirement that RESTful JSON results used as attributes must be
objects, not lists.

* Expanded test coverage to test REFTful JSON attributes with and
without a value template.

* Added support for extracting JSON attributes from RESTful values

Setting the json_attributes configuration option to true on the
RESTful sensor will cause the result of the REST request to be parsed
as a JSON string and if successful the resulting dictionary will be
used for the attributes of the sensor.

* Added requirement that RESTful JSON results used as attributes must be
objects, not lists.

* Expanded test coverage to test REFTful JSON attributes with and
without a value template.

* Added support for extracting JSON attributes from RESTful values

Setting the json_attributes configuration option to true on the
RESTful sensor will cause the result of the REST request to be parsed
as a JSON string and if successful the resulting dictionary will be
used for the attributes of the sensor.

* Added requirement that RESTful JSON results used as attributes must be
objects, not lists.

* Expanded test coverage to test REFTful JSON attributes with and
without a value template.

* Fixed breaks cause by manual upstream merge.

* Added one extra blank line to make PyLint happy.

* Switched json_attributes to be a list of keys rather than a boolean.

The value of json_attributes can now be either a comma sepaated list
of key names or a YAML list of key names. Only matching keys in a
retuned JSON dictionary will be mapped to sensor attributes.

Updated test cases to handle json_attributes being a list.

Also fixed two minor issues arrising from manual merge with 0.58 master.

* Added an explicit default value to the json_attributes config entry.

* Removed self.update() from __init__() body.

* Expended unit tests for error cases of json_attributes processing.

* Align quotes

* Bump dev to 0.60.0.dev0 (home-assistant#10912)

* Update eliqonline.py (home-assistant#10914)

Channel id is now required (change in API)

* Add iAlarm support (home-assistant#10878)

* Add iAlarm support

* Minor fixes to iAlarm

* Rename ialarmpanel to ialarm and add a check for the host value

* corrections in the value validation of ialarm

* add a missing period on ialarm

* Correction of Samsung Power OFF behaviour (home-assistant#10907)

* Correction of Samsung Power OFF behaviour

Addition of a delay after powering OFF a Samsung TV, this avoid status
update from powering the TV back ON.
Deletion of update() return statement, return value not used.

* Rename self._end_of_power_off_command into self._end_of_power_off

* Removal of unused line break in Samsung TV component

* Add Alpha Vantage sensor (home-assistant#10873)

* Add Alpha Vantage sensor

* Remove data object

* Remove unused vars and change return

* Fix typo

* Don't repeat getting receiver name on each update / pushed to denonavr 0.5.5 (home-assistant#10915)

* Add Min and Event Count Metrics To Prometheus (home-assistant#10530)

* Added min and Events sensor types to prometheus

* Updated prometheus client and fixed invalid swith state

* Added metric to count number of times an automation is triggered

* Removed assumption that may not apply to everybody

* Fixed tests

* Updated requirements_test_all

* Fixed unit tests

* fix ios component config generation (home-assistant#10923)

Fixes: home-assistant#19020

* Fix Notifications for Android TV (home-assistant#10798)

* Fixed icon path, added dynamic icon

* Addressing requested changes

* Using DEFAULT_ICON

* Using CONF_ICON from const

* Getting hass_frontend path via import

* Lint

* Using embedded 1px transparent icon

* woof -.-

* Lint

* Update coveragerc (home-assistant#10931)

* Sort coveragerc

* Add climate.honeywell and vacuum.xiaomi_miio to coveragerc

* Update frontend to 20171204.0 (home-assistant#10934)

* Dominos no order fix (home-assistant#10935)

* check for none

* fix error from no store being set

* typo

* Lint

* fix default as per notes. Lint fix and make closest store None not False

* update default

* Version bump to 0.59.1

* Fix Notifications for Android TV (home-assistant#10798)

* Fixed icon path, added dynamic icon

* Addressing requested changes

* Using DEFAULT_ICON

* Using CONF_ICON from const

* Getting hass_frontend path via import

* Lint

* Using embedded 1px transparent icon

* woof -.-

* Lint

* fix ios component config generation (home-assistant#10923)

Fixes: home-assistant#19020

* Update frontend to 20171204.0 (home-assistant#10934)

* Dominos no order fix (home-assistant#10935)

* check for none

* fix error from no store being set

* typo

* Lint

* fix default as per notes. Lint fix and make closest store None not False

* update default

* Report availability of TP-Link smart sockets (home-assistant#10933)

* Report availability of TP-Link smart sockets

* Changes according to our style guide

* Set percent unit for battery level so that history displays properly; edited variable name for consistency (home-assistant#10932)

* Export climate status and target temperature to Prometheus (home-assistant#10919)

* Export climate metrics to Prometheus.

This adds climate_state and temperature_c metrics for each climate
device.

* Add more climate states to state_as_number

* Tado ignore invalid devices (home-assistant#10927)

* Ignore devices without temperatures

* Typo

* Linting

* Removing return false

* Another typo. :(

* Spelling received correctly

* Upgrade tellduslive library version (closes home-assistant#10922) (home-assistant#10950)

* don't ignore voltage data if sensor data changed (home-assistant#10925)

* Fix linksys_ap.py by inheriting DeviceScanner (home-assistant#10947)

As per issue home-assistant#8638, the class wasn't inheriting from DeviceScanner, this commit patches it up.

* Add ADS component (home-assistant#10142)

* add ads hub, light and switch

* add binary sensor prototype

* switch: use adsvar for connection

* fix some issues with binary sensor

* fix binary sensor

* fix all platforms

* use latest pyads

* fixed error with multiple binary sensors

* add sensor

* add ads sensor

* clean up after shutdown

* ads component with platforms switch, binary_sensor, light, sensor

add locking

poll sensors at startup

update state of ads switch and light

update ads requirements

remove update() from constructors on ads platforms

omit ads coverage

ads catch read error when polling

* add ads service

* add default settings for use_notify and poll_interval

* fix too long line

* Fix style issues

* no pydocstyle errors

* Send and receive native brightness data to ADS device to prevent issues with math.floor reducing brightness -1 at every switch

* Enable non dimmable lights

* remove setting of self._state in switch

* remove polling

* Revert "remove polling"

This reverts commit 7da420f.

* add service schema, add links to documentation

* fix naming, cleanup

* re-remove polling

* use async_added_to_hass for setup of callbacks

* fix comment.

* add callbacks for changed values

* use async_add_job for creating device notifications

* set should_poll to False for all platforms

* change should_poll to property

* add service description to services.yaml

* add for brigthness not being None

* put ads component in package

* Remove whitespace

* omit ads package

* Reload closest store on api menu request (home-assistant#10962)

* reload closest store on api request

* revert change from debugging

* Gearbest sensor (home-assistant#10556)

* Added Gearbest Sensor

* Updated required files

* Fixed houndci-bout findings

* Fix tox lint errors

* Changed code according to review
Implemented library version 1.0.5

* Fixed houndci-bot findings

* Fixed tox lint issues

* Updated item schema to use has_at_least_one_key
Added conf constants

* Remove CONF_ constants and import them from homeassistant.const

* Removed CurrencyConverter from hass
Fixed couple of issues found by MartinHjelmare

* Add Ziggo Mediabox XL media_player (home-assistant#10514)

* Add Ziggo Mediabox XL media_player

* Using pypi module ziggo-mediabox-xl now.

* Code review changes

* Generic thermostat initial_operation_mode (home-assistant#10690)

* Generic thermostat restore operation mode

* Test restore operation mode

* Fix trailing whitespace

* Fix line too long

* Fix test duplicate entity_id

* Fix test

* async_added_to_hass modify modify internal state

* Test inital_operation_mode

* More restore state tests

* Fix whitespace

* fix test_custom_setup_param

* Test "None" target temp

* Use new build path for dev translations (home-assistant#10937)

* Add option to set default hide if away for new devices (home-assistant#10762)

* Option to change hide_if_away

* tests fix

* change new device defaults

* tests and requested changes

* fix assert

* Allow chime to work for wink siren/chime (home-assistant#10961)

* Allow Wink siren/chimes to work

* Updated requirements_all.txt

* Revert pychromecast update (home-assistant#10989)

* Revert pychromecast update

* Update cast.py

* Require FF43 for latest js (home-assistant#10941)

* Require FF43 for latest js

`Array.prototype.includes` added in Firefox 43

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes

* Update __init__.py

* Version bump to 0.59.2

* Require FF43 for latest js (home-assistant#10941)

* Require FF43 for latest js

`Array.prototype.includes` added in Firefox 43

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes

* Update __init__.py

* Fix linksys_ap.py by inheriting DeviceScanner (home-assistant#10947)

As per issue home-assistant#8638, the class wasn't inheriting from DeviceScanner, this commit patches it up.

* Upgrade tellduslive library version (closes home-assistant#10922) (home-assistant#10950)

* Reload closest store on api menu request (home-assistant#10962)

* reload closest store on api request

* revert change from debugging

* Allow chime to work for wink siren/chime (home-assistant#10961)

* Allow Wink siren/chimes to work

* Updated requirements_all.txt

* Revert pychromecast update (home-assistant#10989)

* Revert pychromecast update

* Update cast.py

* Allow disabling the LEDs on TP-Link smart plugs (home-assistant#10980)

* Update frontend to 20171206.0

* Meraki AP Device tracker (home-assistant#10971)

* Device tracker for meraki AP

* styles fix

* fix again

* again

* and again :)

* fix hide if away

* docs and optimization

* tests and fixes

* styles

* styles

* styles

* styles

* styles fix. Hope last

* clear track new

* changes

* fix accuracy error and requested changes

* remove meraki from .coveragerc

* tests and minor changes

* remove location

* Update tradfri.py (home-assistant#10991)

* webostv: Ensure source exists before use (home-assistant#10959)

In a case where either (a) an incorrect source name is used, or (b) the
TV isn't currently queryable (e.g. it's off), we get tracebacks because
we assume the source that we are being asked to select exists in
self._source_list.

This makes the lookup code a little more rugged, and adds in a warning
message (in place of the current exception).

* Ensure Docker script files uses LF line endings to support Docker for Windows. (home-assistant#10067)

* Added Vera scenes (home-assistant#10424)

* Added Vera scenes

* Fixed flake8 issues

* Fixed comments

* Moved vera to use hass.data

* Made requested changes

* Fix Egardia alarm status shown as unknown after restart (home-assistant#11010)
akatrevorjay added a commit to akatrevorjay/home-assistant that referenced this pull request Dec 11, 2017
…into dev

* 'dev' of https://github.com/home-assistant/home-assistant: (29 commits)
  Fix linksys_ap.py by inheriting DeviceScanner (home-assistant#10947)
  don't ignore voltage data if sensor data changed (home-assistant#10925)
  Upgrade tellduslive library version (closes home-assistant#10922) (home-assistant#10950)
  Tado ignore invalid devices (home-assistant#10927)
  Export climate status and target temperature to Prometheus (home-assistant#10919)
  Set percent unit for battery level so that history displays properly; edited variable name for consistency (home-assistant#10932)
  Report availability of TP-Link smart sockets (home-assistant#10933)
  Dominos no order fix (home-assistant#10935)
  Update frontend to 20171204.0 (home-assistant#10934)
  fix ios component config generation (home-assistant#10923)
  Fix Notifications for Android TV (home-assistant#10798)
  Version bump to 0.59.1
  Dominos no order fix (home-assistant#10935)
  Update frontend to 20171204.0 (home-assistant#10934)
  Update coveragerc (home-assistant#10931)
  Fix Notifications for Android TV (home-assistant#10798)
  fix ios component config generation (home-assistant#10923)
  Add Min and Event Count Metrics To Prometheus (home-assistant#10530)
  Don't repeat getting receiver name on each update / pushed to denonavr 0.5.5 (home-assistant#10915)
  Add Alpha Vantage sensor (home-assistant#10873)
  ...
@fabaff fabaff mentioned this pull request Dec 16, 2017
@home-assistant home-assistant locked and limited conversation to collaborators Mar 30, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants