Skip to content

sriramsv/custom_component_splitwise

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

Custom component for HomeAssistant for Splitwise API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages