Skip to content

Latest commit

 

History

History
329 lines (250 loc) · 21.4 KB

File metadata and controls

329 lines (250 loc) · 21.4 KB

BookPoint. Руководство пользователя

BookPoint — прошивка для ридеров Xteink X4 и X3 на базе CrossPoint Reader. Этот документ описывает управление, экраны и чтение. То, что отличает BookPoint от обычного CrossPoint, помечено по тексту: статистика чтения, сноски внизу страницы, экономия батареи, программные часы на X4.

1. Кнопки и железо

Раскладка как у заводской прошивки Xteink:

Где Кнопки
Нижний торец Back, Confirm, Left, Right
Правый бок Power, Volume Up, Volume Down, Reset

Раскладку можно переназначить в Настройки, Кнопки.

Скриншот: одновременно Power и Volume Down. Либо во время чтения открыть меню книги и выбрать «Скриншот». Файлы падают в папку screenshots/ на SD-карте.

2. Включение и выключение

Включение и выключение: держать Power около полусекунды. Можно настроить выключение коротким нажатием (Настройки, Кнопки, Короткое нажатие Power).

Перезагрузка (после обновления или зависания): нажать и отпустить Reset, быстро нажать и держать Power несколько секунд.

При включении открывается главный экран. Прошивка сама открывает последнюю читаемую книгу.

3. Экраны

3.1 Главный экран

Отсюда доступны: продолжение чтения, браузер файлов, недавние книги, передача файлов, настройки.

3.2 Браузер файлов

Вверху показан путь к текущей папке, папки в скобках вроде [folder].

  • Перемещение: Left/Right или Volume Up/Down. Долгое нажатие листает страницу списка целиком.
  • Открыть: Confirm. Выбор .bmp или .png открывает просмотр картинки, оттуда же можно поставить её заставкой сна.
  • Удаление: удержать Confirm на файле, потом подтвердить.
  • Переименование доступно из списка.

3.3 Недавние книги

Список последних открытых книг с названием и автором.

3.4 Передача файлов

