Git Product home page Git Product logo

custom_component_splitwise's Introduction

Custom component for HomeAssistant for Splitwise API

This is a custom component integration for Splitwise API

Splitwise Setup

Account

  • In the Your Account section, select Your Apps under the Privacy and Security section

Profile

  • Under the build your own app, click on Register your Application

Register

  • Fill in the following sections
    • Application name: Homeassistant
    • Application Description: Homeassistant API Integration
    • Homepage URL: http://localhost:8123
    • [Important] Callback URL: http://localhost:8123/api/splitwise/callback

Note:

If you are using a reverse proxy in front of your home assistant server, use the public address (https://home.<your-domain>.com>/api/splitwise/callback) as the callback URL in the application settings. Otherwise the oauth authentication won't work

edit-app

  • Click on Register and get API key
  • Copy the Consumer Key and Consumer Secret values and store it some place safe

Installation

HACS:

  • Search for Splitwise Sensor in HACS console and install it.

Manual

  • Copy the contents of the folder custom_components/splitwise into <hass-config-directory>/custom_components/splitwise

  • Add the following lines to the configuration.yaml

Configuration

sensor:
  - platform: splitwise
    client_id: '<consumer-id>'
    client_secret: '<consumer-secret>'
  • Restart Homeassistant
  • Once you login to Homeassistant again, you should see a persistent notification with an authorization URL link in it:

auth-url

  • You will be redirected to the Oauth confirmation page from Splitwise to authorize Homeassistant to pull the data on your behalf.

oauth-confirm

  • Once you accept the Splitwise Oauth Callback, then sensor pulls the data from Splitwise API

Final Output

dash-url

Advanced usage - events

This component will fire events:

image

The event types are defined in the API documentation

custom_component_splitwise's People

Contributors

sriramsv avatar clockwerx avatar dojh342 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.