Home Assistant Custom Components Google Keep Save

This sensor uses gkeepapi library to download a list of notes from https://keep.google.com/.

Project README

HACS Default GitHub Latest Release GitHub All Releases Community Forum Ko-Fi buycoffee.to PayPal.Me Revolut.Me

Google Keep sensor

This sensor downloads a list of notes from Google Keep.

Configuration options

Key Type Required Default Description
name string False Google Keep Name of sensor
username string True - Username for Google Keep account
password string True - Password (or App Password) for Google Keep account
titles list False [] List of titles of notes to be imported
labels list False [] List of labels of notes to be imported
pinned boolean False False Activates downloaded limiting notes to pinned ones

Example usage

sensor:
  - platform: google_keep
    username: !secret google_keep.username
    password: !secret google_keep.password
    labels:
      - 'Home Assistant'
    pinned: true

Installation

This integration can be installed using HACS. To do it search for Google Keep in Integrations section.

Manual

To install this integration manually you have to download google_keep.zip and extract its contents to config/custom_components/google_keep directory:

mkdir -p custom_components/google_keep
cd custom_components/google_keep
wget https://github.com/PiotrMachowski/Home-Assistant-custom-components-Google-Keep/releases/latest/download/google_keep.zip
unzip google_keep.zip
rm google_keep.zip

Hints

  • To present data downloaded by this sensor use companion card: Lovelace Google Keep card

  • If you define more than one constraint (titles, labels, pinned) all of them will be applied and intersection of results will be returned.

  • Do I have to use my Google Account password?

    You can set up an App Password to use this component.

    • Go to https://myaccount.google.com/apppasswords
    • In Select app menu choose other and provide your own identifier (e.g. Home Assistant)
    • Use generated password in sensor configuration (Warning: password will not be shown again!)
  • What to do if Home Assistant does not find this component?

    Most likely you have to install additional dependency required for it to run. Activate Python environment Home Assistant is running in and use following command:

    pip install gkeepapi
    

Support

If you want to support my work with a donation you can use one of the following platforms:

Platform Payment methods Link Comment
Ko-fi
  • PayPal
  • Credit card
  • Buy Me a Coffee at ko-fi.com
  • No fees
  • Single or monthly payment
  • buycoffee.to
  • BLIK
  • Bank transfer
  • Postaw mi kawę na buycoffee.to
    PayPal
  • PayPal
  • PayPal Logo
  • No fees
  • Revolut
  • Revolut
  • Credit Card
  • Revolut
  • No fees
  • Open Source Agenda is not affiliated with "Home Assistant Custom Components Google Keep" Project. README Source: PiotrMachowski/Home-Assistant-custom-components-Google-Keep
    Stars
    66
    Open Issues
    6
    Last Commit
    4 months ago
    License
    MIT

    Open Source Agenda Badge

    Open Source Agenda Rating