Add websockets transport mechanism to MQTT #15601
Open
Conversation
This file contains 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
## Proposed change Add websockets transport mechanism to MQTT. An MQTT server is not always reachable only as raw TCP on port 1881; it can also be accessed as a WebSocket server, sometimes even behind a reverse proxy with TLS. Paho MQTT supports this feature, as does Mosquitto. The default transport option was set to 'tcp', so this change will not affect an already configured Frigate app. The configuration change is validated using a call to a pydantic library field validator. This patch has been tested with Mosquitto 1.6 and 2.0, as well as with a server behind a reverse proxy on port 443 (requiring a TLS connection). The docs/configuration/reference.md file has also been updated to reflect this change. ## Type of change - [ ] Dependency upgrade - [ ] Bugfix (non-breaking change which fixes an issue) - [x] New feature - [ ] Breaking change (fix/feature causing existing functionality to break) - [ ] Code quality improvements to existing code - [x] Documentation Update ## Additional information - This PR fixes or closes issue: fixes blakeblackshear#15600 - This PR is related to issue: ## Checklist - [x] The code change is tested and works locally. - [ ] Local tests pass. **Your PR cannot be merged unless tests pass** - [x] There is no commented out code in this PR. - [x] The code has been formatted using Ruff (`ruff format frigate`)
✅ Deploy Preview for frigate-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
NickM-27
requested changes
Dec 19, 2024
| @@ -15,6 +15,7 @@ class MqttConfig(FrigateBaseModel): | |||
| enabled: bool = Field(default=True, title="Enable MQTT Communication.") | |||
| host: str = Field(default="", title="MQTT Host") | |||
| port: int = Field(default=1883, title="MQTT Port") | |||
| transport: str = Field(default="tcp", title="MQTT Transport Mechanism") | |||
There was a problem hiding this comment.
I think it would be better if we added an enum class to MQTT and used that vs a manual field validator.
| @@ -168,9 +168,11 @@ def _on_disconnect( | |||
|
|
|||
| def _start(self) -> None: | |||
| """Start mqtt client.""" | |||
| logger.info("MQTT transport mechanism: %s" % str(self.mqtt_config.transport)) | |||
There was a problem hiding this comment.
I don't think this should be an info log.
There was a problem hiding this comment.
ok, debug maybe or get rid of this line ?
|
You'll also need to ensure your code is formatted using ruff as the linter is failing. |
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.
Proposed change
Add websockets transport mechanism to MQTT.
An MQTT server is not always reachable only as raw TCP on port 1881; it can also be accessed as a WebSocket server, sometimes even behind a reverse proxy with TLS. Paho MQTT supports this feature, as does Mosquitto.
The default transport option was set to 'tcp', so this change will not affect an already configured Frigate app.
The configuration change is validated using a call to a pydantic library field validator.
This patch has been tested with Mosquitto 1.6 and 2.0, as well as with a server behind a reverse proxy on port 443 (requiring a TLS connection).
The docs/configuration/reference.md file has also been updated to reflect this change.
Type of change
Additional information
Checklist
ruff format frigate)