simonhq / asx_sensor

get ASX information in home assistant
3 stars 2 forks source link
appdaemon asx asx-sensor hacs sensor

Australian Securities Exchange Sensor

hacs_badge hacs_badge

Creates sensors for Home Assistant for each ASX Symbol you provide

Lovelace Examples

Example of the entities in Lovelace

An Entity has 10 days information

Installation

This app is best installed using HACS, so that you can easily track and download updates.

Alternatively, you can download the asx_sensor directory from inside the apps directory here to your local apps directory, then add the configuration to enable the asx_sensor module.

How it works

The yfinance module sources the information from Yahoo Finance and makes the information available as sensors in HA.

This information is only daily information, showing the latest close data, and other relevant information about a stock, it does not provide actual trading information.

As this is non time critical sensor, it only gets the information on a set time schedule, once per day at 5.17am before the opening of the market.

To Run Manually

You will need to create an input_boolean entity to watch for when to update the sensor. When this input_boolean is turned on, whether manually or by another automation you create, the scraping process will be run to create/update the sensor.

AppDaemon Libraries

Please add the following packages to your appdaemon 4 configuration on the supervisor page of the add-on.

system_packages: []
python_packages: ["yfinance"]
init_commands: []

No specific packages are required for this app.

App configuration

In the apps.yaml file in the appdaemon/apps directory -

asx_sensor:
  module: asx_sensor
  class: Get_ASX_info
  TICKER: "CBA,TLS,BHP"
  TICK_FLAG: "input_boolean.check_asx_info"
key optional type default description
module False string asx_sensor
class False string Get_ASX_info
TICKER False string The comma separated symbols for each of the stocks you are interested in
TICK_FLAG False string The name of the flag in HA for triggering this sensor update - e.g. input_boolean.check_asx_info

Sensors Created

This version will create a sensor for each stock you provide

Issues/Feature Requests

Please log any issues or feature requests in this GitHub repository for me to review.