Question about two-way clippings/highlights sync between Xteink X4, Readest app and CrossPoint Sync app

[Mediche]

I'm trying to understand how clippings/highlights synchronization is supposed to work between my two Xteink X4 og running CrossPoint, the Readest app on Android, and the CrossPoint Sync app.

Here's what I've noticed:

• Clippings created on the X4 are successfully synced and displayed in both the CrossPoint Sync app and Readest app, but not on my other X4.

• Highlights created in Readest don't seem to sync back to CrossPoint Sync app or the X4.

Is this the expected behavior, or should clippings/highlights sync bidirectionally across all three platforms? Am I missing a configuration setting, or is this functionality not fully implemented yet?
Thank you

[tw4]

Hi @Mediche,

What you see is mostly expected. The two directions work differently:

Readest → CrossPoint Sync: not implemented. The Readest connector (src/connectors/readest.ts) syncs progress both ways but only sends clippings ("Syncs reading progress both ways … and sends clippings as highlights"). Pulling highlights back in is a separate connector hook, pullHighlights, and right now only the BookOrbit connector has it. So highlights made in Readest stay in Readest.

X4 → other X4: should work, but only on demand. Readers fetch clippings themselves through GET /api/v1/clippings/{document}. From docs/API.md: "Enable Sync Clippings in the firmware's CrossPoint Sync settings to sync clippings alongside the current book's manual progress sync." So on the second X4:

1. turn on Sync Clippings in its CrossPoint Sync settings
2. open the same book and run a manual progress sync there

It's per book and per manual sync, so nothing shows up on the second reader until you do that in that book.

Clippings are stored per {document} id, so both readers need to produce the same id for the book. That means the same file and the same document matching setting on both (binary vs. filename). With filename matching and the file named differently on the two readers, they look up different ids and the second one finds nothing.

Hope that helps!

[Mediche]

Hello @tw4
Thank you very much for the detailed explanation, that answers my question.