Add barcode scanner external bus messages#6903
Open
TimoPtr wants to merge 1 commit into
Open
Conversation
TimoPtr
added
the
WebViewActivity replacement
52 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Adds typed external-bus support for barcode-scanner interactions in the new FrontendScreen pipeline (incoming message models, outgoing command factories, and handler events), with accompanying unit tests.
Changes:
- Introduces incoming external-bus message models for
bar_code/scan,bar_code/notify, andbar_code/close - Adds outgoing command factories for
bar_code/scan_resultandbar_code/aborted - Wires barcode messages into
FrontendMessageHandlerand adds unit tests for parsing/serialization and handler event emission
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| app/src/main/kotlin/io/homeassistant/companion/android/frontend/externalbus/incoming/IncomingExternalBusMessage.kt | Adds typed incoming barcode message models (scan, notify, close) |
| app/src/main/kotlin/io/homeassistant/companion/android/frontend/externalbus/outgoing/CommandMessage.kt | Adds typed outgoing barcode command factories (scan_result, aborted) |
| app/src/main/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendMessageHandler.kt | Maps incoming barcode messages to new handler events |
| app/src/main/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendHandlerEvent.kt | Defines new barcode-related handler events and documentation |
| app/src/main/kotlin/io/homeassistant/companion/android/frontend/FrontendViewModel.kt | Stubs barcode event handling (logging only) until follow-up PR |
| app/src/test/kotlin/io/homeassistant/companion/android/frontend/externalbus/incoming/IncomingExternalBusMessageTest.kt | Adds JSON parsing tests for incoming barcode messages |
| app/src/test/kotlin/io/homeassistant/companion/android/frontend/externalbus/outgoing/CommandMessageTest.kt | Adds serialization tests for outgoing barcode commands |
| app/src/test/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendMessageHandlerTest.kt | Adds handler emission tests for barcode events |
Comment on lines
+104
to
+115
| /** | ||
| * Frontend asked the app to open the barcode scanner overlay. | ||
| * | ||
| * Carries the original message [messageId] (required — the frontend correlates the eventual | ||
| * scan result or cancellation by this id) and the user-facing strings the overlay should display. | ||
| */ | ||
| data class ShowBarcodeScanner( | ||
| val messageId: Int, | ||
| val title: String, | ||
| val description: String, | ||
| val alternativeOptionLabel: String?, | ||
| ) : FrontendHandlerEvent |
| */ | ||
| @Serializable | ||
| @SerialName("bar_code/scan") | ||
| data class BarcodeScanMessage(override val id: Int? = null, val payload: BarcodeScanPayload) : |
Comment on lines
+235
to
+241
| Timber.d("Barcode scan request received with id: ${message.id}") | ||
| FrontendHandlerEvent.ShowBarcodeScanner( | ||
| messageId = message.id ?: -1, | ||
| title = message.payload.title, | ||
| description = message.payload.description, | ||
| alternativeOptionLabel = message.payload.alternativeOptionLabel, | ||
| ) |
Comment on lines
+399
to
+413
| @Test | ||
| fun `Given bar_code scan message without id when messageResults then ShowBarcodeScanner messageId is -1`() = runTest { | ||
| val message = BarcodeScanMessage( | ||
| id = null, | ||
| payload = BarcodeScanPayload(title = "t", description = "d"), | ||
| ) | ||
| every { externalBusRepository.incomingMessages() } returns flowOf(message) | ||
|
|
||
| handler.messageResults().test { | ||
| val result = awaitItem() | ||
| assertTrue(result is FrontendHandlerEvent.ShowBarcodeScanner) | ||
| assertEquals(-1, (result as FrontendHandlerEvent.ShowBarcodeScanner).messageId) | ||
| expectNoEvents() | ||
| } | ||
| } |
Comment on lines
+107
to
+121
| * @param id The id of the originating [io.homeassistant.companion.android.frontend.externalbus.incoming.BarcodeScanMessage] | ||
| * @param rawValue The decoded barcode contents, verbatim | ||
| * @param format The decoded format name, lowercased — `qr_code`, `code_128`, `pdf417`, etc., or | ||
| * `unknown` for formats the frontend does not recognise. | ||
| * | ||
| * @see CommandMessage | ||
| */ | ||
| object BarcodeScanResultMessage { | ||
| operator fun invoke(id: Int, rawValue: String, format: String): OutgoingExternalBusMessage = CommandMessage( | ||
| id = id, | ||
| command = "bar_code/scan_result", | ||
| payload = frontendExternalBusJson.encodeToJsonElement( | ||
| ScanResultPayload(rawValue = rawValue, format = format), | ||
| ), | ||
| ) |
Member
There was a problem hiding this comment.
It is lowercased in the bar code scanner (caller)
TimoPtr
force-pushed
the
feature/barcode_scanner
branch
3 times, most recently
from
7dfc793 to
4e0373a
Compare
TimoPtr
force-pushed
the
feature/barcode_scanner
branch
from
4e0373a to
8e19ce3
Compare
jpelgrom
approved these changes
May 28, 2026
Member
jpelgrom
left a comment
jpelgrom
left a comment
There was a problem hiding this comment.
Minor nitpicks about comments, up to you to agree or disagree
Comment on lines
+280
to
+283
| * | ||
| * Will not be sent by the frontend when the device reports | ||
| * [io.homeassistant.companion.android.frontend.externalbus.outgoing.ConfigResult.hasBarCodeScanner] = `0` | ||
| * (Automotive or no camera). |
Member
There was a problem hiding this comment.
It also won't be sent if you don't use a feature requiring a barcode scanner, or the server version is old, or any number of other reasons. I don't think we should mention when the frontend sends the message if it is the start with a generic feature, like here. The frontend will send it whenever it wants and might change.
Suggested change
| * | |
| * Will not be sent by the frontend when the device reports | |
| * [io.homeassistant.companion.android.frontend.externalbus.outgoing.ConfigResult.hasBarCodeScanner] = `0` | |
| * (Automotive or no camera). |
| ) : FrontendHandlerEvent | ||
|
|
||
| /** | ||
| * Frontend asked the app to surface a notification dialog on top of the active scanner. |
Member
There was a problem hiding this comment.
Match other description
Suggested change
| * Frontend asked the app to surface a notification dialog on top of the active scanner. | |
| * Frontend requested the app to display a notification dialog on top of the active scanner. |
| data class ConfigureImprovDevice(val deviceName: String) : FrontendHandlerEvent | ||
|
|
||
| /** | ||
| * Frontend asked the app to open the barcode scanner overlay. |
Member
There was a problem hiding this comment.
Suggested change
| * Frontend asked the app to open the barcode scanner overlay. | |
| * Frontend requested the app to open the barcode scanner overlay. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This is the first PR to bring barcode capabilities to the FrontendScreen by adding the external bus messages definition and handling to the new code.
Checklist