cottongin/crosspoint-reader
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

Small cleanup

Browse Source
This commit is contained in:
Dave Allie 2026-01-07 19:54:09 +11:00
parent bc04c71f18
commit bbf715a4a3
No known key found for this signature in database
GPG Key ID: F2FDDB3AD8D0276F
3 changed files with 95 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

106
src/activities/network/CalibreWirelessActivity.cpp
View File

@ -33,7 +33,7 @@ void CalibreWirelessActivity::onEnter() {
renderingMutex = xSemaphoreCreateMutex(); renderingMutex = xSemaphoreCreateMutex();
stateMutex = xSemaphoreCreateMutex(); stateMutex = xSemaphoreCreateMutex();
state = CalibreWirelessState::DISCOVERING; state = WirelessState::DISCOVERING;
statusMessage = "Discovering Calibre..."; statusMessage = "Discovering Calibre...";
errorMessage.clear(); errorMessage.clear();
calibreHostname.clear(); calibreHostname.clear();
@ -124,19 +124,19 @@ void CalibreWirelessActivity::networkTaskLoop() {
xSemaphoreGive(stateMutex); xSemaphoreGive(stateMutex);
switch (currentState) { switch (currentState) {
case CalibreWirelessState::DISCOVERING: case WirelessState::DISCOVERING:
listenForDiscovery(); listenForDiscovery();
break; break;
case CalibreWirelessState::CONNECTING: case WirelessState::CONNECTING:
case CalibreWirelessState::WAITING: case WirelessState::WAITING:
case CalibreWirelessState::RECEIVING: case WirelessState::RECEIVING:
handleTcpClient(); handleTcpClient();
break; break;
case CalibreWirelessState::COMPLETE: case WirelessState::COMPLETE:
case CalibreWirelessState::DISCONNECTED: case WirelessState::DISCONNECTED:
case CalibreWirelessState::ERROR: case WirelessState::ERROR:
// Just wait, user will exit // Just wait, user will exit
vTaskDelay(100 / portTICK_PERIOD_MS); vTaskDelay(100 / portTICK_PERIOD_MS);
break; break;
@ -219,7 +219,7 @@ void CalibreWirelessActivity::listenForDiscovery() {
if (calibrePort > 0) { if (calibrePort > 0) {
// Connect to Calibre's TCP server - try main port first, then alt port // Connect to Calibre's TCP server - try main port first, then alt port
setState(CalibreWirelessState::CONNECTING); setState(WirelessState::CONNECTING);
setStatus("Connecting to " + calibreHostname + "..."); setStatus("Connecting to " + calibreHostname + "...");
// Small delay before connecting // Small delay before connecting
@ -241,11 +241,11 @@ void CalibreWirelessActivity::listenForDiscovery() {
} }
if (connected) { if (connected) {
setState(CalibreWirelessState::WAITING); setState(WirelessState::WAITING);
setStatus("Connected to " + calibreHostname + "\nWaiting for commands..."); setStatus("Connected to " + calibreHostname + "\nWaiting for commands...");
} else { } else {
// Don't set error yet, keep trying discovery // Don't set error yet, keep trying discovery
setState(CalibreWirelessState::DISCOVERING); setState(WirelessState::DISCOVERING);
setStatus("Discovering Calibre...\n(Connection failed, retrying)"); setStatus("Discovering Calibre...\n(Connection failed, retrying)");
calibrePort = 0; calibrePort = 0;
calibreAltPort = 0; calibreAltPort = 0;
@ -257,7 +257,7 @@ void CalibreWirelessActivity::listenForDiscovery() {
void CalibreWirelessActivity::handleTcpClient() { void CalibreWirelessActivity::handleTcpClient() {
if (!tcpClient.connected()) { if (!tcpClient.connected()) {
setState(CalibreWirelessState::DISCONNECTED); setState(WirelessState::DISCONNECTED);
setStatus("Calibre disconnected"); setStatus("Calibre disconnected");
return; return;
} }
@ -276,7 +276,13 @@ void CalibreWirelessActivity::handleTcpClient() {
start++; start++;
size_t end = message.find(',', start); size_t end = message.find(',', start);
if (end != std::string::npos) { if (end != std::string::npos) {
const int opcode = std::stoi(message.substr(start, end - start)); const int opcodeInt = std::stoi(message.substr(start, end - start));
if (opcodeInt < 0 || opcodeInt >= OpCode::ERROR) {
Serial.printf("[%lu] [CAL] Invalid opcode: %d\n", millis(), opcodeInt);
sendJsonResponse(OpCode::OK, "{}");
return;
}
const auto opcode = static_cast<OpCode>(opcodeInt);
// Extract data object (everything after the comma until the last ']') // Extract data object (everything after the comma until the last ']')
size_t dataStart = end + 1; size_t dataStart = end + 1;
@ -386,7 +392,7 @@ bool CalibreWirelessActivity::readJsonMessage(std::string& message) {
return true; return true;
} }
void CalibreWirelessActivity::sendJsonResponse(int opcode, const std::string& data) { void CalibreWirelessActivity::sendJsonResponse(const OpCode opcode, const std::string& data) {
// Format: length + [opcode, {data}] // Format: length + [opcode, {data}]
std::string json = "[" + std::to_string(opcode) + "," + data + "]"; std::string json = "[" + std::to_string(opcode) + "," + data + "]";
const std::string lengthPrefix = std::to_string(json.length()); const std::string lengthPrefix = std::to_string(json.length());
@ -396,59 +402,59 @@ void CalibreWirelessActivity::sendJsonResponse(int opcode, const std::string& da
tcpClient.flush(); tcpClient.flush();
} }
void CalibreWirelessActivity::handleCommand(int opcode, const std::string& data) { void CalibreWirelessActivity::handleCommand(const OpCode opcode, const std::string& data) {
switch (opcode) { switch (opcode) {
case OP_GET_INITIALIZATION_INFO: case OpCode::GET_INITIALIZATION_INFO:
handleGetInitializationInfo(data); handleGetInitializationInfo(data);
break; break;
case OP_GET_DEVICE_INFORMATION: case OpCode::GET_DEVICE_INFORMATION:
handleGetDeviceInformation(); handleGetDeviceInformation();
break; break;
case OP_FREE_SPACE: case OpCode::FREE_SPACE:
handleFreeSpace(); handleFreeSpace();
break; break;
case OP_GET_BOOK_COUNT: case OpCode::GET_BOOK_COUNT:
handleGetBookCount(); handleGetBookCount();
break; break;
case OP_SEND_BOOK: case OpCode::SEND_BOOK:
handleSendBook(data); handleSendBook(data);
break; break;
case OP_SEND_BOOK_METADATA: case OpCode::SEND_BOOK_METADATA:
handleSendBookMetadata(data); handleSendBookMetadata(data);
break; break;
case OP_DISPLAY_MESSAGE: case OpCode::DISPLAY_MESSAGE:
handleDisplayMessage(data); handleDisplayMessage(data);
break; break;
case OP_NOOP: case OpCode::NOOP:
handleNoop(data); handleNoop(data);
break; break;
case OP_SET_CALIBRE_DEVICE_INFO: case OpCode::SET_CALIBRE_DEVICE_INFO:
case OP_SET_CALIBRE_DEVICE_NAME: case OpCode::SET_CALIBRE_DEVICE_NAME:
// These set metadata about the connected Calibre instance. // These set metadata about the connected Calibre instance.
// We don't need this info, just acknowledge receipt. // We don't need this info, just acknowledge receipt.
sendJsonResponse(OP_OK, "{}"); sendJsonResponse(OpCode::OK, "{}");
break; break;
case OP_SET_LIBRARY_INFO: case OpCode::SET_LIBRARY_INFO:
// Library metadata (name, UUID) - not needed for receiving books // Library metadata (name, UUID) - not needed for receiving books
sendJsonResponse(OP_OK, "{}"); sendJsonResponse(OpCode::OK, "{}");
break; break;
case OP_SEND_BOOKLISTS: case OpCode::SEND_BOOKLISTS:
// Calibre asking us to send our book list. We report 0 books in // Calibre asking us to send our book list. We report 0 books in
// handleGetBookCount, so this is effectively a no-op. // handleGetBookCount, so this is effectively a no-op.
sendJsonResponse(OP_OK, "{}"); sendJsonResponse(OpCode::OK, "{}");
break; break;
case OP_TOTAL_SPACE: case OpCode::TOTAL_SPACE:
handleFreeSpace(); handleFreeSpace();
break; break;
default: default:
Serial.printf("[%lu] [CAL] Unknown opcode: %d\n", millis(), opcode); Serial.printf("[%lu] [CAL] Unknown opcode: %d\n", millis(), opcode);
sendJsonResponse(OP_OK, "{}"); sendJsonResponse(OpCode::OK, "{}");
break; break;
} }
} }
void CalibreWirelessActivity::handleGetInitializationInfo(const std::string& data) { void CalibreWirelessActivity::handleGetInitializationInfo(const std::string& data) {
setState(CalibreWirelessState::WAITING); setState(WirelessState::WAITING);
setStatus("Connected to " + calibreHostname + setStatus("Connected to " + calibreHostname +
"\nWaiting for transfer...\n\nIf transfer fails, enable\n'Ignore free space' in Calibre's\nSmartDevice " "\nWaiting for transfer...\n\nIf transfer fails, enable\n'Ignore free space' in Calibre's\nSmartDevice "
"plugin settings."); "plugin settings.");
@ -480,7 +486,7 @@ void CalibreWirelessActivity::handleGetInitializationInfo(const std::string& dat
response += "\"versionOK\":true"; response += "\"versionOK\":true";
response += "}"; response += "}";
sendJsonResponse(OP_OK, response); sendJsonResponse(OpCode::OK, response);
} }
void CalibreWirelessActivity::handleGetDeviceInformation() { void CalibreWirelessActivity::handleGetDeviceInformation() {
@ -494,19 +500,19 @@ void CalibreWirelessActivity::handleGetDeviceInformation() {
response += "\"device_version\":\"" CROSSPOINT_VERSION "\""; response += "\"device_version\":\"" CROSSPOINT_VERSION "\"";
response += "}"; response += "}";
sendJsonResponse(OP_OK, response); sendJsonResponse(OpCode::OK, response);
} }
void CalibreWirelessActivity::handleFreeSpace() { void CalibreWirelessActivity::handleFreeSpace() {
// TODO: Report actual SD card free space instead of hardcoded value // TODO: Report actual SD card free space instead of hardcoded value
// Report 10GB free space for now // Report 10GB free space for now
sendJsonResponse(OP_OK, "{\"free_space_on_device\":10737418240}"); sendJsonResponse(OpCode::OK, "{\"free_space_on_device\":10737418240}");
} }
void CalibreWirelessActivity::handleGetBookCount() { void CalibreWirelessActivity::handleGetBookCount() {
// We report 0 books - Calibre will send books without checking for duplicates // We report 0 books - Calibre will send books without checking for duplicates
std::string response = "{\"count\":0,\"willStream\":true,\"willScan\":false}"; std::string response = "{\"count\":0,\"willStream\":true,\"willScan\":false}";
sendJsonResponse(OP_OK, response); sendJsonResponse(OpCode::OK, response);
} }
void CalibreWirelessActivity::handleSendBook(const std::string& data) { void CalibreWirelessActivity::handleSendBook(const std::string& data) {
@ -563,7 +569,7 @@ void CalibreWirelessActivity::handleSendBook(const std::string& data) {
} }
if (lpath.empty() || length == 0) { if (lpath.empty() || length == 0) {
sendJsonResponse(OP_ERROR, "{\"message\":\"Invalid book data\"}"); sendJsonResponse(OpCode::ERROR, "{\"message\":\"Invalid book data\"}");
return; return;
} }
@ -582,18 +588,18 @@ void CalibreWirelessActivity::handleSendBook(const std::string& data) {
currentFileSize = length; currentFileSize = length;
bytesReceived = 0; bytesReceived = 0;
setState(CalibreWirelessState::RECEIVING); setState(WirelessState::RECEIVING);
setStatus("Receiving: " + filename); setStatus("Receiving: " + filename);
// Open file for writing // Open file for writing
if (!SdMan.openFileForWrite("CAL", currentFilename.c_str(), currentFile)) { if (!SdMan.openFileForWrite("CAL", currentFilename.c_str(), currentFile)) {
setError("Failed to create file"); setError("Failed to create file");
sendJsonResponse(OP_ERROR, "{\"message\":\"Failed to create file\"}"); sendJsonResponse(OpCode::ERROR, "{\"message\":\"Failed to create file\"}");
return; return;
} }
// Send OK to start receiving binary data // Send OK to start receiving binary data
sendJsonResponse(OP_OK, "{}"); sendJsonResponse(OpCode::OK, "{}");
// Switch to binary mode // Switch to binary mode
inBinaryMode = true; inBinaryMode = true;
@ -612,7 +618,7 @@ void CalibreWirelessActivity::handleSendBook(const std::string& data) {
void CalibreWirelessActivity::handleSendBookMetadata(const std::string& data) { void CalibreWirelessActivity::handleSendBookMetadata(const std::string& data) {
// We receive metadata after the book - just acknowledge // We receive metadata after the book - just acknowledge
sendJsonResponse(OP_OK, "{}"); sendJsonResponse(OpCode::OK, "{}");
} }
void CalibreWirelessActivity::handleDisplayMessage(const std::string& data) { void CalibreWirelessActivity::handleDisplayMessage(const std::string& data) {
@ -621,16 +627,16 @@ void CalibreWirelessActivity::handleDisplayMessage(const std::string& data) {
if (data.find("\"messageKind\":1") != std::string::npos) { if (data.find("\"messageKind\":1") != std::string::npos) {
setError("Password required"); setError("Password required");
} }
sendJsonResponse(OP_OK, "{}"); sendJsonResponse(OpCode::OK, "{}");
} }
void CalibreWirelessActivity::handleNoop(const std::string& data) { void CalibreWirelessActivity::handleNoop(const std::string& data) {
// Check for ejecting flag // Check for ejecting flag
if (data.find("\"ejecting\":true") != std::string::npos) { if (data.find("\"ejecting\":true") != std::string::npos) {
setState(CalibreWirelessState::DISCONNECTED); setState(WirelessState::DISCONNECTED);
setStatus("Calibre disconnected"); setStatus("Calibre disconnected");
} }
sendJsonResponse(OP_NOOP, "{}"); sendJsonResponse(OpCode::NOOP, "{}");
} }
void CalibreWirelessActivity::receiveBinaryData() { void CalibreWirelessActivity::receiveBinaryData() {
@ -661,11 +667,11 @@ void CalibreWirelessActivity::receiveBinaryData() {
currentFile.close(); currentFile.close();
inBinaryMode = false; inBinaryMode = false;
setState(CalibreWirelessState::WAITING); setState(WirelessState::WAITING);
setStatus("Received: " + currentFilename + "\nWaiting for more..."); setStatus("Received: " + currentFilename + "\nWaiting for more...");
// Send OK to acknowledge completion // Send OK to acknowledge completion
sendJsonResponse(OP_OK, "{}"); sendJsonResponse(OpCode::OK, "{}");
} }
} }
} }
@ -700,7 +706,7 @@ void CalibreWirelessActivity::render() const {
} }
// Draw progress if receiving // Draw progress if receiving
if (state == CalibreWirelessState::RECEIVING && currentFileSize > 0) { if (state == WirelessState::RECEIVING && currentFileSize > 0) {
const int barWidth = pageWidth - 100; const int barWidth = pageWidth - 100;
constexpr int barHeight = 20; constexpr int barHeight = 20;
constexpr int barX = 50; constexpr int barX = 50;
@ -732,7 +738,7 @@ std::string CalibreWirelessActivity::getDeviceUuid() const {
return std::string(uuid); return std::string(uuid);
} }
void CalibreWirelessActivity::setState(CalibreWirelessState newState) { void CalibreWirelessActivity::setState(WirelessState newState) {
xSemaphoreTake(stateMutex, portMAX_DELAY); xSemaphoreTake(stateMutex, portMAX_DELAY);
state = newState; state = newState;
xSemaphoreGive(stateMutex); xSemaphoreGive(stateMutex);
@ -746,5 +752,5 @@ void CalibreWirelessActivity::setStatus(const std::string& message) {
void CalibreWirelessActivity::setError(const std::string& message) { void CalibreWirelessActivity::setError(const std::string& message) {
errorMessage = message; errorMessage = message;
setState(CalibreWirelessState::ERROR); setState(WirelessState::ERROR);
} }

78
src/activities/network/CalibreWirelessActivity.h
View File

@ -1,29 +1,16 @@
#pragma once #pragma once
#include <SDCardManager.h> #include <SDCardManager.h>
#include <WiFi.h>
#include <WiFiClient.h> #include <WiFiClient.h>
#include <WiFiUdp.h> #include <WiFiUdp.h>
#include <freertos/FreeRTOS.h> #include <freertos/FreeRTOS.h>
#include <freertos/semphr.h> #include <freertos/semphr.h>
#include <freertos/task.h> #include <freertos/task.h>
#include <cstdint>
#include <functional> #include <functional>
#include <string> #include <string>
#include "activities/Activity.h" #include "activities/Activity.h"
// Calibre wireless device states
enum class CalibreWirelessState {
DISCOVERING, // Listening for Calibre server broadcasts
CONNECTING, // Establishing TCP connection
WAITING, // Connected, waiting for commands
RECEIVING, // Receiving a book file
COMPLETE, // Transfer complete
DISCONNECTED, // Calibre disconnected
ERROR // Connection/transfer error
};
/** /**
* CalibreWirelessActivity implements Calibre's "wireless device" protocol. * CalibreWirelessActivity implements Calibre's "wireless device" protocol.
* This allows Calibre desktop to send books directly to the device over WiFi. * This allows Calibre desktop to send books directly to the device over WiFi.
@ -39,13 +26,48 @@ enum class CalibreWirelessState {
* 5. Books are transferred as binary data after SEND_BOOK command * 5. Books are transferred as binary data after SEND_BOOK command
*/ */
class CalibreWirelessActivity final : public Activity { class CalibreWirelessActivity final : public Activity {
// Calibre wireless device states
enum class WirelessState {
DISCOVERING, // Listening for Calibre server broadcasts
CONNECTING, // Establishing TCP connection
WAITING, // Connected, waiting for commands
RECEIVING, // Receiving a book file
COMPLETE, // Transfer complete
DISCONNECTED, // Calibre disconnected
ERROR // Connection/transfer error
};
// Calibre protocol opcodes (from calibre/devices/smart_device_app/driver.py)
enum OpCode : uint8_t {
OK = 0,
SET_CALIBRE_DEVICE_INFO = 1,
SET_CALIBRE_DEVICE_NAME = 2,
GET_DEVICE_INFORMATION = 3,
TOTAL_SPACE = 4,
FREE_SPACE = 5,
GET_BOOK_COUNT = 6,
SEND_BOOKLISTS = 7,
SEND_BOOK = 8,
GET_INITIALIZATION_INFO = 9,
BOOK_DONE = 11,
NOOP = 12, // Was incorrectly 18
DELETE_BOOK = 13,
GET_BOOK_FILE_SEGMENT = 14,
GET_BOOK_METADATA = 15,
SEND_BOOK_METADATA = 16,
DISPLAY_MESSAGE = 17,
CALIBRE_BUSY = 18,
SET_LIBRARY_INFO = 19,
ERROR = 20,
};
TaskHandle_t displayTaskHandle = nullptr; TaskHandle_t displayTaskHandle = nullptr;
TaskHandle_t networkTaskHandle = nullptr; TaskHandle_t networkTaskHandle = nullptr;
SemaphoreHandle_t renderingMutex = nullptr; SemaphoreHandle_t renderingMutex = nullptr;
SemaphoreHandle_t stateMutex = nullptr; SemaphoreHandle_t stateMutex = nullptr;
bool updateRequired = false; bool updateRequired = false;
CalibreWirelessState state = CalibreWirelessState::DISCOVERING; WirelessState state = WirelessState::DISCOVERING;
const std::function<void()> onComplete; const std::function<void()> onComplete;
// UDP discovery // UDP discovery
@ -71,28 +93,6 @@ class CalibreWirelessActivity final : public Activity {
FsFile currentFile; FsFile currentFile;
std::string recvBuffer; // Buffer for incoming data (like KOReader) std::string recvBuffer; // Buffer for incoming data (like KOReader)
// Calibre protocol opcodes (from calibre/devices/smart_device_app/driver.py)
static constexpr int OP_OK = 0;
static constexpr int OP_SET_CALIBRE_DEVICE_INFO = 1;
static constexpr int OP_SET_CALIBRE_DEVICE_NAME = 2;
static constexpr int OP_GET_DEVICE_INFORMATION = 3;
static constexpr int OP_TOTAL_SPACE = 4;
static constexpr int OP_FREE_SPACE = 5;
static constexpr int OP_GET_BOOK_COUNT = 6;
static constexpr int OP_SEND_BOOKLISTS = 7;
static constexpr int OP_SEND_BOOK = 8;
static constexpr int OP_GET_INITIALIZATION_INFO = 9;
static constexpr int OP_BOOK_DONE = 11;
static constexpr int OP_NOOP = 12; // Was incorrectly 18
static constexpr int OP_DELETE_BOOK = 13;
static constexpr int OP_GET_BOOK_FILE_SEGMENT = 14;
static constexpr int OP_GET_BOOK_METADATA = 15;
static constexpr int OP_SEND_BOOK_METADATA = 16;
static constexpr int OP_DISPLAY_MESSAGE = 17;
static constexpr int OP_CALIBRE_BUSY = 18;
static constexpr int OP_SET_LIBRARY_INFO = 19;
static constexpr int OP_ERROR = 20;
static void displayTaskTrampoline(void* param); static void displayTaskTrampoline(void* param);
static void networkTaskTrampoline(void* param); static void networkTaskTrampoline(void* param);
[[noreturn]] void displayTaskLoop(); [[noreturn]] void displayTaskLoop();
@ -103,8 +103,8 @@ class CalibreWirelessActivity final : public Activity {
void listenForDiscovery(); void listenForDiscovery();
void handleTcpClient(); void handleTcpClient();
bool readJsonMessage(std::string& message); bool readJsonMessage(std::string& message);
void sendJsonResponse(int opcode, const std::string& data); void sendJsonResponse(OpCode opcode, const std::string& data);
void handleCommand(int opcode, const std::string& data); void handleCommand(OpCode opcode, const std::string& data);
void receiveBinaryData(); void receiveBinaryData();
// Protocol handlers // Protocol handlers
@ -119,7 +119,7 @@ class CalibreWirelessActivity final : public Activity {
// Utility // Utility
std::string getDeviceUuid() const; std::string getDeviceUuid() const;
void setState(CalibreWirelessState newState); void setState(WirelessState newState);
void setStatus(const std::string& message); void setStatus(const std::string& message);
void setError(const std::string& message); void setError(const std::string& message);

1
src/main.cpp
View File

@ -18,7 +18,6 @@
#include "activities/browser/OpdsBookBrowserActivity.h" #include "activities/browser/OpdsBookBrowserActivity.h"
#include "activities/home/HomeActivity.h" #include "activities/home/HomeActivity.h"
#include "activities/network/CrossPointWebServerActivity.h" #include "activities/network/CrossPointWebServerActivity.h"
#include "activities/network/WifiSelectionActivity.h"
#include "activities/reader/ReaderActivity.h" #include "activities/reader/ReaderActivity.h"
#include "activities/settings/SettingsActivity.h" #include "activities/settings/SettingsActivity.h"
#include "activities/util/FullScreenMessageActivity.h" #include "activities/util/FullScreenMessageActivity.h"