https://github.com/allenporter/home-assistant-supernote-cloud
Home Assistant Custom Component for to the excellent Ratta Supernote products
https://github.com/allenporter/home-assistant-supernote-cloud
home-assistant supernote
Last synced: 3 months ago
JSON representation
Home Assistant Custom Component for to the excellent Ratta Supernote products
- Host: GitHub
- URL: https://github.com/allenporter/home-assistant-supernote-cloud
- Owner: allenporter
- License: apache-2.0
- Created: 2024-09-30T02:17:17.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-04-05T09:54:03.000Z (3 months ago)
- Last Synced: 2025-04-05T10:30:12.229Z (3 months ago)
- Topics: home-assistant, supernote
- Language: Python
- Homepage:
- Size: 647 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# home-assistant-supernote-cloud
Home Assistant Custom Component dedicated to the excellent Ratta Supernote products.
This custom component efficiently synchronizes a backup of your notebook to your
local storage and exposes the contents through the media player.
The motivation is to use with [Journal Assistant](https://github.com/allenporter/home-assistant-journal-assistant) and [Supernote LLM](https://github.com/allenporter/supernote-llm/).
## Media Source
Notebook backups are exposed as a [Media Source](https://www.home-assistant.io/integrations/media_source/). This can be
used to browse contents of the backups and view notebook pages as `.png` files. The media source
will query the Supernote Cloud API to look for backups, and caches responses for
one hour to reduce load on the server. Any notebook contents md5 hashes are compared
to the contents on the server and sync'd down to local disk when there is a difference.
## Development
Library for efficient backup based on:
- https://github.com/bwhitman/supernote-cloud-python/
- https://github.com/adrianba/supernote-cloud-api/
- https://github.com/colingourlay/supernote-cloud-api/
### Development plan
- [x] Authentication library and configuration flow
- [x] Media player skeleton of directory contents
- [x] Tests for store
- [x] read cached meta.json from disk
- [x] tests for png fetching
- [x] Syncing of note contents
- [x] cache backup metadata on disk to reduce api calls
- [ ] handle non .note files
- [x] Extracting png content
- [x] async iterator to page through contents
- [x] concurrency fixes
- [x] fully async io
- [x] invalidate .png files when the notebook contents change