feat: add SensorType enums and update telemetry handling in MQTT client - #31
Merged
Conversation
|
Thanks for opening this pull request, @stuartp44! A maintainer will review your PR soon. In the meantime, please make sure:
Feel free to ask questions if you need help! |
|
🎉 This PR is included in version 1.11.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
This pull request introduces a new
enumsmodule for MQTT/protobuf telemetry, providing strongly-typed access to sensor, actuator, process, and error codes throughout the codebase and CLI. The changes improve the clarity and usability of sensor data, enhance the CLI with more human-readable output, and update documentation and exports to reflect these improvements.Core improvements:
pymbrewclient.mqtt.enumsmodule definingSensorType,ActuatorType,MachineType,MachineConnectionStatus,ProcessType,ProcessPhase,ProcessState,ErrorType, andUserActionenums for MiniBrew telemetry, enabling typed access to measurement and state identifiers.Codebase integration and exports:
__init__.pyfiles insrc/pymbrewclientandsrc/pymbrewclient/mqttto import and export the new enums, making them available for users and internal modules. [1] [2] [3]CLI enhancements:
--versionoption to the CLI to display the installedpymbrewclientversion. [1] [2] [3]Documentation updates:
SensorTypeand the new typed measurement access patterns, reflecting the improved approach to sensor data. [1] [2] [3] [4]Internal code updates: