Add preset polish and broadcast metadata (fw 0.8.0).

Ship station reorder, DAB playing ids in presets, RDS PS/RT and DAB DLS in tuner status, Si4684 data-service read, host tests, and UI now-playing lines.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
2026-07-07 00:01:49 +02:00
co-authored by Cursor
parent 9f76ab9e74
commit 0fc714e431
34 changed files with 1379 additions and 65 deletions
+4 -3
View File
@@ -2,8 +2,8 @@
Open-source Hi-Fi DAB+/FM receiver firmware for the ESP32-S3. Open-source Hi-Fi DAB+/FM receiver firmware for the ESP32-S3.
**Status:** fw **0.7.1**CI on `main` (host tests, Doxygen, manual sync); **Status:** fw **0.8.0**RDS/DLS now-playing metadata in tuner status;
companion-chip boot, REST API, Bluetooth pairing, station presets. preset reorder, CI on `main` (host tests, Doxygen, manual sync).
See [`docs/TODO.md`](docs/TODO.md) for the agent task list. See [`docs/TODO.md`](docs/TODO.md) for the agent task list.
## Quick start ## Quick start
@@ -39,7 +39,7 @@ Manual PDF (design + HTTP API + class reference):
cd docs/manual && latexmk -lualatex manual.tex cd docs/manual && latexmk -lualatex manual.tex
``` ```
## HTTP API (fw 0.7.0) ## HTTP API (fw 0.8.0)
| Method | Path | Purpose | | Method | Path | Purpose |
|--------|------|---------| |--------|------|---------|
@@ -61,6 +61,7 @@ cd docs/manual && latexmk -lualatex manual.tex
| GET | `/api/stations` | List saved presets | | GET | `/api/stations` | List saved presets |
| POST | `/api/stations` | Add preset | | POST | `/api/stations` | Add preset |
| POST | `/api/stations/remove` | Remove preset by index | | POST | `/api/stations/remove` | Remove preset by index |
| POST | `/api/stations/reorder` | Move preset (`from`/`to` indices) |
| POST | `/api/stations/tune` | Recall preset on tuner | | POST | `/api/stations/tune` | Recall preset on tuner |
Full schemas, error tokens, and boot flow: [`docs/manual/ch-api.tex`](docs/manual/ch-api.tex). Full schemas, error tokens, and boot flow: [`docs/manual/ch-api.tex`](docs/manual/ch-api.tex).
+3
View File
@@ -29,6 +29,9 @@ idf_component_register(
"src/StationList.cpp" "src/StationList.cpp"
"src/StationListJson.cpp" "src/StationListJson.cpp"
"src/BluetoothJson.cpp" "src/BluetoothJson.cpp"
"src/BroadcastLabel.cpp"
"src/RdsMetadataAccumulator.cpp"
"src/DabDynamicLabelAccumulator.cpp"
INCLUDE_DIRS "include" INCLUDE_DIRS "include"
) )
@@ -0,0 +1,69 @@
/**
* @file BroadcastLabel.hpp
* @brief Validated on-air label text (RDS PS/RT, DAB DLS).
*
* DigiRadio firmware — https://github.com/manvalan/DigiRadio
*
* Copyright 2026 Michele Bigi
* SPDX-License-Identifier: Apache-2.0
*
* @author Michele Bigi
* @date 2026-07-06
*/
#pragma once
#include <cstddef>
#include <optional>
#include <string>
#include <string_view>
namespace core {
/**
* @brief BroadcastLabel — trimmed UTF-8 label from chip byte buffers.
*
* @dname BroadcastLabel
* @return n/a (type)
* @pubstate Owns label_ (immutable after construction).
*
* @author Michele Bigi
* @date 2026-07-06
*/
class BroadcastLabel {
public:
/** Maximum DAB DLS length supported in status JSON. */
static constexpr std::size_t kMaxLength = 128;
/**
* @brief tryFromChipBytes — parse a NUL- or space-padded chip buffer.
*
* @dname tryFromChipBytes
* @param raw Raw bytes from RDS or DAB data service (may contain NUL).
* @return BroadcastLabel when non-empty after trim, otherwise nullopt.
* @pubstate none
*
* @author Michele Bigi
* @date 2026-07-06
*/
[[nodiscard]] static std::optional<BroadcastLabel>
tryFromChipBytes(std::string_view raw);
/**
* @brief value — read the validated label text.
*
* @dname value
* @return Trimmed label string.
* @pubstate reads label_.
*
* @author Michele Bigi
* @date 2026-07-06
*/
[[nodiscard]] std::string_view value() const noexcept;
private:
explicit BroadcastLabel(std::string label);
std::string label_;
};
} // namespace core
@@ -0,0 +1,86 @@
/**
* @file DabDynamicLabelAccumulator.hpp
* @brief Reassemble DAB DLS payloads into one dynamic label string.
*
* DigiRadio firmware — https://github.com/manvalan/DigiRadio
*
* Copyright 2026 Michele Bigi
* SPDX-License-Identifier: Apache-2.0
*
* @author Michele Bigi
* @date 2026-07-06
*/
#pragma once
#include "core/BroadcastLabel.hpp"
#include <array>
#include <cstddef>
#include <cstdint>
#include <optional>
#include <span>
namespace core {
/**
* @brief DabDynamicLabelAccumulator — segmented DAB DLS label buffer.
*
* @dname DabDynamicLabelAccumulator
* @return n/a (type)
* @pubstate Holds partial DLS segments until the label can be read out.
*
* @author Michele Bigi
* @date 2026-07-06
*/
class DabDynamicLabelAccumulator {
public:
/**
* @brief reset — discard accumulated DLS segments.
*
* @dname reset
* @return n/a
* @pubstate clears buffer and segment flags.
*
* @author Michele Bigi
* @date 2026-07-06
*/
void reset() noexcept;
/**
* @brief applySegment — ingest one DLS payload block from the driver.
*
* @dname applySegment
* @param segmentIndex Zero-based segment index from the chip.
* @param segmentCount Total segments advertised for this label.
* @param payload Raw UTF-8 bytes for this segment.
* @return n/a
* @pubstate copies payload into buffer_ at the computed offset.
*
* @author Michele Bigi
* @date 2026-07-06
*/
void applySegment(std::uint16_t segmentIndex,
std::uint16_t segmentCount,
std::span<const std::uint8_t> payload) noexcept;
/**
* @brief label — read the assembled dynamic label when complete.
*
* @dname label
* @return Trimmed DLS text when all segments were received.
* @pubstate reads buffer_ and segmentValid_.
*
* @author Michele Bigi
* @date 2026-07-06
*/
[[nodiscard]] std::optional<BroadcastLabel> label() const;
private:
static constexpr std::size_t kMaxSegments = 32U;
std::array<char, BroadcastLabel::kMaxLength> buffer_{};
std::array<bool, kMaxSegments> segmentValid_{};
std::uint16_t expectedSegments_{0U};
};
} // namespace core
@@ -0,0 +1,102 @@
/**
* @file RdsMetadataAccumulator.hpp
* @brief Accumulate FM RDS program name and radiotext from raw groups.
*
* DigiRadio firmware — https://github.com/manvalan/DigiRadio
*
* Copyright 2026 Michele Bigi
* SPDX-License-Identifier: Apache-2.0
*
* @author Michele Bigi
* @date 2026-07-06
*/
#pragma once
#include "core/BroadcastLabel.hpp"
#include <array>
#include <cstdint>
#include <optional>
namespace core {
/**
* @brief RdsMetadataAccumulator — stateful RDS PS/RT decoder (IEC 62106).
*
* @dname RdsMetadataAccumulator
* @return n/a (type)
* @pubstate Holds partial PS and RT buffers until complete groups arrive.
*
* @author Michele Bigi
* @date 2026-07-06
*/
class RdsMetadataAccumulator {
public:
/**
* @brief reset — clear accumulated PS and radiotext.
*
* @dname reset
* @return n/a
* @pubstate clears internal buffers.
*
* @author Michele Bigi
* @date 2026-07-06
*/
void reset() noexcept;
/**
* @brief applyGroup — ingest one RDS group (blocks AD).
*
* @dname applyGroup
* @param blockA RDS block A (PI code).
* @param blockB RDS block B (group type and address).
* @param blockC RDS block C (text payload).
* @param blockD RDS block D (text payload for RT).
* @return n/a
* @pubstate updates PS/RT buffers for group types 0A and 2A.
*
* @author Michele Bigi
* @date 2026-07-06
*/
void applyGroup(std::uint16_t blockA,
std::uint16_t blockB,
std::uint16_t blockC,
std::uint16_t blockD) noexcept;
/**
* @brief programName — read the accumulated 8-character PS name.
*
* @dname programName
* @return Trimmed PS label when all four segments were received.
* @pubstate reads psBuffer_.
*
* @author Michele Bigi
* @date 2026-07-06
*/
[[nodiscard]] std::optional<BroadcastLabel> programName() const;
/**
* @brief radiotext — read the accumulated 64-character RT string.
*
* @dname radiotext
* @return Trimmed radiotext when at least one RT segment was received.
* @pubstate reads rtBuffer_.
*
* @author Michele Bigi
* @date 2026-07-06
*/
[[nodiscard]] std::optional<BroadcastLabel> radiotext() const;
private:
static constexpr std::size_t kPsSegments = 4U;
static constexpr std::size_t kRtSegments = 16U;
std::array<char, 8> psBuffer_{};
std::array<bool, kPsSegments> psSegmentValid_{};
std::array<char, 64> rtBuffer_{};
std::array<bool, kRtSegments> rtSegmentValid_{};
bool rtAbFlag_{false};
bool rtAbInitialized_{false};
};
} // namespace core
@@ -29,6 +29,7 @@ enum class StationListError {
Full, Full,
NotFound, NotFound,
SlotInUse, SlotInUse,
PersistFailed,
}; };
} // namespace core } // namespace core
@@ -38,6 +38,21 @@ struct StationRemoveRequest {
std::size_t index; ///< Zero-based list index to delete. std::size_t index; ///< Zero-based list index to delete.
}; };
/**
* @brief StationReorderRequest — parsed POST /api/stations/reorder body.
*
* @dname StationReorderRequest
* @return n/a (type)
* @pubstate Plain DTO filled by parseStationReorderJson.
*
* @author Michele Bigi
* @date 2026-07-06
*/
struct StationReorderRequest {
std::size_t fromIndex; ///< Current list position.
std::size_t toIndex; ///< Target list position.
};
/** /**
* @brief serializeStationListJson — serialise all presets for GET /api/stations. * @brief serializeStationListJson — serialise all presets for GET /api/stations.
* *
@@ -93,6 +108,20 @@ parseStationListJson(std::string_view json);
[[nodiscard]] std::expected<StationRemoveRequest, ParseError> [[nodiscard]] std::expected<StationRemoveRequest, ParseError>
parseStationRemoveJson(std::string_view json); parseStationRemoveJson(std::string_view json);
/**
* @brief parseStationReorderJson — validate POST /api/stations/reorder body.
*
* @dname parseStationReorderJson
* @param json Untrusted request body with from/to index fields.
* @return StationReorderRequest on success, or ParseError.
* @pubstate none
*
* @author Michele Bigi
* @date 2026-07-06
*/
[[nodiscard]] std::expected<StationReorderRequest, ParseError>
parseStationReorderJson(std::string_view json);
/** /**
* @brief serializeStationListErrorJson — serialise a station API error. * @brief serializeStationListErrorJson — serialise a station API error.
* *
@@ -12,6 +12,7 @@
*/ */
#pragma once #pragma once
#include "core/BroadcastLabel.hpp"
#include "core/FrequencyKHz.hpp" #include "core/FrequencyKHz.hpp"
#include "core/TunerBand.hpp" #include "core/TunerBand.hpp"
@@ -56,10 +57,15 @@ struct TunerStatus {
std::optional<std::uint8_t> dabFreqIndex; ///< Current Band III ensemble index. std::optional<std::uint8_t> dabFreqIndex; ///< Current Band III ensemble index.
std::optional<std::uint8_t> dabFicQuality; ///< FIC quality 0100 when DAB. std::optional<std::uint8_t> dabFicQuality; ///< FIC quality 0100 when DAB.
std::optional<std::int8_t> dabCnrDb; ///< CNR in dB when DAB. std::optional<std::int8_t> dabCnrDb; ///< CNR in dB when DAB.
std::optional<std::uint32_t> dabPlayingServiceId; ///< Last played DAB service.
std::optional<std::uint32_t> dabPlayingComponentId; ///< Last played DAB component.
std::optional<FrequencyKHz> fmFrequency; ///< Tuned FM centre frequency. std::optional<FrequencyKHz> fmFrequency; ///< Tuned FM centre frequency.
std::optional<std::int8_t> fmRssiDbuV; ///< FM RSSI in dBµV. std::optional<std::int8_t> fmRssiDbuV; ///< FM RSSI in dBµV.
std::optional<std::int8_t> fmSnrDb; ///< FM SNR in dB. std::optional<std::int8_t> fmSnrDb; ///< FM SNR in dB.
std::optional<bool> fmStereo; ///< FM stereo pilot detected. std::optional<bool> fmStereo; ///< FM stereo pilot detected.
std::optional<BroadcastLabel> fmStationName; ///< FM RDS program service name.
std::optional<BroadcastLabel> fmRadiotext; ///< FM RDS radiotext (RT).
std::optional<BroadcastLabel> dabDynamicLabel; ///< DAB DLS now-playing label.
}; };
} // namespace core } // namespace core
@@ -0,0 +1,58 @@
/**
* @file BroadcastLabel.cpp
* @brief BroadcastLabel implementation.
*
* DigiRadio firmware — https://github.com/manvalan/DigiRadio
*
* Copyright 2026 Michele Bigi
* SPDX-License-Identifier: Apache-2.0
*
* @author Michele Bigi
* @date 2026-07-06
*/
#include "core/BroadcastLabel.hpp"
namespace core {
namespace {
[[nodiscard]] std::string trimChipPadding(std::string_view raw)
{
std::size_t end = raw.size();
if (end > BroadcastLabel::kMaxLength) {
end = BroadcastLabel::kMaxLength;
}
while (end > 0U && (raw[end - 1U] == '\0' || raw[end - 1U] == ' ')) {
--end;
}
std::size_t start = 0U;
while (start < end && raw[start] == ' ') {
++start;
}
return std::string(raw.substr(start, end - start));
}
} // namespace
std::optional<BroadcastLabel> BroadcastLabel::tryFromChipBytes(
std::string_view raw)
{
const std::string trimmed = trimChipPadding(raw);
if (trimmed.empty()) {
return std::nullopt;
}
return BroadcastLabel(trimmed);
}
BroadcastLabel::BroadcastLabel(std::string label)
: label_(std::move(label))
{
}
std::string_view BroadcastLabel::value() const noexcept
{
return label_;
}
} // namespace core
@@ -0,0 +1,70 @@
/**
* @file DabDynamicLabelAccumulator.cpp
* @brief DabDynamicLabelAccumulator implementation.
*
* DigiRadio firmware — https://github.com/manvalan/DigiRadio
*
* Copyright 2026 Michele Bigi
* SPDX-License-Identifier: Apache-2.0
*
* @author Michele Bigi
* @date 2026-07-06
*/
#include "core/DabDynamicLabelAccumulator.hpp"
#include <algorithm>
#include <cstring>
namespace core {
void DabDynamicLabelAccumulator::reset() noexcept
{
buffer_.fill('\0');
segmentValid_.fill(false);
expectedSegments_ = 0U;
}
void DabDynamicLabelAccumulator::applySegment(
std::uint16_t segmentIndex,
std::uint16_t segmentCount,
std::span<const std::uint8_t> payload) noexcept
{
if (segmentCount == 0U || segmentCount > kMaxSegments) {
return;
}
if (segmentIndex >= segmentCount) {
return;
}
if (expectedSegments_ != segmentCount) {
reset();
expectedSegments_ = segmentCount;
}
const std::size_t offset =
static_cast<std::size_t>(segmentIndex)
* static_cast<std::size_t>(payload.size());
if (offset >= buffer_.size()) {
return;
}
const std::size_t copyLen =
std::min(payload.size(), buffer_.size() - offset);
std::memcpy(buffer_.data() + offset, payload.data(), copyLen);
segmentValid_[segmentIndex] = true;
}
std::optional<BroadcastLabel> DabDynamicLabelAccumulator::label() const
{
if (expectedSegments_ == 0U) {
return std::nullopt;
}
for (std::uint16_t i = 0U; i < expectedSegments_; ++i) {
if (!segmentValid_[i]) {
return std::nullopt;
}
}
return BroadcastLabel::tryFromChipBytes(
std::string_view(buffer_.data(), buffer_.size()));
}
} // namespace core
@@ -0,0 +1,100 @@
/**
* @file RdsMetadataAccumulator.cpp
* @brief RdsMetadataAccumulator implementation.
*
* DigiRadio firmware — https://github.com/manvalan/DigiRadio
*
* Copyright 2026 Michele Bigi
* SPDX-License-Identifier: Apache-2.0
*
* @author Michele Bigi
* @date 2026-07-06
*/
#include "core/RdsMetadataAccumulator.hpp"
namespace core {
void RdsMetadataAccumulator::reset() noexcept
{
psBuffer_.fill('\0');
psSegmentValid_.fill(false);
rtBuffer_.fill('\0');
rtSegmentValid_.fill(false);
rtAbFlag_ = false;
rtAbInitialized_ = false;
}
void RdsMetadataAccumulator::applyGroup(std::uint16_t blockA,
std::uint16_t blockB,
std::uint16_t blockC,
std::uint16_t blockD) noexcept
{
(void)blockA;
const std::uint8_t groupType =
static_cast<std::uint8_t>((blockB >> 12U) & 0x0FU);
if (groupType == 0U) {
const std::size_t index =
static_cast<std::size_t>((blockB >> 1U) & 0x03U);
if (index < kPsSegments) {
psBuffer_[index * 2U] =
static_cast<char>((blockC >> 8U) & 0xFFU);
psBuffer_[index * 2U + 1U] = static_cast<char>(blockC & 0xFFU);
psSegmentValid_[index] = true;
}
return;
}
if (groupType == 2U) {
const bool abFlag = (blockB & 0x10U) != 0U;
if (!rtAbInitialized_ || abFlag != rtAbFlag_) {
rtBuffer_.fill('\0');
rtSegmentValid_.fill(false);
rtAbFlag_ = abFlag;
rtAbInitialized_ = true;
}
const std::size_t index =
static_cast<std::size_t>(blockB & 0x0FU);
if (index < kRtSegments) {
rtBuffer_[index * 4U] =
static_cast<char>((blockC >> 8U) & 0xFFU);
rtBuffer_[index * 4U + 1U] =
static_cast<char>(blockC & 0xFFU);
rtBuffer_[index * 4U + 2U] =
static_cast<char>((blockD >> 8U) & 0xFFU);
rtBuffer_[index * 4U + 3U] =
static_cast<char>(blockD & 0xFFU);
rtSegmentValid_[index] = true;
}
}
}
std::optional<BroadcastLabel> RdsMetadataAccumulator::programName() const
{
for (bool valid : psSegmentValid_) {
if (!valid) {
return std::nullopt;
}
}
return BroadcastLabel::tryFromChipBytes(
std::string_view(psBuffer_.data(), psBuffer_.size()));
}
std::optional<BroadcastLabel> RdsMetadataAccumulator::radiotext() const
{
bool any = false;
for (bool valid : rtSegmentValid_) {
if (valid) {
any = true;
break;
}
}
if (!any) {
return std::nullopt;
}
return BroadcastLabel::tryFromChipBytes(
std::string_view(rtBuffer_.data(), rtBuffer_.size()));
}
} // namespace core
@@ -240,6 +240,21 @@ parseStationRemoveJson(std::string_view json)
return StationRemoveRequest{.index = static_cast<std::size_t>(index)}; return StationRemoveRequest{.index = static_cast<std::size_t>(index)};
} }
std::expected<StationReorderRequest, ParseError>
parseStationReorderJson(std::string_view json)
{
unsigned long fromIndex = 0;
unsigned long toIndex = 0;
if (!extractJsonUint(json, "from", fromIndex)
|| !extractJsonUint(json, "to", toIndex)) {
return std::unexpected(ParseError::MissingField);
}
return StationReorderRequest{
.fromIndex = static_cast<std::size_t>(fromIndex),
.toIndex = static_cast<std::size_t>(toIndex),
};
}
std::string serializeStationListErrorJson(const char* reason) std::string serializeStationListErrorJson(const char* reason)
{ {
std::ostringstream out; std::ostringstream out;
@@ -258,6 +273,8 @@ const char* stationListErrorToken(StationListError error) noexcept
return "not_found"; return "not_found";
case StationListError::SlotInUse: case StationListError::SlotInUse:
return "slot_in_use"; return "slot_in_use";
case StationListError::PersistFailed:
return "persist_failed";
} }
return "station_error"; return "station_error";
} }
+42 -11
View File
@@ -58,6 +58,29 @@ namespace {
return band == TunerBand::Fm ? "fm" : "dab"; return band == TunerBand::Fm ? "fm" : "dab";
} }
void appendJsonString(std::ostringstream& out, std::string_view value)
{
out << '"';
for (char c : value) {
if (c == '"' || c == '\\') {
out << '\\';
}
out << c;
}
out << '"';
}
void appendOptionalLabel(std::ostringstream& out,
std::string_view key,
const std::optional<BroadcastLabel>& label)
{
if (!label) {
return;
}
out << ",\"" << key << "\":";
appendJsonString(out, label->value());
}
} // namespace } // namespace
std::string serializeTunerStatusJson(const TunerStatus& status) std::string serializeTunerStatusJson(const TunerStatus& status)
@@ -82,6 +105,15 @@ std::string serializeTunerStatusJson(const TunerStatus& status)
if (status.dabCnrDb) { if (status.dabCnrDb) {
out << ",\"cnr_db\":" << static_cast<int>(*status.dabCnrDb); out << ",\"cnr_db\":" << static_cast<int>(*status.dabCnrDb);
} }
if (status.dabPlayingServiceId) {
out << ",\"playing_service_id\":"
<< *status.dabPlayingServiceId;
}
if (status.dabPlayingComponentId) {
out << ",\"playing_component_id\":"
<< *status.dabPlayingComponentId;
}
appendOptionalLabel(out, "dynamic_label", status.dabDynamicLabel);
out << "},\"fm\":null"; out << "},\"fm\":null";
} else { } else {
out << ",\"fm\":{"; out << ",\"fm\":{";
@@ -100,6 +132,8 @@ std::string serializeTunerStatusJson(const TunerStatus& status)
if (status.fmStereo) { if (status.fmStereo) {
out << ",\"stereo\":" << (*status.fmStereo ? "true" : "false"); out << ",\"stereo\":" << (*status.fmStereo ? "true" : "false");
} }
appendOptionalLabel(out, "station_name", status.fmStationName);
appendOptionalLabel(out, "radiotext", status.fmRadiotext);
out << "},\"dab\":null"; out << "},\"dab\":null";
} }
out << '}'; out << '}';
@@ -116,18 +150,15 @@ std::string serializeTunerServicesJson(
out << ','; out << ',';
} }
const auto& s = services[i]; const auto& s = services[i];
out << "{\"service_id\":" << s.serviceId std::string_view labelText(s.label.data(), s.label.size());
<< ",\"component_id\":" << s.componentId << ",\"label\":\""; const std::size_t nul = labelText.find('\0');
for (char c : s.label) { if (nul != std::string_view::npos) {
if (c == '\0') { labelText = labelText.substr(0U, nul);
break;
}
if (c == '"' || c == '\\') {
out << '\\';
}
out << c;
} }
out << "\"}"; out << "{\"service_id\":" << s.serviceId
<< ",\"component_id\":" << s.componentId << ",\"label\":";
appendJsonString(out, labelText);
out << "}";
} }
out << "]}"; out << "]}";
return out.str(); return out.str();
@@ -41,6 +41,9 @@ add_library(digiradio_core STATIC
"${CORE_SRC_DIR}/StationList.cpp" "${CORE_SRC_DIR}/StationList.cpp"
"${CORE_SRC_DIR}/StationListJson.cpp" "${CORE_SRC_DIR}/StationListJson.cpp"
"${CORE_SRC_DIR}/BluetoothJson.cpp" "${CORE_SRC_DIR}/BluetoothJson.cpp"
"${CORE_SRC_DIR}/BroadcastLabel.cpp"
"${CORE_SRC_DIR}/RdsMetadataAccumulator.cpp"
"${CORE_SRC_DIR}/DabDynamicLabelAccumulator.cpp"
) )
target_include_directories(digiradio_core PUBLIC target_include_directories(digiradio_core PUBLIC
"${CMAKE_CURRENT_SOURCE_DIR}/../include" "${CMAKE_CURRENT_SOURCE_DIR}/../include"
@@ -78,6 +81,18 @@ add_executable(enhancements_design_test enhancements_design_test.cpp)
target_link_libraries(enhancements_design_test PRIVATE digiradio_core) target_link_libraries(enhancements_design_test PRIVATE digiradio_core)
add_test(NAME enhancements_design_test COMMAND enhancements_design_test) add_test(NAME enhancements_design_test COMMAND enhancements_design_test)
add_executable(station_service_test station_service_test.cpp)
target_include_directories(station_service_test PRIVATE
"${CMAKE_CURRENT_SOURCE_DIR}/../../services/station/include"
"${CMAKE_CURRENT_SOURCE_DIR}/../../services/tuner/include"
)
target_sources(station_service_test PRIVATE
"${CMAKE_CURRENT_SOURCE_DIR}/../../services/station/src/StationService.cpp"
"${CMAKE_CURRENT_SOURCE_DIR}/../../services/tuner/src/TunerService.cpp"
)
target_link_libraries(station_service_test PRIVATE digiradio_core)
add_test(NAME station_service_test COMMAND station_service_test)
add_executable(station_list_test station_list_test.cpp) add_executable(station_list_test station_list_test.cpp)
target_link_libraries(station_list_test PRIVATE digiradio_core) target_link_libraries(station_list_test PRIVATE digiradio_core)
add_test(NAME station_list_test COMMAND station_list_test) add_test(NAME station_list_test COMMAND station_list_test)
@@ -85,3 +100,7 @@ add_test(NAME station_list_test COMMAND station_list_test)
add_executable(bt1035_at_test bt1035_at_test.cpp) add_executable(bt1035_at_test bt1035_at_test.cpp)
target_link_libraries(bt1035_at_test PRIVATE digiradio_core) target_link_libraries(bt1035_at_test PRIVATE digiradio_core)
add_test(NAME bt1035_at_test COMMAND bt1035_at_test) add_test(NAME bt1035_at_test COMMAND bt1035_at_test)
add_executable(broadcast_metadata_test broadcast_metadata_test.cpp)
target_link_libraries(broadcast_metadata_test PRIVATE digiradio_core)
add_test(NAME broadcast_metadata_test COMMAND broadcast_metadata_test)
@@ -0,0 +1,115 @@
/**
* @file broadcast_metadata_test.cpp
* @brief Host tests for broadcast metadata parsing (RDS / DLS).
*
* DigiRadio firmware — https://github.com/manvalan/DigiRadio
*
* Copyright 2026 Michele Bigi
* SPDX-License-Identifier: Apache-2.0
*
* @author Michele Bigi
* @date 2026-07-06
*/
#include "core/BroadcastLabel.hpp"
#include "core/DabDynamicLabelAccumulator.hpp"
#include "core/RdsMetadataAccumulator.hpp"
#include <cstdlib>
#include <iostream>
#include <string_view>
#include <vector>
namespace {
[[nodiscard]] int runChipLabelTrimTest()
{
const auto label = core::BroadcastLabel::tryFromChipBytes(" RAI 1 \0\0");
if (!label || label->value() != "RAI 1") {
std::cerr << "chip label trim failed\n";
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
[[nodiscard]] int runRdsProgramNameTest()
{
core::RdsMetadataAccumulator acc;
acc.applyGroup(0U, 0x0000U, 0x5445U, 0U);
acc.applyGroup(0U, 0x0002U, 0x5354U, 0U);
acc.applyGroup(0U, 0x0004U, 0x2020U, 0U);
acc.applyGroup(0U, 0x0006U, 0x2020U, 0U);
const auto name = acc.programName();
if (!name || name->value() != "TEST") {
std::cerr << "RDS PS parse failed\n";
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
[[nodiscard]] int runRdsRadiotextTest()
{
core::RdsMetadataAccumulator acc;
acc.applyGroup(0U, 0x2000U, 0x4E6FU, 0x7720U);
const auto text = acc.radiotext();
if (!text || text->value() != "Now") {
std::cerr << "RDS RT parse failed: "
<< (text ? std::string(text->value()) : "nullopt") << '\n';
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
[[nodiscard]] int runDabDynamicLabelTest()
{
core::DabDynamicLabelAccumulator acc;
const std::vector<std::uint8_t> payload = {'L', 'i', 'v', 'e', ' ', 'D', 'J'};
acc.applySegment(0U, 1U, payload);
const auto label = acc.label();
if (!label || label->value() != "Live DJ") {
std::cerr << "DLS single-segment parse failed\n";
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
[[nodiscard]] int runDabDynamicLabelSegmentsTest()
{
core::DabDynamicLabelAccumulator acc;
const std::vector<std::uint8_t> part1 = {'A', 'B', 'C'};
const std::vector<std::uint8_t> part2 = {'D', 'E', 'F'};
acc.applySegment(0U, 2U, part1);
acc.applySegment(1U, 2U, part2);
const auto label = acc.label();
if (!label || label->value() != "ABCDEF") {
std::cerr << "DLS multi-segment parse failed\n";
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
} // namespace
int main()
{
if (runChipLabelTrimTest() != EXIT_SUCCESS) {
return EXIT_FAILURE;
}
if (runRdsProgramNameTest() != EXIT_SUCCESS) {
return EXIT_FAILURE;
}
if (runRdsRadiotextTest() != EXIT_SUCCESS) {
return EXIT_FAILURE;
}
if (runDabDynamicLabelTest() != EXIT_SUCCESS) {
return EXIT_FAILURE;
}
if (runDabDynamicLabelSegmentsTest() != EXIT_SUCCESS) {
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
@@ -81,6 +81,37 @@ namespace {
return EXIT_SUCCESS; return EXIT_SUCCESS;
} }
[[nodiscard]] int runParseStationReorderJsonTest()
{
const auto parsed =
core::parseStationReorderJson(R"({"from":1,"to":0})");
if (!parsed || parsed->fromIndex != 1U || parsed->toIndex != 0U) {
std::cerr << "reorder parse failed\n";
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
[[nodiscard]] int runStationListReorderTest()
{
core::StationList list;
if (auto a = list.add(makeFmStation("A", 88000U, 1U)); !a) {
return EXIT_FAILURE;
}
if (auto b = list.add(makeFmStation("B", 90000U, 2U)); !b) {
return EXIT_FAILURE;
}
if (auto moved = list.move(1U, 0U); !moved) {
std::cerr << "move failed\n";
return EXIT_FAILURE;
}
if (list.stations()[0U].name().value() != "B") {
std::cerr << "expected B first after reorder\n";
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
} // namespace } // namespace
int main() int main()
@@ -94,5 +125,11 @@ int main()
if (runParseStationJsonTest() != EXIT_SUCCESS) { if (runParseStationJsonTest() != EXIT_SUCCESS) {
return EXIT_FAILURE; return EXIT_FAILURE;
} }
if (runParseStationReorderJsonTest() != EXIT_SUCCESS) {
return EXIT_FAILURE;
}
if (runStationListReorderTest() != EXIT_SUCCESS) {
return EXIT_FAILURE;
}
return EXIT_SUCCESS; return EXIT_SUCCESS;
} }
@@ -0,0 +1,226 @@
/**
* @file station_service_test.cpp
* @brief Host tests for StationService with in-memory fake store.
*
* DigiRadio firmware — https://github.com/manvalan/DigiRadio
*
* Copyright 2026 Michele Bigi
* SPDX-License-Identifier: Apache-2.0
*
* @author Michele Bigi
* @date 2026-07-06
*/
#include "core/FrequencyKHz.hpp"
#include "core/ISecureStore.hpp"
#include "core/StationListJson.hpp"
#include "core/StationName.hpp"
#include "core/TunerBand.hpp"
#include "station/StationService.hpp"
#include "tuner/TunerService.hpp"
#include <cstdlib>
#include <iostream>
#include <optional>
#include <string>
namespace {
class FakeTuner final : public core::ITuner {
public:
[[nodiscard]] std::expected<void, core::TunerError> boot(
core::TunerBand) override
{
return {};
}
[[nodiscard]] std::expected<core::TunerBand, core::TunerError> currentBand()
const override
{
return core::TunerBand::Dab;
}
[[nodiscard]] std::expected<core::TunerStatus, core::TunerError> readStatus()
override
{
core::TunerStatus status = {};
status.booted = true;
status.band = core::TunerBand::Dab;
status.locked = true;
status.volume = 40;
status.dabFreqIndex = 12U;
return status;
}
[[nodiscard]] std::expected<void, core::TunerError> tuneDab(
std::uint8_t) override
{
return {};
}
[[nodiscard]] std::expected<void, core::TunerError> tuneFm(
core::FrequencyKHz) override
{
return {};
}
[[nodiscard]] std::expected<core::FrequencyKHz, core::TunerError> seekFm(
core::SeekDirection) override
{
return std::unexpected(core::TunerError::WrongBand);
}
[[nodiscard]] std::expected<std::vector<core::TunerServiceEntry>,
core::TunerError>
listDabServices() override
{
return std::vector<core::TunerServiceEntry>{};
}
[[nodiscard]] std::expected<void, core::TunerError> playDabService(
std::uint32_t, std::uint32_t) override
{
return {};
}
[[nodiscard]] std::expected<void, core::TunerError> setVolume(
std::uint8_t) override
{
return {};
}
};
class FakeSecureStore final : public core::ISecureStore {
public:
[[nodiscard]] bool hasWifiCredentials() const override
{
return false;
}
[[nodiscard]] std::expected<void, core::StoreError> saveWifiCredentials(
const core::WifiCredentials&) override
{
return std::unexpected(core::StoreError::IoFailed);
}
[[nodiscard]] std::expected<core::WifiCredentials, core::StoreError>
loadWifiCredentials() const override
{
return std::unexpected(core::StoreError::NotFound);
}
[[nodiscard]] std::expected<void, core::StoreError> clearWifiCredentials()
override
{
return {};
}
[[nodiscard]] bool hasStationList() const override
{
return stationJson_.has_value();
}
[[nodiscard]] std::expected<void, core::StoreError> saveStationListJson(
std::string_view json) override
{
stationJson_ = std::string(json);
return {};
}
[[nodiscard]] std::expected<std::string, core::StoreError>
loadStationListJson() const override
{
if (!stationJson_) {
return std::unexpected(core::StoreError::NotFound);
}
return *stationJson_;
}
[[nodiscard]] std::expected<void, core::StoreError> clearStationList()
override
{
stationJson_.reset();
return {};
}
private:
std::optional<std::string> stationJson_;
};
[[nodiscard]] core::Station makeFmStation(const char* name, std::uint32_t khz)
{
return core::Station(
*core::StationName::tryFrom(name),
core::TunerBand::Fm,
0U,
std::nullopt,
std::nullopt,
*core::FrequencyKHz::tryFromKhz(khz),
std::nullopt);
}
[[nodiscard]] int runPersistRoundTripTest()
{
FakeSecureStore store;
FakeTuner tuner;
tuner::TunerService tunerService(tuner);
station::StationService service(store, tunerService);
if (auto added = service.add(makeFmStation("Jazz", 101500U)); !added) {
std::cerr << "add failed\n";
return EXIT_FAILURE;
}
station::StationService reloaded(store, tunerService);
if (auto loaded = reloaded.loadFromStore(); !loaded) {
std::cerr << "load failed\n";
return EXIT_FAILURE;
}
if (reloaded.list().stations().size() != 1U) {
std::cerr << "expected one preset after reload\n";
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
[[nodiscard]] int runReorderPersistTest()
{
FakeSecureStore store;
FakeTuner tuner;
tuner::TunerService tunerService(tuner);
station::StationService service(store, tunerService);
if (auto a = service.add(makeFmStation("A", 88000U)); !a) {
return EXIT_FAILURE;
}
if (auto b = service.add(makeFmStation("B", 90000U)); !b) {
return EXIT_FAILURE;
}
if (auto moved = service.reorder(1U, 0U); !moved) {
std::cerr << "reorder failed\n";
return EXIT_FAILURE;
}
station::StationService reloaded(store, tunerService);
if (auto loaded = reloaded.loadFromStore(); !loaded) {
return EXIT_FAILURE;
}
if (reloaded.list().stations()[0U].name().value() != "B") {
std::cerr << "reorder not persisted\n";
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
} // namespace
int main()
{
if (runPersistRoundTripTest() != EXIT_SUCCESS) {
return EXIT_FAILURE;
}
if (runReorderPersistTest() != EXIT_SUCCESS) {
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
@@ -16,6 +16,7 @@
#include "core/TunerBand.hpp" #include "core/TunerBand.hpp"
#include "core/TunerJson.hpp" #include "core/TunerJson.hpp"
#include "core/TunerStatus.hpp" #include "core/TunerStatus.hpp"
#include "core/BroadcastLabel.hpp"
#include <cstdlib> #include <cstdlib>
#include <iostream> #include <iostream>
@@ -102,6 +103,26 @@ namespace {
return EXIT_SUCCESS; return EXIT_SUCCESS;
} }
[[nodiscard]] int runTunerStatusPlayingSerialiseTest()
{
core::TunerStatus status = {};
status.booted = true;
status.band = core::TunerBand::Dab;
status.locked = true;
status.volume = 40;
status.dabFreqIndex = 12U;
status.dabPlayingServiceId = 42U;
status.dabPlayingComponentId = 7U;
const std::string json = core::serializeTunerStatusJson(status);
if (json.find("\"playing_service_id\":42") == std::string::npos
|| json.find("\"playing_component_id\":7") == std::string::npos) {
std::cerr << "playing ids missing: " << json << '\n';
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
[[nodiscard]] int runTunerServicesSerialiseTest() [[nodiscard]] int runTunerServicesSerialiseTest()
{ {
core::TunerServiceEntry entry = {}; core::TunerServiceEntry entry = {};
@@ -118,6 +139,36 @@ namespace {
return EXIT_SUCCESS; return EXIT_SUCCESS;
} }
[[nodiscard]] int runTunerStatusMetadataSerialiseTest()
{
core::TunerStatus status = {};
status.booted = true;
status.band = core::TunerBand::Fm;
status.locked = true;
status.volume = 40;
status.fmFrequency = *core::FrequencyKHz::tryFromKhz(101500U);
status.fmStationName = core::BroadcastLabel::tryFromChipBytes("RADIO 1");
status.fmRadiotext = core::BroadcastLabel::tryFromChipBytes("Now playing");
const std::string json = core::serializeTunerStatusJson(status);
if (json.find("\"station_name\":\"RADIO 1\"") == std::string::npos
|| json.find("\"radiotext\":\"Now playing\"") == std::string::npos) {
std::cerr << "FM metadata missing: " << json << '\n';
return EXIT_FAILURE;
}
status.band = core::TunerBand::Dab;
status.dabFreqIndex = 5U;
status.dabDynamicLabel =
core::BroadcastLabel::tryFromChipBytes("Live show");
const std::string dabJson = core::serializeTunerStatusJson(status);
if (dabJson.find("\"dynamic_label\":\"Live show\"") == std::string::npos) {
std::cerr << "DAB metadata missing: " << dabJson << '\n';
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
[[nodiscard]] int runTunerErrorSerialiseTest() [[nodiscard]] int runTunerErrorSerialiseTest()
{ {
if (!expectEqual(core::serializeTunerErrorJson("not_booted"), if (!expectEqual(core::serializeTunerErrorJson("not_booted"),
@@ -146,6 +197,12 @@ int main()
if (runTunerStatusSerialiseTest() != EXIT_SUCCESS) { if (runTunerStatusSerialiseTest() != EXIT_SUCCESS) {
return EXIT_FAILURE; return EXIT_FAILURE;
} }
if (runTunerStatusPlayingSerialiseTest() != EXIT_SUCCESS) {
return EXIT_FAILURE;
}
if (runTunerStatusMetadataSerialiseTest() != EXIT_SUCCESS) {
return EXIT_FAILURE;
}
if (runTunerServicesSerialiseTest() != EXIT_SUCCESS) { if (runTunerServicesSerialiseTest() != EXIT_SUCCESS) {
return EXIT_FAILURE; return EXIT_FAILURE;
} }
@@ -21,6 +21,7 @@
#include <cstdint> #include <cstdint>
#include <expected> #include <expected>
#include <optional>
#include <span> #include <span>
#include <vector> #include <vector>
@@ -236,6 +237,21 @@ public:
*/ */
[[nodiscard]] std::expected<Si4684FmRdsStatus, Si4684Error> readFmRds(); [[nodiscard]] std::expected<Si4684FmRdsStatus, Si4684Error> readFmRds();
/**
* @brief readDabServiceData — read one queued DAB data-service block.
*
* @dname readDabServiceData
* @param statusOnly Poll queue depth without consuming payload.
* @param ack Acknowledge DSRVINT when reading payload.
* @return Data block on success, nullopt when queue empty, or Si4684Error.
* @pubstate reads GET_DIGITAL_SERVICE_DATA response bytes.
*
* @author Michele Bigi
* @date 2026-07-06
*/
[[nodiscard]] std::expected<std::optional<Si4684DabServiceData>, Si4684Error>
readDabServiceData(bool statusOnly, bool ack);
/** /**
* @brief installDefaultDabFrequencyPlan — load Band III frequency list. * @brief installDefaultDabFrequencyPlan — load Band III frequency list.
* *
@@ -12,10 +12,14 @@
*/ */
#pragma once #pragma once
#include "core/DabDynamicLabelAccumulator.hpp"
#include "core/FrequencyKHz.hpp" #include "core/FrequencyKHz.hpp"
#include "core/ITuner.hpp" #include "core/ITuner.hpp"
#include "core/RdsMetadataAccumulator.hpp"
#include "si4684/Si4684Driver.hpp" #include "si4684/Si4684Driver.hpp"
#include <optional>
namespace si4684 { namespace si4684 {
/** /**
@@ -190,6 +194,10 @@ private:
std::uint8_t dabIndex_; std::uint8_t dabIndex_;
core::FrequencyKHz fmFrequency_; core::FrequencyKHz fmFrequency_;
std::uint8_t volume_; std::uint8_t volume_;
core::RdsMetadataAccumulator rdsMetadata_;
core::DabDynamicLabelAccumulator dabDynamicLabel_;
std::optional<std::uint32_t> lastDabServiceId_;
std::optional<std::uint32_t> lastDabComponentId_;
}; };
} // namespace si4684 } // namespace si4684
@@ -18,6 +18,7 @@
#include <array> #include <array>
#include <cstddef> #include <cstddef>
#include <cstdint> #include <cstdint>
#include <vector>
namespace si4684 { namespace si4684 {
@@ -113,6 +114,27 @@ struct Si4684FmRdsStatus {
std::uint16_t blockC; ///< RDS block C. std::uint16_t blockC; ///< RDS block C.
std::uint16_t blockD; ///< RDS block D. std::uint16_t blockD; ///< RDS block D.
bool received; ///< Group received flag. bool received; ///< Group received flag.
std::uint8_t fifoUsed; ///< Remaining groups in the RDS FIFO.
};
/**
* @brief Si4684DabServiceData — one GET_DIGITAL_SERVICE_DATA block.
*
* @dname Si4684DabServiceData
* @return n/a (type)
* @pubstate Plain DTO from GET_DIGITAL_SERVICE_DATA response bytes.
*
* @author Michele Bigi
* @date 2026-07-06
*/
struct Si4684DabServiceData {
std::uint32_t serviceId; ///< Associated DAB service identifier.
std::uint32_t componentId; ///< Associated component identifier.
std::uint8_t dataSrc; ///< Payload source (2 = DLS PAD).
std::uint16_t byteCount; ///< Payload byte count.
std::uint16_t segmentIndex; ///< Zero-based segment index.
std::uint16_t segmentCount; ///< Total segments for this label object.
std::vector<std::uint8_t> payload; ///< Raw payload bytes.
}; };
/** /**
@@ -587,6 +587,7 @@ std::expected<Si4684FmRdsStatus, Si4684Error> Si4684Driver::readFmRds()
Si4684FmRdsStatus rds = {}; Si4684FmRdsStatus rds = {};
rds.received = (raw[4] & 0x01U) != 0U; rds.received = (raw[4] & 0x01U) != 0U;
rds.fifoUsed = raw[10];
rds.blockA = readLe16(raw.data() + 12); rds.blockA = readLe16(raw.data() + 12);
rds.blockB = readLe16(raw.data() + 14); rds.blockB = readLe16(raw.data() + 14);
rds.blockC = readLe16(raw.data() + 16); rds.blockC = readLe16(raw.data() + 16);
@@ -594,6 +595,60 @@ std::expected<Si4684FmRdsStatus, Si4684Error> Si4684Driver::readFmRds()
return rds; return rds;
} }
std::expected<std::optional<Si4684DabServiceData>, Si4684Error>
Si4684Driver::readDabServiceData(bool statusOnly, bool ack)
{
if (auto band = ensureBand(Si4684Band::Dab); !band) {
return std::unexpected(band.error());
}
const std::uint8_t arg1 =
static_cast<std::uint8_t>((statusOnly ? 0x08U : 0x00U)
| (ack ? 0x01U : 0x00U));
const std::uint8_t args[] = {arg1};
if (auto cmd =
writeCommand(Command::GetDigitalServiceData, args, sizeof(args));
!cmd) {
return std::unexpected(Si4684Error::CommandFailed);
}
std::array<std::uint8_t, 24> header = {};
if (auto rd = readRaw(header); !rd) {
return std::unexpected(rd.error());
}
if (statusOnly) {
if (header[5] == 0U) {
return std::optional<Si4684DabServiceData>{};
}
}
const std::uint16_t byteCount = readLe16(header.data() + 18);
if (byteCount == 0U) {
return std::optional<Si4684DabServiceData>{};
}
if (byteCount + 24U > kSpiBufferSize) {
return std::unexpected(Si4684Error::ReplyTooShort);
}
std::vector<std::uint8_t> body(byteCount, 0U);
if (byteCount > 0U) {
if (auto rd = readRaw(body); !rd) {
return std::unexpected(rd.error());
}
}
Si4684DabServiceData data = {};
data.dataSrc = static_cast<std::uint8_t>((header[7] >> 6U) & 0x03U);
data.serviceId = readLe32(header.data() + 8);
data.componentId = readLe32(header.data() + 12);
data.byteCount = byteCount;
data.segmentIndex = readLe16(header.data() + 20);
data.segmentCount = readLe16(header.data() + 22);
data.payload = std::move(body);
return data;
}
std::expected<void, Si4684Error> Si4684Driver::installDefaultDabFrequencyPlan() std::expected<void, Si4684Error> Si4684Driver::installDefaultDabFrequencyPlan()
{ {
if (auto band = ensureBand(Si4684Band::Dab); !band) { if (auto band = ensureBand(Si4684Band::Dab); !band) {
@@ -89,6 +89,19 @@ std::expected<core::TunerStatus, core::TunerError> Si4684Tuner::readStatus()
} else { } else {
return std::unexpected(mapError(dig.error())); return std::unexpected(mapError(dig.error()));
} }
if (lastDabServiceId_) {
if (auto data = driver_.readDabServiceData(false, true); data) {
if (*data && (*data)->dataSrc == 2U) {
dabDynamicLabel_.applySegment((*data)->segmentIndex,
(*data)->segmentCount,
(*data)->payload);
status.dabDynamicLabel = dabDynamicLabel_.label();
}
} else {
return std::unexpected(mapError(data.error()));
}
}
} else { } else {
status.fmFrequency = fmFrequency_; status.fmFrequency = fmFrequency_;
if (auto rsq = driver_.readFmRsq(); rsq) { if (auto rsq = driver_.readFmRsq(); rsq) {
@@ -101,6 +114,25 @@ std::expected<core::TunerStatus, core::TunerError> Si4684Tuner::readStatus()
} else { } else {
return std::unexpected(mapError(rsq.error())); return std::unexpected(mapError(rsq.error()));
} }
for (int attempt = 0; attempt < 8; ++attempt) {
auto rds = driver_.readFmRds();
if (!rds) {
return std::unexpected(mapError(rds.error()));
}
if (!rds->received) {
break;
}
rdsMetadata_.applyGroup(rds->blockA,
rds->blockB,
rds->blockC,
rds->blockD);
if (rds->fifoUsed <= 1U) {
break;
}
}
status.fmStationName = rdsMetadata_.programName();
status.fmRadiotext = rdsMetadata_.radiotext();
} }
return status; return status;
} }
@@ -112,6 +144,9 @@ std::expected<void, core::TunerError> Si4684Tuner::tuneDab(
return std::unexpected(mapError(result.error())); return std::unexpected(mapError(result.error()));
} }
dabIndex_ = freqIndex; dabIndex_ = freqIndex;
dabDynamicLabel_.reset();
lastDabServiceId_.reset();
lastDabComponentId_.reset();
return {}; return {};
} }
@@ -122,6 +157,7 @@ std::expected<void, core::TunerError> Si4684Tuner::tuneFm(
return std::unexpected(mapError(result.error())); return std::unexpected(mapError(result.error()));
} }
fmFrequency_ = frequency; fmFrequency_ = frequency;
rdsMetadata_.reset();
return {}; return {};
} }
@@ -132,6 +168,7 @@ std::expected<core::FrequencyKHz, core::TunerError> Si4684Tuner::seekFm(
return std::unexpected(mapError(result.error())); return std::unexpected(mapError(result.error()));
} }
fmFrequency_ = *result; fmFrequency_ = *result;
rdsMetadata_.reset();
return *result; return *result;
} }
@@ -171,6 +208,9 @@ std::expected<void, core::TunerError> Si4684Tuner::playDabService(
if (auto result = driver_.startDabService(serviceId, componentId); !result) { if (auto result = driver_.startDabService(serviceId, componentId); !result) {
return std::unexpected(mapError(result.error())); return std::unexpected(mapError(result.error()));
} }
lastDabServiceId_ = serviceId;
lastDabComponentId_ = componentId;
dabDynamicLabel_.reset();
return {}; return {};
} }
+41 -1
View File
@@ -50,7 +50,7 @@ namespace net {
namespace { namespace {
constexpr char kTag[] = "SetupWebServer"; constexpr char kTag[] = "SetupWebServer";
constexpr char kFirmwareVersion[] = "0.7.0"; constexpr char kFirmwareVersion[] = "0.8.0";
constexpr unsigned kRebootDelaySec = 3; constexpr unsigned kRebootDelaySec = 3;
extern const uint8_t www_index_html_gz_start[] asm( extern const uint8_t www_index_html_gz_start[] asm(
@@ -796,6 +796,38 @@ esp_err_t stationsRemovePostHandler(httpd_req_t* req)
return httpd_resp_send(req, "{\"status\":\"removed\"}", 20); return httpd_resp_send(req, "{\"status\":\"removed\"}", 20);
} }
esp_err_t stationsReorderPostHandler(httpd_req_t* req)
{
auto* ctx = routeContextFrom(req);
if (ctx == nullptr || ctx->stations == nullptr) {
httpd_resp_set_status(req, "503 Service Unavailable");
return httpd_resp_send(req, nullptr, 0);
}
std::array<char, 128> body{};
if (!readRequestBody(req, body)) {
httpd_resp_set_status(req, "400 Bad Request");
return httpd_resp_send(req, nullptr, 0);
}
auto parsed = core::parseStationReorderJson(body.data());
if (!parsed) {
const std::string json =
core::serializeStationListErrorJson(parseErrorToken(parsed.error()));
httpd_resp_set_status(req, "400 Bad Request");
httpd_resp_set_type(req, "application/json");
return httpd_resp_send(req, json.c_str(), json.size());
}
if (auto moved = ctx->stations->reorder(parsed->fromIndex, parsed->toIndex);
!moved) {
const std::string json = core::serializeStationListErrorJson(
core::stationListErrorToken(moved.error()));
httpd_resp_set_status(req, "409 Conflict");
httpd_resp_set_type(req, "application/json");
return httpd_resp_send(req, json.c_str(), json.size());
}
httpd_resp_set_type(req, "application/json");
return httpd_resp_send(req, "{\"status\":\"reordered\"}", 22);
}
esp_err_t stationsTunePostHandler(httpd_req_t* req) esp_err_t stationsTunePostHandler(httpd_req_t* req)
{ {
auto* ctx = routeContextFrom(req); auto* ctx = routeContextFrom(req);
@@ -1101,6 +1133,14 @@ std::expected<void, NetError> SetupWebServer::start(
}; };
httpd_register_uri_handler(server_, &stationsRemoveUri); httpd_register_uri_handler(server_, &stationsRemoveUri);
const httpd_uri_t stationsReorderUri = {
.uri = "/api/stations/reorder",
.method = HTTP_POST,
.handler = stationsReorderPostHandler,
.user_ctx = routeCtx,
};
httpd_register_uri_handler(server_, &stationsReorderUri);
const httpd_uri_t stationsTuneUri = { const httpd_uri_t stationsTuneUri = {
.uri = "/api/stations/tune", .uri = "/api/stations/tune",
.method = HTTP_POST, .method = HTTP_POST,
+64 -14
View File
@@ -261,11 +261,14 @@
if (s.dab) { if (s.dab) {
lines.push("DAB index: " + (s.dab.freq_index != null ? s.dab.freq_index : "—")); lines.push("DAB index: " + (s.dab.freq_index != null ? s.dab.freq_index : "—"));
if (s.dab.fic_quality != null) lines.push("FIC: " + s.dab.fic_quality); if (s.dab.fic_quality != null) lines.push("FIC: " + s.dab.fic_quality);
if (s.dab.dynamic_label) lines.push("Now: " + s.dab.dynamic_label);
} }
if (s.fm) { if (s.fm) {
if (s.fm.frequency_khz != null) lines.push("FM: " + s.fm.frequency_khz + " kHz"); if (s.fm.frequency_khz != null) lines.push("FM: " + s.fm.frequency_khz + " kHz");
if (s.fm.rssi_dbuv != null) lines.push("RSSI: " + s.fm.rssi_dbuv + " dBµV"); if (s.fm.rssi_dbuv != null) lines.push("RSSI: " + s.fm.rssi_dbuv + " dBµV");
if (s.fm.stereo != null) lines.push("Stereo: " + s.fm.stereo); if (s.fm.stereo != null) lines.push("Stereo: " + s.fm.stereo);
if (s.fm.station_name) lines.push("Station: " + s.fm.station_name);
if (s.fm.radiotext) lines.push("Text: " + s.fm.radiotext);
} }
return lines.join("\n"); return lines.join("\n");
} }
@@ -623,6 +626,7 @@
var label = s.name + " (" + s.band + ")"; var label = s.name + " (" + s.band + ")";
if (s.fm_frequency_khz) label += " " + s.fm_frequency_khz + " kHz"; if (s.fm_frequency_khz) label += " " + s.fm_frequency_khz + " kHz";
if (s.dab_freq_index != null) label += " idx " + s.dab_freq_index; if (s.dab_freq_index != null) label += " idx " + s.dab_freq_index;
if (s.dab_service_id != null) label += " svc " + s.dab_service_id;
li.textContent = label; li.textContent = label;
var tuneBtn = document.createElement("button"); var tuneBtn = document.createElement("button");
tuneBtn.textContent = "Tune"; tuneBtn.textContent = "Tune";
@@ -643,12 +647,60 @@
body: JSON.stringify({ index: idx }) body: JSON.stringify({ index: idx })
}).then(function () { loadPresets(); }); }).then(function () { loadPresets(); });
}); });
var upBtn = document.createElement("button");
upBtn.textContent = "Up";
upBtn.className = "secondary";
upBtn.disabled = idx === 0;
upBtn.addEventListener("click", function () {
fetch("/api/stations/reorder", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ from: idx, to: idx - 1 })
}).then(function () { loadPresets(); });
});
var downBtn = document.createElement("button");
downBtn.textContent = "Dn";
downBtn.className = "secondary";
downBtn.disabled = idx >= (data.stations.length - 1);
downBtn.addEventListener("click", function () {
fetch("/api/stations/reorder", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ from: idx, to: idx + 1 })
}).then(function () { loadPresets(); });
});
li.appendChild(tuneBtn); li.appendChild(tuneBtn);
li.appendChild(upBtn);
li.appendChild(downBtn);
li.appendChild(delBtn); li.appendChild(delBtn);
list.appendChild(li); list.appendChild(li);
}); });
} }
function buildPresetBody(name, band, status) {
var body = { name: name, band: band };
if (band === "fm") {
var khz = status && status.fm && status.fm.frequency_khz != null
? status.fm.frequency_khz
: parseInt(document.getElementById("fm-khz").value, 10);
body.fm_frequency_khz = khz;
} else {
var idx = status && status.dab && status.dab.freq_index != null
? status.dab.freq_index
: parseInt(document.getElementById("dab-index").value, 10);
body.dab_freq_index = idx;
if (status && status.dab && status.dab.playing_service_id != null) {
body.dab_service_id = status.dab.playing_service_id;
}
if (status && status.dab && status.dab.playing_component_id != null) {
body.dab_component_id = status.dab.playing_component_id;
}
}
var slotVal = document.getElementById("preset-slot").value;
if (slotVal) body.preset_slot = parseInt(slotVal, 10);
return body;
}
function loadPresets() { function loadPresets() {
return fetch("/api/stations") return fetch("/api/stations")
.then(function (r) { return r.json(); }) .then(function (r) { return r.json(); })
@@ -664,20 +716,18 @@
return; return;
} }
var band = document.getElementById("band").value; var band = document.getElementById("band").value;
var body = { name: name, band: band }; fetch("/api/tuner/status")
if (band === "fm") { .then(function (r) { return r.json(); })
body.fm_frequency_khz = parseInt(document.getElementById("fm-khz").value, 10); .then(function (status) {
} else { var body = buildPresetBody(name, band, status);
body.dab_freq_index = parseInt(document.getElementById("dab-index").value, 10); return fetch("/api/stations", {
} method: "POST",
var slotVal = document.getElementById("preset-slot").value; headers: { "Content-Type": "application/json" },
if (slotVal) body.preset_slot = parseInt(slotVal, 10); body: JSON.stringify(body)
fetch("/api/stations", { }).then(function (r) {
method: "POST", return r.json().then(function (d) { return { ok: r.ok, d: d }; });
headers: { "Content-Type": "application/json" }, });
body: JSON.stringify(body) })
})
.then(function (r) { return r.json().then(function (d) { return { ok: r.ok, d: d }; }); })
.then(function (res) { .then(function (res) {
if (res.ok && res.d.status === "saved") { if (res.ok && res.d.status === "saved") {
showMsg(msg, "Preset saved.", true); showMsg(msg, "Preset saved.", true);
Binary file not shown.
@@ -102,6 +102,21 @@ public:
[[nodiscard]] std::expected<void, core::StationListError> removeAt( [[nodiscard]] std::expected<void, core::StationListError> removeAt(
std::size_t index); std::size_t index);
/**
* @brief reorder — move a preset within the list and persist.
*
* @dname reorder
* @param fromIndex Current list position.
* @param toIndex Target list position.
* @return Ok on success, or StationListError.
* @pubstate mutates list_ and NVS on success.
*
* @author Michele Bigi
* @date 2026-07-06
*/
[[nodiscard]] std::expected<void, core::StationListError> reorder(
std::size_t fromIndex, std::size_t toIndex);
/** /**
* @brief tuneToIndex — recall a saved preset on the tuner. * @brief tuneToIndex — recall a saved preset on the tuner.
* *
@@ -62,8 +62,8 @@ std::expected<void, core::StationListError> StationService::add(
return added; return added;
} }
if (auto saved = persist(); !saved) { if (auto saved = persist(); !saved) {
list_.removeAt(list_.stations().size() - 1U); (void)list_.removeAt(list_.stations().size() - 1U);
return std::unexpected(core::StationListError::Full); return std::unexpected(core::StationListError::PersistFailed);
} }
return {}; return {};
} }
@@ -75,6 +75,22 @@ std::expected<void, core::StationListError> StationService::removeAt(
return removed; return removed;
} }
if (auto saved = persist(); !saved) { if (auto saved = persist(); !saved) {
return std::unexpected(core::StationListError::PersistFailed);
}
return {};
}
std::expected<void, core::StationListError> StationService::reorder(
std::size_t fromIndex,
std::size_t toIndex)
{
if (auto moved = list_.move(fromIndex, toIndex); !moved) {
return moved;
}
if (auto saved = persist(); !saved) {
if (list_.move(toIndex, fromIndex)) {
return std::unexpected(core::StationListError::PersistFailed);
}
return std::unexpected(core::StationListError::NotFound); return std::unexpected(core::StationListError::NotFound);
} }
return {}; return {};
@@ -20,6 +20,7 @@
#include <cstdint> #include <cstdint>
#include <expected> #include <expected>
#include <optional>
#include <vector> #include <vector>
namespace tuner { namespace tuner {
@@ -72,7 +73,7 @@ public:
* @dname tuneDab * @dname tuneDab
* @param freqIndex Ensemble index 037. * @param freqIndex Ensemble index 037.
* @return Ok on success, or a TunerError from ITuner. * @return Ok on success, or a TunerError from ITuner.
* @pubstate writes lastDabIndex_ on success. * @pubstate writes lastDabIndex_ on success; clears last-played DAB ids.
* *
* @author Michele Bigi * @author Michele Bigi
* @date 2026-07-06 * @date 2026-07-06
@@ -129,7 +130,7 @@ public:
* @param serviceId Selected service identifier. * @param serviceId Selected service identifier.
* @param componentId Audio component within the service. * @param componentId Audio component within the service.
* @return Ok on success, or a TunerError from ITuner. * @return Ok on success, or a TunerError from ITuner.
* @pubstate delegates to tuner_. * @pubstate delegates to tuner_; caches service/component for status JSON.
* *
* @author Michele Bigi * @author Michele Bigi
* @date 2026-07-06 * @date 2026-07-06
@@ -168,6 +169,8 @@ private:
std::uint8_t lastDabIndex_; std::uint8_t lastDabIndex_;
core::FrequencyKHz lastFmFrequency_; core::FrequencyKHz lastFmFrequency_;
std::uint8_t volume_; std::uint8_t volume_;
std::optional<std::uint32_t> lastPlayedServiceId_;
std::optional<std::uint32_t> lastPlayedComponentId_;
}; };
} // namespace tuner } // namespace tuner
@@ -37,6 +37,10 @@ std::expected<core::TunerStatus, core::TunerError> TunerService::refreshStatus()
auto status = tuner_.readStatus(); auto status = tuner_.readStatus();
if (status) { if (status) {
volume_ = status->volume; volume_ = status->volume;
if (status->band == core::TunerBand::Dab) {
status->dabPlayingServiceId = lastPlayedServiceId_;
status->dabPlayingComponentId = lastPlayedComponentId_;
}
} }
return status; return status;
} }
@@ -48,6 +52,8 @@ std::expected<void, core::TunerError> TunerService::tuneDab(
return result; return result;
} }
lastDabIndex_ = freqIndex; lastDabIndex_ = freqIndex;
lastPlayedServiceId_.reset();
lastPlayedComponentId_.reset();
return {}; return {};
} }
@@ -81,7 +87,12 @@ std::expected<void, core::TunerError> TunerService::playDabService(
std::uint32_t serviceId, std::uint32_t serviceId,
std::uint32_t componentId) std::uint32_t componentId)
{ {
return tuner_.playDabService(serviceId, componentId); if (auto result = tuner_.playDabService(serviceId, componentId); !result) {
return result;
}
lastPlayedServiceId_ = serviceId;
lastPlayedComponentId_ = componentId;
return {};
} }
std::expected<void, core::TunerError> TunerService::setVolume(std::uint8_t level) std::expected<void, core::TunerError> TunerService::setVolume(std::uint8_t level)
+12 -26
View File
@@ -12,16 +12,15 @@ errors, no plaintext secrets.
Working directory for all commands is `Software/`. Working directory for all commands is `Software/`.
**Current firmware:** `0.7.1`CI green gate (Doxygen + host tests + **Current firmware:** `0.8.0`broadcast metadata (RDS PS/RT, DAB DLS),
manual sync), BT1035 pairing, station presets. preset reorder, CI gate (Doxygen + host tests + manual sync).
--- ---
## Completed (fw 0.7.0) ## Completed (fw 0.7.00.7.2)
- **Station / preset list (T3 core)** — `Station`, `StationList`, NVS key - **Broadcast metadata (T4)** — RDS PS/RT and DAB DLS in
`station_list`, `StationService`, REST + Presets UI. Remaining polish: `/api/tuner/status`, core parsers, Si4684 driver hook, UI lines.
reorder API, save DAB `service_id`/`component_id` from UI, HIL on device.
- **BT1035 pairing** — `AT+PAIR`, `AT+A2DPSTAT`, `AT+A2DPDISC`, - **BT1035 pairing** — `AT+PAIR`, `AT+A2DPSTAT`, `AT+A2DPDISC`,
`BluetoothService`, REST + UI (not numbered below; landed with Slice 7). `BluetoothService`, REST + UI (not numbered below; landed with Slice 7).
@@ -42,27 +41,14 @@ push/PR to `main`.
## P1 — Missing domain features ## P1 — Missing domain features
### T3. Station / preset list — polish *(core done in 0.7.0)* ### T3. Station / preset list — polish **DONE (fw 0.7.2)**
**Status:** CRUD, NVS persistence, tune recall, and basic UI are shipped. Reorder API (`POST /api/stations/reorder`), DAB playing ids in tuner
**Remaining:** status and preset save, UI Up/Dn, host tests. **Remaining:** device HIL
- `POST /api/stations/reorder` (core has `StationList::move()`). (preset survives reboot) — manual only.
- Save DAB presets with `service_id` / `component_id` from last played service.
- Device HIL: preset survives reboot, tune recall on hardware.
**Done when:** the gaps above are closed and covered by tests.
### T4. Broadcast metadata (RDS / DLS) ### T4. Broadcast metadata (RDS / DLS) — **DONE (fw 0.8.0)**
**Why:** `TunerStatus` currently carries only a 17-char `label`. Real `BroadcastLabel`, RDS accumulator, DAB DLS accumulator, driver
radio UX needs the FM RDS station name/radiotext and DAB DLS dynamic `readDabServiceData`, status JSON fields, UI now-playing lines, host tests.
label so the UI can show "what's playing".
**What:**
- Extend the tuner data model with structured metadata (station name,
radiotext/dynamic label), read from the Si4684 in the driver.
- Surface it through `TunerService::refreshStatus` and the
`/api/tuner/status` JSON.
- Keep the Si4684 register/command details in the driver; the core model
stays hardware-free.
**Done when:** the status JSON exposes the metadata and host tests cover
the parsing of raw label bytes into the model.
### T5. Remove the services stub — integration service ### T5. Remove the services stub — integration service
**Why:** `components/services/src/component_stub.cpp` is a Slice-7 **Why:** `components/services/src/component_stub.cpp` is a Slice-7
+15 -4
View File
@@ -36,7 +36,7 @@ Returns a health-check DTO serialised by
\begin{drnote}[Response schema] \begin{drnote}[Response schema]
\begin{drcode}[JSON] \begin{drcode}[JSON]
{"status":"ok","fw":"0.7.0", {"status":"ok","fw":"0.8.0",
"chips":{"si4684":true,"adau1701":true,"bt1035":true}} "chips":{"si4684":true,"adau1701":true,"bt1035":true}}
\end{drcode} \end{drcode}
\begin{itemize} \begin{itemize}
@@ -108,15 +108,20 @@ and~\ref{sec:si4684-fm-session}.
\begin{drnote}[Response schema (DAB example)] \begin{drnote}[Response schema (DAB example)]
\begin{drcode}[JSON] \begin{drcode}[JSON]
{"booted":true,"band":"dab","locked":true,"volume":63, {"booted":true,"band":"dab","locked":true,"volume":63,
"dab":{"freq_index":12,"fic_quality":80,"cnr_db":25},"fm":null} "dab":{"freq_index":12,"fic_quality":80,"cnr_db":25,
"playing_service_id":42,"playing_component_id":7,
"dynamic_label":"Live show"},"fm":null}
\end{drcode} \end{drcode}
For FM, \texttt{fm} carries \texttt{frequency\_khz}, \texttt{rssi\_dbuv}, For FM, \texttt{fm} carries \texttt{frequency\_khz}, \texttt{rssi\_dbuv},
\texttt{snr\_db}, and \texttt{stereo}; \texttt{dab} is \texttt{null}. \texttt{snr\_db}, \texttt{stereo}, optional \texttt{station\_name} (RDS PS),
and \texttt{radiotext} (RDS RT); \texttt{dab} is \texttt{null}.
\end{drnote} \end{drnote}
HTTP status: \textbf{200 OK}; \textbf{500} with HTTP status: \textbf{200 OK}; \textbf{500} with
\texttt{\{"status":"error","reason":...\}} on driver failure; \texttt{\{"status":"error","reason":...\}} on driver failure;
\textbf{503} when the tuner service is unavailable. \textbf{503} when the tuner service is unavailable. FM responses may include
\texttt{station\_name} and \texttt{radiotext}; DAB responses may include
\texttt{dynamic\_label} when a programme is playing.
\subsection{\texttt{GET /api/tuner/services}} \subsection{\texttt{GET /api/tuner/services}}
\label{sec:api-tuner-services} \label{sec:api-tuner-services}
@@ -306,6 +311,12 @@ Adds one preset (\texttt{core::parseStationJson()}); persists via
Removes a preset by list index (\texttt{\{"index":0\}}). Removes a preset by list index (\texttt{\{"index":0\}}).
\subsection{\texttt{POST /api/stations/reorder}}
\label{sec:api-stations-reorder}
Reorders presets using \texttt{StationList::move()}. Body:
\texttt{\{"from":1,"to":0\}}. Success: \texttt{\{"status":"reordered"\}}.
\subsection{\texttt{POST /api/stations/tune}} \subsection{\texttt{POST /api/stations/tune}}
\label{sec:api-stations-tune} \label{sec:api-stations-tune}
+12
View File
@@ -230,6 +230,18 @@ Validated at the HTTP boundary by \texttt{core::parseEnhanceLevelJson()}.
Strong type for a preset label (1--32 bytes). Parsed at the HTTP boundary Strong type for a preset label (1--32 bytes). Parsed at the HTTP boundary
via \texttt{StationName::tryFrom()}. via \texttt{StationName::tryFrom()}.
\section{BroadcastLabel}\label{cls:BroadcastLabel}
Trimmed on-air label from RDS or DAB chip byte buffers (up to 128 bytes).
Built by \texttt{BroadcastLabel::tryFromChipBytes()} in the pure core.
\section{RdsMetadataAccumulator}\label{cls:RdsMetadataAccumulator}
Stateful RDS decoder assembling program service name and radiotext from
raw block~A--D snapshots returned by the Si4684 driver.
\section{DabDynamicLabelAccumulator}\label{cls:DabDynamicLabelAccumulator}
Reassembles segmented DAB DLS payloads into one dynamic label for
\texttt{TunerStatus}.
\section{PresetSlot}\label{cls:PresetSlot} \section{PresetSlot}\label{cls:PresetSlot}
Optional hardware preset button index (1--20). Validated by Optional hardware preset button index (1--20). Validated by
\texttt{PresetSlot::tryFrom()}. \texttt{PresetSlot::tryFrom()}.
+3 -1
View File
@@ -180,7 +180,9 @@ Requires \texttt{boot(Si4684Band::Fm)}.
\item \texttt{tuneFm(frequencyKhz)} --- FM\_TUNE\_FREQ, waits for STC. \item \texttt{tuneFm(frequencyKhz)} --- FM\_TUNE\_FREQ, waits for STC.
\item \texttt{seekFm(up, wrap)} --- FM\_SEEK\_START; returns tuned kHz. \item \texttt{seekFm(up, wrap)} --- FM\_SEEK\_START; returns tuned kHz.
\item \texttt{readFmRsq()} --- RSSI, SNR, stereo flag, validity. \item \texttt{readFmRsq()} --- RSSI, SNR, stereo flag, validity.
\item \texttt{readFmRds()} --- last RDS group blocks A--D. \item \texttt{readFmRds()} --- last RDS group blocks A--D (FIFO depth).
\item \texttt{readDabServiceData(statusOnly, ack)} --- DAB data-service
payload (DLS when \texttt{DATA\_SRC=2}).
\end{itemize} \end{itemize}
\subsection{DAB operations} \subsection{DAB operations}