Files
wesandClaude ff42d5c35c Add complete Kobo highlight sync system with NickelMenu integration
- Add text cleaning to remove page reference numbers (e.g., "10After" -> "After")
- Implement cleanHighlightText() function with boundary detection
- Add NickelMenu configuration for UI integration
- Create sync wrapper scripts (with and without FBInk notifications)
- Add installation guides for Kobo deployment
- Include pointer/slice explanation examples for learning

Features:
- Extracts highlights from Kobo SQLite database
- Cleans page references from academic texts
- Computes SHA-256 hashes for deduplication
- POSTs JSON to Flask API endpoint
- Supports ARM static linking for Kobo hardware
- Optional FBInk notifications for user feedback

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-01 21:13:16 -05:00

2.0 KiB

FBInk Integration Guide

What is FBInk?

FBInk is a tool for drawing text and images on e-ink displays. It's commonly bundled with KOReader and other Kobo mods.

Check if FBInk is installed

ssh root@192.168.88.110
which fbink
# or
fbink --version

If not installed, it usually comes with KOReader at /usr/local/koreader/fbink

Basic Usage in Scripts

Show a message

fbink -pm "Hello, World!"

Show message at specific position

fbink -pm -y 10 "Message at row 10"

Clear the screen

fbink -s

Show without refresh (faster)

fbink -q -pm "Quick message"

Common Options

  • -pm - Print centered (middle)
  • -q - Quiet mode (no verbose output)
  • -y N - Print at row N
  • -s - Clear screen
  • -h - Refresh (full screen)
  • -f - Flash (for animations)

Testing FBInk

SSH into your Kobo and try:

fbink -pm "Testing FBInk!"
sleep 2
fbink -s  # Clear it

Enhanced sync_highlights.sh

The sync_highlights_with_fbink.sh script shows:

  • "Syncing highlights..." while running
  • "✓ Synced N highlights!" on success
  • "✗ Sync failed! Check log" on error

Auto-clears after 2-3 seconds so it doesn't clutter the screen.

Installation

Replace your existing sync script:

scp sync_highlights_with_fbink.sh root@192.168.88.110:/usr/local/bin/sync_highlights.sh
ssh root@192.168.88.110 chmod +x /usr/local/bin/sync_highlights.sh

Custom Messages

You can customize the messages in the script:

# Change this line:
$FBINK -q -pm -y 10 "✓ Synced $COUNT highlights!"

# To something like:
$FBINK -q -pm -y 10 "📚 $COUNT new highlights saved!"

Advanced: Progress Bar

For future enhancements, FBInk can show progress bars:

fbink -pm -P 50  # Show 50% progress

Could be useful if syncing takes a while!

Fallback Behavior

The script automatically detects if FBInk is available. If not found, it runs silently (just logs to file). So it works either way!