Skip to content

DEV-1215 Raw Audio config option for Shimmer3R (internal use) - #329

Closed
harithjamadi wants to merge 3 commits into
masterfrom
DEV-1215
Closed

harithjamadi wants to merge 3 commits into
masterfrom
DEV-1215

Conversation

@harithjamadi

@harithjamadi harithjamadi commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds the Shimmer3R Raw Audio config option (SD experiment config byte, bit 1) used by the DEV-1215 audio sync work.

  • Configuration.Shimmer3.GuiLabelConfig.RAW_AUDIO option, compatible with Shimmer3R LogAndStream 1.1.21 and later.
  • The bit is only written when the app allows it (ShimmerObject.setRawAudioAllowed, off by default). Consensys turns it on for internal builds only, so other apps always write it as 0.
  • Read back from the device config as usual.

Merge order

  1. This PR
  2. ShimmerResearch/Shimmer-Advance-API#515 (uses setRawAudioAllowed)
  3. ShimmerResearch/ConsensysApps#505

Testing

  • ShimmerDriver tests pass.
  • On a Shimmer3R: box unticked gives no WAV on the card, ticked gives a WAV; public Consensys clears it.

Config byte 218 (SD trial config 1), bit 1: the audiorec9 bench firmware
stores the microphone WAV beside the fingerprint only when it is set.
Shimmer3R LogAndStream v1.1.21 and later.
Stored in the config map as Raw_Audio and read back, cleared with the
default config, and ignored on devices that do not support it.
Off by default, so any app that has not switched it on writes the bit as
0 and a config write clears raw audio on the device.
Copilot AI lite review requested due to automatic review settings October 21, 2026 03:17

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No unresolved blocking issues were identified.

No open issues 🎉

What changed in this PR

Adds gated Shimmer3R Raw Audio configuration support for compatible LogAndStream firmware.

Changes:

  • Adds the Raw Audio configuration option and database mapping.
  • Reads and writes SD experiment config byte 1, bit 1.
  • Restricts enabling Raw Audio to explicitly authorized apps.
File Description
ShimmerDriver/​src/​main/​java/​com/​shimmerresearch/​driver/​ShimmerObject.java Handles Raw Audio state, persistence, and serialization.
ShimmerDriver/​src/​main/​java/​com/​shimmerresearch/​driver/​ShimmerDevice.java Adds the Raw Audio database configuration key.
ShimmerDriver/​src/​main/​java/​com/​shimmerresearch/​driver/​shimmer2r3/​ConfigByteLayoutShimmer3.java Defines the Raw Audio bit layout.
ShimmerDriver/​src/​main/​java/​com/​shimmerresearch/​driver/​Configuration.java Registers the compatible Shimmer3R configuration option.

Review effort: Lite

@harithjamadi

Copy link
Copy Markdown
Contributor Author

Closing: DEV-1215 audio sync is experimental for now, not for merging. The DEV-1215 branch stays for reference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants