Skip to content
This sensor uses gkeepapi library to download a list of notes from https://keep.google.com/.
Python
Branch: master
Clone or download
Latest commit 476b8bd Oct 31, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
custom_components/google_keep Fixed issue with changing entity id Aug 6, 2019
LICENSE Added license Oct 9, 2019
README.md Updated README Oct 31, 2019
info.md Update info.md Aug 19, 2019

README.md

Google Keep sensor

hacs_badge Community Forum buymeacoffee_badge

This sensor uses gkeepapi to download 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

Download sensor.py and manifest.json 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/raw/master/custom_components/google_keep/binary_sensor.py
wget https://github.com/PiotrMachowski/Home-Assistant-custom-components-Google-Keep/raw/master/custom_components/google_keep/manifest.json

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

Buy Me A Coffee

You can’t perform that action at this time.