Экран запрашивает режим: подключиться к сети, Calibre Wireless или создать точку доступа. После подключения запускается веб-сервер, дальше работаете из браузера на компьютере или телефоне: адрес показан на экране (например http://192.168.1.50 или http://crosspoint.local).

Через веб-интерфейс можно заливать и скачивать файлы, управлять сетями Wi-Fi и OPDS-серверами, конвертировать шрифты, запускать EPUB Optimizer. Поддерживается WebDAV: ридер можно смонтировать как сетевой диск.

Подробнее: docs/webserver.md.

Calibre: плагин для беспроводной отправки книг лежит на https://github.com/crosspoint-reader/calibre-plugins/releases. На ридере выбрать «Calibre Wireless», в Calibre настроить IP устройства в настройках плагина и отправлять через «Send to Device».

Помните: пока ридер в сети, он жрёт батарею. После паузы Wi-Fi выключится сам (см. раздел про батарею).

3.5 Настройки

Экран

  • Заставка сна: тёмная, светлая, своя картинка, обложка книги, обложка только во время чтения, прозрачная картинка поверх страницы, пустая, быстрое возобновление (текст последней страницы и луна; пробуждение возвращает прямо в книгу).
  • Строка состояния при чтении: страницы, процент, прогресс-бар, часы, батарея, название.
  • Частота полного обновления экрана: каждые 1, 5, 10, 15 или 30 страниц (борьба с гостингом).
  • Тема интерфейса: Classic, Lyra, Lyra Extended, RoundedRaff.
  • Ночной режим: инверсия только страниц чтения.

Чтение

  • Шрифт: Noto Serif, Noto Sans или любой установленный с SD-карты.
  • Размер шрифта в пунктах, межстрочный интервал, поля, выравнивание абзацев, переносы, дополнительный интервал между абзацами.
  • Сглаживание текста, картинки в EPUB, встроенные стили книги, Focus Reading (жирные «точки фиксации» в начале слов).
  • Сноски в тексте: «Внизу страницы» (по умолчанию, текст сноски печатается внизу страницы как в бумажной книге) или «Переход с возвратом» (прыжок к примечанию, назад коротким Back или Power). Подробнее в разделе про сноски.
  • Собирать статистику чтения: включает и выключает учет времени. Накопленные данные при этом не удаляются никогда.
  • Ориентация чтения: портрет, альбом, перевернуто.

Кнопки

  • Переназначение передних кнопок, раскладка боковых.
  • Долгое нажатие кнопок листания: перескок главы или смена ориентации.
  • Долгое нажатие Confirm: закладка, синхронизация KOReader, словарь, ничего.
  • Короткое нажатие Power: ничего, сон, листание, принудительное обновление, сноски, подтверждение.
  • Быстрый возврат из сносок (включен по умолчанию): короткий Power работает как Back, пока вы внутри сноски.

Система

  • Автооткл. Wi-Fi (мин): через сколько минут бездействия сетевые экраны сами гасят радио. 0 — не выключать. По умолчанию 3.
  • Лог батареи (диагностика): пишет в /.crosspoint/battery_log.csv строку при загрузке и перед сном с процентом заряда. Помогает искать причины ночного расхода. Выключен по умолчанию.
  • Сон через N минут бездействия.
  • Wi-Fi сети, синхронизация KOReader, OPDS-серверы.
  • Очистить кэш чтения. Кэш книг, прогресс и недавние удаляются. Статистика, закладки и настройки остаются.
  • Проверить обновления. Внимание: это обновит оригинальный CrossPoint без функций BookPoint. Обновляйте BookPoint только файлом из релиза.
  • Язык интерфейса: 24 языка, включая русский.
  • Управление шрифтами.

OPDS-серверы

До 8 каталогов. При первом запуске, а также при каждом старте, если какого-то из стандартных каталогов нет в списке, добавляются: Flibusta (http://flibusta.is/opds), зеркало (http://flibusta.site/opds) и Project Gutenberg (https://m.gutenberg.org/ebooks.opds/). Дубликаты не появляются, свои серверы не трогаются. Основной домен Flibusta у части провайдеров заблокирован, тогда работает зеркало.

KOReader Sync

Синхронизация прогресса с серверами KOReader. Пустой адрес сервера = бесплатный sync.crosspointreader.com. Можно указать свой (sync.koreader.rocks или self-hosted). Настройка: Настройки, Система, KOReader Sync, ввести логин и пароль, при первом входе нажать Sign Up.

Важно: синхронизация никогда не отправит позицию внутри сноски. Перед отправкой прошивка сама возвращается на страницу, откуда сноска была открыта.

3.6 Экран сна

Режимы перечислены в настройках. Свои картинки: папка .sleep в корне SD (несколько .bmp, выбирается случайная) или один файл sleep.bmp в корне. Прозрачные оверлеи: .sleep-overlay или sleep-overlay.bmp/png, белый цвет считается прозрачным. Разрешение X4: 480x800, X3: 528x792.

3.7 Свои шрифты (SD-карта)

Три способа: скачать прямо с устройства (Настройки, Система, Управление шрифтами), залить .cpfont через веб-интерфейс (вкладка Fonts), или скопировать папки с шрифтами в /.fonts/ или /fonts/ на SD. Шрифты с CJK берите готовые из репозитория crosspoint-fonts. Подробнее: docs/sd-card-fonts.md.

4. Чтение

4.1 Листание

Действие Кнопки
Назад Left или Volume Up
Вперёд Right или Volume Down

Боковые кнопки меняются местами в настройках. Если короткое нажатие Power назначено на листание, Power тоже листает вперёд.

Перескок главы: долгое нажатие Left/Right (отключается в настройках). Автолистание: меню книги, «Автолистание» (страниц в минуту). На X3 есть поворот корпуса как способ листать (нужен гироскоп).

Home-жесты: короткий Back закрывает книгу, долгий Back ведёт в браузер файлов.

4.2 Сноски

Два режима, переключаются в Настройки, Чтение, «Сноски в тексте».

Внизу страницы (по умолчанию). Если на странице есть ссылка на сноску, внизу под тонкой линией печатается текст этого примечания мелким шрифтом, как в бумажной книге. Работает и когда примечания вынесены в конец книги отдельным файлом. Место под полосу выделено заранее, поэтому пагинация не скачет при перелистывании. Полный текст и переход доступны через меню книги, «Сноски».

Переход с возвратом. Короткий Back или Power возвращает на исходную страницу. Возврат работает даже если Power назначен на листание: первый нажатий Power внутри сноски возвращает назад, а не листает.

Пока вы читаете примечание, закладка прогресса остаётся на исходной странице: сон, разряд или сбой не перенесут вас в конец книги, а синхронизация KOReader не запишет позицию внутри примечаний на сервер.

4.3 Статистика чтения

Время считается по страницам: пока страница на экране, время капает. Пауза дольше 5 минут считается простоем и не учитывается, поэтому уснул с книгой — время не растёт. Сессия короче минуты не считается сессией, короче 10 секунд не добавляет времени.

Открыть: меню книги, «Статистика чтения», или Настройки, Чтение, «Статистика чтения». Три страницы:

  • Книга: время, сессии, страницы, темп (секунд на страницу), оценка времени до конца книги, даты начала и конца, кнопка «Прочитано»/«Не прочитано».
  • Устройство: общее время, сессии, страницы, прочитано книг, текущая серия дней и рекорд.
  • Активность: график за последние 14 дней (реальные секунды по дням), распределение по дням недели и по времени суток (утро, день, вечер, ночь).

Кнопки: Back выход, Up/Down или Left/Right переключение страниц, Confirm действие (отметка «прочитано» или экспорт CSV).

Хранение: всё в /.crosspoint/stats/ на SD-карте, вне кэша книг. Обновление прошивки, смена шрифта, очистка кэша — данные остаются. Запись атомарная, старый файл уезжает в .bak. После каждой сессии перезаписывается /.crosspoint/stats/reading_stats.csv: статистику можно читать с компьютера, даже если прошивку снести полностью.

Формат CSV: строка GLOBAL с общими числами и по строке на каждую книгу (путь, название, автор, сессии, секунды, страницы, темп, даты).

Если раньше стоял inkMOD, его статистика (общая и по книгам) импортируется автоматически при первом запуске BookPoint.

Даты работают и на X4: время берётся из системных часов, которые синхронизируются по NTP при подключении Wi-Fi и восстанавливаются после сна. До первой синхронизации даты просто не пишутся, секунды и страницы считаются всегда.

4.4 Меню книги

Confirm во время чтения открывает меню: содержание, статистика, сноски, закладки, настройки текста, ночной режим, подсветка, словарь, ориентация, автолистание, перейти на процент, скриншот, QR текущей позиции, домой, синхронизация, удаление кэша книги.

4.5 Закладки

Создать: держать Confirm около полусекунды. Открыть: меню книги, «Закладки». Удалить: удержание на закладке. Хранятся в .crosspoint/bookmarks.

4.6 Словарь

Офис-перевод слов через StarDict-словари с SD-карты. Словари кладутся в /dictionaries/, затем Настройки, Чтение, Словарь. Подробно: docs/dictionary.md.

5. Батарея и время

Что тратит батарею и что сделано:

  • Wi-Fi: главный потребитель. Сетевые экраны гасят радио после настраиваемой паузы (по умолчанию 3 минуты). Перед сном Wi-Fi выключается всегда.
  • Часы: на X4 нет аппаратных часов, время ведёт системный счётчик ESP32. NTP-синхронизация происходит только при подключении Wi-Fi, восстановление после сна берёт время из state.json. Нулевой расход.
  • Статистика и лог батареи пишут на SD несколько раз за сессию чтения, на расход это не влияет.

Если за ночь уходит заметный процент: включите Настройки, Система, «Лог батареи», оставьте на ночь и посмотрите /.crosspoint/battery_log.csv. Строки boot ночью означают, что ридер просыпался; если их нет, а заряд уходит, дело в железе или зарядке.

6. Обновление прошивки

Новые версии BookPoint выходят в разделе Releases репозитория https://github.com/klanva/BookPoint. Прошивка файла: web-флешер по USB (https://crosspointreader.com/#flash-tools) или firmware.bin в корень SD с последующим обновлением с карты.

Не используйте встроенный пункт «Проверить обновления»: он установит оригинальный CrossPoint. Книги, настройки, прогресс и статистика при этом не теряются, но функции BookPoint пропадут до повторной прошивки.

7. Если что-то сломалось

  • После сбоя ридер сам пишет отчёт о падении в корень SD-карты. Приложите его к багрепорту.
  • Зависание: Reset, затем держать Power.
  • Бутлуп: Reset, затем держать Back и Power до главного экрана.
  • Битый кэш или настройки: удалить папку .crosspoint на SD (статистика в .crosspoint/stats — если хотите сохранить её, не удаляйте папку целиком, удалите только settings.json, state.json и папки epub_*).
  • Полное окирпичивание и прошивка через программатор: docs/fix-bricked-xteink.md.

Серийный лог для отладки: python3 scripts/debugging_monitor.py (нужны pip3 install pyserial colorama matplotlib).